Struct ComplexData 

pub struct ComplexData { /* private fields */ }

Implementations

impl ComplexData

pub fn new( x_data: Array1<f64>, y_data: Array2<Complex64>, ) -> Result<Self, DataError>

pub fn from_axis( x_axis: XAxis, y_data: Array2<Complex64>, ) -> Result<Self, DataError>

Create data from an existing axis. Only the length is checked, since an XAxis is always valid.

pub fn zeros(num_channels: usize, num_data_points: usize) -> Self

pub fn from_x_data( x_data: Array1<f64>, num_channels: usize, ) -> Result<Self, DataError>

pub fn from_y_data(y_data: Array2<Complex64>) -> Self

pub fn comment(&self) -> Option<&str>

pub fn set_comment(&mut self, comment: Option<&str>)

pub fn channel_label(&self, channel: usize) -> Option<&str>

pub fn set_channel_label(&mut self, channel: usize, label: Option<&str>)

pub fn num_channels(&self) -> usize

pub fn num_data_points(&self) -> usize

pub fn x_axis(&self) -> &XAxis

The x axis. Prefer this over x_data for single values (XAxis::get) or iteration, because it never allocates.

pub fn x_data(&self) -> CowArray<'_, f64, Ix1>

The x values as an array. Borrowed for an explicit axis, computed (one allocation) for a uniform one.

pub fn set_x_axis(&mut self, x_axis: XAxis) -> Result<(), DataError>

Replace the x axis. It must have one value per data point.

pub fn y_data(&self) -> ArrayView2<'_, Complex64>

pub fn y_data_mut(&mut self) -> ArrayViewMut2<'_, Complex64>

pub fn into_y_data(self) -> Array2<Complex64>

Consume the data and return the owned y values without copying.

pub fn channel(&self, ch: usize) -> ArrayView1<'_, Complex64>

pub fn channel_mut(&mut self, ch: usize) -> ArrayViewMut1<'_, Complex64>

pub fn channel_iter(&self) -> AxisIter<'_, Complex64, Ix1>

pub fn channel_iter_mut(&mut self) -> AxisIterMut<'_, Complex64, Ix1>

pub fn iter(&self) -> Iter<'_, Complex64, Ix2>

pub fn iter_mut(&mut self) -> IterMut<'_, Complex64, Ix2>

pub fn nearest_x_index(&self, x: f64) -> usize

Index of the x value closest to x. On a tie the lower index wins.

O(1) for a uniform axis, a binary search otherwise.

impl ComplexData

pub fn to_magnitude(&self) -> RealData

pub fn to_magnitude_db(&self) -> RealData

pub fn to_phase(&self) -> RealData

pub fn to_phase_unwrapped(&self) -> RealData

pub fn to_phase_2pi(&self) -> RealData

pub fn to_phase_degrees(&self) -> RealData

pub fn to_phase_degrees_unwrapped(&self) -> RealData

Trait Implementations

impl AbsDiffEq for ComplexData

type Epsilon = f64

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Clone for ComplexData

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 ComplexData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComplexData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ComplexData

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a ComplexData

type Item = &'a Complex<f64>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Complex<f64>, Dim<[usize; 2]>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut ComplexData

type Item = &'a mut Complex<f64>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Complex<f64>, Dim<[usize; 2]>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ComplexData

type Item = Complex<f64>

The type of the elements being iterated over.

type IntoIter = IntoIter<Complex<f64>, Dim<[usize; 2]>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ComplexData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ComplexData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.