:py:mod:`rofunc.utils.datalab.data_sampler.holders`
===================================================

.. py:module:: rofunc.utils.datalab.data_sampler.holders

.. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`DataHolder <rofunc.utils.datalab.data_sampler.holders.DataHolder>`
     - .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.DataHolder
          :summary:
   * - :py:obj:`RGBDDataHolder <rofunc.utils.datalab.data_sampler.holders.RGBDDataHolder>`
     -
   * - :py:obj:`XsensDataHolder <rofunc.utils.datalab.data_sampler.holders.XsensDataHolder>`
     -
   * - :py:obj:`OptitrackDataHolder <rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder>`
     -
   * - :py:obj:`MultimodalDataHandler <rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler>`
     - .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler
          :summary:

API
~~~

.. py:class:: DataHolder()
   :canonical: rofunc.utils.datalab.data_sampler.holders.DataHolder

   Bases: :py:obj:`object`

   .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.DataHolder

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.DataHolder.__init__

   .. py:property:: sampled_data
      :canonical: rofunc.utils.datalab.data_sampler.holders.DataHolder.sampled_data

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.DataHolder.sampled_data

   .. py:method:: to_pcd(frame_number)
      :canonical: rofunc.utils.datalab.data_sampler.holders.DataHolder.to_pcd
      :abstractmethod:

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.DataHolder.to_pcd

   .. py:method:: lin_trans(data, inv=False)
      :canonical: rofunc.utils.datalab.data_sampler.holders.DataHolder.lin_trans

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.DataHolder.lin_trans

.. py:class:: RGBDDataHolder(root_path, show_color=True, stat_clean=True, depth_trunc=3500, size=(1920, 1080), tshift=0)
   :canonical: rofunc.utils.datalab.data_sampler.holders.RGBDDataHolder

   Bases: :py:obj:`rofunc.utils.datalab.data_sampler.holders.DataHolder`

   .. py:method:: to_pcd(frame_number)
      :canonical: rofunc.utils.datalab.data_sampler.holders.RGBDDataHolder.to_pcd

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.RGBDDataHolder.to_pcd

   .. py:method:: orig_fn_to_sampled(frame_number)
      :canonical: rofunc.utils.datalab.data_sampler.holders.RGBDDataHolder.orig_fn_to_sampled

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.RGBDDataHolder.orig_fn_to_sampled

.. py:class:: XsensDataHolder(root_path, transform=None)
   :canonical: rofunc.utils.datalab.data_sampler.holders.XsensDataHolder

   Bases: :py:obj:`rofunc.utils.datalab.data_sampler.holders.DataHolder`

   .. py:property:: sampled_data
      :canonical: rofunc.utils.datalab.data_sampler.holders.XsensDataHolder.sampled_data

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.XsensDataHolder.sampled_data

   .. py:method:: sampled_match(label, pos_array, fnb=0, bnds=None)
      :canonical: rofunc.utils.datalab.data_sampler.holders.XsensDataHolder.sampled_match

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.XsensDataHolder.sampled_match

   .. py:method:: to_pcd(frame_number)
      :canonical: rofunc.utils.datalab.data_sampler.holders.XsensDataHolder.to_pcd

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.XsensDataHolder.to_pcd

.. py:class:: OptitrackDataHolder(meta=None, labels=None, data=None)
   :canonical: rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder

   Bases: :py:obj:`rofunc.utils.datalab.data_sampler.holders.DataHolder`

   .. py:property:: sampled_data
      :canonical: rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder.sampled_data

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder.sampled_data

   .. py:method:: to_pcd(frame_number)
      :canonical: rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder.to_pcd

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder.to_pcd

   .. py:method:: orig_fn_to_sampled(frame_number)
      :canonical: rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder.orig_fn_to_sampled

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.OptitrackDataHolder.orig_fn_to_sampled

.. py:class:: MultimodalDataHandler(tstep: int = None, tstart: int = None, tstop: int = None, data_holders: typing.List[rofunc.utils.datalab.data_sampler.holders.DataHolder] = None, interpolate: str = 'repeat')
   :canonical: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler

   Bases: :py:obj:`object`

   .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.__init__

   .. py:property:: sampled_data
      :canonical: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.sampled_data

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.sampled_data

   .. py:method:: update_bounds()
      :canonical: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.update_bounds

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.update_bounds

   .. py:method:: add_data()
      :canonical: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.add_data

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.add_data

   .. py:method:: sample(bounds: typing.Tuple[int, int] = None, tstep=None, interpolate: str = None)
      :canonical: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.sample

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.sample

   .. py:method:: get_slice(bounds)
      :canonical: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.get_slice

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.get_slice

   .. py:method:: to_pcd(frame_number, show_holder=None)
      :canonical: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.to_pcd

      .. autodoc2-docstring:: rofunc.utils.datalab.data_sampler.holders.MultimodalDataHandler.to_pcd