ranking_HM.Rank.from_hdf5#

Back to Class page

Summary#

Load the class from a hdf5 file

Signature#

def from_hdf5(cls, path, outformat = h5py.Dataset, mode = 'r', load_example_trigs = True, outputdir_to_use = None)

Input variables#
Name	Type	Default	Description
`path`			Path to the hdf5 file, can also be a File object
`outformat`		h5py.Dataset	Format of the big data in the output (default is dataset, can also be mmap). It can be a string or a type
`mode`		‘r’	Mode to open the hdf5 file or mmap in
`load_example_trigs`		True	Boolean flag to load the example trigs
`outputdir_to_use`		None	If given, replace the outputdir with this path for the example trigs

Output variables#

Return annotation	Docstring type	Description
`None`		Rank instance with self.fobj set to the hdf5 file

Docstring#

Load the class from a hdf5 file
:param path: Path to the hdf5 file, can also be a File object
:param outformat:
    Format of the big data in the output (default is dataset, can also
    be mmap). It can be a string or a type
:param mode: Mode to open the hdf5 file or mmap in
:param load_example_trigs: Boolean flag to load the example trigs
:param outputdir_to_use:
    If given, replace the outputdir with this path for the example trigs
:return: Rank instance with self.fobj set to the hdf5 file