robokudo.io.file_reader_interface
=================================

.. py:module:: robokudo.io.file_reader_interface


Classes
-------

.. autoapisummary::

   robokudo.io.file_reader_interface.FileReaderInterface
   robokudo.io.file_reader_interface.RGBDFileReaderInterface


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

.. py:class:: FileReaderInterface(camera_config)

   Bases: :py:obj:`robokudo.io.camera_interface.CameraInterface`


   CameraInterface that can read stored data from your local filesystem.
   Data must be read from a directory that shall have the following files:
     - rk_TIMESTAMP_color_image.jpg
     - rk_TIMESTAMP_depth_image.png
     - rk_TIMESTAMP_cam_info.json
   Please note that rk_ is the default prefix, but could be changed.
   The data type (the part before the file extension) is derived from the CASViews.x that have been recorded.

   Data from the filesystem is read once during initialization.

   Please consider using the StorageReaderInterface, as we rather focus on developing that interface.
   This interface is mostly used for simple use cases in unit tests, small demos, etc.


   .. py:class:: DictIteratorReader(data=dict(), data_sequence=[])

      .. py:attribute:: index
         :value: None



      .. py:attribute:: data


      .. py:attribute:: data_sequence
         :value: []



      .. py:method:: reset_cursor()


      .. py:method:: cursor_has_data()


      .. py:method:: get_next_data() -> Optional[dict]



   .. py:attribute:: initialized
      :value: False



   .. py:attribute:: loaded_paths


   .. py:attribute:: loaded_data


   .. py:attribute:: data_reader


   .. py:method:: has_new_data()


.. py:class:: RGBDFileReaderInterface(camera_config)

   Bases: :py:obj:`FileReaderInterface`


   CameraInterface that can read stored data from your local filesystem.
   Data must be read from a directory that shall have the following files:
     - rk_TIMESTAMP_color_image.jpg
     - rk_TIMESTAMP_depth_image.png
     - rk_TIMESTAMP_cam_info.json
   Please note that rk_ is the default prefix, but could be changed.
   The data type (the part before the file extension) is derived from the CASViews.x that have been recorded.

   Data from the filesystem is read once during initialization.

   Please consider using the StorageReaderInterface, as we rather focus on developing that interface.
   This interface is mostly used for simple use cases in unit tests, small demos, etc.


   .. py:method:: set_data(cas: robokudo.cas.CAS)