API / geotoolkit3d / transformation / IndexCoordinates / IndexCoordinates
transformation.IndexCoordinates.IndexCoordinates
IndexCoordinates coordinates object.<br> <br> This object holds the information about the index coordinates of a seismic volume.<br> It is used to compute the Index-to-XY transformation and provides some utility function to retrieve the index coordinates.<br>
↳
IndexCoordinates
Constructors
- [new IndexCoordinates()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.transformation.indexcoordinates.indexcoordinates.md#new indexcoordinates())
Methods
Methods
▸ asBox3(): Box3
Returns the bounding box
Box3
The xyz coordinates as a box 3d
▸ asElevationBox3(): Box3
Returns the bounding box with z being elevation
Box3
The xyz coordinates as a box 3d
▸ fromJSONIndex(index): IndexCoordinates
Initialize index using given json.<br> <br> The third dimension (z) can be specified either using z0&z1&samplerate or z0&samplecount&samplerate<br>
| Name | Type | Description |
|---|---|---|
index | FromJSONIndex | The json |
this
▸ fromJSONPoints(xy): IndexCoordinates
Initialize XYCoordinates using given json.<br> <br> Only 3 corners out of 4 are required.<br>
| Name | Type | Description |
|---|---|---|
xy | PointsXY | json with points |
this
▸ fromJSONXY(xy): IndexCoordinates
Create a Seismic XYCoordinates system using the given corners.<br> <br> Only 3 corners out of 4 are required. Coordinates do not need to be in a specific order.<br>
| Name | Type | Description |
|---|---|---|
xy | XY | The xy json |
this
▸ getClassName(): string
string
▸ getIStep(): number
Gets the I step
number
The sample rate
▸ getJStep(): number
Gets the J step
number
The sample rate
▸ getSampleRate(): number
Gets the sample rate
number
The sample rate
▸ isPointInside(point): boolean
Returns if the given point is inside the XY limits defined by the given 4 corners.
| Name | Type | Description |
|---|---|---|
point | Vector3 | the point to check if it is inside the box |
boolean
true if the point is inside the box
▸ Static getClassName(): string
string