Struct FrequencyBucket 

pub struct FrequencyBucket { /* private fields */ }

A single bucket in a bucketed frequency domain plot.

Implementations

impl FrequencyBucket

pub fn builder() -> Builder<FrequencyStartStage>

Returns a new builder.

impl FrequencyBucket

pub fn frequency_start(&self) -> f64

The start frequency of this bucket (inclusive).

pub fn frequency_end(&self) -> f64

The end frequency of this bucket (exclusive).

pub fn frequency_center(&self) -> f64

The center frequency of this bucket.

pub fn min_amplitude(&self) -> f64

The minimum amplitude value in this bucket.

pub fn max_amplitude(&self) -> f64

The maximum amplitude value in this bucket.

pub fn mean_amplitude(&self) -> f64

The mean amplitude value in this bucket.

pub fn count(&self) -> SafeLong

The number of original frequency points that were aggregated into this bucket.

pub fn first_point(&self) -> &FrequencyPoint

The first point (lowest frequency) in this bucket.

pub fn last_point(&self) -> Option<&FrequencyPoint>

The last point (highest frequency) in this bucket. Will be empty if the bucket only has a single point.

Trait Implementations

impl Clone for FrequencyBucket

fn clone(&self) -> FrequencyBucket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrequencyBucket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrequencyBucket

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FrequencyBucket> for Builder<Complete>

fn from(v: FrequencyBucket) -> Self

Converts to this type from the input type.

impl Hash for FrequencyBucket

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 FrequencyBucket

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 FrequencyBucket

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 FrequencyBucket

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 FrequencyBucket

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 FrequencyBucket