API / geotoolkit / seismic / pipeline / processor / Reverse / Reverse
Defines a processor to reverse trace values
↳
Reverse
Constructors
- [new Reverse(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.pipeline.processor-1.reverse.reverse.md#new reverse(options))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
apply | boolean | Whether the processor is active or not |
inverted | boolean | Invert polarity or not. Specifies if the polarity is +ve or -ve |
name | string | Name of the processor |
reversed | boolean | Reversed trace values or not |
Constructors
• new Reverse(options?)
| Name | Type |
|---|---|
Optional options | Options |
SeismicTraceProcessor.constructor
Methods
▸ apply(apply): Reverse
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
▸ getName(): string
Returns name of the processor
string
▸ getProperties(): OptionsOut
Returns properties
properties
SeismicTraceProcessor.getProperties
▸ getState(): OptionsOut
return state of the processor
SeismicTraceProcessor.getState
▸ invalidate(): Reverse
Invalidate owner
SeismicTraceProcessor.invalidate
▸ inversePolarity(inverse): Reverse
Sets polarity inverted to value
| Name | Type | Description |
|---|---|---|
inverse | boolean | specifies if the polarity is +ve or -ve |
▸ 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
▸ reverseBaseLine(reverse): Reverse
Sets base line reversed to value
| Name | Type | Description |
|---|---|---|
reverse | boolean | specifies if the baseline of the trace is reversed or not |
▸ setName(name): Reverse
Set name of the processor
| Name | Type | Description |
|---|---|---|
name | string | processor name |
▸ setProperties(properties?): Reverse
Sets properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
SeismicTraceProcessor.setProperties
▸ setState(state): Reverse
Sets state
| Name | Type | Description |
|---|---|---|
state | Options | sets the state |
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 |