GUPPIFileReaderInfo¶

class baseband.guppi.file_info.GUPPIFileReaderInfo(parent=None)[source] [edit on github]¶

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.
`decodable`	Whether decoding the first frame worked.
`errors`	dict of attributes that raised errors.
`format`	The file format.
`frame0`	First frame from the file.
`frame_rate`	Number of frames per unit time.
`header0`	Header of the first frame in the file.
`missing`	dict of missing attributes.
`number_of_frames`	Total number of frames.
`overlap`	Number of complete samples that overlap between frames.
`pktfmt`	Packet format for the data.
`readable`	Whether the file is readable and decodable.
`sample_rate`	Number of complete samples per second.
`sample_shape`	Shape of each complete sample (e.g., `(nchan,)`).
`samples_per_frame`	Number of complete samples in each frame.
`start_time`	Link to header0.time
`warnings`	dict of attributes that gave warnings.

Methods Summary

Create a dict with file information.

Attributes Documentation

attr_names = ('format', 'pktfmt', 'number_of_frames', 'frame_rate', 'sample_rate', 'samples_per_frame', 'overlap', 'sample_shape', 'bps', 'complex_data', 'start_time', 'readable', 'missing', 'checks', 'errors', 'warnings')¶: Attributes that the container provides.

Methods Documentation

Create a dict with file information.

This includes information about checks done, possible missing information, as well as possible warnings and errors.