Class: UltrasoundPleuraBLineTool

UltrasoundPleuraBLineAnnotationTool facilitates the creation and manipulation of specialized annotations for ultrasound imaging. Each annotation comprises a line segment and an associated fan-shaped region, designed to highlight or measure features like B-lines or pleural abnormalities.

Interactively, users draw a line by defining two points. A fan is then automatically rendered based on these points and the tool's configuration parameters, such as center, innerRadius, outerRadius. The visual appearance, including distinct colors for different ultrasound findings (e.g., bLineColor, pleuraColor), is customizable through the tool's configuration.

Annotations are managed by the standard annotation state system, ensuring they are persisted and can be programmatically accessed. These annotations exist in 3D world space and are consistently displayed across multiple viewports sharing the same frame of reference.

Example

// Import necessary modules from Cornerstone Tools
import { UltrasoundPleuraBLineAnnotationTool, ToolGroupManager, Enums, addTool } from '@cornerstonejs/tools';
import { canvasCoordinates } from '../../utilities/math/circle/_types';
import { getUnknownVolumeLoaderSchema } from '../../../../core/src/loaders/volumeLoader';
import { deriveFanGeometry } from './utils/deriveFanGeometry';
import { Point3 } from '../../../../../../.nx/cache/6836589865368719691/packages/core/dist/esm/types/Point3';
import { FanGeometry } from '../../../../../../.nx/cache/283231214975993815/packages/tools/dist/esm/tools/annotation/UltrasoundPleuraBLineAnnotationTool/utils/types';
import { subtractIntervals } from '../../../utilities/math/fan/fanUtils';

// Register the tool with the ToolGroupManager (or globally if preferred)
addTool(UltrasoundPleuraBLineAnnotationTool);

// Create a new tool group or get an existing one
const toolGroupId = 'myUltrasoundToolGroup';
const toolGroup = ToolGroupManager.getToolGroup(toolGroupId) || ToolGroupManager.createToolGroup(toolGroupId);

// Add the UltrasoundPleuraBLineAnnotationTool's name to the tool group
toolGroup.addTool(UltrasoundPleuraBLineAnnotationTool.toolName);

// Associate a viewport with the tool group
toolGroup.addViewport('myViewportId', 'myRenderingEngineId');

// Activate the tool for interaction
toolGroup.setToolActive(UltrasoundPleuraBLineAnnotationTool.toolName, {
  bindings: [
    {
      mouseButton: Enums.MouseBindings.Primary, // e.g., Left mouse button
    },
  ],
});

// Optionally, customize the tool's behavior and appearance
toolGroup.setToolConfiguration(UltrasoundPleuraBLineAnnotationTool.toolName, {
  center: [128, 128, 0], // Center of the fan in image voxel coordinates (IJK)
  innerRadius: 10,          // Inner radius of the fan in image voxel units
  outerRadius: 50,          // Outer radius of the fan in image voxel units
  bLineColor: 'rgba(0, 255, 0, 0.7)', // Color for B-Line type annotations
  pleuraColor: 'rgba(89, 0, 255, 0.7)', // Color for Pleura type annotations
  // Note: startAngle and endAngle are typically derived from the drawn line points.
});

If the user do not give the fan shape geometry parameters it will be derived via US image segmentation. The method gives a good rough estimate of the US fan shape if the US is completely enclosed by a black background and should not be considered as the best parameters.

For comprehensive details on API, configuration options, and advanced usage patterns, refer to the official CornerstoneJS documentation.

Extends

AnnotationTool

Constructors

new UltrasoundPleuraBLineTool()

new UltrasoundPleuraBLineTool(toolProps, defaultToolProps): UltrasoundPleuraBLineTool

constructor for the UltrasoundPleuraBLineTool

Parameters

• toolProps: PublicToolProps = {}

public tool props

• defaultToolProps: SharedToolProp = ...

default tool props

Properties

_throttledCalculateCachedStats

_throttledCalculateCachedStats: Function

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:142

activeAnnotationType

activeAnnotationType: string

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:153

bLineAnnotations

bLineAnnotations: UltrasoundPleuraBLineAnnotation[] = []

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:155

configuration

configuration: Record<string, any>

Inherited from

AnnotationTool.configuration

Defined in

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

editData

editData: object

annotation

annotation: Annotation

handleIndex?

optional handleIndex: number

hasMoved?

optional hasMoved: boolean

movingTextBox?

optional movingTextBox: boolean

newAnnotation?

optional newAnnotation: boolean

viewportIdsToRender

viewportIdsToRender: string[]

Overrides

AnnotationTool.editData

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:143

eventDispatchDetail

protected eventDispatchDetail: object

renderingEngineId

renderingEngineId: string

viewportId

viewportId: string

Inherited from

AnnotationTool.eventDispatchDetail

Defined in

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

isDrawing

isDrawing: boolean

Overrides

AnnotationTool.isDrawing

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:151

isHandleOutsideImage

isHandleOutsideImage: boolean

Overrides

AnnotationTool.isHandleOutsideImage

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:152

isSuvScaled()

isSuvScaled: (viewport, targetId, imageId?) => boolean = AnnotationTool.isSuvScaled

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:420

memo

protected memo: Memo

A memo recording the starting state of a tool. This will be updated as changes are made, and reflects the fact that a memo has been created.

Inherited from

AnnotationTool.memo

Defined in

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

mode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

Inherited from

AnnotationTool.mode

Defined in

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

pleuraAnnotations

pleuraAnnotations: UltrasoundPleuraBLineAnnotation[] = []

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:154

supportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

Inherited from

AnnotationTool.supportedInteractionTypes

Defined in

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

toolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

Inherited from

AnnotationTool.toolGroupId

Defined in

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

defaults

static defaults: object

Has the defaults associated with the base tool.

configuration

configuration: object

configuration.activeStrategy

activeStrategy: any = undefined

configuration.defaultStrategy

defaultStrategy: any = undefined

configuration.strategies

strategies: object = {}

configuration.strategyOptions

strategyOptions: object = {}

Inherited from

AnnotationTool.defaults

Defined in

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

toolName

static toolName: string = 'UltrasoundPleuraBLineTool'

Overrides

AnnotationTool.toolName

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:132

USPleuraBLineAnnotationType

static USPleuraBLineAnnotationType: object

Enum for ultrasound annotation types

BLINE

readonly BLINE: "bLine" = 'bLine'

PLEURA

readonly PLEURA: "pleura" = 'pleura'

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:137

Accessors

toolName

get toolName(): string

Newer method for getting the tool name as a property

Returns

string

Inherited from

AnnotationTool.toolName

Defined in

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

Methods

_activateDraw()

_activateDraw(element): void

Activates the draw mode

Parameters

• element: HTMLDivElement

element

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:901

_activateModify()

_activateModify(element): void

Activates the modify mode

Parameters

• element: HTMLDivElement

element

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:831

_deactivateDraw()

_deactivateDraw(element): void

Deactivates the draw mode

Parameters

• element: HTMLDivElement

element

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:940

_deactivateModify()

_deactivateModify(element): void

Deactivates the modify mode

Parameters

• element: HTMLDivElement

element

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:866

_dragCallback()

_dragCallback(evt): void

Callback that is called when the tool is dragged

Parameters

• evt: InteractionEventType

event

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:713

_endCallback()

_endCallback(evt): void

Callback that is called when the tool is done editing

Parameters

• evt: InteractionEventType

event

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:646

_isInsideVolume()

_isInsideVolume(index1, index2, dimensions): boolean

Checks if the given indices are inside the volume dimensions

Parameters

• index1: any

First index to check

• index2: any

Second index to check

• dimensions: any

The dimensions of the volume

Returns

boolean

True if both indices are inside the volume, false otherwise

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1515

addNewAnnotation()

addNewAnnotation(evt): UltrasoundPleuraBLineAnnotation

Adds a new annotation based on the current mouse position and image ID.

Parameters

• evt: InteractionEventType

The event.

Returns

UltrasoundPleuraBLineAnnotation

The new annotation object.

Overrides

AnnotationTool.addNewAnnotation

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:442

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:102

applyActiveStrategyCallback()

applyActiveStrategyCallback(enabledElement, operationData, callbackType, ...extraArgs): 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

• ...extraArgs: any[]

Returns

any

The result of the strategy.

Inherited from

AnnotationTool.applyActiveStrategyCallback

Defined in

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

calculateBLinePleuraPercentage()

calculateBLinePleuraPercentage(viewport): number

Calculates the percentage of bLine inside the pleura for the current image

Parameters

• viewport: any

viewport

Returns

number

percentage of bLine inside the pleura for the current image

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1057

cancel()

cancel(element): string

Cancels the drawing of the annotation

Parameters

• element: HTMLDivElement

element

Returns

string

annotationUID

Overrides

AnnotationTool.cancel

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:801

createAnnotation()

protected createAnnotation(evt): Annotation

Creates an annotation containing the basic data set.

Parameters

• evt: InteractionEventType

Returns

Annotation

Inherited from

AnnotationTool.createAnnotation

Defined in

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

createMemo()

protected createMemo(element, annotation, options?): void

Creates a memo on the given annotation.

Parameters

• element: any

• annotation: any

• options?: any

Returns

void

Inherited from

AnnotationTool.createMemo

Defined in

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

deleteLastAnnotationType()

deleteLastAnnotationType(element, type): void

Deletes the last annotation of a specific type.

Parameters

• element: HTMLDivElement

The HTML element containing the annotations.

• type: string

The annotation type to delete (UltrasoundPleuraBLineAnnotationTool.USAnnotationType.PLEURA or UltrasoundPleuraBLineAnnotationTool.USAnnotationType.BLINE).

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:342

deriveFanGeometryFromViewport()

deriveFanGeometryFromViewport(viewport): void

Derive the fan shape geometry parameters via US image segmentation, if the parameters were not defined

Parameters

• viewport: any

The viewport to derive fan geometry from

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1001

doneEditMemo()

doneEditMemo(): void

This clears and edit memo storage to allow for further history functions to be called. Calls the complete function if present, and pushes the memo to the history memo stack.

This should be called when a tool has finished making a change which should be separated from future/other changes in terms of the history. Usually that means on endCallback (mouse up), but some tools also make changes on the initial creation of an object or have alternate flows and the doneEditMemo has to be called on mouse down or other initiation events to ensure that new changes are correctly recorded.

If the tool has no end callback, then the doneEditMemo is called from the pre mouse down callback. See ZoomTool for an example of this usage.

Returns

void

Inherited from

AnnotationTool.doneEditMemo

Defined in

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

drawDepthGuide()

drawDepthGuide(svgDrawingHelper, viewport): void

Draws the depth guide lines on the ultrasound fan

Parameters

• svgDrawingHelper: SVGDrawingHelper

The SVG drawing helper

• viewport: any

The viewport to draw on

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1159

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:63

getActiveAnnotationType()

getActiveAnnotationType(): string

Gets the active annotation type

Returns

string

the active annotation type

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:332

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:426

getColorForLineType()

getColorForLineType(annotation): any

Gets the color for the line type

Parameters

• annotation: UltrasoundPleuraBLineAnnotation

annotation

Returns

any

color for the line type

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1117

getFanShapeGeometryParameters()

getFanShapeGeometryParameters(viewport): boolean

Gets the fan shape geometry parameters, attempting to derive them if they are invalid

Parameters

• viewport: any

The viewport to get or derive fan geometry from

Returns

boolean

True if valid fan geometry parameters are available, false otherwise

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1034

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:293

getIndexToCanvasRatio()

getIndexToCanvasRatio(viewport): number

Calculates the ratio between index coordinates and canvas coordinates

Parameters

• viewport: any

The viewport to calculate the ratio for

Returns

number

The ratio between index and canvas coordinates

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1142

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:359

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:184

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:221

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:238

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:181

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:90

handleSelectedCallback()

handleSelectedCallback(evt, annotation, handle): void

Callback that is called when a handle is selected

Parameters

• evt: InteractionEventType

event

• annotation: UltrasoundPleuraBLineAnnotation

annotation

• handle: ToolHandle

handle

Returns

void

Overrides

AnnotationTool.handleSelectedCallback

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:600

isFanShapeGeometryParametersValid()

isFanShapeGeometryParametersValid(fanGeometry?): boolean

Check fan shape geometry parameters

Parameters

• fanGeometry?: FanGeometry

Optional fan geometry to check, if not provided uses the tool's configuration

Returns

boolean

True if the fan geometry parameters are valid, false otherwise

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1014

isInsideFanShape()

isInsideFanShape(viewport, point): boolean

Checks if a point is inside the fan shape defined by the tool's configuration

Parameters

• viewport: any

The viewport to check against

• point: Point3

The 3D point to check

Returns

boolean

True if the point is inside the fan shape, false otherwise

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:690

isPointNearTool()

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

It returns if the canvas point is near the provided length 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: UltrasoundPleuraBLineAnnotation

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/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:521

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:228

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:88

redo()

redo(): void

Redo an action (undo the undo)

Returns

void

Inherited from

AnnotationTool.redo

Defined in

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

renderAnnotation()

renderAnnotation(enabledElement, svgDrawingHelper): boolean

It is used to draw the length annotation in each request animation frame. It calculates the updated cached statistics if data is invalidated and cache it. Only annotations from the current image are rendered.

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/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:1234

setActiveAnnotationType()

setActiveAnnotationType(type): void

Sets the active annotation type (bLine or pleura)

Parameters

• type: string

annotation type from UltrasoundPleuraBLineAnnotationTool.USAnnotationType

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:324

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:167

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:153

toolSelectedCallback()

toolSelectedCallback(evt, annotation): void

Callback that is called when the tool is selected

Parameters

• evt: InteractionEventType

event

• annotation: UltrasoundPleuraBLineAnnotation

annotation

Returns

void

Overrides

AnnotationTool.toolSelectedCallback

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:564

undo()

undo(): void

Undoes an action

Returns

void

Inherited from

AnnotationTool.undo

Defined in

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

updateFanGeometryConfiguration()

updateFanGeometryConfiguration(fanGeometry): void

Updates the fan geometry configuration with the provided parameters

Parameters

• fanGeometry: FanGeometry

The fan geometry parameters to update the configuration with

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:979

countAnnotations()

static countAnnotations(element, filterFunction): Map<any, any>

Counts the number of annotations per image ID.

Parameters

• element: HTMLDivElement

The HTML element.

• filterFunction: FilterFunction = ...

A function that takes an imageId and returns a boolean to filter annotations. If not provided, all annotations will be counted.

Returns

Map<any, any>

A map of image IDs to annotation counts.

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:238

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:128

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:73

createAnnotationForViewport()

static createAnnotationForViewport<T>(viewport, ...annotationBaseData): T

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.

Type Parameters

• T extends Annotation

Parameters

• viewport: any

• ...annotationBaseData: any[]

Returns

T

Inherited from

AnnotationTool.createAnnotationForViewport

Defined in

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

createAnnotationMemo()

static createAnnotationMemo(element, annotation, options?): object

Creates an annotation memo storing the current data state on the given annotation object. This will store/recover handles data, text box and contour data, and if the options are set for deletion, will apply that correctly.

Parameters

• element: any

that the annotation is shown on.

• annotation: Annotation

to store a memo for the current state.

• options?

whether the annotation is being created (newAnnotation) or is in the process of being deleted (deleting)

Note the naming on deleting is to indicate the deletion is in progress, as the createAnnotationMemo needs to be called BEFORE the annotation is actually deleted.
deleting with a value of false is the same as newAnnotation=true, as it is simply the opposite direction. Use undefined for both newAnnotation and deleting for non-create/delete operations.

• options.deleting?: boolean

• options.newAnnotation?: boolean

Returns

object

Memo containing the annotation data.

id

id: string = annotationUID

operationType

operationType: string = 'annotation'

restoreMemo()

restoreMemo: () => void

Returns

void

Inherited from

AnnotationTool.createAnnotationMemo

Defined in

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

createAnnotationState()

protected static createAnnotationState(annotation, deleting?): object

Creates an annotation state copy to allow storing the current state of an annotation. This class has knowledge about the contour and spline implementations in order to copy the contour object efficiently, and to allow copying the spline object (which has member variables etc).

Parameters

• annotation: Annotation

the annotation to create a clone of

• deleting?: boolean

a flag to indicate that this object is about to be deleted (deleting true), or was just created (deleting false), or neither (deleting undefined).

Returns

object

state information for the given annotation.

annotationUID

annotationUID: string

data

data: object

Index Signature

[key: string]: unknown

data.cachedStats?

optional cachedStats: Record<string, unknown>

Cached Annotation statistics which is specific to the tool

data.contour?

optional contour: Contour

contour data

data.handles?

optional handles: Handles

Annotation handles that are grabbable for manipulation

data.label?

optional label: string

Label of an annotation

deleting

deleting: boolean

Inherited from

AnnotationTool.createAnnotationState

Defined in

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

createZoomPanMemo()

static createZoomPanMemo(viewport): object

Creates a zoom/pan memo that remembers the original zoom/pan position for the given viewport.

Parameters

• viewport: any

Returns

object

restoreMemo()

restoreMemo: () => void

Returns

void

Inherited from

AnnotationTool.createZoomPanMemo

Defined in

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

deleteAnnotations()

static deleteAnnotations(element, filterFunction): void

Deletes annotations based on a provided filter function.

Parameters

• element: HTMLDivElement

The HTML element.

• filterFunction: FilterFunction = ...

A function that takes an imageId and returns a boolean to filter annotations for deletion. If not provided or returns false for all annotations, no annotations will be deleted.

Returns

void

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:300

endGroupRecording()

static endGroupRecording(): void

Ends a group recording of history memo

Returns

void

Inherited from

AnnotationTool.endGroupRecording

Defined in

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

filterAnnotations()

static filterAnnotations(element, filterFunction): UltrasoundPleuraBLineAnnotation[]

Filters annotations based on a provided filter function.

Parameters

• element: HTMLDivElement

The HTML element containing the annotations.

• filterFunction: FilterFunction = ...

A function that takes an imageId and returns a boolean. If not provided, all annotations will be returned.

Returns

UltrasoundPleuraBLineAnnotation[]

An array of filtered ultrasound annotations.

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:213

hydrate()

static hydrate(viewportId, points, options?): UltrasoundPleuraBLineAnnotation

Hydrates an UltrasoundPleuraBLineAnnotation from a set of points and options.

Parameters

• viewportId: string

The ID of the viewport.

• points: Point3[]

The points to hydrate from.

• options?

The options to hydrate with.

• options.annotationUID?: string

The annotation UID.

• options.referencedImageId?: string

The referenced image ID.

• options.toolInstance?: UltrasoundPleuraBLineTool

The tool instance.

• options.viewplaneNormal?: Point3

The viewplane normal.

• options.viewUp?: Point3

The view up.

Returns

UltrasoundPleuraBLineAnnotation

The hydrated annotation.

Defined in

tools/src/tools/annotation/UltrasoundPleuraBLineTool/UltrasoundPleuraBLineTool.ts:381

hydrateBase()

protected static hydrateBase<T>(ToolClass, enabledElement, points, options): object

Type Parameters

• T extends AnnotationTool

Parameters

• ToolClass

• enabledElement: IEnabledElement

• points: Point3[]

• options = {}

• options.annotationUID?: string

• options.referencedImageId?: string

• options.toolInstance?: T

• options.viewplaneNormal?: Point3

• options.viewUp?: Point3

Returns

object

FrameOfReferenceUID

FrameOfReferenceUID: string

instance

instance: T

referencedImageId

referencedImageId: any

viewPlaneNormal

viewPlaneNormal: Point3 = finalViewPlaneNormal

viewport

viewport: StackViewport | VolumeViewport

viewUp

viewUp: Point3 = finalViewUp

Inherited from

AnnotationTool.hydrateBase

Defined in

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

isSuvScaled()

static 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:405

mergeDefaultProps()

static mergeDefaultProps(defaultProps, additionalProps?): any

Does a deep merge of property options. Allows extending the default values for a child class.

Parameters

• defaultProps = {}

this is a base set of defaults to merge into

• additionalProps?: any

the additional properties to merge into the default props

Returns

any

defaultProps if additional props not defined, or a merge into a new object containing additionalProps adding onto and overriding defaultProps.

Inherited from

AnnotationTool.mergeDefaultProps

Defined in

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

startGroupRecording()

static startGroupRecording(): void

Starts a group recording of history memo, so that with a single undo you can undo multiple actions that are related to each other

Returns

void

Inherited from

AnnotationTool.startGroupRecording

Defined in

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

Example​

Extends​

Constructors​

new UltrasoundPleuraBLineTool()​

Parameters​

Returns​

Overrides​

Defined in​

Properties​

_throttledCalculateCachedStats​

Defined in​

activeAnnotationType​

Defined in​

bLineAnnotations​

Defined in​

configuration​

Inherited from​

Defined in​

editData​

annotation​

handleIndex?​

hasMoved?​

movingTextBox?​

newAnnotation?​

viewportIdsToRender​

Overrides​

Defined in​

eventDispatchDetail​

renderingEngineId​

viewportId​

Inherited from​

Defined in​

isDrawing​

Overrides​

Defined in​

isHandleOutsideImage​

Overrides​

Defined in​

isSuvScaled()​

Parameters​

Returns​

Inherited from​

Defined in​

memo​

Inherited from​

Defined in​

mode​

Inherited from​

Defined in​

pleuraAnnotations​

Defined in​

supportedInteractionTypes​

Inherited from​

Defined in​

toolGroupId​

Inherited from​

Defined in​

defaults​

configuration​

configuration.activeStrategy​

configuration.defaultStrategy​

configuration.strategies​

configuration.strategyOptions​

Inherited from​

Defined in​

toolName​

Overrides​

Defined in​

USPleuraBLineAnnotationType​

BLINE​

PLEURA​

Defined in​

Accessors​

toolName​

Returns​

Inherited from​

Defined in​

Methods​

_activateDraw()​

Parameters​

Example

Extends

Constructors

new UltrasoundPleuraBLineTool()

Parameters

Returns

Overrides

Defined in

Properties

_throttledCalculateCachedStats

Defined in

activeAnnotationType

Defined in

bLineAnnotations

Defined in

configuration

Inherited from

Defined in

editData

annotation

handleIndex?

hasMoved?

movingTextBox?

newAnnotation?

viewportIdsToRender

Overrides

Defined in

eventDispatchDetail

renderingEngineId

viewportId

Inherited from

Defined in

isDrawing

Overrides

Defined in

isHandleOutsideImage

Overrides

Defined in

isSuvScaled()

Parameters

Returns

Inherited from

Defined in

memo

Inherited from

Defined in

mode

Inherited from

Defined in

pleuraAnnotations

Defined in

supportedInteractionTypes

Inherited from

Defined in

toolGroupId

Inherited from

Defined in

defaults

configuration

configuration.activeStrategy

configuration.defaultStrategy

configuration.strategies

configuration.strategyOptions

Inherited from

Defined in

toolName

Overrides

Defined in

USPleuraBLineAnnotationType

BLINE

PLEURA

Defined in

Accessors

toolName

Returns

Inherited from

Defined in

Methods

_activateDraw()

Parameters