API / geotoolkit / seismic / analysis / filters / TaperFilterProcess / TaperFilterProcess
filters.TaperFilterProcess.TaperFilterProcess
The TaperFilterProcess applies both pass band and band reject filtering on the traces <br> <br> This class uses a taper function and applies filtering in the Fourier domain.<br> The taper function is defined using four frequencies (encapsulated in the class TaperFrequencyBoundary).<br> 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.
↳
TaperFilterProcess
Constructors
- [new TaperFilterProcess(state)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.analysis.filters.taperfilterprocess.taperfilterprocess.md#new taperfilterprocess(state))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
apply | boolean | Whether the processor is active or not |
f1 | number | 1st frequency |
f2 | number | 2nd frequency |
f3 | number | 3rd frequency |
f4 | number | 4th frequency |
name | string | Name of the processor |
passflag | boolean | Filtering mode |
samplerate | number | The sample rate |
Constructors
• new TaperFilterProcess(state?)
| Name | Type |
|---|---|
Optional state | Options |
SeismicTraceProcessor.constructor
Methods
▸ apply(apply): TaperFilterProcess
Sets apply
| Name | Type | Description |
|---|---|---|
apply | boolean | whether the processor is active or not |
▸ clone(): SeismicTraceProcessor
Clones processor
this
▸ Protected copyConstructor(src): void
Copy constructor
| Name | Type | Description |
|---|---|---|
src | SeismicTraceProcessor | Source to copy from |
void
SeismicTraceProcessor.copyConstructor
▸ dispose(): void
Dispose
void
▸ Protected equalsProcessor(other): boolean
Return true if processors are identical
| Name | Type | Description |
|---|---|---|
other | SeismicTraceProcessor | seismic processor |
boolean
SeismicTraceProcessor.equalsProcessor
▸ getClassName(): string
string
SeismicTraceProcessor.getClassName
▸ getFrequencyBoundary(): TaperFrequencyBoundary
Gets the frequency boundary
frequencyBoundary The frequency boundary
▸ getName(): string
Returns name of the processor
string
▸ getPassFlag(): boolean
Gets the pass flag
boolean
passFlag The pass flag
▸ getProperties(): OptionsOut
Returns properties
properties
SeismicTraceProcessor.getProperties
▸ getSampleRate(): number
Gets the sample rate
number
sampleRate The sample rate
▸ getState(): OptionsOut
returns state of the taper filter
The state of the taper filter
SeismicTraceProcessor.getState
▸ invalidate(): TaperFilterProcess
Invalidate owner
SeismicTraceProcessor.invalidate
▸ isApplicable(): boolean
Returns true if processor is active
boolean
SeismicTraceProcessor.isApplicable
▸ process(pipeline, metadata, dataIn, dataOut): boolean
The function returns 'True' if the process was applied to the traces or 'False' if it was not applied.
| Name | Type | Description |
|---|---|---|
pipeline | SeismicPipeline | the seismic pipeline name |
metadata | SeismicMetaData | seismic metadata |
dataIn | Float32Array | The input data array on which the process should be applied |
dataOut | Float32Array | The output/processed data array |
boolean
returns whether the processing was successful
▸ setFrequencyBoundary(f1): TaperFilterProcess
Sets frequency boundary
| Name | Type | Description |
|---|---|---|
f1 | TaperFrequencyBoundary | another TaperFrequencyBoundary |
this
▸ setFrequencyBoundary(f1, f2, f3, f4): TaperFilterProcess
Sets frequency boundary
| Name | Type | Description |
|---|---|---|
f1 | number | 1st frequency (hrz) |
f2 | number | 2-nd frequency (hrz) |
f3 | number | 3-rd frequency (hrz) |
f4 | number | 4-th frequency (hrz) |
this
▸ setName(name): TaperFilterProcess
Set name of the processor
| Name | Type | Description |
|---|---|---|
name | string | processor name |
▸ setPassFlag(passFlag): TaperFilterProcess
Sets the pass flag
| Name | Type | Description |
|---|---|---|
passFlag | boolean | The pass flag |
this
▸ setProperties(properties?): TaperFilterProcess
Sets properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
SeismicTraceProcessor.setProperties
▸ setSampleRate(sampleRate): TaperFilterProcess
Sets the sample rate
| Name | Type | Description |
|---|---|---|
sampleRate | number | Sample rate is the number of times an analog signal is measured (sampled) per second. |
this
▸ setState(state): TaperFilterProcess
Sets state of the taper filter
Throws
Error if state is null
| Name | Type | Description |
|---|---|---|
state | Options | The state of the taper filter |
this
SeismicTraceProcessor.setState
▸ verify(stateValue, value): any
Returns stateValue not null, value instead
| Name | Type | Description |
|---|---|---|
stateValue | any | value |
value | any | default value |
any
▸ verifyBoolean(value, defaultValue): boolean
Returns stateValue if true or false, value instead
| Name | Type | Description |
|---|---|---|
value | boolean | value |
defaultValue | boolean | default value |
boolean
SeismicTraceProcessor.verifyBoolean
▸ verifyString(value, defaultValue): string
Returns stateValue if string, value instead
| Name | Type | Description |
|---|---|---|
value | string | value |
defaultValue | string | default value |
string
SeismicTraceProcessor.verifyString
▸ Static getClassName(): string
string
SeismicTraceProcessor.getClassName
▸ Static verifyState(state, name): Options
Sets state 'name' and 'apply' values to respectively name and false. Returns state object
| Name | Type | Description |
|---|---|---|
state | Options | the default properties |
name | string | name of the processor |