Struct ProbeResult 

pub struct ProbeResult { /* private fields */ }

The recorded time series of one csx ProbeBox, restricted to its StartTime/StopTime window (a stop time ≤ 0 means “no limit”) and multiplied by its weight.

In a Bloch run (Simulation, Bloch mode) the probe value is complex: values is the real part (the real engine), imag the imaginary part, and the DFTs (dft, dft_vector, spectrum) return the spectrum of the complex series, X(f) = DFT[x_re](f) + j·DFT[x_im](f).

Implementations

impl ProbeResult

pub fn name(&self) -> &str

csx property name.

pub fn id(&self) -> u32

csx property id (csx::Property::id, equal to csx::PropertyId::get).

pub fn number(&self) -> u32

The probe number of the property.

pub fn kind(&self) -> ProbeKind

What is measured.

pub fn frequencies(&self) -> &[f64]

The property’s frequencies for frequency-domain output [Hz] (FD_Samples; may be empty).

pub fn dt(&self) -> f64

Sample interval [s].

pub fn times(&self) -> &[f64]

Sample times [s] (uniform, dt apart).

pub fn values(&self) -> &ProbeValues

The recorded values.

pub fn scalar(&self) -> Option<&[f64]>

Voltage / current samples (None for field probes).

pub fn vector(&self) -> Option<&[[f64; 3]]>

Field samples (None for voltage / current probes).

pub fn imag(&self) -> Option<&ProbeValues>

The imaginary part of the recorded values in a Bloch run (None otherwise); same kind and length as values.

pub fn dft(&self, freqs: &[f64]) -> Result<Vec<Complex64>>

DFT X(f) = Σ x(t_n)·e^{−j2πf·t_n}·dt of a voltage / current probe at freqs [Hz], with the samples’ own absolute times (so the half-step offset of currents is exact). The result equals that of a running DFT (RunningDft) over the same samples.

Errors

Error::Invalid for a field probe (use dft_vector) or a probe without samples.

pub fn dft_vector(&self, freqs: &[f64]) -> Result<Vec<[Complex64; 3]>>

DFT of each component of a field probe at freqs [Hz] (see dft).

Errors

Error::Invalid for a voltage / current probe or a probe without samples.

pub fn spectrum(&self) -> Result<Vec<Complex64>>

dft at the probe’s own frequencies.

Errors

See dft.

Trait Implementations

impl Clone for ProbeResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProbeResult

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

Formats the value using the given formatter.

impl PartialEq for ProbeResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProbeResult