dcnum.read.mapped

Classes

MappedHDF5Dataset

An index-mapped object for accessing an HDF5 dataset

Functions

get_mapping_indices(index_mapping)

Return integer numpy array with mapping indices for a range

_get_mapping_indices_cached(index_mapping)

get_mapped_object(obj[, index_mapping])

Module Contents

class dcnum.read.mapped.MappedHDF5Dataset(h5ds: dcnum.common.h5py.Dataset, mapping_indices: numpy.ndarray)[source]

An index-mapped object for accessing an HDF5 dataset

Parameters:

  • h5ds (h5py.Dataset) – HDF5 dataset from which to map data

  • mapping_indices (np.ndarray) – numpy indexing array containing integer indices

h5ds
mapping_indices
shape
__getitem__(idx)[source]
__len__()[source]
dcnum.read.mapped.get_mapping_indices(index_mapping: numbers.Integral | slice | list | numpy.ndarray)[source]

Return integer numpy array with mapping indices for a range

Parameters:

index_mapping (numbers.Integral | slice | list | np.ndarray) – 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

dcnum.read.mapped._get_mapping_indices_cached(index_mapping: numbers.Integral | tuple)[source]
dcnum.read.mapped.get_mapped_object(obj, index_mapping=None)[source]