seisplotjs.filter

2.0.0-alpha.4
Need help reading this?

Complex

src/filter.js
Complex

createComplex

src/filter.js
createComplex(real: number, imag: number)
Parameters
real (number)
imag (number)

BAND_PASS

src/filter.js

Constant for bandpass OregonDSP filter creation.

BAND_PASS

LOW_PASS

src/filter.js

Constant for lowpass OregonDSP filter creation.

LOW_PASS

HIGH_PASS

src/filter.js

Constant for highpass OregonDSP filter creation.

HIGH_PASS

amplitude

src/filter.js
amplitude(real: number, imag: number)
Parameters
real (number)
imag (number)

rMean

src/filter.js

Remove the mean from a seismogram. Subtract the mean from each data point.

rMean(seis: [type]): [type]
Parameters
seis ([type]) input seismogram
Returns
[type]: seismogram with mean of zero

gainCorrect

src/filter.js

Apply the frequency independent overall gain to a seismogram. This does not do a full transfer using poles and zero, this only applies the scalar conversion factor to convert counts back to original real world units and update the units.

gainCorrect(seis: [type], instrumentSensitivity: [type]): [type]
Parameters
seis ([type]) the seismogram to correct
instrumentSensitivity ([type]) overall gain object, usually pulled from stationxml
Returns
[type]: new seismogram with original units, like m/s and gain applied.

MinMaxMean

src/filter.js
MinMaxMean

Type: {min: number, max: number, mean: number}

Properties
min (number)
max (number)
mean (number)

createButterworth

src/filter.js

Creates a Butterworth IIR filter using the OregonDSP library.

createButterworth(numPoles: [type], passband: [type], lowFreqCorner: [type], highFreqCorner: [type], delta: [type]): [type]
Parameters
numPoles ([type]) number of poles
passband ([type]) type, use constants of BAND_PASS, LOW_PASS, HIGH_PASS
lowFreqCorner ([type]) low corner frequency
highFreqCorner ([type]) high corner frequency
delta ([type]) delta, period, of timeseries
Returns
[type]: Butterworth IIR filter

createChebyshevI

src/filter.js

Creates a Chebyshev I IIR filter using the OregonDSP library.

createChebyshevI(numPoles: [type], epsilon: [type], passband: [type], lowFreqCorner: [type], highFreqCorner: [type], delta: [type]): [type]
Parameters
numPoles ([type]) number of poles
epsilon ([type]) Chebyshev epsilon value
passband ([type]) type, use constants of BAND_PASS, LOW_PASS, HIGH_PASS
lowFreqCorner ([type]) low corner frequency
highFreqCorner ([type]) high corner frequency
delta ([type]) delta, period, of timeseries
Returns
[type]: Chebyshev I IIR filter

createChebyshevII

src/filter.js

Creates a Chebyshev II IIR filter using the OregonDSP library.

createChebyshevII(numPoles: [type], epsilon: [type], passband: [type], lowFreqCorner: [type], highFreqCorner: [type], delta: [type]): [type]
Parameters
numPoles ([type]) number of poles
epsilon ([type]) Chebyshev epsilon value
passband ([type]) type, use constants of BAND_PASS, LOW_PASS, HIGH_PASS
lowFreqCorner ([type]) low corner frequency
highFreqCorner ([type]) high corner frequency
delta ([type]) delta, period, of timeseries
Returns
[type]: Chebyshev II IIR filter

applyFilter

src/filter.js
applyFilter(iirFilter: OregonDSP.filter.iir.IIRFilter, seis: Seismogram): Seismogram
Parameters
iirFilter (OregonDSP.filter.iir.IIRFilter)
seis (Seismogram)
Returns
Seismogram

envelope

src/filter.js

Calculates the envelope, y_i = sqrt( y_i y_i + h_i h_i) where h is the hilber transform of y. The default configuration for the hilbet transform is n=100, lowEdge=.05 and highEdge = 0.95

envelope(seis: Seismogram): Seismogram
Parameters
seis (Seismogram)
Returns
Seismogram

hilbert

src/filter.js

Calculates the hilbert transform using the OregonDSP library with default number of points, n=10 (to yield a 21 pt FIR transform) and default low and high edge of 0.05 and 0.95. Low and high edge are given normalized 0 to 1.

hilbert(seis: Seismogram, n: number?, lowEdge: number?, highEdge: number?): Seismogram
Parameters
seis (Seismogram)
n (number?)
lowEdge (number?)
highEdge (number?)
Returns
Seismogram