API / geotoolkit / welllog / data / ScaledData / ScaledData
data.ScaledData.ScaledData
The ScaledData is a helper object that encapsulates the data representing a well log curve and allows to associate either conversion and/or interpolation objects with this data.
↳
ScaledData
Constructors
| [new ScaledData(data, conversion, interpolation, useOutOfRangeData)](/solutions/geotoolkit/apis/classes/geotoolkit.welllog.data-4.scaleddata.scaleddata.md#new scaleddata(data, conversion, interpolation, useoutofrangedata)) | [new ScaledData(options)](/solutions/geotoolkit/apis/classes/geotoolkit.welllog.data-4.scaleddata.scaleddata.md#new scaleddata(options)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
maxwraplevel | number | Maximum wrap level |
minwraplevel | number | Minimum wrap level |
Constructors
• new ScaledData(data?, conversion?, interpolation?, useOutOfRangeData?)
Create ScaledData
| Name | Type | Description |
|---|---|---|
Optional data | LogAbstractData | abstract log data |
Optional conversion | DataConversion | data conversion |
Optional interpolation | DataInterpolation | algorithm to interpolate samples |
Optional useOutOfRangeData | boolean | convert values equals or less to zero to 0 instead of NaN |
AbstractScaledData.constructor
• new ScaledData(options?)
Create ScaledData
| Name | Type | Description |
|---|---|---|
Optional options | Options | options object |
AbstractScaledData.constructor
Methods
▸ convertValueFromSource(v, d?): number
Convert value from original source to current scaled data
| Name | Type | Description |
|---|---|---|
v | number | value of the original data source |
Optional d | number | depth of the original data source |
number
AbstractScaledData.convertValueFromSource
▸ convertValueFromSource(v, d?): number[]
Convert array of values from original source to current scaled data
| Name | Type | Description |
|---|---|---|
v | number[] | array of values of the original data source |
Optional d | number[] | array of depths of the original data source |
number[]
AbstractScaledData.convertValueFromSource
▸ convertValueToSource(v): number
Convert value from scaled data source to original source
| Name | Type | Description |
|---|---|---|
v | number | value of the scaled data source |
number
AbstractScaledData.convertValueToSource
▸ convertValueToSource(v): number[]
Convert values from scaled data source to original source
| Name | Type | Description |
|---|---|---|
v | number[] | values of the scaled data source |
number[]
AbstractScaledData.convertValueToSource
▸ getClassName(): string
string
AbstractScaledData.getClassName
▸ getDataOrder(): Order
return the order of depths array
AbstractScaledData.getDataOrder
▸ getIndexRange(fromDepth, toDepth): Range
Return a wrap levels, If data doesn't have wraps than it returns null
Throws
Error if scaled data cannot be created
| Name | Type | Description |
|---|---|---|
fromDepth | number | from depth |
toDepth | number | to depth |
AbstractScaledData.getIndexRange
▸ getLength(): number
Gets a count of samples
number
▸ getMaxDepth(): number
Returns maximum depth
number
▸ getMaxPosition(): number
Returns maximum depth
number
AbstractScaledData.getMaxPosition
▸ getMaxValue(): number
Returns maximum value
number
AbstractScaledData.getMaxValue
▸ getMaxWrapLevel(): number
Return maximum wrap level. By default it is 0
number
AbstractScaledData.getMaxWrapLevel
▸ getMinDepth(): number
Get minimum depth
number
▸ getMinPosition(): number
Get minimum depth
number
AbstractScaledData.getMinPosition
▸ getMinValue(): number
Returns minimum value
number
AbstractScaledData.getMinValue
▸ getMinWrapLevel(): number
Return minimum wrap level. By default it is 0
number
AbstractScaledData.getMinWrapLevel
▸ getName(): string
Return name of the data
string
▸ getPositionArray(): number[]
Gets position array
number[]
Position array
AbstractScaledData.getPositionArray
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties object
AbstractScaledData.getProperties
▸ getSample(index): LogDataSample
Return sample at specified index
| Name | Type | Description |
|---|---|---|
index | number | index of the sample |
sample
▸ getSampleAt(samples, depth, prev, next): number
private
| Name | Type | Description |
|---|---|---|
samples | LogDataSample[] | samples |
depth | number | depth |
prev | number | prev |
next | number | next |
number
▸ getSamples(): LogDataSample[]
Gets scaled samples
array of LogDataSample.
▸ getSize(): number
Return the count of the samples
number
▸ getSource(): LogAbstractData
Gets source
▸ getTimeStamp(): number
number
▸ getValue(depth): number
Returns value at specified depth
| Name | Type | Description |
|---|---|---|
depth | number | to return value |
number
return value by depth
▸ getValueArray(): number[]
Gets value array either
number[]
Value array
AbstractScaledData.getValueArray
▸ getValueAt(depth, fromIndex?, toIndex?, interpolation?): number
Return the value matching the given depth or NaN if the given depth is out of the logdata depth range.
If the depths are strictly increasing:
- The returned value will be interpolated when necessary. See example 1
If the depths are not strictly increasing but never decreasing:
- The value returned will be the first one found (in the insertion order). See example 2
- The value returned will be interpolated between the last one found and its closest larger neighbor. See example 2
If the depths are not always increasing (not forward only):
- The value returned will be the last one found (in the insertion order). See example 3
- The value returned will be interpolated between the first one found and its closest larger neighbor. See example 3
| Name | Type | Description |
|---|---|---|
depth | number | The depth for which you want to compute the value |
Optional fromIndex | number | index of sample in depths |
Optional toIndex | number | index of sample in depths |
Optional interpolation | InterpolationType | interpolation type for the value |
number
▸ Protected getValueInternal(depth, samples): number
| Name | Type |
|---|---|
depth | number |
samples | LogDataSample[] |
number
▸ isForwardOnly(): boolean
Return true if array of the depths is ordered
boolean
AbstractScaledData.isForwardOnly
▸ isOutdated(): boolean
If data is outdated
boolean
▸ setConversion(conversion): ScaledData
Sets conversion
| Name | Type | Description |
|---|---|---|
conversion | DataConversion | conversion of the data |
this
AbstractScaledData.setConversion
▸ setInterpolation(interpolation): ScaledData
Sets interpolation
| Name | Type | Description |
|---|---|---|
interpolation | DataInterpolation | algorithm to interpolate samples |
this
AbstractScaledData.setInterpolation
▸ setMaxWrapLevel(level): ScaledData
Sets maximum wrap level value
| Name | Type | Description |
|---|---|---|
level | number | maximum wrap level. |
this
▸ setMinWrapLevel(level): ScaledData
Sets minimum wrap level value
| Name | Type | Description |
|---|---|---|
level | number | minimum wrap level |
this
▸ setProperties(properties?): ScaledData
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
AbstractScaledData.setProperties
▸ Static findIndex(scaledSamples, depth, length): number
Find index corresponding to depth
| Name | Type | Description |
|---|---|---|
scaledSamples | LogDataSample[] | samples |
depth | number | depth |
length | number | length of the array in the sample |
number
▸ Static getClassName(): string
string