:py:mod:`tonic.datasets.visual_place_recognition`
=================================================

.. py:module:: tonic.datasets.visual_place_recognition


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   tonic.datasets.visual_place_recognition.VPR




.. py:class:: VPR(save_to, transform: collections.abc.Callable | None = None, target_transform: collections.abc.Callable | None = None, transforms: collections.abc.Callable | None = None)


   Bases: :py:obj:`tonic.dataset.Dataset`

   `Visual Place Recognition <https://zenodo.org/record/4302805>`_

   Event-Based Visual Place Recognition With Ensembles of Temporal Windows.
   Events have (txyp) ordering.

   .. note::  To be able to read this dataset and its GPS files, you will need the `pynmea2` package installed.

   ::

       @article{fischer2020event,
         title={Event-based visual place recognition with ensembles of temporal windows},
         author={Fischer, Tobias and Milford, Michael},
         journal={IEEE Robotics and Automation Letters},
         volume={5},
         number={4},
         pages={6924--6931},
         year={2020},
         publisher={IEEE}
       }

   :param save_to: Location to save files to on disk.
   :type save_to: string
   :param transform: A callable of transforms to apply to the data.
   :type transform: callable, optional
   :param target_transform: A callable of transforms to apply to the targets/labels.
   :type target_transform: callable, optional
   :param transforms: A callable of transforms that is applied to both data and
                      labels at the same time.
   :type transforms: callable, optional

   .. py:attribute:: base_url
      :value: 'https://zenodo.org/record/4302805/files/'

      

   .. py:attribute:: recordings
      :value: [[['dvs_vpr_2020-04-21-17-03-03.bag', '04473f623aec6bda3d7eadfecfc1b2ce'],...

      

   .. py:attribute:: sensor_size
      :value: (346, 260, 2)

      

   .. py:attribute:: dtype

      

   .. py:attribute:: ordering

      

   .. py:method:: __getitem__(index)

      :returns: a tuple of (data, target) where data is another tuple of (events, imu, images) and target is gps positional data.


   .. py:method:: __len__()


   .. py:method:: download()

      Downloads from a given url, places into target folder and verifies the file hash.


   .. py:method:: read_gps_file(nmea_file_path)