Class: PaintFillTool
Tool for manipulating segmentation data by filling in regions. It acts on the active Segmentation on the viewport (enabled element) and requires an active segmentation to be already present. By default it will fill a given labelled or empty region with the the activeSegmentIndex label. You can use the SegmentationModule to set the active segmentation and segmentIndex.
Extends
Constructors
new PaintFillTool()
new PaintFillTool(
toolProps,defaultToolProps):PaintFillTool
Parameters
• toolProps: PublicToolProps = {}
• defaultToolProps: SharedToolProp = ...
Returns
Overrides
Defined in
tools/src/tools/segmentation/PaintFillTool.ts:55
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
Defined in
tools/src/tools/base/BaseTool.ts:56
isPrimary
isPrimary:
boolean=false
Primary tool - this is set to true when this tool is primary
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:66
memo
protectedmemo: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
Defined in
tools/src/tools/base/BaseTool.ts:72
mode
mode:
ToolModes
Tool Mode - Active/Passive/Enabled/Disabled/
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:64
supportedInteractionTypes
supportedInteractionTypes:
InteractionTypes[]
Supported Interaction Types - currently only Mouse
Inherited from
BaseTool.supportedInteractionTypes
Defined in
tools/src/tools/base/BaseTool.ts:49
toolGroupId
toolGroupId:
string
ToolGroup ID the tool instance belongs to
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:62
activeCursorTool
staticactiveCursorTool: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
Defined in
tools/src/tools/base/BaseTool.ts:46
defaults
staticdefaults: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
Defined in
tools/src/tools/base/BaseTool.ts:77
toolName
statictoolName:any
Overrides
Defined in
tools/src/tools/segmentation/PaintFillTool.ts:53
Accessors
configurationTyped
getconfigurationTyped():ToolConfiguration
Returns
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:57
toolName
gettoolName():string
Newer method for getting the tool name as a property
Returns
string
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:150
Methods
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
Defined in
tools/src/tools/base/BaseTool.ts:170
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
BaseTool.applyActiveStrategyCallback
Defined in
tools/src/tools/base/BaseTool.ts:194
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
Defined in
tools/src/tools/base/BaseTool.ts:690
ensureCachedStatsTargets()
protectedensureCachedStatsTargets(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
BaseTool.ensureCachedStatsTargets
Defined in
tools/src/tools/base/BaseTool.ts:607
getMeasurementTargetCandidates()
protectedgetMeasurementTargetCandidates(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
Inherited from
BaseTool.getMeasurementTargetCandidates
Defined in
tools/src/tools/base/BaseTool.ts:417
getMeasurementTargets()
protectedgetMeasurementTargets(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
BaseTool.getMeasurementTargets
Defined in
tools/src/tools/base/BaseTool.ts:354
getTargetId()
protectedgetTargetId(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
Defined in
tools/src/tools/base/BaseTool.ts:316
getTargetImageData()
protectedgetTargetImageData(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
Defined in
tools/src/tools/base/BaseTool.ts:249
getToolName()
getToolName():
string
Returns the name of the tool
Returns
string
The name of the tool.
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:158
preMouseDownCallback()
preMouseDownCallback(
evt):boolean
Based on the current position of the mouse and the enabledElement, it finds the active segmentation info and use it for the current tool.
Parameters
• evt: InteractionEventType
EventTypes.NormalizedMouseEventType
Returns
boolean
The annotation object.
Defined in
tools/src/tools/segmentation/PaintFillTool.ts:72
redo()
redo():
void
Redo an action (undo the undo)
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:637
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
Defined in
tools/src/tools/base/BaseTool.ts:235
setConfiguration()
setConfiguration(
newConfiguration):void
merges the new configuration with the tool configuration
Parameters
• newConfiguration: Record<string, any>
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:221
undo()
undo():
void
Undoes an action
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:627
calculateLengthInIndex()
staticcalculateLengthInIndex(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
BaseTool.calculateLengthInIndex
Defined in
tools/src/tools/base/BaseTool.ts:713
createZoomPanMemo()
staticcreateZoomPanMemo(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
Defined in
tools/src/tools/base/BaseTool.ts:645
endGroupRecording()
staticendGroupRecording():void
Ends a group recording of history memo
Returns
void
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:703
findCachedStatsTargetId()
protectedstaticfindCachedStatsTargetId(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
BaseTool.findCachedStatsTargetId
Defined in
tools/src/tools/base/BaseTool.ts:579
getExemplarInstance()
protectedstaticgetExemplarInstance(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
Defined in
tools/src/tools/base/BaseTool.ts:562
getViewportDisplaySets()
protectedstaticgetViewportDisplaySets(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
BaseTool.getViewportDisplaySets
Defined in
tools/src/tools/base/BaseTool.ts:491
isInsideVolume()
staticisInsideVolume(dimensions,indexPoints):boolean
Return true if all the index points are within the dimensions provided.
Parameters
• dimensions: any
• indexPoints: any
Returns
boolean
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:735
isSpecifiedTargetId()
staticisSpecifiedTargetId(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
Defined in
tools/src/tools/base/BaseTool.ts:136
mergeDefaultProps()
staticmergeDefaultProps(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
Defined in
tools/src/tools/base/BaseTool.ts:116
startGroupRecording()
staticstartGroupRecording():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