Skip to content
Last updated

API / geotoolkit / welllog3d / data / Borehole3DDataRow / Borehole3DDataRow

Class: Borehole3DDataRow

data.Borehole3DDataRow.Borehole3DDataRow

One line of 3D data to be passed into Borehole3DData.<br> The number of entries in the radii array determines the number of sectors; each sector spans an equal angle region (360 degrees total).<br> Each row contains a radius per sector, and a value per sector.

Hierarchy

Table of contents

Constructors
  • [new Borehole3DDataRow(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog3d.data-6.borehole3ddatarow.borehole3ddatarow.md#new borehole3ddatarow(options))
Methods
Css Properties
Name Type Description
depthnumberDepth of this sample along the borehole

Contents

Constructors

new Borehole3DDataRow(options)

• new Borehole3DDataRow(options)

Creates a borehole 3D data row for a single depth sample.

Parameters

Name Type Description
optionsOptionsdepth and optional sector data for this sample

Overrides

AbstractDataRow.constructor

Methods

getAngles

▸ getAngles(): number[]

Returns the azimuth angle (in radians) assigned to each sector.<br> Angles are evenly distributed from 0 to 2π based on the radii count.

Returns

number[]

sector angle array

Overrides

AbstractDataRow.getAngles


getClassName

▸ getClassName(): string

Returns

string

Inherited from

AbstractDataRow.getClassName


getDepth

▸ getDepth(): number

Returns the depth of this sample.

Returns

number

depth

Overrides

AbstractDataRow.getDepth


getProperties

▸ getProperties(): Required<Options&gt;

Gets all the properties pertaining to this object.

Returns

Required<Options&gt;

properties object

Overrides

AbstractDataRow.getProperties


getRadii

▸ getRadii(): number[]

Returns the radius assigned to each sector.

Returns

number[]

sector radii


getSize

▸ getSize(): number

Returns the number of sectors (equal to the radii count).

Returns

number

sector count

Overrides

AbstractDataRow.getSize


getValues

▸ getValues(values?): number[]

Returns the log values per sector, optionally copying them into the provided array.

Parameters

Name Type Description
Optional valuesnumber[]optional output array to receive values

Returns

number[]

sector values

Overrides

AbstractDataRow.getValues


setData

▸ setData(options): Borehole3DDataRow

Sets the sector data for this depth sample.<br> When the number of values does not match the number of radii, values are padded with 0 or truncated and a warning is logged.<br> Sector angles are computed automatically as equal steps around 360 degrees.

Parameters

Name Type Description
optionsDataOptionsradii, and optional values per sector

Returns

Borehole3DDataRow

this


setProperties

▸ setProperties(properties?): Borehole3DDataRow

Sets all the properties pertaining to this object.

Parameters

Name Type Description
Optional propertiesOptionsan object containing the properties to set

Returns

Borehole3DDataRow

this

Overrides

AbstractDataRow.setProperties


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

AbstractDataRow.getClassName