dcnum.read.mapped
=================

.. py:module:: dcnum.read.mapped


Classes
-------

.. autoapisummary::

   dcnum.read.mapped.MappedHDF5Dataset


Functions
---------

.. autoapisummary::

   dcnum.read.mapped.get_mapping_indices
   dcnum.read.mapped._get_mapping_indices_cached
   dcnum.read.mapped.get_mapped_object


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

.. py:class:: MappedHDF5Dataset(h5ds: dcnum.common.h5py.Dataset, mapping_indices: numpy.ndarray)

   An index-mapped object for accessing an HDF5 dataset

   :param h5ds: HDF5 dataset from which to map data
   :type h5ds: h5py.Dataset
   :param mapping_indices: numpy indexing array containing integer indices
   :type mapping_indices: np.ndarray


   .. py:attribute:: h5ds


   .. py:attribute:: mapping_indices


   .. py:attribute:: shape


   .. py:method:: __getitem__(idx)


   .. py:method:: __len__()


.. py:function:: get_mapping_indices(index_mapping: numbers.Integral | slice | list | numpy.ndarray)

   Return integer numpy array with mapping indices for a range

   :param index_mapping: Several options you have here:
                         - integer: results in np.arrange(integer)
                         - slice: results in np.arrange(slice.start, slice.stop, slice.step)
                         - list or np.ndarray: returns the input as  unit32 array
   :type index_mapping: numbers.Integral | slice | list | np.ndarray


.. py:function:: _get_mapping_indices_cached(index_mapping: numbers.Integral | tuple)

.. py:function:: get_mapped_object(obj, index_mapping=None)