TODReader#

class caput.containers.tod.TODReader(files: caput.memdata._memh5.FileLike | collections.abc.Sequence[caput.memdata._memh5.FileLike], file_format: caput.memdata.fileformats.FileFormat | None = None)[source]#

Provides high-level reading of time ordered data.

Parses and stores meta-data from file headers allowing for the interpretation and selection of the data without reading it all from disk.

Parameters:
filesFileLike

Files containing data. Filename patterns with wild cards (e.g. “foo*.h5”) are supported.

file_formatmemdata.fileformats.FileFormat, optional

File format to use. Default None (format will be guessed).

property dataset_sel: list[str][source]#

Which datasets to read.

Returns:
datasetslist

Names of datasets to read.

property datasets: list[str][source]#

Datasets available in data files.

property files: tuple[source]#

Data files.

property time: numpy.typing.ArrayLike[source]#

Time bin centres in data files.

property time_sel: tuple[int, int][source]#

Start and stop indices to read in the time axis.

Returns:
indicestuple

Start and stop indices for reading along the time axis.

Methods#

read(→ TOData)

Read the selected data.

select_time_range(→ None)

Sets time_sel to include a time range.