Struct HilbertSpectrumConfig 

#[non_exhaustive]
pub struct HilbertSpectrumConfig {
    pub num_freq_bins: usize,
    pub freq_range: (f64, f64),
    pub log_freq: bool,
    pub time_smoothing: Option<usize>,
    pub mask_unreliable_phase: bool,
}

Configuration for hilbert_spectrum.

Constructed via HilbertSpectrumConfig::new (which requires the frequency range, since it is data-dependent and has no universal default) and chained with_* setters. The struct is #[non_exhaustive] so struct-literal construction from outside the crate is blocked.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

num_freq_bins: usize

Number of frequency bins spanning freq_range. Must be ≥ 2. Default 128.

freq_range: (f64, f64)

(f_min, f_max) in Hz. Required; must satisfy 0 ≤ f_min < f_max ≤ sample_rate / 2, with f_min > 0 when Self::log_freq is true.

log_freq: bool

Use logarithmic bin spacing across freq_range. Default false.

time_smoothing: Option<usize>

Optional conservative Gaussian time-smoothing σ in samples, applied per freq bin after binning. None (default) leaves the density unsmoothed.

mask_unreliable_phase: bool

Mask samples whose instantaneous amplitude is below the per-IMF noise floor 1e-6 · max_t |a_k(t)|. Default true. The phase of the analytic signal becomes ill-conditioned as the envelope approaches zero: tiny real/imaginary noise dominates arg, and the central-difference instantaneous frequency derived from that phase is garbage. Setting this false includes those samples; they typically scatter energy into random bins.

Implementations

impl HilbertSpectrumConfig

pub fn new(f_min: f64, f_max: f64) -> Self

Create a config for a given (f_min, f_max) band in Hz. Other fields take their documented defaults.

pub fn with_num_freq_bins(self, n: usize) -> Self

Override the number of frequency bins.

pub fn with_log_freq(self, yes: bool) -> Self

Toggle logarithmic frequency-bin spacing.

pub fn with_time_smoothing(self, sigma: Option<usize>) -> Self

Set the time-smoothing σ in samples. Pass None to disable.

pub fn with_mask_unreliable_phase(self, yes: bool) -> Self

Toggle the amplitude noise-floor mask.

Trait Implementations

impl Clone for HilbertSpectrumConfig

fn clone(&self) -> HilbertSpectrumConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HilbertSpectrumConfig

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

Formats the value using the given formatter.