Constructor
new Annotation()
Constructor: set default annotation id and uid.
- Source
Classes
Members
colour :string
Colour: for example 'green', '#00ff00' or 'rgb(0,255,0)'.
- string
- Source
labelPosition :Point2D|undefined
Label position. If undefined, the default shape label position will be used.
- Point2D |
undefined
- Source
mathShape :object
Mathematical shape.
- object
- Source
planeOrigin :Point3D|undefined
Plane origin: 3D position of index [0, 0, k].
- Point3D |
undefined
- Source
planePoints :Array.<Point3D>|undefined
A couple of points that help define the annotation plane.
- Array.<Point3D> |
undefined
- Source
quantification :object|undefined
Annotation quantification.
- object |
undefined
- Source
referencePoints :Array.<Point2D>|undefined
Additional points used to define the annotation.
- Array.<Point2D> |
undefined
- Source
referencedFrameNumber :number|undefined
Referenced frame number.
- number |
undefined
- Source
referencedSopClassUID :string
Referenced image SOP class UID.
- string
- Source
referencedSopInstanceUID :string
Referenced image SOP isntance UID.
- string
- Source
textExpr :string
Text expression. Can contain variables surrounded with '{}' that will be extracted from the quantification object.
- string
- Source
trackingId :string
Tracking id, unique within domain.
- string
- Source
trackingUid :string
Tracking Unique id.
- string
- Source
Methods
addMetaItem(concept, value)
Add annotation meta data.
| Name | Type | Description |
|---|---|---|
concept | DicomCode | The concept code. |
value | DicomCode | | The value code. |
- Source
canView() → {boolean}
Check if the annotation can be displayed: true if it has an associated view controller.
- Source
True if the annotation can be displayed.
- Type:
- boolean
getCentroid() → {Point|undefined}
Get the centroid of the math shape.
- Source
The 3D centroid point.
- Type:
- Point |
undefined
getFactory() → {object|undefined}
Get the math shape associated draw factory.
- Source
The factory.
- Type:
- object |
undefined
getMetaConceptIds() → {Array.<string>}
Get the concepts ids of the annotation meta data.
- Source
The ids.
- Type:
- Array.<string>
getMetaItem(conceptId) → {object|undefined}
Get an annotation meta data.
| Name | Type | Description |
|---|---|---|
conceptId | string | The value of the concept dicom code. |
- Source
The corresponding meta data item as {concept, value} or undefined.
- Type:
- object |
undefined
getOrientationName() → {string|undefined}
Get the orientation name for this annotation.
- Source
The orientation name, undefined if same as reference data.
- Type:
- string |
undefined
getText() → {string}
Get the annotation label text by applying the text expression on the current quantification.
- Source
The resulting text.
- Type:
- string
init(viewController)
Initialise the annotation.
| Name | Type | Description |
|---|---|---|
viewController | ViewController | The associated view controller. |
- Source
isCompatibleView(planeHelper) → {boolean}
Check if an input view is compatible with the annotation.
| Name | Type | Description |
|---|---|---|
planeHelper | PlaneHelper | The input view to check. |
- Source
True if compatible view.
- Type:
- boolean
removeMetaItem(conceptId)
Remove an annotation meta data.
| Name | Type | Description |
|---|---|---|
conceptId | string | The value of the concept dicom code. |
- Source
setTextExpr(labelText)
Set the annotation text expression.
| Name | Type | Description |
|---|---|---|
labelText | Object.<string, string> | The list of label texts indexed by modality. |
- Source
setViewController(viewController)
Set the associated view controller if it is compatible.
| Name | Type | Description |
|---|---|---|
viewController | ViewController | The view controller. |
- Source
updateQuantification()
Update the annotation quantification.
- Source