Enum DisplayMode

pub enum DisplayMode {
    Abs,
    RealPart,
}

Represents whether a spectrum is meant to be displayed as the real part or as the absolute value

Note that this is very experimental and you should default to using DisplayMode::Abs in parameters. The PSF Polisher publication only uses DisplayMode::Abs.

Future research can look into whether knowing the display mode of an experiment can inform schedule generation and reconstruction.

The PSF polisher, when passed in DisplayMode::RealPart, will only “see” the real part of the PSF during filtering and ignore the imaginary part, potentially leaving artifacts in and moving PSF noise into the imaginary part. If it is known that all of the signal will be exclusively in the real part, then moving sampling noise from the real part to the imaginary part may be desirable.

The IST reconstructor will also only “see” the real part when passed in DisplayMode::RealPart. It will assume that all signals in the imaginary axis are noise and ignore them.

Variants

Abs

The spectrum will be displayed in absolute value mode

RealPart

The spectrum will be displayed in real part mode; the complex part will be ignored.

Implementations

impl DisplayMode

pub fn magnitude(self, complex: Complex<f64>) -> f64

Calculate the magnitude of the complex number given the display mode. In Abs mode, this will return complex.abs(), and in RealPart mode, this will return complex.re().abs().

pub fn threshold<T: ComplexSequence + ?Sized>( self, sequence: &mut T, threshold: f64, )

Apply a soft threshold to a sequence, zeroing out all components with DisplayMode::magnitude less than the threshold.

pub fn maybe_real_part<T: ComplexSequence + ?Sized>(self, sequence: &mut T)

Take the real part of the sequence if self is RealPart, otherwise leaving it alone.

Trait Implementations

impl Clone for DisplayMode

fn clone(&self) -> DisplayMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayMode

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

Formats the value using the given formatter.

impl Default for DisplayMode

fn default() -> DisplayMode

Returns the “default value” for a type.

impl Copy for DisplayMode