Model a log curve as it is defined by LIS.
More...
|
void | AddValue (int sampleNo, int dimension, object value) |
| Add a value to this curve.
|
|
void | AddValue (object value) |
| Add a value to this curve.
|
|
void | Clear () |
| Remove all values from this curve.
|
|
string | GetDescription () |
| Return description of this curve.
|
|
string | GetName () |
| Return name of this curve.
|
|
int | GetNDimensions () |
| Return the number of dimensions of this curve.
|
|
int | GetNSamples () |
| Return number of samples per depth for this curve.
|
|
int | GetNValues () |
| Return the number of values in this curve.
|
|
object[] | GetRange () |
| Return the range (i.e. the min and max value) of this curve.
|
|
int | GetRepresentationCode () |
| Return the LIS representation code for the data of this curve.
|
|
Statistics | GetStatistics () |
| Return curve statistics.
|
|
string | GetUnit () |
| Return unit of measure of the data of this curve.
|
|
object | GetValue (int index) |
| Return a specific value from this curve.
|
|
object | GetValue (int sampleNo, int dimension, int index) |
| Return a specific value from the given dimension of this curve.
|
|
Type | GetValueType () |
| Return value type (i.e. .Net Type) of curve values.
|
|
| LisCurve (string name, string unit, string description, int representationCode, int nDimensions, int nSamples) |
| Create a LIS curve instance.
|
|
override string | ToString () |
|
Model a log curve as it is defined by LIS.
A log curve consist of measurement data of a specific type. The curve may have one or more dimensions. In addition, a curve may have one or more samples for each index step.
- Author
- Petroware AS
◆ LisCurve()
LisCurve |
( |
string | name, |
|
|
string | unit, |
|
|
string | description, |
|
|
int | representationCode, |
|
|
int | nDimensions, |
|
|
int | nSamples ) |
Create a LIS curve instance.
- Parameters
-
name | Name (mnemonic) of curve. Non-null. |
unit | Unit of measure for the curve data. Null if unitless. |
description | Curve long name or description. May be null if not provided. |
representationCode | Type of curve data. See LisRepresentationCode. |
nDimensions | Dimension of curve. <0,>. |
nSamples | Number of samples per depth. <0,>. |
- Exceptions
-
ArgumentNullException | If name is null |
ArgumentNullException | If representationCode is invalid |
ArgumentException | If nDimensions is <= 0 |
ArgumentException | If nSamples is <= 0 |
◆ AddValue() [1/2]
void AddValue |
( |
int | sampleNo, |
|
|
int | dimension, |
|
|
object | value ) |
Add a value to this curve.
- Parameters
-
sampleNo | Sample number. [0,nSamples>. |
dimension | Dimension index. [0,nDimensions>. |
value | Value to add. Null to indicate absent. |
- Exceptions
-
ArgumentException | If sampleNo < 0 or >= nSamples. |
ArgumentException | If dimension < 0 or >= nDimensions. |
◆ AddValue() [2/2]
void AddValue |
( |
object | value | ) |
|
Add a value to this curve.
If this is a multi-dimensional curve, the value is added to the first dimension.
- Parameters
-
value | Value to add. Null to indicate absent. |
◆ GetDescription()
string GetDescription |
( |
| ) |
|
Return description of this curve.
- Returns
- Description of this curve. Null if not provided.
◆ GetName()
Return name of this curve.
- Returns
- Name of this curve. Never null.
◆ GetNDimensions()
Return the number of dimensions of this curve.
- Returns
- Number of dimensions of this curve. [1,>.
◆ GetNSamples()
Return number of samples per depth for this curve.
- Returns
- Number of samples per depth. [1,>.
◆ GetNValues()
Return the number of values in this curve.
- Returns
- Number of values (per dimension) in this curve. [0,>.
◆ GetRange()
Return the range (i.e. the min and max value) of this curve.
The returned array is never null. The two entries may be null if min/max does not exist.
If the curve is multi-dimensional, the range is reported across all dimensions.
- Returns
- The range of this curve as an array of two (min/max). Never null. The entries may be null in no range exists.
◆ GetRepresentationCode()
int GetRepresentationCode |
( |
| ) |
|
Return the LIS representation code for the data of this curve.
- Returns
- Representation code for the data of this curve.
◆ GetStatistics()
Return curve statistics.
Statistics is available even if log data has not been stored.
- Returns
- Curve statistics. Never null.
◆ GetUnit()
Return unit of measure of the data of this curve.
- Returns
- Unit of measure of the curve data. Null if unitless.
◆ GetValue() [1/2]
object GetValue |
( |
int | index | ) |
|
Return a specific value from this curve.
If this is a multi-dimensional curve, the value is retrieved from the first dimension. If there are multiple samples per depth, the first sample is returned.
- Parameters
-
index | Position index. [0,nValues>. |
- Returns
- The requested value. Null if absent.
- Exceptions
-
ArgumentException | If index is out of bounds. |
◆ GetValue() [2/2]
object GetValue |
( |
int | sampleNo, |
|
|
int | dimension, |
|
|
int | index ) |
Return a specific value from the given dimension of this curve.
- Parameters
-
sampleNo | Sample number. [0,nSamples>. |
dimension | Dimension index. [0,nDimensions>. |
index | Position index. [0,nValues>. |
- Returns
- The requested value. Null if absent.
- Exceptions
-
ArgumentException | If sampleNo, dimension or index is out of bounds. |
◆ GetValueType()
Return value type (i.e. .Net Type) of curve values.
- Returns
- Value type of curve data. Never null.
The documentation for this class was generated from the following file:
- Petroware/LogIo/Lis/LisCurve.cs