Constructor
new PlaneHelper(imageGeometry, viewOrientation)
| Name | Type | Description |
|---|---|---|
imageGeometry | Geometry | The image geometry. |
viewOrientation | Matrix33 | The view orientation. |
- Source
Classes
Methods
getCosines() → {Array.<number>}
Get the cosines of this plane.
- Source
The 2 cosines vectors (3D).
- Type:
- Array.<number>
getImageDeOrientedPoint3D(point) → {Point3D}
De-orient an input point from image to target space.
| Name | Type | Description |
|---|---|---|
point | Point3D | The input point. |
- Source
The de-orienteded point.
- Type:
- Point3D
getImageDeOrientedVector3D(vector) → {Vector3D}
De-orient an input vector from image to target space.
| Name | Type | Description |
|---|---|---|
vector | Vector3D | The input vector. |
- Source
The de-orienteded vector.
- Type:
- Vector3D
getImageOrientedPoint3D(planePoint) → {Point3D}
Orient an input point from target to image space.
| Name | Type | Description |
|---|---|---|
planePoint | Point3D | The input vector. |
- Source
The orienteded vector.
- Type:
- Point3D
getImageOrientedVector3D(planeVector) → {Vector3D}
Orient an input vector from target to image space.
| Name | Type | Description |
|---|---|---|
planeVector | Vector3D | The input vector. |
- Source
The orienteded vector.
- Type:
- Vector3D
getNativeScrollIndex() → {number}
Get the native (image) scroll dimension index.
- Source
The index.
- Type:
- number
getOffset3DFromPlaneOffset(offset2D) → {Vector3D}
Get a 3D offset from a plane one.
| Name | Type | Description |
|---|---|---|
offset2D | Scalar2D | The plane offset as {x,y}. |
- Source
The 3D world offset.
- Type:
- Vector3D
getPlaneOffsetFromOffset3D(offset3D) → {Scalar2D}
Get a plane offset from a 3D one.
| Name | Type | Description |
|---|---|---|
offset3D | Scalar3D | The 3D offset as {x,y,z}. |
- Source
The plane offset as {x,y}.
- Type:
- Scalar2D
getPlanePointFromPosition(point) → {Point3D}
Get a 2D plane position from a world position.
| Name | Type | Description |
|---|---|---|
point | Point | The world position. |
- Source
The plane point.
- Type:
- Point3D
getPlanePoints(position) → {Array.<Point3D>}
Get a list of points that define the plane at input position, given this classes orientation.
| Name | Type | Description |
|---|---|---|
position | Point | The position. |
- Source
An origin and 2 cosines vectors.
- Type:
- Array.<Point3D>
getPositionFromPlanePoint(point2D, k) → {Point3D}
Get a world position from a 2D plane position.
| Name | Type | Description |
|---|---|---|
point2D | Point2D | The plane point. |
k | number | The slice index. |
- Source
The world position.
- Type:
- Point3D
getScrollIndex() → {number}
Get the (view) scroll dimension index.
- Source
The index.
- Type:
- number
getTargetDeOrientedPoint3D(planePoint) → {Point3D}
De-orient an input point from target to real space.
| Name | Type | Description |
|---|---|---|
planePoint | Point3D | The input point. |
- Source
The de-orienteded point.
- Type:
- Point3D
getTargetDeOrientedVector3D(planeVector) → {Vector3D}
De-orient an input vector from target to real space.
| Name | Type | Description |
|---|---|---|
planeVector | Vector3D | The input vector. |
- Source
The de-orienteded vector.
- Type:
- Vector3D
getTargetOrientation() → {Matrix33}
Get the target orientation.
- Source
The orientation matrix.
- Type:
- Matrix33
getTargetOrientedPositiveXYZ(values) → {Scalar3D}
Reorder values to follow target orientation.
| Name | Type | Description |
|---|---|---|
values | Scalar3D | Values as {x,y,z}. |
- Source
Reoriented values as {x,y,z}.
- Type:
- Scalar3D
getTargetOrientedVector3D(vector) → {Vector3D}
Orient an input vector from real to target space.
| Name | Type | Description |
|---|---|---|
vector | Vector3D | The input vector. |
- Source
The oriented vector.
- Type:
- Vector3D
getViewOrientation() → {Matrix33}
Get the view orientation.
- Source
The orientation matrix.
- Type:
- Matrix33
isAquisitionOrientation() → {boolean}
Is this view in the same orientation as the image aquisition.
- Source
True if in aquisition plane.
- Type:
- boolean
worldToIndex(point) → {Index}
Image world to index.
| Name | Type | Description |
|---|---|---|
point | Point | The input point. |
- Source
The corresponding index.
- Type:
- Index