VDIFLegacyHeader¶
-
class
baseband.vdif.header.
VDIFLegacyHeader
(words, edv=None, verify=True, **kwargs)[source] [edit on github]¶ Bases:
baseband.vdif.header.VDIFHeader
Legacy VDIF header that uses only 4 32-bit words.
See Section 6 of http://www.vlbi.org/vdif/docs/VDIF_specification_Release_1.1.1.pdf
Attributes Summary
bps
Bits per elementary sample. edv
VDIF Extended Data Version (EDV). frame_nbytes
Size of the frame in bytes. mutable
Whether the header can be modified. nbytes
Size of the header in bytes. nchan
Number of channels in the frame. payload_nbytes
Size of the payload in bytes. samples_per_frame
Number of complete samples in the frame. station
Station ID: two ASCII characters, or 16-bit int. time
Converts ref_epoch, seconds, and frame_nr to Time object. Methods Summary
copy
()Create a mutable and independent copy of the header. from_mark5b_header
(mark5b_header, bps, …)Construct an Mark5B over VDIF header (EDV=0xab). fromfile
(fh[, edv, verify])Read VDIF Header from file. fromkeys
(**kwargs)Initialise a header from parsed values. fromvalues
([edv])Initialise a header from parsed values. get_time
([frame_rate])Converts ref_epoch, seconds, and frame_nr to Time object. keys
()same_stream
(other)Whether header is consistent with being from the same stream. set_time
(time[, frame_rate])Converts Time object to ref_epoch, seconds, and frame_nr. tofile
(fh)Write VLBI frame header to filehandle. update
(**kwargs)Update the header by setting keywords or properties. verify
()Basic checks of header integrity. Attributes Documentation
-
bps
¶ Bits per elementary sample.
-
edv
¶ VDIF Extended Data Version (EDV).
-
frame_nbytes
¶ Size of the frame in bytes.
-
mutable
¶ Whether the header can be modified.
-
nbytes
¶ Size of the header in bytes.
-
nchan
¶ Number of channels in the frame.
-
payload_nbytes
¶ Size of the payload in bytes.
-
samples_per_frame
¶ Number of complete samples in the frame.
-
station
¶ Station ID: two ASCII characters, or 16-bit int.
-
time
¶ Converts ref_epoch, seconds, and frame_nr to Time object.
Uses ‘ref_epoch’, which stores the number of half-years from 2000, and ‘seconds’. By default, it also calculates the offset using the current frame number. For non-zero ‘frame_nr’, this requires the frame rate, which is calculated from the sample rate in the header.
Parameters: frame_rate :
Quantity
, optionalFor non-zero ‘frame_nr’, this is required to calculate the corresponding offset.
Returns: time :
Time
Methods Documentation
-
copy
() [edit on github]¶ Create a mutable and independent copy of the header.
Keyword arguments can be passed on as needed by possible subclasses.
-
classmethod
from_mark5b_header
(mark5b_header, bps, nchan, **kwargs) [edit on github]¶ Construct an Mark5B over VDIF header (EDV=0xab).
See http://www.vlbi.org/vdif/docs/vdif_extension_0xab.pdf
Note that the Mark 5B header does not encode the bits-per-sample and the number of channels used in the payload, so these need to be given separately. A complete frame can be encapsulated with
from_mark5b_frame
.Parameters: mark5b_header :
Mark5BHeader
Used to set time, etc.
bps : int
Bits per elementary sample.
nchan : int
Number of channels carried in the Mark 5B payload.
**kwargs
Any further arguments. Strictly, none are necessary to create a valid VDIF header, but this can be used to pass on, e.g.,
invalid_data
.
-
classmethod
fromfile
(fh, edv=None, verify=True) [edit on github]¶ Read VDIF Header from file.
Parameters: fh : filehandle
To read data from.
edv : int, False, or None, optional
verify : bool, optional
Whether to do basic verification of integrity. Default:
True
.
-
classmethod
fromkeys
(**kwargs) [edit on github]¶ Initialise a header from parsed values.
Like
fromvalues()
, but without any interpretation of keywords.Raises: KeyError : if not all keys required are pass in.
-
classmethod
fromvalues
(edv=False, **kwargs) [edit on github]¶ Initialise a header from parsed values.
Here, the parsed values must be given as keyword arguments, i.e., for any
header = cls(<data>)
,cls.fromvalues(**header) == header
.However, unlike for the
fromkeys()
class method, data can also be set using arguments named after methods, such asbps
andtime
.Given defaults:
invalid_data :
False
legacy_mode :False
vdif_version : 1 thread_id : 0 frame_nr : 0 sync_pattern : 0xACABFEED for EDV 1 and 3, 0xa5ea5 for EDV 2Values set by other keyword arguments (if present):
bits_per_sample : from
bps
frame_length : fromsamples_per_frame
orframe_nbytes
lg2_nchan : fromnchan
station_id : fromstation
sampling_rate, sampling_unit : fromsample_rate
ref_epoch, seconds, frame_nr : fromtime
Note that to set
time
to non-integer seconds one also needs to pass inframe_rate
orsample_rate
.
-
get_time
(frame_rate=None) [edit on github]¶ Converts ref_epoch, seconds, and frame_nr to Time object.
Uses ‘ref_epoch’, which stores the number of half-years from 2000, and ‘seconds’. By default, it also calculates the offset using the current frame number. For non-zero ‘frame_nr’, this requires the frame rate, which is calculated from the sample rate in the header.
Parameters: frame_rate :
Quantity
, optionalFor non-zero ‘frame_nr’, this is required to calculate the corresponding offset.
Returns: time :
Time
-
keys
() [edit on github]¶
-
same_stream
(other) [edit on github]¶ Whether header is consistent with being from the same stream.
-
set_time
(time, frame_rate=None) [edit on github]¶ Converts Time object to ref_epoch, seconds, and frame_nr.
For non-integer seconds, a frame rate is needed to calculate the ‘frame_nr’.
Parameters: time :
Time
The time to use for this header.
frame_rate :
Quantity
, optionalFor calculating ‘frame_nr’ from the fractional seconds.
-
tofile
(fh) [edit on github]¶ Write VLBI frame header to filehandle.
-
update
(**kwargs) [edit on github]¶ Update the header by setting keywords or properties.
Here, any keywords matching header keys are applied first, and any remaining ones are used to set header properties, in the order set by the class (in
_properties
).Parameters: verify : bool, optional
If
True
(default), verify integrity after updating.**kwargs
Arguments used to set keywords and properties.
-
verify
()[source] [edit on github]¶ Basic checks of header integrity.
-