rawacf¶
Each field contains metadata that determines how the field is written to file.
descriptionA description of the field.
dim_labelsIf applicable, a brief descriptor for each dimension of the dataset. This could be different for different
groupvalues. If so, this metadata will be a dict, with the keys being thegroupname and the values the associated list of dimension labels.dim_scalesIf applicable, dimension scales will be associated to the field. These are datasets that match one of the dimensions of the data, such as timestamps to go along with an array of collected data. Note that some dimensions may be associated with multiple fields. If a dimension has no associated dataset, the list will have a
Noneentry.groupsThe types of data file that need this field to be written.
levelThe level within the file that the data will be stored at. Either
fileorrecord, indicating that the field is either written once per file, or once per record.nicknameA nickname for the field, used for making Dimension Scale names.
unitsUnits for the data.
Fields¶
- agc_status_word
32 bits, a 1 in bit position corresponds to an AGC fault on that transmitter
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- antenna_locations
Relative antenna locations
dim_labels:
['antenna', 'local_coord']dim_scales:
['antennas', 'local_coord']level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']units:
m
- antennas
Labels for each antenna of the radar
dim_labels:
['antenna']level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- averaging_method
Averaging method, e.g. mean, median
level:
filerequired_for:
['rawacf']
- beam_azms
Beams azimuths for each beam in degrees CW of boresight
dim_labels:
['beam']level:
recordnickname:
beam directionrequired_for:
['antennas_iq', 'bfiq', 'rawacf']units:
degrees
- beam_nums
Beam numbers used in this slice
dim_labels:
['beam']level:
recordnickname:
beam numberrequired_for:
['antennas_iq', 'bfiq', 'rawacf']
- blanked_samples
Samples blanked during transmission of a pulse
dim_labels:
['time']level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- borealis_git_hash
Version and commit hash of Borealis at runtime
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- cfs_freqs
Frequencies measured during clear frequency search
dim_labels:
['freq']level:
filenickname:
freqrequired_for:
[]units:
Hz
- cfs_masks
Mask for cfs_freqs restricting freqs available for setting cfs slice freq
dim_labels:
['freq']dim_scales:
['cfs_freqs']level:
recordrequired_for:
[]
- cfs_noise
Power measured during clear frequency search
dim_labels:
['freq']dim_scales:
['cfs_freqs']level:
recordrequired_for:
[]units:
a.u. ~ dBW
- cfs_range
Lower and upper bound of frequencies examined by clear frequency search
level:
filerequired_for:
[]units:
Hz
- data_normalization_factor
Cumulative scale of all of the filters for a total scaling factor to normalize by
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']
- experiment_comment
Comment about the whole experiment
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- experiment_id
Number used to identify experiment
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- experiment_name
Name of the experiment class
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- first_range
Distance to first range in km
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']units:
km
- first_range_rtt
Round trip time of flight to first range in microseconds
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']units:
μs
- freq
Frequency used for this experiment slice, in kHz
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']units:
kHz
- global_coord
Descriptors for global coordinates
dim_labels:
['global_coord']level:
filenickname:
global coordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- gps_locked
True if the GPS was locked during the entire averaging period
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- gps_to_system_time_diff
Max time diff in seconds between GPS and system/NTP time during the averaging period
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']units:
s
- int_time
Integration time in seconds
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']units:
s
- intf_acfs
Interferometer array autocorrelations
dim_labels:
['beam', 'range', 'lag']dim_scales:
[['beam_azms', 'beam_nums'], 'range_gates', 'lag_numbers']level:
recordrequired_for:
[]units:
a.u. ~ W
- lags
Lag indices
level:
filenickname:
lagrequired_for:
['rawacf']
- lag_numbers
Difference in units of tau_spacing of unique pairs of pulse in the pulse array
level:
filenickname:
lagrequired_for:
['rawacf']units:
tau_spacing
- lag_pulses
Unique pairs of pulses in pulse array, in units of tau_spacing
dim_labels:
['lag', 'pulse']dim_scales:
['lags', 'lag_pulse_descriptors']level:
filerequired_for:
['rawacf']units:
tau_spacing
- lag_pulse_descriptors
Descriptor of the pulse pairs used in a lag
level:
filerequired_for:
['rawacf']
- local_coord
Descriptors for local coordinates
dim_labels:
['local_coord']level:
filenickname:
local coordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- lp_status_word
32 bits, a 1 in bit position corresponds to a low power condition on that transmitter
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- main_acfs
Main array autocorrelations
dim_labels:
['beam', 'range', 'lag']dim_scales:
[['beam_azms', 'beam_nums'], 'range_gates', 'lag_numbers']level:
recordrequired_for:
['rawacf']units:
a.u. ~ W
- num_sequences
Number of sampling periods in the averaging period
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- num_slices
Number of slices in the experiment for this averaging period
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- pulses
Pulse sequence in units of tau_spacing
dim_labels:
['pulse']level:
filenickname:
pulserequired_for:
['antennas_iq', 'bfiq', 'rawacf']
- range_gates
Range gates of interest for the experiment, beginning at
first_rangeand spaced byrange_seplevel:
filenickname:
range gaterequired_for:
['antennas_iq', 'bfiq', 'rawacf']
- range_sep
Range gate separation (equivalent distance between samples) in km
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']units:
km
- rx_intf_antennas
Indices into
antenna_locationsof the interferometer array antennas used in this experimentlevel:
filerequired_for:
[]
- rx_main_antennas
Indices into
antenna_locationsof the main array antennas used in this experimentlevel:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- rx_sample_rate
Sampling rate of the samples being written to file in Hz
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']units:
Hz
- rx_main_excitations
Complex excitations of main array receive antennas for each antenna. Magnitude between 0 (off) and 1 (full power)
dim_labels:
['beam', 'antenna']dim_scales:
[['beam_azms', 'beam_nums'], 'rx_main_antennas']level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- rx_intf_excitations
Complex excitations of interferometer array receive antennas for each antenna. Magnitude between 0 (off) and 1 (full power)
dim_labels:
['beam', 'antenna']dim_scales:
[['beam_azms', 'beam_nums'], 'rx_intf_antennas']level:
recordrequired_for:
[]
- samples_data_type
C data type of the samples
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- scan_start_marker
Designates if the record is the first in a scan
level:
recordrequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- scheduling_mode
Type of scheduling time at the time of this dataset
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- slice_comment
Comment that describes the slice
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']
- slice_id
Slice ID of the file and dataset
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']
- slice_interfacing
Interfacing of this slice to other slices
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']
- sqn_timestamps
GPS timestamps of start of first pulse for each sampling period in the averaging period
dim_labels:
['sequence']level:
recordnickname:
timestamprequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']units:
seconds since 1970-01-01 00:00:00 UTC
- station
Three letter radar identifier
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- station_location
Location of the radar
dim_labels:
['global_coord']dim_scales:
['global_coord']level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- tau_spacing
Unit of spacing between pulses in microseconds
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']units:
μs
- tx_antennas
Indices into
antenna_locationsof the antennas used for transmitting in this experimentlevel:
filenickname:
tx antennarequired_for:
['antennas_iq', 'bfiq', 'rawacf', 'rawrf']
- tx_excitations
Complex excitations of transmit signal for each antenna. Magnitude between 0 (off) and 1 (full power)
dim_labels:
['antenna']dim_scales:
['tx_antennas']level:
recordrequired_for:
[]units:
a.u.
- tx_pulse_len
Length of the pulse in microseconds
level:
filerequired_for:
['antennas_iq', 'bfiq', 'rawacf']units:
μs
- xcfs
Cross-correlations between main and interferometer arrays
dim_labels:
['beam', 'range', 'lag']dim_scales:
[['beam_azms', 'beam_nums'], 'range_gates', 'lag_numbers']level:
recordrequired_for:
[]units:
a.u. ~ W