ppeaks

Documentation

Overview

Package ppeaks detects the peaks in a time series by means of persistent homology: https://www.sthu.org/blog/13-perstopology-peakdetection/index.html.

Index

• type Peak
• type Peaks
  • func GetPeaks(seq []float64) *Peaks
  • func GetPeaksInt(seq []int) *Peaks
  • func (pks *Peaks) GetIndices(fracOfMaxPersistence float64) []int
  • func (pks *Peaks) Max(fracOfMaxPersistence float64) int
  • func (pks *Peaks) MinMaxPersistence() (min, max float64)

Types

type Peak

type Peak struct {
	// contains filtered or unexported fields
}

type Peaks

type Peaks struct {
	// contains filtered or unexported fields
}

func GetPeaks

func GetPeaks(seq []float64) *Peaks

GetPeaks returns the peaks in a floating point time series. Peaks are returnend in increasing order of their indices.

func GetPeaksInt

func GetPeaksInt(seq []int) *Peaks

GetPeaksInt finds the peaks in an integer time series. Peaks are returnend in increasing order of their indices.

func (*Peaks) GetIndices

func (pks *Peaks) GetIndices(fracOfMaxPersistence float64) []int

GetIndices returns the indices in the original time series `seq` of the peaks with persistence/max(persitence of seq) >= `fracOfMaxPersistence`

func (*Peaks) Max

func (pks *Peaks) Max(fracOfMaxPersistence float64) int

Max returns the index in the original time series `seq` of the peak with the highest y-value. See GetIndices for fracOfMaxPersistence.

func (*Peaks) MinMaxPersistence

func (pks *Peaks) MinMaxPersistence() (min, max float64)

MinMaxPersistence returns the minimum and maximum persistence of the peaks in `seq`.