Skip to main content

Class: AdvancedMagnifyTool

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

Constructors

new AdvancedMagnifyTool()

new AdvancedMagnifyTool(toolProps, defaultToolProps): AdvancedMagnifyTool

Parameters

toolProps: PublicToolProps = {}

defaultToolProps: SharedToolProp = ...

Returns

AdvancedMagnifyTool

Overrides

AnnotationTool.constructor

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:156

Properties

configuration

configuration: Record<string, any>

Inherited from

AnnotationTool.configuration

Defined in

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


editData

editData: object

annotation

annotation: Annotation

handleIndex?

optional handleIndex: number

hasMoved?

optional hasMoved: boolean

newAnnotation?

optional newAnnotation: boolean

viewportIdsToRender

viewportIdsToRender: string[]

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:147


isDrawing

isDrawing: boolean

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:154


magnifyViewportManager

magnifyViewportManager: MagnifyViewportManager

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:146


mode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

Inherited from

AnnotationTool.mode

Defined in

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


supportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

Inherited from

AnnotationTool.supportedInteractionTypes

Defined in

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


toolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

Inherited from

AnnotationTool.toolGroupId

Defined in

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


Actions

static Actions: typeof AdvancedMagnifyToolActions = AdvancedMagnifyToolActions

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:144


toolName

static toolName: any

Overrides

AnnotationTool.toolName

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:143

Methods

_activateModify()

_activateModify(element): void

Parameters

element: any

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:540


_deactivateModify()

_deactivateModify(element): void

Parameters

element: any

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:552


_dragDrawCallback()

_dragDrawCallback(evt): void

Parameters

evt: InteractionEventType

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:427


_dragHandle()

_dragHandle(evt): void

Parameters

evt: InteractionEventType

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:475


_dragModifyCallback()

_dragModifyCallback(evt): void

Parameters

evt: InteractionEventType

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:447


_endCallback()

_endCallback(evt): void

Parameters

evt: InteractionEventType

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:404


addNewAnnotation()

addNewAnnotation(evt): AdvancedMagnifyAnnotation

Based on the current position of the mouse and the current imageId to create a CircleROI Annotation and stores it in the annotationManager

Parameters

evt: InteractionEventType

EventTypes.NormalizedMouseEventType

Returns

AdvancedMagnifyAnnotation

The annotation object.

Overrides

AnnotationTool.addNewAnnotation

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:197


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

AnnotationTool.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

AnnotationTool.applyActiveStrategyCallback

Defined in

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


cancel()

cancel(element): string

cancel Used to cancel the ongoing tool drawing and manipulation

Parameters

element: HTMLDivElement

Returns

string

Overrides

AnnotationTool.cancel

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:514


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

Inherited from

AnnotationTool.filterInteractableAnnotationsForElement

Defined in

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


getAnnotationStyle()

protected getAnnotationStyle(context): AnnotationStyle

Get the style that will be applied to all annotations such as length, cobb angle, arrow annotate, etc. when rendered on a canvas or svg layer

Parameters

context

context.annotation: Annotation

context.styleSpecifier: StyleSpecifier

Returns

AnnotationStyle

Inherited from

AnnotationTool.getAnnotationStyle

Defined in

tools/src/tools/base/AnnotationTool.ts:393


getHandleNearImagePoint()

getHandleNearImagePoint(element, annotation, canvasCoords, proximity): ToolHandle

It checks if the mouse click is near TextBoxHandle or AnnotationHandle itself, and return either it. It prioritize TextBoxHandle over AnnotationHandle. If the mouse click is not near any of the handles, it does not return anything.

Parameters

element: HTMLDivElement

The element that the tool is attached to.

annotation: Annotation

The annotation object associated with the annotation

canvasCoords: Point2

The coordinates of the mouse click on canvas

proximity: number

The distance from the mouse cursor to the point that is considered "near".

Returns

ToolHandle

The handle that is closest to the cursor, or null if the cursor is not near any of the handles.

Inherited from

AnnotationTool.getHandleNearImagePoint

Defined in

tools/src/tools/base/AnnotationTool.ts:262


getLinkedTextBoxStyle()

getLinkedTextBoxStyle(specifications, annotation?): Record<string, unknown>

It returns the style for the text box

Parameters

specifications: StyleSpecifier

annotation?: Annotation

The annotation for the tool that is currently active.

Returns

Record<string, unknown>

An object of the style settings for the text box.

Inherited from

AnnotationTool.getLinkedTextBoxStyle

Defined in

tools/src/tools/base/AnnotationTool.ts:328


getReferencedImageId()

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

Parameters

viewport: Viewport

worldPos: Point3

viewPlaneNormal: Point3

viewUp?: Point3

Returns

string

Inherited from

AnnotationTool.getReferencedImageId

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.

Inherited from

AnnotationTool.getStyle

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

AnnotationTool.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

AnnotationTool.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

AnnotationTool.getToolName

Defined in

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


handleSelectedCallback()

handleSelectedCallback(evt, annotation, handle): void

handleSelectedCallback Custom callback for when a handle is selected.

Parameters

evt: InteractionEventType

The normalized mouse event

annotation: AdvancedMagnifyAnnotation

The annotation selected.

handle: ToolHandle

The selected handle (either Types.Point3 in space for annotations, or TextBoxHandle object for text boxes).

Returns

void

Overrides

AnnotationTool.handleSelectedCallback

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:370


isPointNearTool()

isPointNearTool(element, annotation, canvasCoords, proximity): boolean

It returns if the canvas point is near the provided annotation in the provided element or not. A proximity is passed to the function to determine the proximity of the point to the annotation in number of pixels.

Parameters

element: HTMLDivElement

HTML Element

annotation: AdvancedMagnifyAnnotation

Annotation

canvasCoords: Point2

Canvas coordinates

proximity: number

Proximity to tool to consider

Returns

boolean

Boolean, whether the canvas point is near tool

Overrides

AnnotationTool.isPointNearTool

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:312


isSuvScaled()

isSuvScaled(viewport, targetId, imageId?): boolean

Returns true if the viewport is scaled to SUV units

Parameters

viewport: StackViewport | VolumeViewport

The viewport

targetId: string

The annotation targetId

imageId?: string

The annotation imageId

Returns

boolean

Inherited from

AnnotationTool.isSuvScaled

Defined in

tools/src/tools/base/AnnotationTool.ts:374


mouseMoveCallback()

mouseMoveCallback(evt, filteredAnnotations?): boolean

Event handler for Cornerstone MOUSE_MOVE event.

Parameters

evt: MouseMoveEventType

The normalized mouse event

filteredAnnotations?: Annotations

The annotations to check for hover interactions

Returns

boolean

True if the annotation needs to be re-drawn by the annotationRenderingEngine.

Inherited from

AnnotationTool.mouseMoveCallback

Defined in

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


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

Inherited from

AnnotationTool.onImageSpacingCalibrated

Defined in

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


onSetToolDisabled()

onSetToolDisabled(): void

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:289


renderAnnotation()

renderAnnotation(enabledElement, svgDrawingHelper): boolean

it is used to draw the circleROI annotation in each request animation frame. It calculates the updated cached statistics if data is invalidated and cache it.

Parameters

enabledElement: IEnabledElement

The Cornerstone's enabledElement.

svgDrawingHelper: SVGDrawingHelper

The svgDrawingHelper providing the context for drawing.

Returns

boolean

Overrides

AnnotationTool.renderAnnotation

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:572


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

AnnotationTool.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

AnnotationTool.setConfiguration

Defined in

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


showZoomFactorsList()

showZoomFactorsList(evt, annotation): void

Parameters

evt: InteractionEventType

annotation: AdvancedMagnifyAnnotation

Returns

void

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:694


toolSelectedCallback()

toolSelectedCallback(evt, annotation): void

Custom callback for when an annotation is selected

Parameters

evt: InteractionEventType

The normalized mouse event

annotation: AdvancedMagnifyAnnotation

The Annotation to check.

Returns

void

Overrides

AnnotationTool.toolSelectedCallback

Defined in

tools/src/tools/AdvancedMagnifyTool.ts:342


createAndAddAnnotation()

static createAndAddAnnotation(viewport, ...annotationBaseData): void

Creates and adds an annotation of the given type, firing the annotation modified event on the new annotation. This implicitly uses the static class when you call it on the correct base class. For example, you can call the KeyImageTool.createAnnotation method on KeyImageTool.toolName by calling KeyImageTool.createAndAddAnnotation

Parameters

viewport: any

• ...annotationBaseData: any[]

Returns

void

Inherited from

AnnotationTool.createAndAddAnnotation

Defined in

tools/src/tools/base/AnnotationTool.ts:97


createAnnotation()

static createAnnotation(...annotationBaseData): Annotation

Creates a base annotation object, adding in any annotation base data provided

Parameters

• ...annotationBaseData: any[]

Returns

Annotation

Inherited from

AnnotationTool.createAnnotation

Defined in

tools/src/tools/base/AnnotationTool.ts:45


createAnnotationForViewport()

static createAnnotationForViewport(viewport, ...annotationBaseData): Annotation

Creates a new annotation for the given viewport. This just adds the viewport reference data to the metadata, and otherwise returns the static class createAnnotation data.

Parameters

viewport: any

• ...annotationBaseData: any[]

Returns

Annotation

Inherited from

AnnotationTool.createAnnotationForViewport

Defined in

tools/src/tools/base/AnnotationTool.ts:82