Struct birli::cli::BirliContext

source ·
pub struct BirliContext<'a> {
    pub corr_ctx: CorrelatorContext,
    pub prep_ctx: PreprocessContext<'a>,
    pub vis_sel: VisSelection,
    pub flag_ctx: FlagContext,
    pub io_ctx: IOContext,
    pub avg_time: usize,
    pub avg_freq: usize,
    pub num_timesteps_per_chunk: Option<usize>,
    pub channel_range_sel: ChannelRanges,
}
Expand description

Args for preprocessing a correlator context.

Fields§

§corr_ctx: CorrelatorContext

mwalib::CorrelatorContext

§prep_ctx: PreprocessContext<'a>

Preprocessing parameters

§vis_sel: VisSelection

selected visibility indices

§flag_ctx: FlagContext

Flagging Parameters

§io_ctx: IOContext

Input / output paths

§avg_time: usize

temporal averaging factor

§avg_freq: usize

spectral averaging factor

§num_timesteps_per_chunk: Option<usize>

temporal chunking factor

§channel_range_sel: ChannelRanges

channel selections for picket-fencing

Implementations§

source§

impl<'a> BirliContext<'a>

source

pub fn from_args<I, T>(args: I) -> Result<Self, BirliError>where I: IntoIterator<Item = T> + Debug, T: Into<OsString> + Clone,

Parse an iterator of arguments, args into a BirliContext.

Errors

Can raise:

  • clap::Error if clap cannot parse args
  • mwalib::MwalibError if mwalib can’t open the input files.
  • BirliError::CLIError if the arguments are invalid.
source

pub fn run_ranges(self) -> Result<(), BirliError>

Call run() for every channel range in self.channel_range_sel.

Errors

see: run()

source

pub fn run(&self) -> Result<(), BirliError>

Read, Preprocess and write corrected visibilities chunks.

Errors

can raise:

  • BadArrayShape if the shape of the calibration solutions is incompatible with the visibility shape.
  • preprocessing errors

Trait Implementations§

source§

impl Display for BirliContext<'_>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for BirliContext<'a>

§

impl<'a> Send for BirliContext<'a>

§

impl<'a> Sync for BirliContext<'a>

§

impl<'a> Unpin for BirliContext<'a>

§

impl<'a> UnwindSafe for BirliContext<'a>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.