Last updated

API / geotoolkit / seismic / util / SeismicColors / SeismicColors

Class: SeismicColors

util.SeismicColors.SeismicColors

Defines a default SeismicColor set. Users can create a custom SeismicColor set or get a default implementation. Please refer to SeismicColors.getDefault() for a list of default sets.

Table of contents

Constructors
Methods

Contents

Constructors

new SeismicColors()

new SeismicColors()

Methods

createNamedColorMap

createNamedColorMap(name, rampSize?): ColorMap

Build named color map with specified ramp size

Parameters

Name Type Description
namestringThe name of the colorMap
Optional rampSizenumberThe number of color bins in the colorMap.

Returns

ColorMap


listNameColorMaps

listNameColorMaps(): string[]

Returns list of available color map

Returns

string[]

colorMapNames The array with all the colorMap names.


register

register(name, callback): SeismicColors

Register colorMap

Parameters

Name Type Description
namestringThe name of the colorMap
callbackRegisterCallbackThe registration function.

Returns

SeismicColors


getDefault

Static getDefault(): SeismicColors

Returns the default instance of colormaps. See examples. The default colormaps available are:

geotoolkit.seismic.util.defines.Angles5color,
geotoolkit.seismic.util.defines.BlackRedYellowWhite,
geotoolkit.seismic.util.defines.GreyOrange,
geotoolkit.seismic.util.defines.IntervalVelocity,
geotoolkit.seismic.util.defines.IntervalVelocity16,
geotoolkit.seismic.util.defines.IntervalVelocity32,
geotoolkit.seismic.util.defines.Rainbow,
geotoolkit.seismic.util.defines.RedGreenBlue,
geotoolkit.seismic.util.defines.RedWhiteBlack,
geotoolkit.seismic.util.defines.RedWhiteBlue,
geotoolkit.seismic.util.defines.RedWhiteBlueExtremes,
geotoolkit.seismic.util.defines.RedWhiteBlueHot,
geotoolkit.seismic.util.defines.RedYellowBlue,
geotoolkit.seismic.util.defines.Saddleback,
geotoolkit.seismic.util.defines.SaddlebackHot,
geotoolkit.seismic.util.defines.Spectrum,
geotoolkit.seismic.util.defines.WhiteBlack

Example

import {SeismicColors} from '@int/geotoolkit/seismic/util/SeismicColors';
const colorProvider = SeismicColors.getDefault();
const colormap = colorProvider.createNamedColorMap('WhiteBlack');

Example

// positive and negative colors can be changed if you use Positive and Negative fill
import {SeismicPipeline} from '@int/geotoolkit/seismic/pipeline/SeismicPipeline';
const positiveNegativeWigglePipeline = new SeismicPipeline({'name': 'PositiveNegativeWigglePipeline', 'reader': reader, 'statistics': reader.getStatistics()})
.setOptions({
'colors': {
'colorMap': SeismicColors.getDefault()
.createNamedColorMap('RedWhiteBlue')
.clone()
.setNegativeFillColor('blue') // or any other color
.setPositiveFillColor('red')
},
'plot': {
'type': {
'Wiggle': true,
'NegativeFill': true, //in case if you use 'NegativeFill' instead of 'NegativeColorFill' we use fixed color for all negative values
'PositiveFill': true
}
}
}));

Example

// or you can simply reverse it
const positiveNegativeWigglePipeline = new SeismicPipeline({'name': 'PositiveNegativeWigglePipeline', 'reader': reader, 'statictics': reader.getStatistics()})
.setOptions({
'colors': {
'colorMap': SeismicColors.getDefault().createNamedColorMap('RedWhiteBlue')
.reverse()
},
...
});

Returns

SeismicColors

seismicColors