Last updated

API / geotoolkit / seismic / analysis / filters / TaperFilter / TaperFilter

Class: TaperFilter

filters.TaperFilter.TaperFilter

The TaperFilter implements both pass band and band reject filtering on the traces.
This class uses a taper function and applies filtering in the Fourier domain.
The taper function is defined using four frequencies (encapsulated in the class TaperFrequencyBoundary).
Because this filter is applied in the Fourier domain, the filter object has to be aware of the
sample rate in order to map the frequencies to the data values property.

Table of contents

Constructors
Methods

Contents

Constructors

new TaperFilter(sampleRate, f1, f2, f3, f4, passFlag)

new TaperFilter(sampleRate, f1, f2, f3, f4, passFlag)

Parameters

Name Type Description
sampleRatenumberThe sample rate
f1number1st frequency (hrz)
f2number2nd frequency (hrz)
f3number3rd frequency (hrz)
f4number4th frequency (hrz)
passFlagbooleanThe filtering mode
Methods

apply

apply(input, length): Float32Array

Applies the filter on an array of data

Parameters

Name Type Description
inputFloat32ArrayThe input array
lengthnumberThe length of the input array that needs to be filtered.

Returns

Float32Array

output The processed array


getClassName

getClassName(): string

Returns

string


getFrequencyBoundary

getFrequencyBoundary(): TaperFrequencyBoundary

Gets the frequency boundary

Returns

TaperFrequencyBoundary

frequencyBoundary The frequency boundary


getPassFlag

getPassFlag(): boolean

Gets the pass flag

Returns

boolean

passFlag The pass flag


getSampleRate

getSampleRate(): number

Gets the sample rate

Returns

number

sampleRate The sample rate


setFrequencyBoundary

setFrequencyBoundary(f1): TaperFilter

Sets frequency boundary

Parameters

Name Type Description
f1TaperFrequencyBoundaryanother TaperFrequencyBoundary

Returns

TaperFilter

this

setFrequencyBoundary(f1, f2, f3, f4): TaperFilter

Sets frequency boundary

Parameters

Name Type Description
f1number1st frequency (hrz)
f2number2-nd frequency (hrz)
f3number3-rd frequency (hrz)
f4number4-th frequency (hrz)

Returns

TaperFilter

this


setPassFlag

setPassFlag(passFlag): TaperFilter

This sets the filtering mode. Usually this filter is used as band pass filter, but it can be reverted to band rejection mode by calling this method with flag set to false

Parameters

Name Type Description
passFlagbooleanThe pass flag

Returns

TaperFilter

this


setSampleRate

setSampleRate(sampleRate): TaperFilter

Sets the sample rate

Parameters

Name Type Description
sampleRatenumberSample rate is the number of times an analog signal is measured (sampled) per second.

Returns

TaperFilter

this


getClassName

Static getClassName(): string

Returns

string