VLBIStreamReaderInfo

class baseband.vlbi_base.file_info.VLBIStreamReaderInfo(parent=None)

Bases: baseband.vlbi_base.file_info.VLBIInfoBase

Standardized information on stream readers.

The info descriptor provides a few standard attributes, most of which can also be accessed directly on the stream filehandle, and tests basic readability of the stream. More detailed information on the underlying file is stored in its info, accessible via info.file_info (and shown by __repr__).

Attributes

start_timeTime

Time of the first complete sample.

stop_timeTime

Time of the complete sample just beyond the end of the file.

sample_rateQuantity

Complete samples per unit of time.

shapetuple

Equivalent shape of the whole file, i.e., combining the number of complete samples and the shape of those samples.

bpsint

Number of bits used to encode each elementary sample.

complex_databool

Whether the data are complex.

verifybool or str

The type of verification done by the stream reader.

readablebool

Whether the first and last samples could be read and decoded.

checksdict

Checks that were done to determine whether the file was readable (normally ‘continuous’ and ‘decodable’).

errorsdict

Any exceptions raised while trying to determine attributes or doing checks. Keyed by the attributes/checks.

warningsdict

Any warnings about the attributes or about the checks. Keyed by the attributes/checks.

Attributes Summary

attr_names	Attributes that the container provides.
bps	Link to parent.bps
checks	Link to file_info.checks
complex_data	Link to parent.complex_data
continuous	Check the stream is continuous.
errors	Link to file_info.errors
file_info	Information from the underlying file reader.
format	Format of the underlying file.
readable	Whether the stream can be read (possibly fixing errors).
sample_rate	Link to parent.sample_rate
shape	Link to parent.shape
start_time	Link to parent.start_time
stop_time	Link to parent.stop_time
verify	Link to parent.verify
warnings	Link to file_info.warnings

Methods Summary

__call__(self)

Create a dict with information about the stream and the raw file.

Attributes Documentation

attr_names = ('start_time', 'stop_time', 'sample_rate', 'shape', 'format', 'bps', 'complex_data', 'verify', 'readable', 'checks', 'errors', 'warnings')

Attributes that the container provides.

bps

Link to parent.bps

checks

Link to file_info.checks

complex_data

Link to parent.complex_data

continuous

Check the stream is continuous.

Tries reading the very end. If there is a problem, will bisect to find the exact offset at which the problem occurs.

Errors are raised only to the extent verification is done. Hence, if the stream was opened with verify=False, many fewer problems will be found, while if it was opened with verify='fix', then for file types that support it, one will get warnings rather than exceptions (if the errors are fixable, of course).

errors

Link to file_info.errors

file_info

Information from the underlying file reader.

format

Format of the underlying file.

readable

Whether the stream can be read (possibly fixing errors).

sample_rate

Link to parent.sample_rate

shape

Link to parent.shape

start_time

Link to parent.start_time

stop_time

Link to parent.stop_time

verify

Link to parent.verify

warnings

Link to file_info.warnings

Methods Documentation

__call__(self)

Create a dict with information about the stream and the raw file.