Class: ProbeTool
ProbeTool let you get the underlying voxel value by putting a probe in that location. It will give index of the location and value of the voxel. You can use ProbeTool in all perpendicular views (axial, sagittal, coronal). Note: annotation tools in cornerstone3DTools exists in the exact location in the physical 3d space, as a result, by default, all annotations that are drawing in the same frameOfReference will get shared between viewports that are in the same frameOfReference. Probe tool's text box are dynamically generated based on the viewport's underlying Modality. For instance, if the viewport is displaying CT, the text box will shown the statistics in Hounsfield units, and if the viewport is displaying PET, the text box will show the statistics in SUV units.
The resulting annotation's data (statistics) 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.
To use the ProbeTool, you first need to add it to cornerstoneTools, then create a toolGroup and add the ProbeTool to it. Finally, setToolActive on the toolGroup
cornerstoneTools.addTool(ProbeTool)
const toolGroup = ToolGroupManager.createToolGroup('toolGroupId')
toolGroup.addTool(ProbeTool.toolName)
toolGroup.addViewport('viewportId', 'renderingEngineId')
toolGroup.setToolActive(ProbeTool.toolName, {
bindings: [
{
mouseButton: MouseBindings.Primary, // Left Click
},
],
})
Read more in the Docs section of the website.
Extends
Extended by
Constructors
new ProbeTool()
new ProbeTool(
toolProps,defaultToolProps):ProbeTool
Parameters
• toolProps: PublicToolProps = {}
• defaultToolProps: SharedToolProp = ...
Returns
Overrides
Defined in
tools/src/tools/annotation/ProbeTool.ts:109
Properties
configuration
configuration:
Record<string,any>
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:17
editData
editData:
object
annotation
annotation:
Annotation
newAnnotation?
optionalnewAnnotation:boolean
viewportIdsToRender
viewportIdsToRender:
string[]
Defined in
tools/src/tools/annotation/ProbeTool.ts:97
eventDispatchDetail
eventDispatchDetail:
object
renderingEngineId
renderingEngineId:
string
viewportId
viewportId:
string
Defined in
tools/src/tools/annotation/ProbeTool.ts:102
isDrawing
isDrawing:
boolean
Defined in
tools/src/tools/annotation/ProbeTool.ts:106
isHandleOutsideImage
isHandleOutsideImage:
boolean
Defined in
tools/src/tools/annotation/ProbeTool.ts:107
mode
mode:
ToolModes
Tool Mode - Active/Passive/Enabled/Disabled/
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:21
supportedInteractionTypes
supportedInteractionTypes:
InteractionTypes[]
Supported Interaction Types - currently only Mouse
Inherited from
AnnotationTool.supportedInteractionTypes
Defined in
tools/src/tools/base/BaseTool.ts:15
toolGroupId
toolGroupId:
string
ToolGroup ID the tool instance belongs to
Inherited from
Defined in
tools/src/tools/base/BaseTool.ts:19
toolName
statictoolName:any
Overrides
Defined in
tools/src/tools/annotation/ProbeTool.ts:95
Methods
_activateModify()
_activateModify(
element):void
Parameters
• element: any
Returns
void
Defined in
tools/src/tools/annotation/ProbeTool.ts:342
_calculateCachedStats()
_calculateCachedStats(
annotation,renderingEngine,enabledElement):any
Parameters
• annotation: any
• renderingEngine: any
• enabledElement: any
Returns
any
Defined in
tools/src/tools/annotation/ProbeTool.ts:516
_deactivateModify()
_deactivateModify(
element):void
Parameters
• element: any
Returns
void
Defined in
tools/src/tools/annotation/ProbeTool.ts:354
_dragCallback()
_dragCallback(
evt):void
Parameters
• evt: any
Returns
void
Defined in
tools/src/tools/annotation/ProbeTool.ts:300
_endCallback()
_endCallback(
evt):void
Parameters
• evt: InteractionEventType
Returns
void
Defined in
tools/src/tools/annotation/ProbeTool.ts:267
addNewAnnotation()
addNewAnnotation(
evt):ProbeAnnotation
Based on the current position of the mouse and the current imageId to create a Probe Annotation and stores it in the annotationManager
Parameters
• evt: InteractionEventType
EventTypes.NormalizedMouseEventType
Returns
The annotation object.
Overrides
AnnotationTool.addNewAnnotation
Defined in
tools/src/tools/annotation/ProbeTool.ts:139
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:62
applyActiveStrategyCallback()
applyActiveStrategyCallback(
enabledElement,operationData,callbackType):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.
Inherited from
AnnotationTool.applyActiveStrategyCallback
Defined in
tools/src/tools/base/BaseTool.ts:86
cancel()
cancel(
element):string
cancel Used to cancel the ongoing tool drawing and manipulation
Parameters
• element: HTMLDivElement
Returns
string
Overrides
Defined in
tools/src/tools/annotation/ProbeTool.ts:318
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
The filtered annotations
Inherited from
AnnotationTool.filterInteractableAnnotationsForElement
Defined in
tools/src/tools/base/AnnotationDisplayTool.ts:60
getAnnotationStyle()
protectedgetAnnotationStyle(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
Inherited from
AnnotationTool.getAnnotationStyle
Defined in
tools/src/tools/base/AnnotationTool.ts:393
getHandleNearImagePoint()
getHandleNearImagePoint(
element,annotation,canvasCoords,proximity):ToolHandle
It checks if the mouse click is near ProveTool, it overwrites the baseAnnotationTool getHandleNearImagePoint method.
Parameters
• element: HTMLDivElement
The element that the tool is attached to.
• annotation: ProbeAnnotation
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
The handle that is closest to the cursor, or null if the cursor is not near any of the handles.
Overrides
AnnotationTool.getHandleNearImagePoint
Defined in
tools/src/tools/annotation/ProbeTool.ts:213
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:328
getReferencedImageId()
protectedgetReferencedImageId(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:126
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
Defined in
tools/src/tools/base/AnnotationDisplayTool.ts:163
getTargetId()
protectedgetTargetId(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
Defined in
tools/src/tools/base/BaseTool.ts:197
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
AnnotationTool.getTargetImageData
Defined in
tools/src/tools/base/BaseTool.ts:140
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:50
handleSelectedCallback()
handleSelectedCallback(
evt,annotation):void
handleSelectedCallback Custom callback for when a handle is selected.
Parameters
• evt: InteractionEventType
The normalized mouse event
• annotation: ProbeAnnotation
The annotation selected.
Returns
void
Overrides
AnnotationTool.handleSelectedCallback
Defined in
tools/src/tools/annotation/ProbeTool.ts:234
isPointNearTool()
isPointNearTool():
boolean
Returns true if the provided canvas coordinate tool is near the annotation
Returns
boolean
boolean if the point is near.
Overrides
AnnotationTool.isPointNearTool
Defined in
tools/src/tools/annotation/ProbeTool.ts:125
isSuvScaled()
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
Defined in
tools/src/tools/base/AnnotationTool.ts:374
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:197
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:83
renderAnnotation()
renderAnnotation(
enabledElement,svgDrawingHelper):boolean
it is used to draw the probe 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
Overrides
AnnotationTool.renderAnnotation
Defined in
tools/src/tools/annotation/ProbeTool.ts:374
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:126
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:112
toolSelectedCallback()
toolSelectedCallback():
void
Custom callback for when an annotation is selected
Returns
void
Overrides
AnnotationTool.toolSelectedCallback
Defined in
tools/src/tools/annotation/ProbeTool.ts:129
createAndAddAnnotation()
staticcreateAndAddAnnotation(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:97
createAnnotation()
staticcreateAnnotation(...annotationBaseData):Annotation
Creates a base annotation object, adding in any annotation base data provided
Parameters
• ...annotationBaseData: any[]
Returns
Inherited from
AnnotationTool.createAnnotation
Defined in
tools/src/tools/base/AnnotationTool.ts:45
createAnnotationForViewport()
staticcreateAnnotationForViewport(viewport, ...annotationBaseData):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
• ...annotationBaseData: any[]
Returns
Inherited from
AnnotationTool.createAnnotationForViewport