noiseColors#

class peccary.examples.noiseColors(n)[source]#

Bases: object

The noiseColors class generates noisy timeseries of length n with different power spectra. Various methods generate timesereis for white noise (flat power density spectrum), blue noise (density \(\propto \nu\)), violet noise (density \(\propto \nu^2\)), Brownian/red noise (density \(\propto \nu^{-2}\)), and pink noise (density \(\propto \nu^{-1}\)).

Examples

To initialize the noiseColors class for 1000 points, use:

>>> import peccary.examples as ex
>>> noise = ex.noiseColors(1000)

To generate the different noise power spectra, use:

>>> white = noise.white()
>>> blue = noise.blue()
>>> violet = noise.violet()
>>> red = noise.red() # this is equivalent to using noise.brownian()
>>> pink = noise.pink()

The timeseries are stored in the x attribute with all of the methods.

Alternatively, the method getNoiseTypes can be used to generate a list of all available noise colors, e.g.,

>>> noises = ex.noiseColors(1000).getNoiseTypes()

Methods Summary

blue()

Generate blue noise (density \(\propto \nu\))

brownian()

Generate Brownian noise (density \(\propto \nu^{-2}\))

getNoiseTypes()

Generate all noise types

pink()

Generate pink noise (density \(\propto \nu^{-1}\))

red()

Generate red noise (density \(\propto \nu^{-2}\)).

violet()

Generate violet noise (density \(\propto \nu^2\))

white()

Generate white noise (flat frequency power spectrum)

Methods Documentation

blue()[source]#

Generate blue noise (density \(\propto \nu\))

Returns:
peccary.timeseries.Timeseries

Timeseries for blue noise, stored in x attribute of Timeseries class

brownian()[source]#

Generate Brownian noise (density \(\propto \nu^{-2}\))

Returns:
peccary.timeseries.Timeseries

Timeseries for Brownian/red noise noise, stored in x attribute of Timeseries class

getNoiseTypes()[source]#

Generate all noise types

Returns:
list

List containing generated white, blue, violet, Brownian/red, and pink noise timeseries

pink()[source]#

Generate pink noise (density \(\propto \nu^{-1}\))

Returns:
peccary.timeseries.Timeseries

Timeseries for pink noise, stored in x attribute of Timeseries class

red()[source]#

Generate red noise (density \(\propto \nu^{-2}\)). This is an alias of the Brownian noise function

Returns:
peccary.timeseries.Timeseries

Timeseries for red/Brownian noise noise, stored in x attribute of Timeseries class

violet()[source]#

Generate violet noise (density \(\propto \nu^2\))

Returns:
peccary.timeseries.Timeseries

Timeseries for violet noise, stored in x attribute of Timeseries class

white()[source]#

Generate white noise (flat frequency power spectrum)

Returns:
peccary.timeseries.Timeseries

Timeseries for white noise, stored in x attribute of Timeseries class