VDIFStreamBase¶
-
class
baseband.vdif.base.
VDIFStreamBase
(fh_raw, header0, sample_rate=None, nthread=1, squeeze=True, subset=(), fill_value=0.0, verify=True)[source] [edit on github]¶ Bases:
baseband.vlbi_base.base.VLBIStreamBase
Base for VDIF streams.
Attributes Summary
Bits per elementary sample.
Whether the data are complex.
First header of the file.
Number of complete samples per second.
Shape of a complete sample (possibly subset or squeezed).
Number of complete samples per frame.
Whether data arrays have dimensions with length unity removed.
Start time of the file.
Specific components of the complete sample to decode.
Time of the sample pointer’s current offset in file.
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
- unit
Unit
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.
- unit
- Returns
-