Averaging

Struct Averaging 

Source
pub struct Averaging<G: PdfGenerator<Ix1>> { /* private fields */ }
Expand description

A generator that…

  1. Generates a specified number of randomly sampled schedules
  2. Lists the positions of the samples in sorted order
  3. Averages each position across each of the randomly sampled schedules
  4. Quantizes them to the Nyquist grid.

The iteration parameter alters the random seed.

Palmer, M.R., Wenrich, B.R., Stahlfeld, P. et al. Performance tuning non-uniform sampling for sensitivity enhancement of signal-limited biological NMR. J Biomol NMR 58, 303–314 (2014). https://doi.org/10.1007/s10858-014-9823-5

Implementations§

Source§

impl<G: PdfGenerator<Ix1>> Averaging<G>

Source

pub const fn new(pdf: G, avg_count: usize, seed: [u8; 32]) -> Averaging<G>

Create a new AveragedSchedule where pdf is the PDF, avg_count is the number of random schedules to average, and seed is the random seed.

Trait Implementations§

Source§

impl<G: Clone + PdfGenerator<Ix1>> Clone for Averaging<G>

Source§

fn clone(&self) -> Averaging<G>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<G: Debug + PdfGenerator<Ix1>> Debug for Averaging<G>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<G: PdfGenerator<Ix1>> Generator<Dim<[usize; 1]>> for Averaging<G>

Source§

fn _generate_no_trace( &self, count: usize, dims: Ix1, iteration: u64, ) -> Schedule<Ix1>

This function may be overridden when a generator can be sped up in cases where the trace is not needed. Users should not call this directly because it doesn’t perform correctness assertions.
Source§

fn _generate(&self, count: usize, dims: Ix1, iteration: u64) -> Trace<Ix1>

The underlying implementation of a schedule generator. Users should not call this directly because it doesn’t perform correctness assertions. Read more
Source§

fn generate(&self, count: usize, dims: Dim) -> Schedule<Dim>

Generate a schedule where the iteration parameter is set to zero.
Source§

fn generate_with_iter( &self, count: usize, dims: Dim, iteration: u64, ) -> Schedule<Dim>

Generate a schedule with a user-defined iteration parameter.
Source§

fn generate_with_trace(&self, count: usize, dims: Dim) -> Trace<Dim>

Generate a schedule including trace output from each generation step. Read more
Source§

fn generate_with_iter_and_trace( &self, count: usize, dims: Dim, iteration: u64, ) -> Trace<Dim>

Generate a schedule with a user-defined iteration parameter while returning a trace.
Source§

fn then<T: Modifier<Dim>>(self, modifier: T) -> T::Output<Self>
where Self: Sized,

Apply a modifier to the generator. Read more
Source§

impl<G: Copy + PdfGenerator<Ix1>> Copy for Averaging<G>

Auto Trait Implementations§

§

impl<G> Freeze for Averaging<G>
where G: Freeze,

§

impl<G> RefUnwindSafe for Averaging<G>
where G: RefUnwindSafe,

§

impl<G> Send for Averaging<G>
where G: Send,

§

impl<G> Sync for Averaging<G>
where G: Sync,

§

impl<G> Unpin for Averaging<G>
where G: Unpin,

§

impl<G> UnwindSafe for Averaging<G>
where G: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> FillCornersBuilder for T
where T: Generator<Dim<[usize; 1]>>,

Source§

fn fill_corners<F: Fn(usize, usize) -> [usize; 2]>( self, amt: F, ) -> <FillCorners<F> as Modifier<Ix1>>::Output<Self>
where Self: Sized,

Guarantee that the first amt(count, len)[0] samples and the last amt(count, len)[1] samples are taken. 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 T
where 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.

Source§

impl<Dim, T> IterateBuilder<Dim> for T
where Dim: Dimension, T: Generator<Dim>,

Source§

fn iterate<F: Fn(&Schedule<Dim>) -> f64>( self, iterations: u64, scorer: F, ) -> <Iterate<Dim, F> as Modifier<Dim>>::Output<Self>
where Self: Sized,

Generate many schedules each using different iteration parameters and choose the one that minimizes the value returned by scorer.
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> PSFPolisherBuilder for T
where T: Generator<Dim<[usize; 1]>>,

Source§

fn polish_psf( self, threshold: f64, swap_value: f64, mode: DisplayMode, ) -> <PSFPolisher as Modifier<Ix1>>::Output<Self>
where Self: Sized,

Swap sample points to smooth away point-spread function artifacts.
Source§

impl<T> TMFilterBuilder for T
where T: Generator<Dim<[usize; 1]>>,

Source§

fn tm_filter(self) -> <TMFilter as Modifier<Ix1>>::Output<Self>
where Self: Sized,

Filter the schedule to reduce patterns by swapping samples to make the schedule “look like” the Thue-Morse sequence. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V