Copyright  (c) Justin Le 2018 

License  BSD3 
Maintainer  justin@jle.im 
Stability  experimental 
Portability  nonportable 
Safe Haskell  None 
Language  Haskell2010 
HilbertHuang transform in pure Haskell.
The main data type is HHT
, which can be generated using hht
or
hhtEmd
. See Numeric.EMD for information on why this module uses
"sized vectors", and how to convert unsized vectors to sized vectors.
Since: 0.1.2.0
Synopsis
 newtype HHT v n a = HHT {}
 data HHTLine v n a = HHTLine {}
 hhtEmd :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => EMD v (n + 1) a > HHT v n a
 hht :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => EMDOpts a > Vector v (n + 1) a > HHT v n a
 hhtSpectrum :: forall v n a k. (Vector v a, KnownNat n, Ord k, Num a) => (a > k) > HHT v n a > Vector n (Map k a)
 hhtSparseSpectrum :: forall v n a k. (Vector v a, KnownNat n, Ord k, Num a) => (a > k) > HHT v n a > Map (Finite n, k) a
 hhtDenseSpectrum :: forall v n m a. (Vector v a, KnownNat n, KnownNat m, Num a) => (a > Finite m) > HHT v n a > Vector n (Vector m a)
 marginal :: forall v n a k. (Vector v a, KnownNat n, Ord k, Num a) => (a > k) > HHT v n a > Map k a
 instantaneousEnergy :: forall v n a. (Vector v a, KnownNat n, Num a) => HHT v n a > Vector v n a
 degreeOfStationarity :: forall v n a k. (Vector v a, KnownNat n, Ord k, Fractional a) => (a > k) > HHT v n a > Map k a
 expectedFreq :: forall v n a. (Vector v a, KnownNat n, Fractional a) => HHT v n a > Vector v n a
 dominantFreq :: forall v n a. (Vector v a, KnownNat n, Ord a) => HHT v n a > Vector v n a
 data EMDOpts a = EO {}
 defaultEO :: Fractional a => EMDOpts a
 data BoundaryHandler
 data SiftCondition a
 = SCStdDev !a
  SCTimes !Int
  SCOr (SiftCondition a) (SiftCondition a)
  SCAnd (SiftCondition a) (SiftCondition a)
 defaultSC :: Fractional a => SiftCondition a
 data SplineEnd a
 = SENotAKnot
  SENatural
  SEClamped a a
 hilbert :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v n a > Vector v n (Complex a)
 hilbertIm :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v n a > Vector v n a
 hilbertPolar :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v (n + 1) a > (Vector v (n + 1) a, Vector v (n + 1) a)
 hilbertMagFreq :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v (n + 1) a > (Vector v (n + 1) a, Vector v n a)
HilbertHuang Transform
A HilbertHuang Transform. An
is a HilbertHuang
transform of an HHT
v n an
item time series of items of type a
represented
using vector v
.
Instances
Eq (v a) => Eq (HHT v n a) Source #  
Ord (v a) => Ord (HHT v n a) Source #  
Defined in Numeric.HHT  
Show (v a) => Show (HHT v n a) Source #  
Generic (HHT v n a) Source #  
(Vector v a, KnownNat n, Binary (v a)) => Binary (HHT v n a) Source #  Since: 0.1.3.0 
NFData (v a) => NFData (HHT v n a) Source #  Since: 0.1.5.0 
Defined in Numeric.HHT  
type Rep (HHT v n a) Source #  
Defined in Numeric.HHT 
A Hilbert Trasnform of a given IMF, given as a "skeleton line".
Instances
Eq (v a) => Eq (HHTLine v n a) Source #  
Ord (v a) => Ord (HHTLine v n a) Source #  
Defined in Numeric.HHT compare :: HHTLine v n a > HHTLine v n a > Ordering # (<) :: HHTLine v n a > HHTLine v n a > Bool # (<=) :: HHTLine v n a > HHTLine v n a > Bool # (>) :: HHTLine v n a > HHTLine v n a > Bool # (>=) :: HHTLine v n a > HHTLine v n a > Bool #  
Show (v a) => Show (HHTLine v n a) Source #  
Generic (HHTLine v n a) Source #  
(Vector v a, KnownNat n, Binary (v a)) => Binary (HHTLine v n a) Source #  Since: 0.1.3.0 
NFData (v a) => NFData (HHTLine v n a) Source #  Since: 0.1.5.0 
Defined in Numeric.HHT  
type Rep (HHTLine v n a) Source #  
Defined in Numeric.HHT type Rep (HHTLine v n a) = D1 (MetaData "HHTLine" "Numeric.HHT" "emd0.1.7.0inplace" False) (C1 (MetaCons "HHTLine" PrefixI True) (S1 (MetaSel (Just "hlMags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Vector v n a)) :*: S1 (MetaSel (Just "hlFreqs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Vector v n a)))) 
hhtEmd :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => EMD v (n + 1) a > HHT v n a Source #
Compute the HilbertHuang transform from a given Empirical Mode Decomposition.
hht :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => EMDOpts a > Vector v (n + 1) a > HHT v n a Source #
HilbertHuang Spectrum
:: (Vector v a, KnownNat n, Ord k, Num a)  
=> (a > k)  binning function. takes rev/tick freq between 0 and 1. 
> HHT v n a  
> Vector n (Map k a) 
Compute the full HilbertHuang Transform spectrum. At each timestep is a sparse map of frequency components and their respective magnitudes. Frequencies not in the map are considered to be zero.
Takes a "binning" function to allow you to specify how specific you want your frequencies to be.
See hhtSparseSpetrum
for a sparser version, and hhtDenseSpectrum
for
a denser version.
:: (Vector v a, KnownNat n, Ord k, Num a)  
=> (a > k)  binning function. takes rev/tick freq between 0 and 1. 
> HHT v n a  
> Map (Finite n, k) a 
A sparser vesion of hhtSpectrum
. Compute the full HilbertHuang
Transform spectrum. Returns a sparse matrix representing the power at
each time step (the
) and frequency (the Finite
nk
).
Takes a "binning" function to allow you to specify how specific you want your frequencies to be.
Since: 0.1.4.0
:: (Vector v a, KnownNat n, KnownNat m, Num a)  
=> (a > Finite m)  binning function. takes rev/tick freq between 0 and 1. 
> HHT v n a  
> Vector n (Vector m a) 
A denser version of hhtSpectrum
. Compute the full HilbertHuang
Transform spectrum, returning a dense matrix (as a vector of vectors)
representing the power at each time step and each frequency.
Takes a "binning" function that maps a frequency to one of m
discrete
slots, for accumulation in the dense matrix.
Since: 0.1.4.0
Properties of spectrum
:: (Vector v a, KnownNat n, Ord k, Num a)  
=> (a > k)  binning function. takes rev/tick freq between 0 and 1. 
> HHT v n a  
> Map k a 
Compute the marginal spectrum given a HilbertHuang Transform. It is similar to a Fourier Transform; it provides the "total power" over the entire time series for each frequency component.
A binning function is accepted to allow you to specify how specific you want your frequencies to be.
instantaneousEnergy :: forall v n a. (Vector v a, KnownNat n, Num a) => HHT v n a > Vector v n a Source #
Compute the instantaneous energy of the time series at every step via the HilbertHuang Transform.
:: (Vector v a, KnownNat n, Ord k, Fractional a)  
=> (a > k)  binning function. takes rev/tick freq between 0 and 1. 
> HHT v n a  
> Map k a 
Degree of stationarity, as a function of frequency.
expectedFreq :: forall v n a. (Vector v a, KnownNat n, Fractional a) => HHT v n a > Vector v n a Source #
Returns the "expected value" of frequency at each time step, calculated as a weighted average of all contributions at every frequency at that time step.
Since: 0.1.4.0
dominantFreq :: forall v n a. (Vector v a, KnownNat n, Ord a) => HHT v n a > Vector v n a Source #
Returns the dominant frequency (frequency with largest magnitude contribution) at each time step.
Since: 0.1.4.0
Options
Options for EMD composition.
EO  

Instances
Eq a => Eq (EMDOpts a) Source #  
Ord a => Ord (EMDOpts a) Source #  
Defined in Numeric.EMD  
Show a => Show (EMDOpts a) Source #  
Generic (EMDOpts a) Source #  
Binary a => Binary (EMDOpts a) Source #  Since: 0.1.3.0 
Fractional a => Default (EMDOpts a) Source #  Since: 0.1.3.0 
Defined in Numeric.EMD  
type Rep (EMDOpts a) Source #  
Defined in Numeric.EMD type Rep (EMDOpts a) = D1 (MetaData "EMDOpts" "Numeric.EMD" "emd0.1.7.0inplace" False) (C1 (MetaCons "EO" PrefixI True) (S1 (MetaSel (Just "eoSiftCondition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (SiftCondition a)) :*: (S1 (MetaSel (Just "eoSplineEnd") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (SplineEnd a)) :*: S1 (MetaSel (Just "eoBoundaryHandler") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe BoundaryHandler))))) 
data BoundaryHandler Source #
BHClamp  Clamp envelope at end points (Matlab implementation) 
BHSymmetric  Extend boundaries symmetrically 
Instances
data SiftCondition a Source #
Stop conditions for sifting process
Data type is lazy in its fields, so this infinite data type:
nTimes n = SCTimes n SCOr
nTimes (n + 1)
will be treated identically as:
nTimes = SCTimes
SCStdDev !a  Stop using standard SD method 
SCTimes !Int  Stop after a fixed number of sifting iterations 
SCOr (SiftCondition a) (SiftCondition a)  One or the other 
SCAnd (SiftCondition a) (SiftCondition a)  Stop when both conditions are met 
Instances
defaultSC :: Fractional a => SiftCondition a Source #
Default SiftCondition
End condition for spline
SENotAKnot  "Notaknot" condition: third derivatives are continuous at endpoints. Default for matlab spline. 
SENatural  "Natural" condition: curve becomes a straight line at endpoints. 
SEClamped a a  "Clamped" condition: Slope of curves at endpoints are explicitly given. Since: 0.1.2.0 
Instances
Eq a => Eq (SplineEnd a) Source #  
Ord a => Ord (SplineEnd a) Source #  
Defined in Numeric.EMD.Internal.Spline  
Show a => Show (SplineEnd a) Source #  
Generic (SplineEnd a) Source #  
Binary a => Binary (SplineEnd a) Source #  Since: 0.1.3.0 
type Rep (SplineEnd a) Source #  
Defined in Numeric.EMD.Internal.Spline type Rep (SplineEnd a) = D1 (MetaData "SplineEnd" "Numeric.EMD.Internal.Spline" "emd0.1.7.0inplace" False) (C1 (MetaCons "SENotAKnot" PrefixI False) (U1 :: Type > Type) :+: (C1 (MetaCons "SENatural" PrefixI False) (U1 :: Type > Type) :+: C1 (MetaCons "SEClamped" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))) 
Hilbert transforms (internal usage)
hilbert :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v n a > Vector v n (Complex a) Source #
Real part is original series and imaginary part is hilbert transformed series. Creates a "helical" form of the original series that rotates along the complex plane.
Note that since 0.1.7.0, this uses the same algorithm as the matlab implementation https://www.mathworks.com/help/signal/ref/hilbert.html
hilbertIm :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v n a > Vector v n a Source #
Hilbert transformed series. Essentially the same series, but
phaseshifted 90 degrees. Is sonamed because it is the "imaginary
part" of the proper hilbert transform, hilbert
.
Note that since 0.1.7.0, this uses the same algorithm as the matlab implementation https://www.mathworks.com/help/signal/ref/hilbert.html
hilbertPolar :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v (n + 1) a > (Vector v (n + 1) a, Vector v (n + 1) a) Source #
The polar form of hilbert
: returns the magnitude and phase of the
discrete hilbert transform of a series.
The computation of magnitude is unique, but computing phase gives us some ambiguity. The interpretation of the hilbert transform for instantaneous frequency is that the original series "spirals" around the complex plane as time progresses, like a helix. So, we impose a constraint on the phase to uniquely determine it: \(\phi_{t+1}\) is the minimal valid phase such that \(\phi_{t+1} \geq \phi_{t}\). This enforces the phase to be monotonically increasing at the slowest possible detectable rate.
Note that this function effectively resets the initial phase to be zero,
conceptually rotating hilbert
to begin on the real axis.
Since: 0.1.6.0
hilbertMagFreq :: forall v n a. (Vector v a, Vector v (Complex a), KnownNat n, FFTWReal a) => Vector v (n + 1) a > (Vector v (n + 1) a, Vector v n a) Source #
Given a time series, return a time series of the magnitude of the hilbert transform and the frequency of the hilbert transform, in units of revolutions per tick. Is only expected to taken in proper/legal IMFs.
The frequency will always be between 0 and 1, since we can't determine anything faster given the discretization, and we exclude negative values as physically unmeaningful for an IMF.