Struct birli::preprocessing::PreprocessContext

pub struct PreprocessContext<'a> {
    pub array_pos: LatLngHeight,
    pub phase_centre: RADec,
    pub correct_cable_lengths: bool,
    pub correct_digital_gains: bool,
    pub passband_gains: Option<&'a [f64]>,
    pub calsols: Option<Array2<Jones<f64>>>,
    pub correct_geometry: bool,
    pub aoflagger_strategy: Option<String>,
    pub draw_progress: bool,
}

Options for preprocessing a chunk of correlator data

Fields

array_pos: LatLngHeight

The array position used for geometric corrections

phase_centre: RADec

The phase centre used for geometric corrections

correct_cable_lengths: bool

Whether cable length corrections are enabled

correct_digital_gains: bool

Whether digital gain corrections are enabled

passband_gains: Option<&'a [f64]>

the pfb passband gains to use for corrections

calsols: Option<Array2<Jones<f64>>>

The calibration solutions to apply

correct_geometry: bool

Whether geometric corrections are enabled

aoflagger_strategy: Option<String>

AOFlagger strategy path for flagging

draw_progress: bool

Whether to draw progress bars

Implementations

impl<'a> PreprocessContext<'a>

pub fn as_comment(&self) -> String

A one line description of the tasks preprocessing will do.

pub fn preprocess( &self, corr_ctx: &CorrelatorContext, jones_array: ArrayViewMut3<'_, Jones<f32>>, weight_array: ArrayViewMut3<'_, f32>, flag_array: ArrayViewMut3<'_, bool>, vis_sel: &VisSelection ) -> Result<(), BirliError>

Preprocess visibilities for a chunk of correlator data

Arguments

• corr_ctx - marlu::mwalib::CorrelatorContext
• jones_array - Array of Jones visibilties
• weight_array - Array of weights associated with Jones visibilities
• flag_array - Array of flags associated with Jones visibilities

Errors

will wrap errors from correct_digital_gains, correct_coarse_passband_gains

TODO: more granular error types: PreprocessingError -> {DigitalGainsError, etc.}

Trait Implementations

impl<'a> Clone for PreprocessContext<'a>

fn clone(&self) -> PreprocessContext<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for PreprocessContext<'a>

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

Formats the value using the given formatter.

impl<'a> Default for PreprocessContext<'a>

fn default() -> PreprocessContext<'a>

Returns the “default value” for a type.

impl Display for PreprocessContext<'_>

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

Formats the value using the given formatter.