seisplotjs

3.1.4
Need help reading this?

transfer

src/transfer.ts

Applies response, poles and zeros along with overall gain to the seismogram. Should produce results similar to the sac command: transfer from polezero to none

transfer(seis: Seismogram, response: Response, lowCut: number, lowPass: number, highPass: number, highCut: number): Seismogram
Parameters
seis (Seismogram) seismogram to instrument correct
response (Response) response to apply
lowCut (number) low cut
lowPass (number) low pass
highPass (number) high pass
highCut (number) high cut
Returns
Seismogram: instrument corrected seismogram

transferSacPZ

src/transfer.ts
transferSacPZ(seis: Seismogram, sacPoleZero: SacPoleZero, lowCut: number, lowPass: number, highPass: number, highCut: number): Seismogram
Parameters
seis (Seismogram)
sacPoleZero (SacPoleZero)
lowCut (number)
lowPass (number)
highPass (number)
highCut (number)
Returns
Seismogram

transferSacPZSegment

src/transfer.ts
transferSacPZSegment(seis: SeismogramSegment, sacPoleZero: SacPoleZero, lowCut: number, lowPass: number, highPass: number, highCut: number): SeismogramSegment
Parameters
seis (SeismogramSegment)
sacPoleZero (SacPoleZero)
lowCut (number)
lowPass (number)
highPass (number)
highCut (number)
Returns
SeismogramSegment

calcResponse

src/transfer.ts
calcResponse(response: Response, numPoints: number, sampleRate: number, unit: string): FFTResult
Parameters
response (Response)
numPoints (number)
sampleRate (number)
unit (string)
Returns
FFTResult

calcResponseFromSacPoleZero

src/transfer.ts

Caclulates the frequency response from the given poles and zeros.

calcResponseFromSacPoleZero(sacPoleZero: SacPoleZero, numPoints: number, sampleRate: number): FFTResult
Parameters
sacPoleZero (SacPoleZero) poles and zeros
numPoints (number) number of points in the output fft
sampleRate (number) sample rate to compute at
Returns
FFTResult: frequency response

combine

src/transfer.ts

Applies poles and zeros to the fft of a time series. Modifies the freqValues in place.

combine(freqValues: Float32Array, sampFreq: number, sacPoleZero: SacPoleZero, lowCut: number, lowPass: number, highPass: number, highCut: number): Float32Array
Parameters
freqValues (Float32Array) fft of a timeseries
sampFreq (number) sampling frequency
sacPoleZero (SacPoleZero) poles and zeros
lowCut (number) low cut
lowPass (number) low pass
highPass (number) high pass
highCut (number) high cut
Returns
Float32Array: input freq values, with poles and zeros applied

evalPoleZeroInverse

src/transfer.ts

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: SacPoleZero, freq: number): InstanceType<any>
Parameters
sacPoleZero (SacPoleZero) SAC PoleZero response
freq (number) frequency to evaluate
Returns
InstanceType<any>: complex frequency domain value for this frequency

calcFreqTaper

src/transfer.ts

Calculates the frequency taper for the given parameters.

calcFreqTaper(freq: number, lowCut: number, lowPass: number, highPass: number, highCut: number): number
Parameters
freq (number) frequency
lowCut (number) low cut
lowPass (number) low pass
highPass (number) high pass
highCut (number) high cut
Returns
number: taper value at the frequency

applyFreqTaper

src/transfer.ts

Applies the frequency taper to the fft of the time series.

applyFreqTaper(fftResult: FFTResult, sampleRate: number, lowCut: number, lowPass: number, highPass: number, highCut: number): FFTResult
Parameters
fftResult (FFTResult) fft of time series
sampleRate (number) sample rate
lowCut (number) low cut
lowPass (number) low pass
highPass (number) high pass
highCut (number) high cut
Returns
FFTResult: fft with taper applied

METER

src/transfer.ts

commonly used units

METER

METER_PER_SECOND

src/transfer.ts
METER_PER_SECOND

METER_PER_SECOND_PER_SECOND

src/transfer.ts
METER_PER_SECOND_PER_SECOND

calcGamma

src/transfer.ts
calcGamma(unit: string): number
Parameters
unit (string)
Returns
number

calcScaleUnit

src/transfer.ts
calcScaleUnit(unit: string): number
Parameters
unit (string)
Returns
number

convertToSacPoleZero

src/transfer.ts

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. To maintain compatibility with SAC, this includes extra zeros if needed to convert to displacement. The number of extra zeros added is kept as gamma in the result.

convertToSacPoleZero(response: Response): SacPoleZero
Parameters
response (Response) stationxml Response to convert
Returns
SacPoleZero: SAC PoleZero style version of the response

convertPoleZeroToSacStyle

src/transfer.ts
convertPoleZeroToSacStyle(polesZeros: PolesZeros, sensitivity: number, sensitivity_freq: number, gamma: number): SacPoleZero
Parameters
polesZeros (PolesZeros)
sensitivity (number)
sensitivity_freq (number)
gamma (number)
Returns
SacPoleZero

calc_A0

src/transfer.ts
calc_A0(poles: Array<InstanceType<any>>, zeros: Array<InstanceType<any>>, ref_freq: number): number
Parameters
poles (Array<InstanceType<any>>)
zeros (Array<InstanceType<any>>)
ref_freq (number)
Returns
number