Struct PhaseUnwrapSeries 

pub struct PhaseUnwrapSeries { /* private fields */ }

Removes discontinuities from a wrapping signal (e.g. phase or heading) by adding whole multiples of period whenever the step between consecutive samples exceeds half the period. Output length equals input length.

Implementations

impl PhaseUnwrapSeries

pub fn builder() -> Builder<InputStage>

Returns a new builder.

impl PhaseUnwrapSeries

pub fn new(input: NumericSeries, period: DoubleConstant) -> PhaseUnwrapSeries

Constructs a new instance of the type.

pub fn input(&self) -> &NumericSeries

pub fn period(&self) -> &DoubleConstant

The wrapping period of the signal (e.g. 2*pi for radians, 360 for degrees). A jump between consecutive samples greater than period/2 in magnitude is corrected by adding/subtracting a whole multiple of period.

Trait Implementations

impl Clone for PhaseUnwrapSeries

fn clone(&self) -> PhaseUnwrapSeries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PhaseUnwrapSeries

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PhaseUnwrapSeries

fn deserialize<__D>( __deserializer: __D, ) -> Result<PhaseUnwrapSeries, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PhaseUnwrapSeries

impl From<PhaseUnwrapSeries> for Builder<Complete>

fn from(v: PhaseUnwrapSeries) -> Builder<Complete>

Converts to this type from the input type.

impl Hash for PhaseUnwrapSeries

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

where H: Hasher,

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 PhaseUnwrapSeries

fn cmp(&self, other: &PhaseUnwrapSeries) -> 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 PhaseUnwrapSeries

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PhaseUnwrapSeries

fn partial_cmp(&self, other: &PhaseUnwrapSeries) -> 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 PhaseUnwrapSeries

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

where __S: Serializer,

Serialize this value into the given Serde serializer.