class baseband.base.file_info.StreamReaderInfo(parent=None)[source] [edit on github]

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 Summary

 attr_names Attributes that the container provides. bps Number of bits used to encode each elementary sample. checks dict of checks for readability. closed Whether parent is closed complex_data Whether the data are complex. continuous Check the stream is continuous. errors dict of attributes that raised 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 Complete samples per unit of time. shape Equivalent shape of the whole file. start_time Time of the first complete sample. stop_time Time of the sample just beyond the end of the file. verify The type of verification done by the stream reader. warnings dict of attributes that gave warnings

Methods Summary

 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

Number of bits used to encode each elementary sample.

checks

closed

Whether parent is closed

complex_data

Whether the data are complex.

continuous[source]

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

dict of attributes that raised errors

file_info[source]

Information from the underlying file reader.

format[source]

Format of the underlying file.

readable[source]

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

sample_rate

Complete samples per unit of time.

shape

Equivalent shape of the whole file.

start_time

Time of the first complete sample.

stop_time

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

verify

The type of verification done by the stream reader.

warnings

dict of attributes that gave warnings

Methods Documentation

__call__()[source] [edit on github]

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