Last updated

API / geotoolkit / seismic / pipeline / processor / Reverse / Reverse

Class: Reverse

processor.Reverse.Reverse

Defines a processor to reverse trace values

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
applybooleanWhether the processor is active or not
invertedbooleanInvert polarity or not. Specifies if the polarity is +ve or -ve
namestringName of the processor
reversedbooleanReversed trace values or not

Contents

Constructors

new Reverse(options)

new Reverse(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

SeismicTraceProcessor.constructor

Methods

apply

apply(apply): Reverse

Sets apply

Parameters

Name Type Description
applybooleanwhether the processor is active or not

Returns

Reverse

Inherited from

SeismicTraceProcessor.apply


clone

clone(): SeismicTraceProcessor

Clones processor

Returns

SeismicTraceProcessor

this

Inherited from

SeismicTraceProcessor.clone


copyConstructor

Protected copyConstructor(src): void

Copy constructor

Parameters

Name Type Description
srcSeismicTraceProcessorSource to copy from

Returns

void

Inherited from

SeismicTraceProcessor.copyConstructor


dispose

dispose(): void

Dispose

Returns

void

Inherited from

SeismicTraceProcessor.dispose


equalsProcessor

Protected equalsProcessor(other): boolean

Return true if processors are identical

Parameters

Name Type Description
otherSeismicTraceProcessorseismic processor

Returns

boolean

Inherited from

SeismicTraceProcessor.equalsProcessor


getClassName

getClassName(): string

Returns

string

Inherited from

SeismicTraceProcessor.getClassName


getName

getName(): string

Returns name of the processor

Returns

string

Inherited from

SeismicTraceProcessor.getName


getProperties

getProperties(): OptionsOut

Returns properties

Returns

OptionsOut

properties

Overrides

SeismicTraceProcessor.getProperties


getState

getState(): OptionsOut

return state of the processor

Returns

OptionsOut

Overrides

SeismicTraceProcessor.getState


invalidate

invalidate(): Reverse

Invalidate owner

Returns

Reverse

Inherited from

SeismicTraceProcessor.invalidate


inversePolarity

inversePolarity(inverse): Reverse

Sets polarity inverted to value

Parameters

Name Type Description
inversebooleanspecifies if the polarity is +ve or -ve

Returns

Reverse


isApplicable

isApplicable(): boolean

Returns true if processor is active

Returns

boolean

Inherited from

SeismicTraceProcessor.isApplicable


process

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.

Parameters

Name Type Description
pipelineSeismicPipelinethe seismic pipeline name
metadataSeismicMetaDataseismic metadata
dataInFloat32ArrayThe input data array on which the process should be applied
dataOutFloat32ArrayThe output/processed data array

Returns

boolean

returns whether the processing was successful

Inherited from

SeismicTraceProcessor.process


reverseBaseLine

reverseBaseLine(reverse): Reverse

Sets base line reversed to value

Parameters

Name Type Description
reversebooleanspecifies if the baseline of the trace is reversed or not

Returns

Reverse


setName

setName(name): Reverse

Set name of the processor

Parameters

Name Type Description
namestringprocessor name

Returns

Reverse

Inherited from

SeismicTraceProcessor.setName


setProperties

setProperties(properties?): Reverse

Sets properties

Parameters

Name Type Description
Optional propertiesOptionsproperties

Returns

Reverse

this

Overrides

SeismicTraceProcessor.setProperties


setState

setState(state): Reverse

Sets state

Parameters

Name Type Description
stateOptionssets the state

Returns

Reverse

this

Overrides

SeismicTraceProcessor.setState


verify

verify(stateValue, value): any

Returns stateValue not null, value instead

Parameters

Name Type Description
stateValueanyvalue
valueanydefault value

Returns

any

Inherited from

SeismicTraceProcessor.verify


verifyBoolean

verifyBoolean(value, defaultValue): boolean

Returns stateValue if true or false, value instead

Parameters

Name Type Description
valuebooleanvalue
defaultValuebooleandefault value

Returns

boolean

Inherited from

SeismicTraceProcessor.verifyBoolean


verifyString

verifyString(value, defaultValue): string

Returns stateValue if string, value instead

Parameters

Name Type Description
valuestringvalue
defaultValuestringdefault value

Returns

string

Inherited from

SeismicTraceProcessor.verifyString


getClassName

Static getClassName(): string

Returns

string

Inherited from

SeismicTraceProcessor.getClassName


verifyState

Static verifyState(state, name): Options

Sets state 'name' and 'apply' values to respectively name and false. Returns state object

Parameters

Name Type Description
stateOptionsthe default properties
namestringname of the processor

Returns

Options

Inherited from

SeismicTraceProcessor.verifyState