HDF5CodedPayload

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

Bases: baseband_tasks.io.hdf5.payload.HDF5Payload, baseband.base.payload.PayloadBase

Attributes Summary

data	Full decoded payload.
dtype	Numeric type of the decoded data array.
nbytes	Size of the payload in bytes.
ndim	Number of dimensions of the decoded data array.
shape	Shape of the decoded data array.
size	Total number of component samples in the decoded data array.

Methods Summary

fromdata(data[, header, bps])	Encode data as a payload.
fromfile(fh[, header])	Get payload words from HDF5 file or group.
tofile(fh)	Write payload to filehandle.

Attributes Documentation

data

Full decoded payload.

dtype

Numeric type of the decoded data array.

nbytes

Size of the payload in bytes.

ndim

Number of dimensions of the decoded data array.

shape

Shape of the decoded data array.

size

Total number of component samples in the decoded data array.

Methods Documentation

classmethod fromdata(data, header=None, bps=2)

Encode data as a payload.

Parameters

datandarray

Data to be encoded, either complex or real. The trailing dimensions are used to infer sample_shape.

headerheader instance, optional

If given, used to infer to get bps.

bpsint, optional

Bits per elementary sample, i.e., per channel and per real or imaginary component, used if header is not given. Default: 2.

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.

tofile(fh)

Write payload to filehandle.