DADAPayload

class baseband.dada.payload.DADAPayload(words, header=None, sample_shape=(), bps=8, complex_data=False)

Bases: baseband.vlbi_base.payload.VLBIPayloadBase

Container for decoding and encoding DADA payloads.

Parameters:

words : ndarray

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

header : DADAHeader

Header that provides information about how the payload is encoded. If not given, the following arguments have to be passed in.

bps : int, optional

Number of bits per sample part (i.e., per channel and per real or imaginary component). Default: 8.

sample_shape : tuple, optional

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

complex_data : bool, optional

Whether data are complex. 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])	Encode data as a payload.
fromfile(fh[, header, memmap, payload_nbytes])	Read or map encoded data in file.
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:

data : ndarray

Data to be encoded. The last dimension is taken as the number of channels.

header : header instance, optional

If given, used to infer the bps.

bps : int, 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, memmap=False, payload_nbytes=None, **kwargs)

Read or map encoded data in file.

Parameters:

fh : filehandle

Handle to the file which will be read or mapped.

header : DADAHeader, optional

If given, used to infer payload_nbytes, bps, sample_shape, and complex_data. If not given, those have to be passed in.

memmap : bool, optional

If False (default), read from file. Otherwise, map the file in memory (see memmap).

payload_nbytes : int, optional

Number of bytes to read (default: as given in header, cls._nbytes, or, for mapping, to the end of the file).

**kwargs

Additional arguments are passed on to the class initializer. These are only needed if header is not given.

tofile(fh)

Write payload to filehandle.