Enum ComplexMode 

pub enum ComplexMode {
    Absolute,
    Phase,
    Real,
    Imaginary,
    SquareAmplitude,
    Log10Amplitude,
    AmplitudePhase,
    Log10AmplitudePhase,
}

Visualization mode for complex data (2D image or 3D field).

Mirrors ComplexMixIn.ComplexMode in silx. Each scalar mode maps a complex sample (re, im) to a single f32 via ComplexMode::to_scalar; ComplexMode::AmplitudePhase instead produces an RGBA composite.

silx exposes ABSOLUTE, PHASE, REAL, IMAGINARY, SQUARE_AMPLITUDE, AMPLITUDE_PHASE, and LOG10_AMPLITUDE_PHASE. The first six are mirrored directly; Log10Amplitude here is the scalar log10(|z|) map (silx only uses log10 amplitude inside its RGBA LOG10_AMPLITUDE_PHASE composite).

Variants

Absolute

|z| — the absolute value (numpy.absolute).

Phase

angle(z) — the phase in [-pi, pi] (numpy.angle).

Real

re(z) — the real part.

Imaginary

im(z) — the imaginary part.

SquareAmplitude

|z|^2 — the square amplitude (numpy.absolute(z) ** 2).

Log10Amplitude

log10(|z|) — the base-10 log of the amplitude.

AmplitudePhase

HSV composite: hue from the phase, value from the linearly normalized amplitude (silx AMPLITUDE_PHASE).

Log10AmplitudePhase

HSV composite: hue from the phase, value from the log10-normalized amplitude over a settable displayed range (silx LOG10_AMPLITUDE_PHASE, see crate::widget::complex_image_view::amplitude_phase_log_rgba).

Implementations

impl ComplexMode

pub const ALL: [ComplexMode; 8]

All modes in the silx menu order, for building a picker.

pub fn label(self) -> &'static str

Human-readable label, matching the silx menu text.

pub fn is_rgba(self) -> bool

true for modes whose displayed image is an RGBA composite rather than a colormapped scalar (ComplexMode::AmplitudePhase and ComplexMode::Log10AmplitudePhase).

pub fn to_scalar(self, re: f32, im: f32) -> f32

Convert a complex sample (re, im) to the scalar shown by this mode.

Faithful to silx ImageComplexData.__convertComplexData:

• Absolute → hypot(re, im) = numpy.absolute
• Phase → atan2(im, re) = numpy.angle
• Real → re
• Imaginary → im
• SquareAmplitude → re^2 + im^2 = numpy.absolute(z) ** 2
• Log10Amplitude → log10(hypot(re, im))

Returns 0.0 for the RGBA composite modes (ComplexMode::AmplitudePhase / ComplexMode::Log10AmplitudePhase), which have no scalar representation.

Trait Implementations

impl Clone for ComplexMode

fn clone(&self) -> ComplexMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ComplexMode

impl Debug for ComplexMode

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

Formats the value using the given formatter.

impl Eq for ComplexMode

impl PartialEq for ComplexMode

fn eq(&self, other: &ComplexMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ComplexMode