Last updated

API / geotoolkit / data / OptimizedData / OptimizedData

Class: OptimizedData

data.OptimizedData.OptimizedData

The OptimizedData is a helper object that decorate ScaledData and allows to optimize it

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new OptimizedData(scaledData, useXAxisForX)

new OptimizedData(scaledData, useXAxisForX?)

Create OptimizedData

Parameters

Name Type Description
scaledDataAbstractScaledDataabstract scaled data
Optional useXAxisForXbooleanuse OX axis for x coordinate of the sample

Overrides

AbstractScaledData.constructor

Methods

convertValueFromSource

convertValueFromSource(v, d?): number

Convert value from original source to current scaled data

Parameters

Name Type Description
vnumbervalue of the original data source
Optional dnumberdepth of the original data source

Returns

number

Overrides

AbstractScaledData.convertValueFromSource

convertValueFromSource(v, d?): number[]

Convert array of values from original source to current scaled data

Parameters

Name Type Description
vnumber[]array of values of the original data source
Optional dnumber[]array of depths of the original data source

Returns

number[]

Overrides

AbstractScaledData.convertValueFromSource


convertValueToSource

convertValueToSource(v): number

Convert value from scaled data source to original source

Parameters

Name Type Description
vnumbervalue of the scaled data source

Returns

number

Overrides

AbstractScaledData.convertValueToSource

convertValueToSource(v): number[]

Convert array of values from scaled data source to original source

Parameters

Name Type Description
vnumber[]array of values of the scaled data source

Returns

number[]

Overrides

AbstractScaledData.convertValueToSource


getClassName

getClassName(): string

Returns

string

Inherited from

AbstractScaledData.getClassName


getDataOrder

getDataOrder(): Order

return the order of the data set

Returns

Order

Overrides

AbstractScaledData.getDataOrder


getIndexRange

getIndexRange(fromPosition, toPosition): Range

Return a wrap levels, If data doesn't have wraps than it returns null

Parameters

Name Type Description
fromPositionnumberfrom position
toPositionnumberto position

Returns

Range

Overrides

AbstractScaledData.getIndexRange


getLength

getLength(needOptimization?): number

Gets a count of samples either optimized or not

Parameters

Name Type Description
Optional needOptimizationbooleanis optimization needed

Returns

number

Overrides

AbstractScaledData.getLength


getMaxPosition

getMaxPosition(): number

Gets max depth

Returns

number

Overrides

AbstractScaledData.getMaxPosition


getMaxValue

getMaxValue(): number

Gets max value

Returns

number

Overrides

AbstractScaledData.getMaxValue


getMaxWrapLevel

getMaxWrapLevel(): number

Gets max wrap level

Returns

number

Overrides

AbstractScaledData.getMaxWrapLevel


getMinPosition

getMinPosition(): number

Gets min depth

Returns

number

Overrides

AbstractScaledData.getMinPosition


getMinValue

getMinValue(): number

Gets min value

Returns

number

Overrides

AbstractScaledData.getMinValue


getMinWrapLevel

getMinWrapLevel(): number

Gets min wrap level

Returns

number

Overrides

AbstractScaledData.getMinWrapLevel


getOptimization

getOptimization(): boolean

Returns the state of optimization, is it on or off

Returns

boolean

needOptimization Is optimization on`


getPositionArray

getPositionArray(needOptimization?): number[]

Gets position array either optimized or not

Parameters

Name Type Description
Optional needOptimizationbooleanIs optimization needed

Returns

number[]

Position array

Overrides

AbstractScaledData.getPositionArray


getProperties

getProperties(): Record<string, any>

Gets all the properties pertaining to this object

Returns

Record<string, any>

Inherited from

AbstractScaledData.getProperties


getSample

getSample(index): DataSample

Return sample at specified index

Parameters

Name Type Description
indexnumbersample index

Returns

DataSample

sample.

Overrides

AbstractScaledData.getSample


getSamples

getSamples(needOptimization?): DataSample[]

Gets scaled samples

Parameters

Name Type
Optional needOptimizationboolean

Returns

DataSample[]

Overrides

AbstractScaledData.getSamples


getSource

getSource(): any

Get data source

Returns

any

Overrides

AbstractScaledData.getSource


getValue

getValue(position): number

Returns value at specified position

Parameters

Name Type Description
positionnumberposition to return value

Returns

number

return value by position

Overrides

AbstractScaledData.getValue


getValueArray

getValueArray(needOptimization?): number[]

Gets value array either optimized or not

Parameters

Name Type Description
Optional needOptimizationbooleanIs optimization needed

Returns

number[]

Value array

Overrides

AbstractScaledData.getValueArray


getValueAt

getValueAt(depth): number

Gets value

Parameters

Name Type
depthnumber

Returns

number

Overrides

AbstractScaledData.getValueAt


isForwardOnly

isForwardOnly(): boolean

Is data source forward only

Returns

boolean

Overrides

AbstractScaledData.isForwardOnly


isOutdated

isOutdated(): boolean

If data is outdated

Returns

boolean

Overrides

AbstractScaledData.isOutdated


setConversion

setConversion(conversion): OptimizedData

Sets conversion

Parameters

Name Type Description
conversionDataConversionconversion of the data

Returns

OptimizedData

this

Overrides

AbstractScaledData.setConversion


setInterpolation

setInterpolation(interpolation): OptimizedData

Sets interpolation

Parameters

Name Type Description
interpolationDataInterpolationalgorithm to interpolate samples

Returns

OptimizedData

this

Overrides

AbstractScaledData.setInterpolation


setModelToDevice

setModelToDevice(modelToDevice): OptimizedData

Sets transformation for which optimization was/will be calculated

Parameters

Name Type Description
modelToDeviceTransformationmodel to device transformation

Returns

OptimizedData

this


setOptimization

setOptimization(needOptimization?): OptimizedData

Turns on/off optimization

Parameters

Name Type Description
Optional needOptimizationbooleanIs optimization on

Returns

OptimizedData

this


setOptimizationType

setOptimizationType(optimizationType): OptimizedData

Sets optimization type

Parameters

Name Type Description
optimizationTypeOptimizationTypeoptimization type which is used

Returns

OptimizedData

this


setProperties

setProperties(properties): OptimizedData

Sets all the properties pertaining to this object

Parameters

Name Type Description
propertiesRecord<string, any>An object containing the properties to set

Returns

OptimizedData

this

Inherited from

AbstractScaledData.setProperties


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractScaledData.getClassName