Usage

Generally either

import * as filter from 'seisplotjs-filter'
filter.xxxx

or

import * as seisplotjs from 'seisplotjs'
seisplotjs.filter.xxxx

Core Functionality

Core functions for using the timeseries filtering module.

taper

src/taper.js

taper(seis: any, width: any, taperType: any)

Parameters

seis (any)

width (any = 0.05)

taperType (any = HANNING)

taper

src/index.js

taper

transfer

src/transfer.js

transfer(seis: any, response: any, lowCut: any, lowPass: any, highPass: any, highCut: any)

Parameters

seis (any)

response (any)

lowCut (any)

lowPass (any)

highPass (any)

highCut (any)

transfer

src/index.js

transfer

transferSacPZ

src/transfer.js

transferSacPZ(seis: any, sacPoleZero: any, lowCut: any, lowPass: any, highPass: any, highCut: any)

Parameters

seis (any)

sacPoleZero (any)

lowCut (any)

lowPass (any)

highPass (any)

highCut (any)

amplitude

src/index.js

amplitude(real: any, imag: any)

Parameters

real (any)

imag (any)

getCoefficients

src/taper.js

Calculates the coefficients for tapering, [omega, f0, f1]

getCoefficients(type: any, length: any)

Parameters

type (any)

length (any)

rMean

src/index.js

rMean(seis: any)

Parameters

seis (any)

mean

src/index.js

mean(waveform: any)

Parameters

waveform (any)

evalPoleZeroInverse

src/transfer.js

Evaluates the poles and zeros at the given value. The return value is 1/(pz(s) to avoid divide by zero issues. If there is a divide by zero situation, then the response is set to be 0+0i.

evalPoleZeroInverse(sacPoleZero: any, freq: any)

Parameters

sacPoleZero (any)

freq (any)

calcDFT

src/index.js

calcDFT(waveform: any, npts: any)

Parameters

waveform (any)

npts (any)

inverseDFT

src/index.js

inverseDFT(packedFreq: any, npts: any)

Parameters

packedFreq (any)

npts (any)

ampPhase

src/index.js

converts a packed real/imag array output from calcDFT into amplitude and phase. Output is object with amp and phase fields, each of which is an array.

ampPhase(packedFreq: any)

Parameters

packedFreq (any)

convertToSacPoleZero

src/transfer.js

Converts a StationXML response to SAC PoleZero style. This converts the analog to digital stage (usually 0) along with the overall gain, but does not include later FIR stages.

convertToSacPoleZero(response: any)

Parameters

response (any)

createButterworth

src/index.js

createButterworth(numPoles: any, passband: any, lowFreqCorner: any, highFreqCorner: any, delta: any)

Parameters

numPoles (any)

passband (any)

lowFreqCorner (any)

highFreqCorner (any)

delta (any)

createChebyshevI

src/index.js

createChebyshevI(numPoles: any, epsilon: any, passband: any, lowFreqCorner: any, highFreqCorner: any, delta: any)

Parameters

numPoles (any)

epsilon (any)

passband (any)

lowFreqCorner (any)

highFreqCorner (any)

delta (any)

createChebyshevII

src/index.js

createChebyshevII(numPoles: any, epsilon: any, passband: any, lowFreqCorner: any, highFreqCorner: any, delta: any)

Parameters

numPoles (any)

epsilon (any)

passband (any)

lowFreqCorner (any)

highFreqCorner (any)

delta (any)

rotate

src/index.js

rotate(seisA: any, azimuthA: any, seisB: any, azimuthB: any, azimuth: any)

Parameters

seisA (any)

azimuthA (any)

seisB (any)

azimuthB (any)

azimuth (any)

Core Classes and Constants

Core classes returned from the above functions.

BAND_PASS

src/index.js

BAND_PASS

LOW_PASS

src/index.js

LOW_PASS

HIGH_PASS

src/index.js

HIGH_PASS

HANNING

src/taper.js

HANNING

Type: string

HAMMING

src/taper.js

HAMMING

Type: string

COSINE

src/taper.js

COSINE

Type: string

UNITS

src/transfer.js

UNITS

Static Members

▸ COUNT

src/transfer.js

COUNT

▸ METER

src/transfer.js

METER

▸ METER_PER_SECOND

src/transfer.js

METER_PER_SECOND

▸ METER_PER_SECOND_PER_SECOND

src/transfer.js

METER_PER_SECOND_PER_SECOND

Re-export

Re-exporting imported modules for easier reuse.

OregonDSP

src/index.js

OregonDSP

model

src/index.js

model

Other/Private

Stuff I forgot to put in the TOC.

combine

src/transfer.js

combine(freqValues: any, sampFreq: any, sacPoleZero: any, lowCut: any, lowPass: any, highPass: any, highCut: any)

Parameters

freqValues (any)

sampFreq (any)

sacPoleZero (any)

lowCut (any)

lowPass (any)

highPass (any)

highCut (any)

calc_A0

src/transfer.js

calc_A0(poles: any, zeros: any, ref_freq: any)

Parameters

poles (any)

zeros (any)

ref_freq (any)

freqTaper

src/transfer.js

freqTaper(freq: any, lowCut: any, lowPass: any, highPass: any, highCut: any)

Parameters

freq (any)

lowCut (any)

lowPass (any)

highPass (any)

highCut (any)