API / geotoolkit / seismic / pipeline / processor / SeismicTraceProcessor / SeismicTraceProcessor
processor.SeismicTraceProcessor.SeismicTraceProcessor
A Seismic Trace Processor is the implementation of a trace processing algorithm for seismic data. It is an extension point that allows the addition of custom trace processors.<br> A trace process usually represents an operation that can be performed on trace data (samples). It processes data trace by trace.
Constructors
- [new SeismicTraceProcessor(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.pipeline.processor-1.seismictraceprocessor.seismictraceprocessor.md#new seismictraceprocessor(options))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
apply | boolean | Whether the processor is active or not |
name | string | Name of the processor |
Constructors
• new SeismicTraceProcessor(options?)
Create trace processor
| Name | Type | Description |
|---|---|---|
Optional options | Options | the default properties |
Methods
▸ apply(apply): SeismicTraceProcessor
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
▸ dispose(): void
Dispose
void
▸ Protected equalsProcessor(other): boolean
Return true if processors are identical
| Name | Type | Description |
|---|---|---|
other | SeismicTraceProcessor | seismic processor |
boolean
▸ getClassName(): string
string
▸ getName(): string
Returns name of the processor
string
▸ getProperties(): OptionsOut
Gets the properties
the state properties
▸ getState(): OptionsOut
Returns apply and name values
the state properties
▸ invalidate(): SeismicTraceProcessor
Invalidate owner
▸ isApplicable(): boolean
Returns true if processor is active
boolean
▸ 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
▸ setName(name): SeismicTraceProcessor
Set name of the processor
| Name | Type | Description |
|---|---|---|
name | string | processor name |
▸ setProperties(props?): SeismicTraceProcessor
Sets the properties
| Name | Type | Description |
|---|---|---|
Optional props | Options | the default properties |
this
▸ setState(state): SeismicTraceProcessor
Set apply and name values
| Name | Type | Description |
|---|---|---|
state | Options | the default properties |
this
▸ 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
▸ verifyString(value, defaultValue): string
Returns stateValue if string, value instead
| Name | Type | Description |
|---|---|---|
value | string | value |
defaultValue | string | default value |
string
▸ Static getClassName(): string
string
▸ 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 |