tlpipe.timestream.rfi_flagging.RawTimestream.from_file

RawTimestream.from_file(file_, ondisk=False, distributed=False, comm=None, detect_subclass=True, **kwargs)[source]

Create data object from analysis hdf5 file, store in memory or on disk.

If ondisk is True, do not load into memory but store data in h5py objects that remain associated with the file on disk. This is almost identical to the default constructor, when providing a file as the data_group object, however provides more flexibility when opening the file through the additional keyword arguments.

This does not call __init__ on the subclass when restoring.

Parameters:
  • file (string or h5py.Group object) – File with the hdf5 data. File must be compatible with memh5 objects.
  • ondisk (bool) – Whether the data should be stored in-place in file_ or should be copied into memory.
  • distributed (boolean, optional) – Allow the container to hold distributed datasets.
  • comm (MPI.Comm, optional) – MPI Communicator to distributed over. If not set, use MPI.COMM_WORLD.
  • detect_subclass (boolean, optional) – If data_group is specified, whether to inspect for a ‘__memh5_subclass’ attribute which specifies a subclass to return.
  • **kwargs (any other arguments) – Any additional keyword arguments are passed to h5py.File‘s constructor if file_ is a filename and silently ignored otherwise.