Skip to main content

PlanarFreehandROITool

PlanarFreehandROITool lets you draw annotations that define an arbitrarily drawn region. You can use the PlanarFreehandROITool in all perpendicular views (axial, sagittal, coronal), support for oblique views is possible, but not yet supported, due to the implementation of getSubPixelSpacingAndXYDirections.

The resulting annotation’s data and metadata (the state of the viewport while drawing was happening) will get added to the ToolState manager and can be accessed from the ToolState by calling getAnnotations or similar methods.

PlanarFreehandROITool annotation can be smoothed on drawing completion. This is a configured based approach. The smoothing process uses b-spline algorithm and consider 4 configurations properties:

  • smoothing.smoothOnAdd: to tell whether it should be smoothed or not (for editing it is considered the property smoothOnEdit) (default: false)
  • smoothing.smoothOnEdit: to tell whether it should be smoothed or not when editing (default: false)
  • smoothing.knotsRatioPercentageOnAdd: percentage of points from Segment that are likely to be considered knots during smoothing (for editing it is considered the property knotsRatioPercentageOnEdit) ( default: 40)
  • smoothing.knotsRatioPercentageOnEdit: same as knotsRatioPercentageOnAdd but applicable only when editing the tool (default: 40)

So, with that said the smoothing might occur when:

  • drawing is done (i.e mouse is released) and smoothing.smoothOnAdd is true. smoothing algorithm uses knotsRatioPercentageOnAdd
  • edit drawing is done (i.e mouse is released) and smoothing.smoothOnEdit is true. smoothing algorithm uses knotsRatioPercentageOnEdit and its only applied to changed segment smoothing does not occur when:
  • smoothing.smoothOnAdd is false and drawing is completed
  • smoothing.smoothOnEdit is false and edit is completed
  • drawing still happening (editing or not)

The result of smoothing will be removal of some of the outliers Changing tool configuration (see below) you can fine-tune the smoothing process by changing knotsRatioPercentageOnAdd and knotsRatioPercentageOnEdit value, which smaller values produces a more agressive smoothing. A smaller value of knotsRatioPercentageOnAdd/knotsRatioPercentageOnEdit produces a more aggressive smoothing.

cornerstoneTools.addTool(PlanarFreehandROITool)

const toolGroup = ToolGroupManager.createToolGroup('toolGroupId')

toolGroup.addTool(PlanarFreehandROITool.toolName)

toolGroup.addViewport('viewportId', 'renderingEngineId')

toolGroup.setToolActive(PlanarFreehandROITool.toolName, {
  bindings: [
   {
      mouseButton: MouseBindings.Primary, // Left Click
    },
  ],
})

// set smoothing aggressiveness while adding new annotation (ps: this does not change if smoothing is ON or OFF)
toolGroup.setToolConfiguration(PlanarFreehandROITool.toolName, {
  smoothing: { knotsRatioPercentageOnAdd: 30 },
});

// set smoothing to be ON while editing only
toolGroup.setToolConfiguration(PlanarFreehandROITool.toolName, {
  smoothing: { smoothOnAdd: false, smoothOnEdit: true  },
});

Read more in the Docs section of the website.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_throttledCalculateCachedStats

_throttledCalculateCachedStats: any

publicconfiguration

configuration: Record<string, any>

isDrawing

isDrawing: boolean = false

isEditingClosed

isEditingClosed: boolean = false

isEditingOpen

isEditingOpen: boolean = false

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

publicmouseDragCallback

mouseDragCallback: any

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

publictouchDragCallback

touchDragCallback: any

statictoolName

toolName: any

Methods

_calculateStatsIfActive

  • _calculateStatsIfActive(annotation: PlanarFreehandROIAnnotation, targetId: string, viewport: any, renderingEngine: any, enabledElement: any): void

  • Parameters

    • annotation: PlanarFreehandROIAnnotation
    • targetId: string
    • viewport: any
    • renderingEngine: any
    • enabledElement: any

    Returns void

addNewAnnotation

  • addNewAnnotation(evt: InteractionEventType): PlanarFreehandROIAnnotation

  • Based on the current position of the mouse and the current image, creates a PlanarFreehandROIAnnotation and stores it in the annotationManager.

    Parameters

    • evt: InteractionEventType

      EventTypes.NormalizedMouseEventType

    Returns PlanarFreehandROIAnnotation

    The PlanarFreehandROIAnnotation object.

publicapplyActiveStrategy

  • applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): 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.

publicapplyActiveStrategyCallback

  • applyActiveStrategyCallback(enabledElement: IEnabledElement, operationData: unknown, callbackType: string): 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.

publiccancel

  • cancel(element: HTMLDivElement): void

  • Parameters

    • element: HTMLDivElement

    Returns void

publicfilterInteractableAnnotationsForElement

  • We need to override this method as the tool doesn’t always have handles, which means filterAnnotationsForDisplay fails inside filterAnnotationsWithinSlice.

    Parameters

    Returns Annotations

getHandleNearImagePoint

  • getHandleNearImagePoint(element: HTMLDivElement, annotation: Annotation, canvasCoords: Point2, proximity: number): 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.

publicgetLinkedTextBoxStyle

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

  • It returns the style for the text box

    Parameters

    • specifications: StyleSpecifier
    • optionalannotation: Annotation

      The annotation for the tool that is currently active.

    Returns Record<string, unknown>

    An object of the style settings for the text box.

publicgetStyle

  • getStyle(property: string, specifications: StyleSpecifier, annotation?: 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
    • optionalannotation: Annotation

      The annotation for the tool that is currently active.

    Returns unknown

    The value of the property.

publicgetToolName

  • getToolName(): string

  • Returns the name of the tool

    Returns string

    The name of the tool.

handleSelectedCallback

  • handleSelectedCallback(evt: InteractionEventType, annotation: PlanarFreehandROIAnnotation, handle: ToolHandle): void

  • Begins an edit of an open contour, when the mouse has selected a handle (end) of the open contour.

    Parameters

    • evt: InteractionEventType

      EventTypes.MouseDownEventType

    • annotation: PlanarFreehandROIAnnotation

      PlanarFreehandROIAnnotation annotation.

    • handle: ToolHandle

      The handle index, 0 for the start and 1 for the end.

    Returns void

isPointNearTool

  • isPointNearTool(element: HTMLDivElement, annotation: PlanarFreehandROIAnnotation, canvasCoords: Point2, proximity: number): boolean

  • Returns if the canvas point is near the line of the given 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: PlanarFreehandROIAnnotation

      The PlanarFreehandROIAnnotation.

    • canvasCoords: Point2

      Canvas coordinates

    • proximity: number

      Proximity to tool to consider

    Returns boolean

    Boolean, whether the canvas point is near tool

isSuvScaled

  • isSuvScaled(viewport: default | default, targetId: string, imageId?: string): boolean

  • Returns true if the viewport is scaled to SUV units

    Parameters

    • viewport: default | default

      The viewport

    • targetId: string

      The annotation targetId

    • optionalimageId: string

      The annotation imageId

    Returns boolean

publicmouseMoveCallback

  • mouseMoveCallback(evt: MouseMoveEventType, filteredAnnotations?: Annotations): boolean

  • Event handler for Cornerstone MOUSE_MOVE event.

    Parameters

    • evt: MouseMoveEventType

      The normalized mouse event

    • optionalfilteredAnnotations: Annotations

      The annotations to check for hover interactions

    Returns boolean

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

publiconImageSpacingCalibrated

  • onImageSpacingCalibrated(evt: ImageSpacingCalibratedEvent): 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

publicrenderAnnotation

  • renderAnnotation(enabledElement: IEnabledElement, svgDrawingHelper: SVGDrawingHelper): boolean

  • it is used to draw the 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

publicsetActiveStrategy

  • setActiveStrategy(strategyName: string): 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

publicsetConfiguration

  • setConfiguration(newConfiguration: Record<string, any>): void

  • merges the new configuration with the tool configuration

    Parameters

    • newConfiguration: Record<string, any>

    Returns void

toolSelectedCallback

  • toolSelectedCallback(evt: InteractionEventType, annotation: PlanarFreehandROIAnnotation): void

  • Edits the open or closed contour when the line is grabbed and dragged.

    Parameters

    • evt: InteractionEventType
    • annotation: PlanarFreehandROIAnnotation

    Returns void

publicstaticcreateAndAddAnnotation

  • createAndAddAnnotation(viewport: any, ...annotationBaseData: any[]): 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
    • rest...annotationBaseData: any[]

    Returns void

publicstaticcreateAnnotation

  • createAnnotation(...annotationBaseData: any[]): Annotation

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

    Parameters

    • rest...annotationBaseData: any[]

    Returns Annotation

publicstaticcreateAnnotationForViewport

  • createAnnotationForViewport(viewport: any, ...annotationBaseData: any[]): 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
    • rest...annotationBaseData: any[]

    Returns Annotation