VDIFPayload

class baseband.vdif.VDIFPayload(words, header=None, nchan=1, bps=2, complex_data=False)

Bases: baseband.vlbi_base.payload.VLBIPayloadBase

Container for decoding and encoding VDIF payloads.

Parameters:

words : ndarray

Array containg LSB unsigned words (with the right size) that encode the payload.

header : VDIFHeader

If given, used to infer the number of channels, bps, and whether the data are complex.

nchan : int, optional

Number of channels, used if header is not given. Default: 1.

bps : int, optional

Bits per elementary sample, used if header is not given. Default: 2.

complex_data : bool, optional

Whether the data are complex, used if header is not given. Default: False.

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, edv])	Encode data as payload, using header information.
fromfile(fh, header)	Read payload from filehandle and decode it into data.
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, edv=None)

Encode data as payload, using header information.

Parameters:

data : ndarray

Values to be encoded.

header : VDIFHeader, optional

If given, used to infer the encoding, and to verify the number of channels and whether the data are complex.

bps : int, optional

Bits per elementary sample, used if header is not given. Default: 2.

edv : int, optional

Should be given if header is not given and the payload is encoded as Mark 5 data (i.e., edv=0xab).

classmethod fromfile(fh, header)

Read payload from filehandle and decode it into data.

Parameters:

fh : filehandle

To read data from.

header : VDIFHeader

Used to infer the payload size, number of channels, bits per sample, and whether the data are complex.

tofile(fh)

Write payload to filehandle.