Struct Cpsd 

pub struct Cpsd { /* private fields */ }

Returns the cross-spectral density magnitude and phase of the two input series.

Implementations

impl Cpsd

pub fn builder() -> Builder<XStage>

Returns a new builder.

impl Cpsd

pub fn new(x: NumericSeries, y: NumericSeries) -> Self

Constructs a new instance of the type.

pub fn x(&self) -> &NumericSeries

pub fn y(&self) -> &NumericSeries

pub fn stft_options(&self) -> Option<&StftOptions>

pub fn magnitude_scaling(&self) -> Option<&MagnitudeScaling>

The scaling to apply to the output magnitude. Defaults to MAGNITUDE_DB_10 if not specified.

pub fn output_frequency_type(&self) -> Option<&OutputFrequencyType>

The type of the output frequency. Defaults to LINEAR if not specified. Changing the output frequency type may also rescale the magnitude of the output in order to ensure the density of the output is consistent.

pub fn unwrap_phase(&self) -> Option<bool>

Unwrap the phase of the output. Defaults to true if not specified.

pub fn output_phase_unit(&self) -> Option<&OutputPhaseUnit>

The unit of the output phase. Defaults to RADIANS if not specified.

Trait Implementations

impl Clone for Cpsd

fn clone(&self) -> Cpsd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cpsd

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cpsd

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Cpsd> for Builder<Complete>

fn from(v: Cpsd) -> Self

Converts to this type from the input type.

impl Hash for Cpsd

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Cpsd

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Cpsd

fn eq(&self, other: &Self) -> 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 PartialOrd for Cpsd

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Cpsd

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Cpsd