Struct FlagContext 

pub struct FlagContext {
    pub timestep_flags: Vec<bool>,
    pub coarse_chan_flags: Vec<bool>,
    pub fine_chan_flags: Vec<bool>,
    pub antenna_flags: Vec<bool>,
    pub autos: bool,
    pub flag_dc: bool,
    pub flag_init: f32,
    pub flag_end: f32,
}

Which timesteps, channels and baselines are flagged in a given observation

Fields

timestep_flags: Vec<bool>

Which mwalib timestep indices are flagged

coarse_chan_flags: Vec<bool>

Which mwalib coarse channel indices are flagged

fine_chan_flags: Vec<bool>

Which fine channel indices are flagged in every coarse channel

antenna_flags: Vec<bool>

Which mwalib antenna indices are flagged

autos: bool

Whether auto-correlations are flagged

flag_dc: bool

Whether DC (centre) fine channel indices are flagged

flag_init: f32

How many seconds to flag from the start of the observation

flag_end: f32

How many seconds to flag from the end of the observation

Implementations

impl FlagContext

pub fn blank_from_dimensions( num_timesteps: usize, num_coarse_chans: usize, num_fine_chans_per_coarse: usize, num_ants: usize, ) -> Self

Create a new FlagContext with all flags false, in the given dimensions

pub fn from_mwalib(corr_ctx: &CorrelatorContext) -> Self

Create a new FlagContext from a marlu::mwalib::CorrelatorContext, flagging anything not provided.

• Timesteps are flagged in they are not provided in any of the gpubox files.
• Coarse channels are flagged if they appear in the metafits, but are not provided.
• No fine channel flags are set by default.

Examples

use birli::{FlagContext, mwalib::CorrelatorContext};

// define our input files
let metafits_path = "tests/data/1196175296_mwa_ord/1196175296.metafits";
let gpufits_paths = vec![
    "tests/data/1196175296_mwa_ord/1196175296_20171201145440_gpubox01_00.fits",
    "tests/data/1196175296_mwa_ord/1196175296_20171201145540_gpubox01_01.fits",
    "tests/data/1196175296_mwa_ord/1196175296_20171201145440_gpubox02_00.fits",
    "tests/data/1196175296_mwa_ord/1196175296_20171201145540_gpubox02_01.fits",
];

// Create an mwalib::CorrelatorContext for accessing visibilities.
let corr_ctx = CorrelatorContext::new(metafits_path, &gpufits_paths).unwrap();
let flag_ctx = FlagContext::from_mwalib(&corr_ctx);

assert!(!flag_ctx.antenna_flags[0]);
assert!(flag_ctx.antenna_flags[63]);
assert!(flag_ctx.coarse_chan_flags[0]);
assert!(!flag_ctx.coarse_chan_flags[23]);

TODO:

• quack time
• flag side bandwidth
• auto flag centre

pub fn get_flagged_antenna_idxs(&self) -> Vec<usize>

Get the mwalib antenna indices which are flagged

pub fn get_baseline_flags(&self, ant_pairs: &[(usize, usize)]) -> Vec<bool>

Produce a vector of flags for baslines where either antenna is flagged in antenna_flags or if autos is true and it is an autocorrelation.

pub fn finalise_flag_settings(&mut self, corr_ctx: &CorrelatorContext)

Apply timestep flags from flag_init and flag_end

Default values for these are inferred from metadata, but may be overridden by command line arguments, so we apply the flags only after both have been considered.

TODO: move DC flagging and other flags that combine contextual defaults and command line arguments here.

pub fn set_flags( &self, flag_array: ArrayViewMut3<'_, bool>, timestep_range: &Range<usize>, coarse_chan_range: &Range<usize>, ant_pairs: &[(usize, usize)], ) -> Result<(), BirliError>

Set flags from this context in an existing array.

Errors

Can throw error if array is not the correct shape.

Trait Implementations

impl Debug for FlagContext

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

Formats the value using the given formatter.

impl Default for FlagContext

fn default() -> FlagContext

Returns the “default value” for a type.