Skip to content

nabu.io

source package nabu.io

Classes

  • NPReader — Reader for NPY/NPZ files. Mostly used for internal development. Please refer to the documentation of nabu.io.reader.Reader

  • EDFReader — A class for reading series of EDF Files. Multi-frames EDF are not supported.

  • HDF5Loader — An alternative class to HDF5Reader where information is first passed at class instantiation

  • NXProcessWriter — A class to write Nexus file with a processing result.

source class NPReader(sub_region=None, mmap=True)

Bases : Reader

Reader for NPY/NPZ files. Mostly used for internal development. Please refer to the documentation of nabu.io.reader.Reader

Methods

source method NPReader.get_data(data_url)

source method NPReader.release()

source class EDFReader(sub_region=None)

Bases : Reader

A class for reading series of EDF Files. Multi-frames EDF are not supported.

Methods

source method EDFReader.read(fname)

source method EDFReader.get_data(data_url)

source class HDF5Loader(fname, data_path, sub_region=None, data_buffer=None, pre_allocate=True, dtype='f')

An alternative class to HDF5Reader where information is first passed at class instantiation

Methods

source method HDF5Loader.load_data(force_load=False, output=None)

source class NXProcessWriter(fname, entry=None, filemode='a', overwrite=False)

Bases : Writer

A class to write Nexus file with a processing result.

Initialize a NXProcessWriter.

Parameters

  • fname : str — Path to the HDF5 file.

  • entry : str, optional — Entry in the HDF5 file. Default is "entry"

Methods

  • write — Write the result in the current NXProcess group.

source method NXProcessWriter.write(result, process_name, processing_index=0, config=None, data_name='data', is_frames_stack=True, direct_access=True)

Write the result in the current NXProcess group.

Parameters

  • result : numpy.ndarray — Array containing the processing result

  • process_name : str — Name of the processing

  • processing_index : int — Index of the processing (in a pipeline)

  • config : dict, optional — Dictionary containing the configuration.