API / geotoolkit / deviation / Trajectory2d / Trajectory2d
deviation.Trajectory2d.Trajectory2d
Type Aliases
Ƭ CreateTrajectoryArg: Object
an array of the measured depth or object containing data and options
| Name | Type | Description |
|---|---|---|
data | { inclination: number[] ; md: number[] } | data section |
data.inclination | number[] | inclination-values array |
data.md | number[] | md-values array |
options? | { approximate?: boolean ; depthinterval?: number ; filter?: boolean ; md?: { max?: number ; min?: number } ; rightdeviation?: boolean ; start?: number ; units?: { angle?: string | AbstractUnit ; distance?: string | AbstractUnit } } | options section |
options.approximate? | boolean | flag set to enable approximation of the trajectory along the path |
options.depthinterval? | number | threshold depth interval |
options.filter? | boolean | if true, perform filtering of redundant points. |
options.md? | { max?: number ; min?: number } | cut-off MD-range |
options.md.max? | number | cut-off max MD-value |
options.md.min? | number | cut-off min MD-value |
options.rightdeviation? | boolean | rightDeviation means trajectory goes from north-west to south-east with positive inclination angle |
options.start? | number | start index |
options.units? | { angle?: string | AbstractUnit ; distance?: string | AbstractUnit } | units options section |
options.units.angle? | string | AbstractUnit | angle unit |
options.units.distance? | string | AbstractUnit | distance (TVD and horizontal) unit |
Ƭ EventMap: EventMap & { DataChanged: null }
Ƭ Options: Object
object containing data and options
| Name | Type | Description |
|---|---|---|
data? | { d?: number[] ; x?: number[] ; y?: number[] } | data section |
data.d? | number[] | d-measured depths array for each station |
data.x? | number[] | x-coordinate of the transformed stations |
data.y? | number[] | y-coordinate of the transformed stations |
options? | { approximate?: boolean ; depthinterval?: number ; units?: { distance?: string | AbstractUnit ; x?: string | AbstractUnit ; y?: string | AbstractUnit } } | options section |
options.approximate? | boolean | flag set to enable approximation of the trajectory along the path |
options.depthinterval? | number | threshold depth interval |
options.units? | { distance?: string | AbstractUnit ; x?: string | AbstractUnit ; y?: string | AbstractUnit } | units options section |
options.units.distance? | string | AbstractUnit | distance (vertical and horizontal) unit |
options.units.x? | string | AbstractUnit | horizontal unit (use if units for "x" and "y" are different) |
options.units.y? | string | AbstractUnit | vertical unit (use if units for "x" and "y" are different) |
Ƭ OptionsOut: Object
object containing data and options
| Name | Type | Description |
|---|---|---|
data | { d: number[] ; x: number[] ; y: number[] } | data section |
data.d | number[] | d-measured depths array for each station |
data.x | number[] | x-coordinate of the transformed stations |
data.y | number[] | y-coordinate of the transformed stations |
options? | { approximate?: boolean ; depthinterval?: number ; units?: { distance?: string | AbstractUnit ; x?: string | AbstractUnit ; y?: string | AbstractUnit } } | options |
options.approximate? | boolean | flag set to enable approximation of the trajectory along the path |
options.depthinterval? | number | threshold depth interval |
options.units? | { distance?: string | AbstractUnit ; x?: string | AbstractUnit ; y?: string | AbstractUnit } | units options section |
options.units.distance? | string | AbstractUnit | distance (vertical and horizontal) unit |
options.units.x? | string | AbstractUnit | horizontal unit |
options.units.y? | string | AbstractUnit | vertical unit |
Ƭ UnitsOptions: Object
An object containing the properties to set
| Name | Type | Description |
|---|---|---|
distance? | string | AbstractUnit | distance ("x" and "y") units |
x? | string | AbstractUnit | horizontal unit (use if units for "x" and "y" are different) |
y? | string | AbstractUnit | vertical unit (use if units for "x" and "y" are different) |