HDF5Payload

class baseband_tasks.io.hdf5.payload.HDF5Payload(words, header=None, **kwargs)

Bases: object

Container for decoding and encoding HDF5 payloads.

The data will be taken to represent their values directly unless the header has a bps attribute, or bps is given explicitly.

Parameters

wordsDataset

Array containg data as stored in the HDF5 file, which possibly are encoded similar to a VDIF payload.

headerHDF5Header, optional

Header providing information about whether, and if so, how the payload is encoded. If not given and if the data are encoded, then the following should be passed in.

sample_shapetuple, optional

Shape of the samples; e.g., (nchan,). Default: ().

bpsint, optional

Number of bits per sample part (i.e., per channel and per real or imaginary component). No default.

complex_databool, optional

Whether data are complex. Default: False.

Methods Summary

fromfile(fh[, header])

Get payload words from HDF5 file or group.

Methods Documentation

classmethod fromfile(fh, header=None)

Get payload words from HDF5 file or group.

Parameters

fhFile or Group

Handle to the HDF5 file/group which has an ‘payload’ dataset. If the payload does not exist, it will be created.

headerHDF5Header, optional

Must be given for encoded payloads, or to create a payload.