DFAnalysis

Struct DFAnalysis 

Source
pub struct DFAnalysis {
    pub alpha: f64,
    pub intercept: f64,
    pub r_squared: f64,
    pub log_n: Vec<f64>,
    pub log_f: Vec<f64>,
}
Expand description

A struct representing Detrended Fluctuation Analysis (DFA) results.

DFA is a method used to find long-term statistical dependencies in time series data.

§Fields

  • alpha - The scaling exponent, which indicates the presence of long-range correlations.
  • intercept - The intercept of the linear fit in the log-log plot.
  • r_squared - The coefficient of determination, which indicates the goodness of fit.
  • log_n - A vector containing the logarithm of the box sizes used in the analysis.
  • log_f - A vector containing the logarithm of the fluctuation function values corresponding to the box sizes.

Fields§

§alpha: f64§intercept: f64§r_squared: f64§log_n: Vec<f64>§log_f: Vec<f64>

Implementations§

Source§

impl DFAnalysis

Source

pub fn dfa( data: &[f64], windows: &[usize], detrender: DetrendStrategy, ) -> Result<Self>

Performs Detrended Fluctuation Analysis (DFA) on the provided data.

This method computes the scaling exponent (Hurst exponent) and other statistical properties of a time series using the DFA algorithm. DFA is used to detect long-range correlations in time series data.

§Arguments
  • data: A slice of f64 representing the input time series data.
  • windows: A slice of usize specifying the window sizes to use for the fluctuation analysis.
  • detrender: A DetrendStrategy implementation used to remove trends from each segment.
§Returns

If successful, this method returns a DFAnalysis instance containing:

  • alpha: The estimated scaling exponent.
  • intercept: The intercept of the log-log regression.
  • r_squared: The coefficient of determination for the log-log fit.
  • log_n: A vector of log-transformed window sizes.
  • log_f: A vector of log-transformed fluctuation amplitudes.
§Errors

This method returns an error if:

  • windows is empty.
  • The length of the input data is less than four times the largest window size.
  • The smallest window size is less than 4.
  • The detrender fails to detrend a segment.
§Algorithm Overview
  1. Integration:

    • The input data is transformed into a cumulative deviation profile (mean-centered).
  2. Segment Detrending:

    • The profile is divided into overlapping segments, and each segment is detrended using the provided DetrendStrategy.
  3. Variance Calculation:

    • Variances of the detrended segments are computed.
  4. Log-Log Regression:

    • The log-transformed window sizes (log_n) and fluctuations (log_f) are used to perform a linear regression, yielding the scaling exponent alpha.
Source

pub fn udfa( data: &[f64], windows: &[usize], detrender: DetrendStrategy, ) -> Result<Self>

Performs an unbiased Detrended Fluctuation Analysis (DFA) on the provided data. this algorithm uses overlapping windows.

This method computes the scaling exponent (Hurst exponent) and other statistical properties of a time series using the DFA algorithm. DFA is used to detect long-range correlations in time series data.

§Arguments
  • data: A slice of f64 representing the input time series data.
  • windows: A slice of usize specifying the window sizes to use for the fluctuation analysis.
  • detrender: A DetrendStrategy implementation used to remove trends from each segment.
§Returns

If successful, this method returns a DFAnalysis instance containing:

  • alpha: The estimated scaling exponent.
  • intercept: The intercept of the log-log regression.
  • r_squared: The coefficient of determination for the log-log fit.
  • log_n: A vector of log-transformed window sizes.
  • log_f: A vector of log-transformed fluctuation amplitudes.
§Errors

This method returns an error if:

  • windows is empty.
  • The length of the input data is less than four times the largest window size.
  • The smallest window size is less than 4.
  • The detrender fails to detrend a segment.
§Algorithm Overview
  1. Integration:

    • The input data is transformed into a cumulative deviation profile (mean-centered).
  2. Segment Detrending:

    • The profile is divided into overlapping segments, and each segment is detrended using the provided DetrendStrategy.
  3. Variance Calculation:

    • Variances of the detrended segments are computed.
  4. Log-Log Regression:

    • The log-transformed window sizes (log_n) and fluctuations (log_f) are used to perform a linear regression, yielding the scaling exponent alpha.

Trait Implementations§

Source§

impl Clone for DFAnalysis

Source§

fn clone(&self) -> DFAnalysis

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DFAnalysis

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V