Struct mwalib::VoltageContext

source · [−]

pub struct VoltageContext {Show 44 fields
    pub metafits_context: MetafitsContext,
    pub mwa_version: MWAVersion,
    pub timesteps: Vec<TimeStep>,
    pub num_timesteps: usize,
    pub timestep_duration_ms: u64,
    pub coarse_chans: Vec<CoarseChannel>,
    pub num_coarse_chans: usize,
    pub common_timestep_indices: Vec<usize>,
    pub num_common_timesteps: usize,
    pub common_coarse_chan_indices: Vec<usize>,
    pub num_common_coarse_chans: usize,
    pub common_start_unix_time_ms: u64,
    pub common_end_unix_time_ms: u64,
    pub common_start_gps_time_ms: u64,
    pub common_end_gps_time_ms: u64,
    pub common_duration_ms: u64,
    pub common_bandwidth_hz: u32,
    pub common_good_timestep_indices: Vec<usize>,
    pub num_common_good_timesteps: usize,
    pub common_good_coarse_chan_indices: Vec<usize>,
    pub num_common_good_coarse_chans: usize,
    pub common_good_start_unix_time_ms: u64,
    pub common_good_end_unix_time_ms: u64,
    pub common_good_start_gps_time_ms: u64,
    pub common_good_end_gps_time_ms: u64,
    pub common_good_duration_ms: u64,
    pub common_good_bandwidth_hz: u32,
    pub provided_timestep_indices: Vec<usize>,
    pub num_provided_timesteps: usize,
    pub provided_coarse_chan_indices: Vec<usize>,
    pub num_provided_coarse_chans: usize,
    pub coarse_chan_width_hz: u32,
    pub fine_chan_width_hz: u32,
    pub num_fine_chans_per_coarse: usize,
    pub sample_size_bytes: u64,
    pub num_voltage_blocks_per_timestep: u64,
    pub num_voltage_blocks_per_second: u64,
    pub num_samples_per_voltage_block: u64,
    pub voltage_block_size_bytes: u64,
    pub delay_block_size_bytes: u64,
    pub data_file_header_size_bytes: u64,
    pub expected_voltage_data_file_size_bytes: u64,
    pub voltage_batches: Vec<VoltageFileBatch>,
    pub voltage_time_map: BTreeMap<u64, BTreeMap<usize, String>>,
}

Expand description

mwalib voltage captue system (VCS) observation context. This represents the basic metadata for a voltage capture observation.

Fields

metafits_context: MetafitsContext

Observation Metadata obtained from the metafits file

mwa_version: MWAVersion

MWA version, derived from the files passed in

timesteps: Vec<TimeStep>

This is an array of all known timesteps (union of metafits and provided timesteps from data files). The only exception is when the metafits timesteps are offset from the provided timesteps, in which case see description in timestep::populate_metafits_provided_superset_of_timesteps.

num_timesteps: usize

Number of timesteps in the timesteps vector

timestep_duration_ms: u64

length in millseconds of each timestep

coarse_chans: Vec<CoarseChannel>

Vector of coarse channel structs which is the same as the metafits provided coarse channels

num_coarse_chans: usize

Number of coarse channels in coarse chans struct

common_timestep_indices: Vec<usize>

Vector of (in)common timestep indices

num_common_timesteps: usize

Number of common timesteps

common_coarse_chan_indices: Vec<usize>

Vector of (in)common coarse channel indices

num_common_coarse_chans: usize

Number of common coarse channels

common_start_unix_time_ms: u64

The start of the observation (the time that is common to all provided data files).

common_end_unix_time_ms: u64

end_unix_time_ms is the common end time of the observation i.e. start time of last common timestep plus integration time.

common_start_gps_time_ms: u64

start_unix_time_ms but in GPS milliseconds

common_end_gps_time_ms: u64

end_unix_time_ms but in GPS milliseconds

common_duration_ms: u64

Total duration of common timesteps

common_bandwidth_hz: u32

Total bandwidth of the common coarse channels

common_good_timestep_indices: Vec<usize>

Vector of (in)common timestep indices only including timesteps after the quack time

num_common_good_timesteps: usize

Number of common timesteps only including timesteps after the quack time

common_good_coarse_chan_indices: Vec<usize>

Vector of (in)common coarse channel indices only including timesteps after the quack time

num_common_good_coarse_chans: usize

Number of common coarse channels only including timesteps after the quack time

common_good_start_unix_time_ms: u64

The start of the observation (the time that is common to all provided data files) only including timesteps after the quack time

common_good_end_unix_time_ms: u64

end_unix_time_ms is the common end time of the observation only including timesteps after the quack time i.e. start time of last common timestep plus integration time.

common_good_start_gps_time_ms: u64

common_good_start_unix_time_ms but in GPS milliseconds

common_good_end_gps_time_ms: u64

common_good_end_unix_time_ms but in GPS milliseconds

common_good_duration_ms: u64

Total duration of common_good timesteps

common_good_bandwidth_hz: u32

Total bandwidth of the common coarse channels only including timesteps after the quack time

provided_timestep_indices: Vec<usize>

The indices of any timesteps which we have some data for

num_provided_timesteps: usize

Number of provided timestep indices we have at least some data for

provided_coarse_chan_indices: Vec<usize>

The indices of any coarse channels which we have some data for

num_provided_coarse_chans: usize

Number of provided coarse channel indices we have at least some data for

coarse_chan_width_hz: u32

Bandwidth of each coarse channel

fine_chan_width_hz: u32

Volatge fine_chan_resolution (if applicable- MWA legacy is 10 kHz, MWAX is unchannelised i.e. the full coarse channel width)

num_fine_chans_per_coarse: usize

Number of fine channels in each coarse channel

sample_size_bytes: u64

Number of bytes in each sample (a sample is a complex, thus includes r and i)

num_voltage_blocks_per_timestep: u64

Number of voltage blocks per timestep

num_voltage_blocks_per_second: u64

Number of voltage blocks of samples in each second of data

num_samples_per_voltage_block: u64

Number of samples in each voltage_blocks for each second of data per rf_input * fine_chans * real|imag

voltage_block_size_bytes: u64

The size of each voltage block

delay_block_size_bytes: u64

Number of bytes used to store delays - for MWAX this is the same as a voltage block size, for legacy it is 0

data_file_header_size_bytes: u64

The amount of bytes to skip before getting into real data within the voltage files

expected_voltage_data_file_size_bytes: u64

Expected voltage file size

voltage_batches: Vec<VoltageFileBatch>

voltage_batches must be sorted appropriately. See voltage::determine_voltage_batches. The order of the filenames corresponds directly to other voltage-related objects (e.g. voltage_hdu_limits). Structured: voltage_batches[batch][filename].

voltage_time_map: BTreeMap<u64, BTreeMap<usize, String>>

We assume as little as possible about the data layout in the voltage files; here, a BTreeMap contains each unique GPS time from every voltage file, which is associated with another BTreeMap, associating each voltage number with a voltage batch number and HDU index. The voltage number, batch number and HDU index are everything needed to find the correct HDU out of all voltage files.

Struct mwalib::VoltageContext

Fields

Implementations

impl VoltageContext

pub fn new<T: AsRef<Path>>( metafits_filename: &T, voltage_filenames: &[T]) -> Result<Self, MwalibError>

pub fn get_fine_chan_freqs_hz_array( &self, volt_coarse_chan_indices: &[usize]) -> Vec<f64>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn read_second( &self, gps_second_start: u64, gps_second_count: usize, coarse_chan_index: usize, buffer: &mut [u8]) -> Result<(), VoltageFileError>

pub fn read_file( &self, timestep_index: usize, coarse_chan_index: usize, buffer: &mut [u8]) -> Result<(), VoltageFileError>

Trait Implementations

impl Debug for VoltageContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Display for VoltageContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Auto Trait Implementations

impl RefUnwindSafe for VoltageContext

impl Send for VoltageContext

impl Sync for VoltageContext

impl Unpin for VoltageContext

impl UnwindSafe for VoltageContext

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn new<T: AsRef<Path>>(
metafits_filename: &T,
voltage_filenames: &[T]
) -> Result<Self, MwalibError>

pub fn get_fine_chan_freqs_hz_array(
&self,
volt_coarse_chan_indices: &[usize ]
) -> Vec<f64>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn read_second(
&self,
gps_second_start: u64,
gps_second_count: usize,
coarse_chan_index: usize,
buffer: &mut [u8 ]
) -> Result<(), VoltageFileError>

pub fn read_file(
&self,
timestep_index: usize,
coarse_chan_index: usize,
buffer: &mut [u8 ]
) -> Result<(), VoltageFileError>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,