Mark5BStreamBase

class baseband.mark5b.base.Mark5BStreamBase(fh_raw, header0, sample_rate=None, nchan=1, bps=2, squeeze=True, subset=(), fill_value=0.0, verify=True)[source] [edit on github]

Bases: baseband.vlbi_base.base.VLBIStreamBase

Base for Mark 5B streams.

Attributes Summary

bps

Bits per elementary sample.

complex_data

Whether the data are complex.

header0

First header of the file.

sample_rate

Number of complete samples per second.

sample_shape

Shape of a complete sample (possibly subset or squeezed).

samples_per_frame

Number of complete samples per frame.

squeeze

Whether data arrays have dimensions with length unity removed.

start_time

Start time of the file.

subset

Specific components of the complete sample to decode.

time

Time of the sample pointer’s current offset in file.

verify

Whether to do consistency checks on frames being read.

Methods Summary

close(self)

tell(self[, unit])

Current offset in the file.

Attributes Documentation

bps

Bits per elementary sample.

complex_data

Whether the data are complex.

header0

First header of the file.

sample_rate

Number of complete samples per second.

sample_shape

Shape of a complete sample (possibly subset or squeezed).

samples_per_frame

Number of complete samples per frame.

squeeze

Whether data arrays have dimensions with length unity removed.

If True, data read out has such dimensions removed, and data passed in for writing has them inserted.

start_time

Start time of the file.

See also time for the time of the sample pointer’s current offset.

subset

Specific components of the complete sample to decode.

The order of dimensions is the same as for sample_shape. Set by the class initializer.

time

Time of the sample pointer’s current offset in file.

See also start_time for the start time of the file.

verify

Whether to do consistency checks on frames being read.

Methods Documentation

close(self) [edit on github]
tell(self, unit=None) [edit on github]

Current offset in the file.

Parameters
unitUnit or str, optional

Time unit the offset should be returned in. By default, no unit is used, i.e., an integer enumerating samples is returned. For the special string ‘time’, the absolute time is calculated.

Returns
offsetint, Quantity, or Time

Offset in current file (or time at current position).