[−][src]Struct find_peaks::Peak

pub struct Peak<T> {
    pub position: Range<usize>,
    pub left_diff: T,
    pub right_diff: T,
    pub height: Option<T>,
    pub prominence: Option<T>,
}

Struct containing the information of a found peak.

Some values can be Nones -- you have to specify at least one of the corresponding bounds in PeakFinder. If you don't, find_peaks skipps their calculation.

Fields

position: Range<usize>

range indices the peak spans

left_diff: T

absolute value of difference to the nearest neighbour to the left

right_diff: T

absolute value of difference to the nearest neighbour to the right

height: Option<T>prominence: Option<T>

Implementations

impl<T> Peak<T>[src]

pub fn middle_position(&self) -> usize[src]

Get the middle index of a peak (plateau). For an even plateau size the function rounds down.

Trait Implementations

impl<T: Clone> Clone for Peak<T>[src]

impl<T: Debug> Debug for Peak<T>[src]

impl<T: PartialEq> PartialEq<Peak<T>> for Peak<T>[src]

impl<T> StructuralPartialEq for Peak<T>[src]

Auto Trait Implementations

impl<T> RefUnwindSafe for Peak<T> where
    T: RefUnwindSafe, 

impl<T> Send for Peak<T> where
    T: Send, 

impl<T> Sync for Peak<T> where
    T: Sync, 

impl<T> Unpin for Peak<T> where
    T: Unpin, 

impl<T> UnwindSafe for Peak<T> where
    T: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.