Skip to main content

Class: RegionSegmentTool

Extends​

  • GrowCutBaseTool

Constructors​

new RegionSegmentTool()​

new RegionSegmentTool(toolProps, defaultToolProps): RegionSegmentTool

Parameters​

• toolProps: PublicToolProps = {}

• defaultToolProps: SharedToolProp = ...

Returns​

RegionSegmentTool

Overrides​

GrowCutBaseTool.constructor

Defined in​

tools/src/tools/annotation/RegionSegmentTool.ts:37

Properties​

configuration​

configuration: Record<string, any>

The configuration for this tool. IBaseTool contains some default configuration values, and you can use configurationTyped to get the typed version of this.

Inherited from​

GrowCutBaseTool.configuration

Defined in​

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

growCutData​

protected growCutData: RegionSegmentToolData

Overrides​

GrowCutBaseTool.growCutData

Defined in​

tools/src/tools/annotation/RegionSegmentTool.ts:35

handlesMultiTouchGestures​

handlesMultiTouchGestures: boolean = false

Whether this tool implements its own handling for touch points that arrive after a gesture has already started.

When false (the default), an extra finger during an in-progress gesture releases the tool through cancel() so the gesture can re-resolve to the tool bound to the new finger count - normally pinch zoom or multi-finger scroll. See releaseToolForMultiTouchGesture.

Multi-part tools set this to true: cancelling them would discard points the user has already placed, and they instead ignore the extra finger for the duration of the gesture. Declaring it also keeps the manipulation tools reachable, since the dispatcher bypasses the interaction guard for such tools rather than clearing it.

Inherited from​

GrowCutBaseTool.handlesMultiTouchGestures

Defined in​

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

isPrimary​

isPrimary: boolean = false

Primary tool - this is set to true when this tool is primary

Inherited from​

GrowCutBaseTool.isPrimary

Defined in​

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

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​

GrowCutBaseTool.memo

Defined in​

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

mode​

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

Inherited from​

GrowCutBaseTool.mode

Defined in​

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

seeds​

protected seeds: object

negativeSeedIndices​

negativeSeedIndices: Set<number>

positiveSeedIndices​

positiveSeedIndices: Set<number>

Inherited from​

GrowCutBaseTool.seeds

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:74

supportedInteractionTypes​

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

Inherited from​

GrowCutBaseTool.supportedInteractionTypes

Defined in​

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

toolGroupId​

toolGroupId: string

ToolGroup ID the tool instance belongs to

Inherited from​

GrowCutBaseTool.toolGroupId

Defined in​

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

activeCursorTool​

static activeCursorTool: any

Set to the tool that is currently drawing the active cursor. This will be either primary mouse button tool if no tool is currently being directly interacted with, OR the tool that is directly interacted with. This logic ensures that there is only a single tool at a time drawing, which prevents tools not getting mouse updates from over-writing the cursor.

  • If the tool bound to the primary button is a cursor drawing tool, use that tool and there is NOT a tool currently drawing directly
  • If there is a tool currently drawing directly, then that tool should display a cursor EVEN if it normally doesn't have a custom cursor
  • When a tool finishes drawing direct, it should stop being the active cursor tool unless it is also the primary tool

Inherited from​

GrowCutBaseTool.activeCursorTool

Defined in​

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

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​

GrowCutBaseTool.defaults

Defined in​

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

MOUSE_PROXIMITY​

readonly static MOUSE_PROXIMITY: 6

Canvas-pixel radius used to hit-test annotations and handles for mouse interactions.

Inherited from​

GrowCutBaseTool.MOUSE_PROXIMITY

Defined in​

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

toolName​

static toolName: string = 'RegionSegment'

Overrides​

GrowCutBaseTool.toolName

Defined in​

tools/src/tools/annotation/RegionSegmentTool.ts:33

TOUCH_PROXIMITY​

readonly static TOUCH_PROXIMITY: 36

Canvas-pixel radius used to hit-test annotations and handles for touch interactions. A fingertip covers far more screen than a cursor hotspot, so touch targets are much larger than BaseTool.MOUSE_PROXIMITY. Tools that need to widen an in-draw target for touch should use this rather than restating the number.

Inherited from​

GrowCutBaseTool.TOUCH_PROXIMITY

Defined in​

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

TOUCH_TAP_MAX_CANVAS_DISTANCE​

readonly static TOUCH_TAP_MAX_CANVAS_DISTANCE: 24

Maximum canvas-pixel distance a gesture may travel and still be counted as a tap by the touch start listener. Tools that commit a gesture on TOUCH_END need this to recognize the trailing TOUCH_TAP echo.

Inherited from​

GrowCutBaseTool.TOUCH_TAP_MAX_CANVAS_DISTANCE

Defined in​

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

TOUCH_TAP_TOLERANCE_MS​

readonly static TOUCH_TAP_TOLERANCE_MS: 300

Window in milliseconds within which successive taps are aggregated into a single multi-tap TOUCH_TAP. The tap is emitted one tolerance after the chain's last touchend.

Inherited from​

GrowCutBaseTool.TOUCH_TAP_TOLERANCE_MS

Defined in​

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

Accessors​

configurationTyped​

get configurationTyped(): ToolConfiguration

Returns​

ToolConfiguration

Inherited from​

GrowCutBaseTool.configurationTyped

Defined in​

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

toolName​

get toolName(): string

Newer method for getting the tool name as a property

Returns​

string

Inherited from​

GrowCutBaseTool.toolName

Defined in​

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

Methods​

_isOrthogonalView()​

protected _isOrthogonalView(viewport, referencedVolumeId): boolean

Parameters​

• viewport: Viewport

• referencedVolumeId: string

Returns​

boolean

Inherited from​

GrowCutBaseTool._isOrthogonalView

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:434

_isTouchInteraction()​

protected _isTouchInteraction(evt?): boolean

Whether an interaction event came in through the touch pipeline rather than the mouse pipeline.

Note this is a property of the gesture, not of the device: hybrid hardware (touchscreen laptops, tablets with a mouse attached) delivers both, so tools must branch on the event rather than on a device probe such as isMobile().

Parameters​

• evt?: InteractionEventType

The interaction event, or undefined when a caller has no event to attribute (treated as not-touch).

Returns​

boolean

Inherited from​

GrowCutBaseTool._isTouchInteraction

Defined in​

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

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​

GrowCutBaseTool.applyActiveStrategy

Defined in​

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

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​

GrowCutBaseTool.applyActiveStrategyCallback

Defined in​

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

applyGrowCutLabelmap()​

protected applyGrowCutLabelmap(segmentationId, segmentIndex, targetLabelmap, sourceLabelmap): void

Parameters​

• segmentationId: string

• segmentIndex: number

• targetLabelmap: ImageVolume

• sourceLabelmap: ImageVolume

Returns​

void

Inherited from​

GrowCutBaseTool.applyGrowCutLabelmap

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:281

applyPartialGrowCutLabelmap()​

protected applyPartialGrowCutLabelmap(segmentationId, segmentIndex, targetLabelmap, sourceLabelmap): void

Parameters​

• segmentationId: string

• segmentIndex: number

• targetLabelmap: ImageVolume

• sourceLabelmap: ImageVolume

Returns​

void

Inherited from​

GrowCutBaseTool.applyPartialGrowCutLabelmap

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:226

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​

GrowCutBaseTool.doneEditMemo

Defined in​

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

ensureCachedStatsTargets()​

protected ensureCachedStatsTargets(data, targetIds, needsUpdate?): boolean

Ensures a cachedStats entry exists for every measurement target, so that the tool stats calculators (which iterate the cachedStats keys) compute statistics for each of them. This is what allows a single fusion viewport to compute the statistics of several display sets at once, even when no other viewport has computed them.

Parameters​

• data: AnnotationData

the annotation data containing the cachedStats

• targetIds: string[]

the targets to seed (see getMeasurementTargets)

• needsUpdate?

optional test flagging an existing entry as incomplete (eg hydrated annotations missing units) and needing to be recalculated

Returns​

boolean

true if any entry was added or flagged, meaning the stats need to be (re)calculated

Inherited from​

GrowCutBaseTool.ensureCachedStatsTargets

Defined in​

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

expand()​

expand(): void

Returns​

void

Inherited from​

GrowCutBaseTool.expand

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:147

getGrowCutLabelmap()​

protected getGrowCutLabelmap(growCutData): Promise<ImageVolume>

Parameters​

• growCutData: any

Returns​

Promise<ImageVolume>

Overrides​

GrowCutBaseTool.getGrowCutLabelmap

Defined in​

tools/src/tools/annotation/RegionSegmentTool.ts:101

getLabelmapSegmentationData()​

protected getLabelmapSegmentationData(viewport): Promise<object>

Parameters​

• viewport: Viewport

Returns​

Promise<object>

labelmapVolumeId​

labelmapVolumeId: string

referencedVolumeId​

referencedVolumeId: string

segmentationId​

segmentationId: string

segmentIndex​

segmentIndex: number

Inherited from​

GrowCutBaseTool.getLabelmapSegmentationData

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:307

getMeasurementTargetCandidates()​

protected getMeasurementTargetCandidates(viewport, data?): MeasurementTargetCandidate[]

Builds the list of candidate measurement targets for the given viewport: one per volume actor being displayed (including segmentation representations, which carry a representationUID and are excluded by the default filter rather than skipped here), falling back to a single candidate for the default view reference when there are none. The candidates are what the targetsFilter tool configuration chooses from - each carries the display set related parameters (display set, uid, exemplar instance and index) where they are known.

The candidate modality is taken from the display set where available - the exemplar instance or volume metadata for volume backed candidates, or the registered display set of the viewport for the fallback candidate. When the display set is unknown (eg a stack viewport using the legacy set image ids), the candidate has none of the display set fields, and filters can choose whether to include it based on that.

When the annotation already has a cachedStats entry for a candidate's volume (possibly created by another viewport with a different view reference), the existing key is reused as the targetId so statistics are shared rather than recomputed per view.

Parameters​

• viewport: Viewport

• data?: AnnotationData

Returns​

MeasurementTargetCandidate[]

Inherited from​

GrowCutBaseTool.getMeasurementTargetCandidates

Defined in​

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

getMeasurementTargets()​

protected getMeasurementTargets(viewport, data?): string[]

Gets the array of targetIds the tool should compute and display measurement statistics for on the given viewport.

The targets are selected by the targetsFilter tool configuration option (see measurementTargetFilters for ready made filters). The filter receives the viewport's candidate display sets and the viewport, and returns the subset to measure.

Each returned targetId reuses an existing cachedStats key when statistics were already computed for the same volume (possibly by a different viewport), and is otherwise the view reference id of this viewport for that volume - so a single fusion viewport can seed and compute the statistics of every filtered target itself, even when no other viewport has computed them.

A configured filter's result is authoritative: when it returns no candidates (eg a PT-only filter on a CT viewport, or the default allPixelData filter when only a SEG is shown), an empty array is returned and no statistics are computed or displayed.

The deprecated isPreferredTargetId configuration is honoured before the filter, so existing configurations keep their behaviour. When neither selects anything and no filter is configured, the viewport's default view reference id is the single target.

Multi-target selection only works for volumes displayed on screen

TODO: Fix this for other fusion types on stack and also for inclusion of annotation measurements which are not currently on screen.

Parameters​

• viewport: Viewport

• data?: AnnotationData

Returns​

string[]

Inherited from​

GrowCutBaseTool.getMeasurementTargets

Defined in​

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

getRemoveIslandData()​

protected getRemoveIslandData(_growCutData): RemoveIslandData

Parameters​

• _growCutData: GrowCutToolData

Returns​

RemoveIslandData

Inherited from​

GrowCutBaseTool.getRemoveIslandData

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:455

getSegmentStyle()​

protected getSegmentStyle(__namedParameters): object

Parameters​

• __namedParameters

• __namedParameters.segmentationId: any

• __namedParameters.segmentIndex: any

• __namedParameters.viewportId: any

Returns​

object

color​

color: string

fillColor​

fillColor: string

fillOpacity​

fillOpacity: number

lineDash​

lineDash: any

lineWidth​

lineWidth: number

textbox​

textbox: object

textbox.color​

color: string

visibility​

visibility: boolean

Inherited from​

GrowCutBaseTool.getSegmentStyle

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:519

getTargetId()​

protected getTargetId(viewport, data?): 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 usually derived from the imageId. For VolumeViewport, it's derived from the volumeId.

This is the primary (first) entry of getMeasurementTargets, so it honours the targetsFilter tool configuration - configuring, for example, measurementTargetFilters.forModality('PT') makes the PT volume of a fusion viewport the target the statistics are stored/read for.

Parameters​

• viewport: Viewport

viewport to get the targetId for

• data?: AnnotationData

Optional: The annotation's data object, containing cachedStats.

Returns​

string

targetId, or undefined when a configured filter selects no targets for this viewport

Inherited from​

GrowCutBaseTool.getTargetId

Defined in​

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

getTargetImageData()​

protected getTargetImageData(targetId): IImageData | CPUIImageData

Parameters​

• targetId: string

Returns​

IImageData | CPUIImageData

Inherited from​

GrowCutBaseTool.getTargetImageData

Defined in​

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

getToolName()​

getToolName(): string

Returns the name of the tool

Returns​

string

The name of the tool.

Inherited from​

GrowCutBaseTool.getToolName

Defined in​

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

preMouseDownCallback()​

preMouseDownCallback(evt): Promise<boolean>

Parameters​

• evt: MouseDownActivateEventType

Returns​

Promise<boolean>

Overrides​

GrowCutBaseTool.preMouseDownCallback

Defined in​

tools/src/tools/annotation/RegionSegmentTool.ts:51

redo()​

redo(): void

Redo an action (undo the undo)

Returns​

void

Inherited from​

GrowCutBaseTool.redo

Defined in​

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

refresh()​

refresh(): void

Returns​

void

Inherited from​

GrowCutBaseTool.refresh

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:153

renderAnnotation()​

renderAnnotation(enabledElement, svgDrawingHelper): void

Parameters​

• enabledElement: IEnabledElement

• svgDrawingHelper: SVGDrawingHelper

Returns​

void

Defined in​

tools/src/tools/annotation/RegionSegmentTool.ts:210

runGrowCut()​

protected runGrowCut(): Promise<void>

Returns​

Promise<void>

Inherited from​

GrowCutBaseTool.runGrowCut

Defined in​

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

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​

GrowCutBaseTool.setActiveStrategy

Defined in​

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

setConfiguration()​

setConfiguration(newConfiguration): void

merges the new configuration with the tool configuration

Parameters​

• newConfiguration: Record<string, any>

Returns​

void

Inherited from​

GrowCutBaseTool.setConfiguration

Defined in​

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

shrink()​

shrink(): void

Returns​

void

Inherited from​

GrowCutBaseTool.shrink

Defined in​

tools/src/tools/base/GrowCutBaseTool.ts:141

undo()​

undo(): void

Undoes an action

Returns​

void

Inherited from​

GrowCutBaseTool.undo

Defined in​

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

calculateLengthInIndex()​

static calculateLengthInIndex(calibrate, indexPoints, closed): number

Calculates the length between two index coordinates using the calibrate information for scaling information.

Parameters​

• calibrate: any

• indexPoints: any

• closed: boolean = false

set to true to calculate the closed length, including the line between the first/last index

Returns​

number

Inherited from​

GrowCutBaseTool.calculateLengthInIndex

Defined in​

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

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​

GrowCutBaseTool.createZoomPanMemo

Defined in​

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

endGroupRecording()​

static endGroupRecording(): void

Ends a group recording of history memo

Returns​

void

Inherited from​

GrowCutBaseTool.endGroupRecording

Defined in​

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

findCachedStatsTargetId()​

protected static findCachedStatsTargetId(data, referencedId): string

Finds an existing cachedStats key for the given referenced volume id, if statistics were already computed for that volume - the keys are view reference ids of the form volumeId:<volumeId>?..., so entries created by other viewports (with a different slice/orientation) still match.

Parameters​

• data: AnnotationData

• referencedId: string

Returns​

string

Inherited from​

GrowCutBaseTool.findCachedStatsTargetId

Defined in​

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

getExemplarInstance()​

protected static getExemplarInstance(imageIds?): Record<string, unknown>

Resolves an exemplar (first) instance - naturalized DICOM metadata - from the image ids of a display set/volume, when available.

Parameters​

• imageIds?: string[]

Returns​

Record<string, unknown>

Inherited from​

GrowCutBaseTool.getExemplarInstance

Defined in​

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

getViewportDisplaySets()​

protected static getViewportDisplaySets(viewport): object[]

Resolves the display sets a viewport is displaying, when known. Viewports displaying registered display sets (see setDisplaySets on the generic viewports) resolve through the displaySetModule metadata (an IDisplaySet from @cornerstonejs/metadata) falling back to the generic viewport display set registration; legacy viewports (setStack with plain image ids) have no display set, so an empty list is returned and their candidates carry no display set fields.

Parameters​

• viewport: Viewport

Returns​

object[]

Inherited from​

GrowCutBaseTool.getViewportDisplaySets

Defined in​

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

isInsideVolume()​

static isInsideVolume(dimensions, indexPoints): boolean

Return true if all the index points are within the dimensions provided.

Parameters​

• dimensions: any

• indexPoints: any

Returns​

boolean

Inherited from​

GrowCutBaseTool.isInsideVolume

Defined in​

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

isSpecifiedTargetId()​

static isSpecifiedTargetId(desiredVolumeId): (_viewport, __namedParameters) => any

A function generator to test if the target id is the desired one. Used for deciding which set of cached stats is appropriate to display for a given viewport.

This relies on the fact that the target id contains a substring which is the desired volume id when the target is a volume. It is also possible to use series query parameters such as /series/{seriesUID}/ to generate specific series selections within a stack viewport.

Parameters​

• desiredVolumeId: string

Returns​

Function

Parameters​

• _viewport: any

• __namedParameters

• __namedParameters.targetId: any

Returns​

any

Deprecated​

Use the targetsFilter configuration option with measurementTargetFilters.forId instead.

Inherited from​

GrowCutBaseTool.isSpecifiedTargetId

Defined in​

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

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​

GrowCutBaseTool.mergeDefaultProps

Defined in​

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

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​

GrowCutBaseTool.startGroupRecording

Defined in​

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