nmr_schedule::generators

Struct Quantiles

pub struct Quantiles<G: PdfGenerator<Ix1>>(/* private fields */);

Expand description

Schedule generation by Quantiles.

L. Craft, R. Sonstrom, V. Rovnyak, D. Rovnyak, Journal of magnetic resonance, 288, 109-121. https://doi.org/10.1016/j.jmr.2018.01.014

Implementations§

impl<G: PdfGenerator<Ix1>> Quantiles<G>

pub const fn new(pdf: G) -> Quantiles<G>

Create a new quantiles generator with the given PDF

Trait Implementations§

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

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

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

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.

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

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

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

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

Generate a schedule with a user-defined iteration parameter.

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

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

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.

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

Apply a modifier to the generator. Read more

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

Auto Trait Implementations§

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

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

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

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

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

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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<Dim, T> IterateBuilder<Dim> for T
where Dim: Dimension, T: Generator<Dim>,

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.

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

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.

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

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V