Mark5BPayload¶

class baseband.mark5b.Mark5BPayload(words, *, header=None, sample_shape=(), bps=2, complex_data=False)[source] [edit on github]¶

Container for decoding and encoding VDIF payloads.

Parameters:

wordsndarray: Array containg LSB unsigned words (with the right size) that encode the payload.
nchanint, optional: Number of channels. Default: 1.
bpsint, optional: Bits per elementary sample. Default: 2.

Attributes Summary

`complex_data`
`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, *[, bps])	Encode data as payload, using a given number of bits per sample.
`fromfile`(fh[, header, payload_nbytes, ...])	Read payload from filehandle and decode it into data.
`tofile`(fh)	Write payload to filehandle.

Attributes Documentation

Methods Documentation

classmethod fromdata(data, *, bps=2)[source] [edit on github]¶

Encode data as payload, using a given number of bits per sample.

It is assumed that the last dimension is the number of channels.

classmethod fromfile(fh, header=None, *, payload_nbytes=None, dtype=None, memmap=None, **kwargs) [edit on github]¶

Read payload from filehandle and decode it into data.

Parameters:

fhfilehandle: From which data is read.
headerheader instance, optional: If given, used to infer payload_nbytes, bps, sample_shape, and complex_data. If not given, those have to be passed in.
payload_nbytesint, optional: Number of bytes to read. Except for fixed-length payloads, required if no header is given.
dtypedtype, optional: Type of words to read. Default: taken from class attribute.
memmapbool, optional: If False, read from file. Otherwise, map the file in memory (see memmap). Only useful for large payloads. Default: taken from class attribute.
Any other (keyword) arguments are passed on to the class initialiser.