Skip to main content

LivewireContourTool

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

publicconfiguration

configuration: Record<string, any>

editData

editData: { annotation: ContourAnnotation; closed?: boolean; confirmedPath?: LivewirePath; confirmedPathRight?: LivewirePath; contourHoleProcessingEnabled?: boolean; currentPath?: LivewirePath; handleIndex?: number; hasMoved?: boolean; lastCanvasPoint?: Point2; newAnnotation?: boolean; originalPath?: Point3[]; sliceToWorld?: (point: Point2) => Point3; viewportIdsToRender: string[]; worldToSlice?: (point: Point3) => Point2 }

Type declaration

  • annotation: ContourAnnotation
  • optionalclosed?: boolean
  • optionalconfirmedPath?: LivewirePath
  • optionalconfirmedPathRight?: LivewirePath

    The next path segment, on the other side of the handle

  • optionalcontourHoleProcessingEnabled?: boolean
  • optionalcurrentPath?: LivewirePath
  • optionalhandleIndex?: number
  • optionalhasMoved?: boolean
  • optionallastCanvasPoint?: Point2
  • optionalnewAnnotation?: boolean
  • optionaloriginalPath?: Point3[]
  • optionalsliceToWorld?: (point: Point2) => Point3
      • (point: Point2): Point3

      • Parameters

        • point: Point2

        Returns Point3

  • viewportIdsToRender: string[]
  • optionalworldToSlice?: (point: Point3) => Point2
      • (point: Point3): Point2

      • Parameters

        • point: Point3

        Returns Point2

isDrawing

isDrawing: boolean

isHandleOutsideImage

isHandleOutsideImage: boolean = false

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

mouseDragCallback

mouseDragCallback: any

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

touchDragCallback

touchDragCallback: any

publicstatictoolName

toolName: string

Methods

_endCallback

  • _endCallback(evt: InteractionEventType, clearAnnotation?: boolean): void

  • Parameters

    • evt: InteractionEventType
    • clearAnnotation: boolean = false

    Returns void

addNewAnnotation

  • 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 ContourAnnotation

    The annotation 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.

cancel

  • cancel(element: HTMLDivElement): string

  • Parameters

    • element: HTMLDivElement

    Returns string

publiceditHandle

  • editHandle(worldPos: Point3, element: any, annotation: any, handleIndex: number): void

  • Parameters

    • worldPos: Point3
    • element: any
    • annotation: any
    • handleIndex: number

    Returns void

filterInteractableAnnotationsForElement

  • 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

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

  • Parameters

    Returns void

isPointNearTool

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

      Annotation

    • 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

  • Parameters

    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

  • Parameters

    Returns void

triggerChangeEvent

  • triggerChangeEvent(annotation: ContourAnnotation, enabledElement: IEnabledElement, changeType?: ChangeTypes, contourHoleProcessingEnabled?: boolean): void

  • Triggers an annotation complete or modified event based on changeType.

    Parameters

    • annotation: ContourAnnotation
    • enabledElement: IEnabledElement
    • changeType: ChangeTypes = ChangeTypes.StatsUpdated
    • contourHoleProcessingEnabled: boolean = false

    Returns void

publicundo

  • undo(element: any, config: any, evt: any): void

  • Clears any in progress edits, mostly used to get rid of accidentally started contours that happen on clicking not quite the right handle point. Eventually this is to be replaced with a proper undo, once that framework is available.

    Parameters

    • element: any
    • config: any
    • evt: any

    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