RectangleROIStartEndThresholdTool
Hierarchy
- RectangleROITool
- RectangleROIStartEndThresholdTool
Index
Constructors
Properties
Methods
- _activateDraw
- _activateModify
- _calculateCachedStats
- _calculateCachedStatsTool
- _computeProjectionPoints
- _deactivateDraw
- _deactivateModify
- _dragCallback
- _endCallback
- _getEndSliceIndex
- _getRectangleImageCoordinates
- _getTextLines
- _isInsideVolume
- addNewAnnotation
- applyActiveStrategy
- cancel
- filterInteractableAnnotationsForElement
- getHandleNearImagePoint
- getLinkedTextBoxStyle
- getStyle
- getToolName
- handleSelectedCallback
- isPointNearTool
- mouseMoveCallback
- onImageSpacingCalibrated
- renderAnnotation
- setActiveStrategy
- setConfiguration
- toolSelectedCallback
Constructors
constructor
Parameters
toolProps: PublicToolProps = {}
defaultToolProps: SharedToolProp = ...
Returns RectangleROIStartEndThresholdTool
Properties
_throttledCalculateCachedStats
publicconfiguration
editData
Type declaration
annotation: any
optionalhandleIndex?: number
optionalhasMoved?: boolean
optionalnewAnnotation?: boolean
viewportIdsToRender: string[]
isDrawing
isHandleOutsideImage
publicmode
Tool Mode - Active/Passive/Enabled/Disabled/
publicsupportedInteractionTypes
Supported Interaction Types - currently only Mouse
publictoolGroupId
ToolGroup ID the tool instance belongs to
statictoolName
Methods
_activateDraw
Add event handlers for the modify event loop, and prevent default event prapogation.
Parameters
element: any
Returns void
_activateModify
Add event handlers for the modify event loop, and prevent default event prapogation.
Parameters
element: any
Returns void
_calculateCachedStats
_calculateCachedStats - For each volume in the frame of reference that a tool instance in particular viewport defines as its target volume, find the volume coordinates (i,j,k) being probed by the two corners. One of i,j or k will be constant across the two points. In the other two directions iterate over the voxels and calculate the first and second-order statistics.
Parameters
annotation: any
viewPlaneNormal: any
The normal vector of the camera.
viewUp: any
The viewUp vector of the camera.
renderingEngine: any
enabledElement: any
Returns any
_calculateCachedStatsTool
Parameters
annotation: any
enabledElement: any
Returns any
_computeProjectionPoints
Parameters
annotation: RectangleROIStartEndThresholdAnnotation
imageVolume: IImageVolume
Returns void
_deactivateDraw
Add event handlers for the modify event loop, and prevent default event prapogation.
Parameters
element: any
Returns void
_deactivateModify
Remove event handlers for the modify event loop, and enable default event propagation.
Parameters
element: any
Returns void
_dragCallback
Parameters
evt: InteractionEventType
Returns void
_endCallback
Parameters
evt: InteractionEventType
Returns void
_getEndSliceIndex
Parameters
imageVolume: IImageVolume
worldPos: Point3
spacingInNormal: number
viewPlaneNormal: Point3
Returns number
_getRectangleImageCoordinates
Parameters
points: Point2[]
Returns { height: number; left: number; top: number; width: number }
height: number
left: number
top: number
width: number
_getTextLines
_getTextLines - Returns the Area, mean and std deviation of the area of the target volume enclosed by the rectangle.
Parameters
data: any
The annotation tool-specific data.
targetId: string
The volumeId of the volume to display the stats for.
isPreScaled: boolean
Whether the viewport is pre-scaled or not.
Returns string[]
_isInsideVolume
Parameters
index1: any
index2: any
dimensions: any
Returns boolean
addNewAnnotation
Based on the current position of the mouse and the enabledElement it creates the edit data for the tool.
Parameters
evt: InteractionEventType
EventTypes.NormalizedMouseEventType
Returns { data: { cachedStats: { projectionPoints: any[]; projectionPointsImageIds: any[] }; endSlice: number; handles: { activeHandleIndex: any; points: Point3[]; textBox: { hasMoved: boolean; worldBoundingBox: any; worldPosition: any } }; label: string; labelmapUID: any; startSlice: number }; highlighted: boolean; invalidated: boolean; metadata: { FrameOfReferenceUID: string; enabledElement: IEnabledElement; referencedImageId: any; spacingInNormal: number; toolName: string; viewPlaneNormal: Point3; viewUp: Point3; volumeId: any } }
The annotation object.
data: { cachedStats: { projectionPoints: any[]; projectionPointsImageIds: any[] }; endSlice: number; handles: { activeHandleIndex: any; points: Point3[]; textBox: { hasMoved: boolean; worldBoundingBox: any; worldPosition: any } }; label: string; labelmapUID: any; startSlice: number }
cachedStats: { projectionPoints: any[]; projectionPointsImageIds: any[] }
projectionPoints: any[]
projectionPointsImageIds: any[]
endSlice: number
handles: { activeHandleIndex: any; points: Point3[]; textBox: { hasMoved: boolean; worldBoundingBox: any; worldPosition: any } }
activeHandleIndex: any
points: Point3[]
textBox: { hasMoved: boolean; worldBoundingBox: any; worldPosition: any }
hasMoved: boolean
worldBoundingBox: any
worldPosition: any
label: string
labelmapUID: any
startSlice: number
highlighted: boolean
invalidated: boolean
metadata: { FrameOfReferenceUID: string; enabledElement: IEnabledElement; referencedImageId: any; spacingInNormal: number; toolName: string; viewPlaneNormal: Point3; viewUp: Point3; volumeId: any }
FrameOfReferenceUID: string
enabledElement: IEnabledElement
referencedImageId: any
spacingInNormal: number
toolName: string
viewPlaneNormal: Point3
viewUp: Point3
volumeId: any
publicapplyActiveStrategy
It applies the active strategy to the enabled element.
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.
cancel
Parameters
element: HTMLDivElement
Returns any
filterInteractableAnnotationsForElement
Given the element and annotations which is an array of annotation, it filters the annotations array to only include the annotation based on the viewportType. If the viewport is StackViewport, it filters based on the current imageId of the viewport, if the viewport is volumeViewport, it only returns those that are within the same slice as the current rendered slice in the volume viewport. imageId as the enabledElement.
Parameters
element: HTMLDivElement
The HTML element
annotations: Annotations
The annotations to filter (array of annotation)
Returns Annotations
The filtered annotations
getHandleNearImagePoint
It checks if the mouse click is near TextBoxHandle or AnnotationHandle itself, and return either it. It prioritize TextBoxHandle over AnnotationHandle. If the mouse click is not near any of the handles, it does not return anything.
Parameters
element: HTMLDivElement
The element that the tool is attached to.
annotation: Annotation
The annotation object associated with the annotation
canvasCoords: Point2
The coordinates of the mouse click on canvas
proximity: number
The distance from the mouse cursor to the point that is considered “near”.
Returns ToolHandle
The handle that is closest to the cursor, or null if the cursor is not near any of the handles.
publicgetLinkedTextBoxStyle
It returns the style for the text box
Parameters
specifications: StyleSpecifier
optionalannotation: Annotation
The annotation for the tool that is currently active.
Returns Record<string, unknown>
An object of the style settings for the text box.
publicgetStyle
It takes the property (color, lineDash, etc.) and based on the state of the annotation (selected, highlighted etc.) it returns the appropriate value based on the central toolStyle settings for each level of specification.
Parameters
property: string
The name of the style property to get.
specifications: StyleSpecifier
optionalannotation: Annotation
The annotation for the tool that is currently active.
Returns unknown
The value of the property.
publicgetToolName
Returns the name of the tool
Returns string
The name of the tool.
handleSelectedCallback
handleSelectedCallback Custom callback for when a handle is selected.
Parameters
evt: InteractionEventType
The normalized mouse event
annotation: RectangleROIAnnotation
The annotation selected.
handle: ToolHandle
The selected handle (either Types.Point3 in space for annotations, or TextBoxHandle object for text boxes).
Returns void
isPointNearTool
It returns if the canvas point is near the provided annotation in the provided element or not. A proximity is passed to the function to determine the proximity of the point to the annotation in number of pixels.
Parameters
element: HTMLDivElement
HTML Element
annotation: RectangleROIAnnotation
Annotation
canvasCoords: Point2
Canvas coordinates
proximity: number
Proximity to tool to consider
Returns boolean
Boolean, whether the canvas point is near tool
publicmouseMoveCallback
Event handler for Cornerstone MOUSE_MOVE event.
Parameters
evt: MouseMoveEventType
The normalized mouse event
optionalfilteredAnnotations: Annotations
The annotations to check for hover interactions
Returns boolean
True if the annotation needs to be re-drawn by the annotationRenderingEngine.
publiconImageSpacingCalibrated
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
renderAnnotation
it is used to draw the rectangleROIStartEnd annotation in each request animation frame.
Parameters
enabledElement: IEnabledElement
The Cornerstone’s enabledElement.
svgDrawingHelper: SVGDrawingHelper
The svgDrawingHelper providing the context for drawing.
Returns boolean
publicsetActiveStrategy
Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.
Parameters
strategyName: string
name of the strategy to be set as active
Returns void
publicsetConfiguration
merges the new configuration with the tool configuration
Parameters
newConfiguration: Record<string, any>
Returns void
toolSelectedCallback
Custom callback for when an annotation is selected
Parameters
evt: InteractionEventType
The normalized mouse event
annotation: RectangleROIAnnotation
The
Annotationto check.
Returns void
This tool is similar to the RectangleROIThresholdTool which only draws a rectangle on the image, and by using utility functions such as thresholdByRange and thresholdByROIStat it can be used to create a segmentation. The only difference is that it only acts on the acquisition plane and not the 3D volume, and accepts a start and end slice, and renders a dashed rectangle on the image between the start and end but a solid rectangle on start and end slice. Utility functions should be used to modify the start and end slice. // Todo: right now only the first slice has grabbable handles, need to make // it so that the handles are grabbable on all slices.