Skip to main content

Class: abstract AnnotationDisplayTool

Abstract class for tools which create and display annotations on the cornerstone3D canvas. In addition, it provides a base class for segmentation tools that require drawing an annotation before running the segmentation strategy for instance threshold segmentation based on an area and a threshold. Annotation tools make use of drawing utilities to draw SVG elements on the viewport.

To create a new annotation tool, derive from this class and implement the abstract methods.

Extends​

Extended by​

Constructors​

new AnnotationDisplayTool()​

new AnnotationDisplayTool(toolProps, defaultToolProps): AnnotationDisplayTool

Parameters​

• toolProps: PublicToolProps

• defaultToolProps: SharedToolProp

Returns​

AnnotationDisplayTool

Inherited from​

BaseTool.constructor

Defined in​

tools/src/tools/base/BaseTool.ts:23

Properties​

configuration​

configuration: Record<string, any>

Inherited from​

BaseTool.configuration

Defined in​

tools/src/tools/base/BaseTool.ts:17

mode​

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

Inherited from​

BaseTool.mode

Defined in​

tools/src/tools/base/BaseTool.ts:21

supportedInteractionTypes​

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

Inherited from​

BaseTool.supportedInteractionTypes

Defined in​

tools/src/tools/base/BaseTool.ts:15

toolGroupId​

toolGroupId: string

ToolGroup ID the tool instance belongs to

Inherited from​

BaseTool.toolGroupId

Defined in​

tools/src/tools/base/BaseTool.ts:19

toolName​

static toolName: any

Overrides​

BaseTool.toolName

Defined in​

tools/src/tools/base/AnnotationDisplayTool.ts:31

Methods​

applyActiveStrategy()​

applyActiveStrategy(enabledElement, operationData): any

Applies the active strategy function to the enabled element with the specified operation data.

Parameters​

• enabledElement: IEnabledElement

The element that is being operated on.

• operationData: unknown

The data that needs to be passed to the strategy.

Returns​

any

The result of the strategy.

Inherited from​

BaseTool.applyActiveStrategy

Defined in​

tools/src/tools/base/BaseTool.ts:62

applyActiveStrategyCallback()​

applyActiveStrategyCallback(enabledElement, operationData, callbackType): any

Applies the active strategy, with a given event type being applied. The event type function is found by indexing it on the active strategy function.

Parameters​

• enabledElement: IEnabledElement

The element that is being operated on.

• operationData: unknown

The data that needs to be passed to the strategy.

• callbackType: string

the type of the callback

Returns​

any

The result of the strategy.

Inherited from​

BaseTool.applyActiveStrategyCallback

Defined in​

tools/src/tools/base/BaseTool.ts:86

filterInteractableAnnotationsForElement()​

filterInteractableAnnotationsForElement(element, annotations): Annotations

Given the element and annotations which is an array of annotation, it filters the annotations array to only include the annotation based on the viewportType. If the viewport is StackViewport, it filters based on the current imageId of the viewport, if the viewport is volumeViewport, it only returns those that are within the same slice as the current rendered slice in the volume viewport. imageId as the enabledElement.

Parameters​

• element: HTMLDivElement

The HTML element

• annotations: Annotations

The annotations to filter (array of annotation)

Returns​

Annotations

The filtered annotations

Defined in​

tools/src/tools/base/AnnotationDisplayTool.ts:60

getReferencedImageId()​

protected getReferencedImageId(viewport, worldPos, viewPlaneNormal, viewUp?): string

Parameters​

• viewport: Viewport

• worldPos: Point3

• viewPlaneNormal: Point3

• viewUp?: Point3

Returns​

string

Defined in​

tools/src/tools/base/AnnotationDisplayTool.ts:126

getStyle()​

getStyle(property, specifications, annotation?): unknown

It takes the property (color, lineDash, etc.) and based on the state of the annotation (selected, highlighted etc.) it returns the appropriate value based on the central toolStyle settings for each level of specification.

Parameters​

• property: string

The name of the style property to get.

• specifications: StyleSpecifier

• annotation?: Annotation

The annotation for the tool that is currently active.

Returns​

unknown

The value of the property.

Defined in​

tools/src/tools/base/AnnotationDisplayTool.ts:163

getTargetId()​

protected getTargetId(viewport): string

Get the target Id for the viewport which will be used to store the cached statistics scoped to that target in the annotations. For StackViewport, targetId is the viewportId, but for the volume viewport, the targetId will be grabbed from the volumeId if particularly specified in the tool configuration, or if not, the first actorUID in the viewport.

Parameters​

• viewport: Viewport

viewport to get the targetId for

Returns​

string

targetId

Inherited from​

BaseTool.getTargetId

Defined in​

tools/src/tools/base/BaseTool.ts:197

getTargetImageData()​

protected getTargetImageData(targetId): IImageData | CPUIImageData

Get the image that is displayed for the targetId in the cachedStats which can be

  • imageId:<imageId>
  • volumeId:<volumeId>
  • videoId:<basePathForVideo>/frames/<frameSpecifier>

Parameters​

• targetId: string

annotation targetId stored in the cached stats

Returns​

IImageData | CPUIImageData

The image data for the target.

Inherited from​

BaseTool.getTargetImageData

Defined in​

tools/src/tools/base/BaseTool.ts:140

getToolName()​

getToolName(): string

Returns the name of the tool

Returns​

string

The name of the tool.

Inherited from​

BaseTool.getToolName

Defined in​

tools/src/tools/base/BaseTool.ts:50

onImageSpacingCalibrated()​

onImageSpacingCalibrated(evt): void

On Image Calibration, take all the annotation from the AnnotationState manager, and invalidate them to force them to be re-rendered and their stats to be recalculated. Then use the old and new imageData (non-calibrated and calibrated) to calculate the new position for the annotations in the space of the new imageData.

Parameters​

• evt: ImageSpacingCalibratedEvent

The calibration event

Returns​

void

Defined in​

tools/src/tools/base/AnnotationDisplayTool.ts:83

renderAnnotation()​

abstract renderAnnotation(enabledElement, svgDrawingHelper): any

renderAnnotation it used to draw the tool's annotation in each request animation frame

Parameters​

• enabledElement: IEnabledElement

The Cornerstone's enabledElement.

• svgDrawingHelper: SVGDrawingHelper

The svgDrawingHelper providing the context for drawing.

Returns​

any

Defined in​

tools/src/tools/base/AnnotationDisplayTool.ts:44

setActiveStrategy()​

setActiveStrategy(strategyName): void

Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.

Parameters​

• strategyName: string

name of the strategy to be set as active

Returns​

void

Inherited from​

BaseTool.setActiveStrategy

Defined in​

tools/src/tools/base/BaseTool.ts:126

setConfiguration()​

setConfiguration(newConfiguration): void

merges the new configuration with the tool configuration

Parameters​

• newConfiguration: Record<string, any>

Returns​

void

Inherited from​

BaseTool.setConfiguration

Defined in​

tools/src/tools/base/BaseTool.ts:112