OrsVolumeROIPainter

Handles all aspects of painting Regions of Interest

author:ORS Team
contact:http://theobjects.com
email:info@theobjects.com
organization:Object Research Systems (ORS), Inc.
address:460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7
copyright:Object Research Systems (ORS), Inc. All rights reserved 2021.
date:Jun 10 2015 13:37
dragonflyVersion:
 3.1.0.286 (D)
UUID:1d3fb7ba761e11e7a73e448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsVolumeROIPainter.OrsVolumeROIPainter.OrsVolumeROIPainter(varname=None)
CONNECTED_COMPONENTS_26 = '26-connected'
CONNECTED_COMPONENTS_4 = '4-connected'
CONNECTED_COMPONENTS_6 = '6-connected'
CONNECTED_COMPONENTS_8 = '8-connected'
OrsState2DPath = 'OrsState2DPath'
OrsState2DPathAction()
OrsState2DPathAdd = 'OrsState2DPathAdd'
OrsState2DPathAddAction()
OrsState2DPathRemove = 'OrsState2DPathRemove'
OrsState2DPathRemoveAction()
OrsState2DSnap = 'OrsState2DSnap'
OrsState2DSnapAction()
OrsState2DSnapAdd = 'OrsState2DSnapAdd'
OrsState2DSnapAddAction()
OrsState2DSnapRemove = 'OrsState2DSnapRemove'
OrsState2DSnapRemoveAction()
OrsStateCircularBrush = 'OrsStateCircularBrush'
OrsStateCircularBrushAction()
OrsStateCircularBrushAdd = 'OrsStateCircularBrushAdd'
OrsStateCircularBrushAddAction()
OrsStateCircularBrushRemove = 'OrsStateCircularBrushRemove'
OrsStateCircularBrushRemoveAction()
OrsStateCircularBrushSelectFirstROIUnderCursorAction()
OrsStatePointClick = 'OrsStatePointClick'
OrsStatePointClickAction()
OrsStatePointClickAdd = 'OrsStatePointClickAdd'
OrsStatePointClickAddAction()
OrsStatePointClickOutline = 'OrsStatePointClickOutline'
OrsStatePointClickOutlineAction()
OrsStatePointClickOutlineAdd = 'OrsStatePointClickOutlineAdd'
OrsStatePointClickOutlineAddAction()
OrsStatePointClickOutlineRemove = 'OrsStatePointClickOutlineRemove'
OrsStatePointClickOutlineRemoveAction()
OrsStatePointClickRemove = 'OrsStatePointClickRemove'
OrsStatePointClickRemoveAction()
OrsStatePointFill = 'OrsStatePointFill'
OrsStatePointFillAction()
OrsStatePointFillAdd = 'OrsStatePointFillAdd'
OrsStatePointFillAddAction()
OrsStateRectangularBrush = 'OrsStateRectangularBrush'
OrsStateRectangularBrushAction()
OrsStateRectangularBrushAdd = 'OrsStateRectangularBrushAdd'
OrsStateRectangularBrushAddAction()
OrsStateRectangularBrushRemove = 'OrsStateRectangularBrushRemove'
OrsStateRectangularBrushRemoveAction()
OrsStateRectangularBrushSelectFirstROIUnderCursorAction()
OrsStateSmartGridSegmentation = 'OrsStateSmartGridSegmentation'
OrsStateSmartGridSegmentationAction()
OrsStateSmartGridSegmentationAdd = 'OrsStateSmartGridSegmentationAdd'
OrsStateSmartGridSegmentationAddAction()
OrsStateSmartGridSegmentationRemove = 'OrsStateSmartGridSegmentationRemove'
OrsStateSmartGridSegmentationRemoveAction()
OrsStateVolumeROIPainterRegionEllipse = 'OrsStateVolumeROIPainterRegionEllipse'
OrsStateVolumeROIPainterRegionEllipseActivation()
OrsStateVolumeROIPainterRegionEllipseAdd = 'OrsStateVolumeROIPainterRegionEllipseAdd'
OrsStateVolumeROIPainterRegionEllipseAddActivation()
OrsStateVolumeROIPainterRegionEllipseRemove = 'OrsStateVolumeROIPainterRegionEllipseRemove'
OrsStateVolumeROIPainterRegionEllipseRemoveActivation()
OrsStateVolumeROIPainterRegionFreehand = 'OrsStateVolumeROIPainterRegionFreehand'
OrsStateVolumeROIPainterRegionFreehandActivation()
OrsStateVolumeROIPainterRegionFreehandAdd = 'OrsStateVolumeROIPainterRegionFreehandAdd'
OrsStateVolumeROIPainterRegionFreehandAddActivation()
OrsStateVolumeROIPainterRegionFreehandRemove = 'OrsStateVolumeROIPainterRegionFreehandRemove'
OrsStateVolumeROIPainterRegionFreehandRemoveActivation()
OrsStateVolumeROIPainterRegionPoly = 'OrsStateVolumeROIPainterRegionPoly'
OrsStateVolumeROIPainterRegionPolyActivation()
OrsStateVolumeROIPainterRegionPolyAdd = 'OrsStateVolumeROIPainterRegionPolyAdd'
OrsStateVolumeROIPainterRegionPolyAddActivation()
OrsStateVolumeROIPainterRegionPolyRemove = 'OrsStateVolumeROIPainterRegionPolyRemove'
OrsStateVolumeROIPainterRegionPolyRemoveActivation()
OrsStateVolumeROIPainterRegionRectangle = 'OrsStateVolumeROIPainterRegionRectangle'
OrsStateVolumeROIPainterRegionRectangleActivation()
OrsStateVolumeROIPainterRegionRectangleAdd = 'OrsStateVolumeROIPainterRegionRectangleAdd'
OrsStateVolumeROIPainterRegionRectangleAddActivation()
OrsStateVolumeROIPainterRegionRectangleRemove = 'OrsStateVolumeROIPainterRegionRectangleRemove'
OrsStateVolumeROIPainterRegionRectangleRemoveActivation()
OrsVolumeROIPainterCircularBrushGrowInAddMode()
OrsVolumeROIPainterCircularBrushGrowInRemoveMode()
OrsVolumeROIPainterCircularBrushShrinkInAddMode()
OrsVolumeROIPainterCircularBrushShrinkInRemoveMode()
OrsVolumeROIPainterPointAndClickBrushGrowInAddMode()
OrsVolumeROIPainterPointAndClickBrushGrowInRemoveMode()
OrsVolumeROIPainterPointAndClickBrushShrinkInAddMode()
OrsVolumeROIPainterPointAndClickBrushShrinkInRemoveMode()
OrsVolumeROIPainterPointAndClickOutlineBrushGrowInAddMode()
OrsVolumeROIPainterPointAndClickOutlineBrushGrowInRemoveMode()
OrsVolumeROIPainterPointAndClickOutlineBrushShrinkInAddMode()
OrsVolumeROIPainterPointAndClickOutlineBrushShrinkInRemoveMode()
OrsVolumeROIPainterPointAndFillBrushGrowInAddMode()
OrsVolumeROIPainterPointAndFillBrushShrinkInAddMode()
OrsVolumeROIPainterRectangularBrushGrowInAddMmode()
OrsVolumeROIPainterRectangularBrushGrowInRemoveMode()
OrsVolumeROIPainterRectangularBrushShrinkInAddMode()
OrsVolumeROIPainterRectangularBrushShrinkInRemoveMode()
OrsVolumeROIPainterSmartGridSegmentationBrushGrowInAddMode()
OrsVolumeROIPainterSmartGridSegmentationBrushGrowInRemoveMode()
OrsVolumeROIPainterSmartGridSegmentationBrushShrinkInAddMode()
OrsVolumeROIPainterSmartGridSegmentationBrushShrinkInRemoveMode()
OrsVolumeROIPainterSnapBrushGrowinAddMode()
OrsVolumeROIPainterSnapBrushGrowinRemoveMode()
OrsVolumeROIPainterSnapBrushShrinkInAddMmode()
OrsVolumeROIPainterSnapBrushShrinkInRemoveMmode()
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
classmethod addControlPoint(anAnnotation, timeStep, position)
addGlobalCallbacks()
addOrRemoveRegion(adding=True)
addRegion()
addRemovePath(adding=True)
cleanup()

Deletes the variables managed by the plugin. It is the place to remove callbacks and other references to Python objects that would prevent them to be garbage collected. This method is called during the process of deletion of the plugin. It calls for the cleanup and deletion of the forms.

deleteSmartGridSegmentation()
draw2DCircularBrush(worldPosition)
interfacemethod draw2DPath(aROI, path, transformationMatrix, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, kernelSize=1, isSingleSlicePath=False, bplane=None)

Inject a path in a ROI

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • path (ORSModel.ors.VisualPath) – the path
  • transformationMatrix (ORSModel.ors.Matrix4x4) – the transformation matrix from the view to the region
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • kernelSize (int) – the size of the path drawn
  • isSingleSlicePath (bool) – is the path single slice
  • bplane (ORSModel.ors.Rectangle) – bouding plane of current view
draw2DRectangularBrush(worldPosition)
interfacemethod draw2DRegion(aROI, region, transformationMatrix, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0)

Inject a region in a ROI

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • region (ORSModel.ors.VisualRegion) – the region
  • transformationMatrix (ORSModel.ors.Matrix4x4) – the transformation matrix from the view to the region
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
interfacemethod draw2dPointAndClick(roi, subsetStructuredGrid, worldCoordinate=None, isInAdd=False, connectivityForLabelization=False, currentTime=0, minValue=0, maxValue=0, outlineMode=False, isPointAndFillMode=False, isEnterAction=False)

Draw point and click 2D in a ROI

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • subsetStructuredGrid (ORSModel.ors.StructuredGrid) – the structured grid to use for point and click
  • worldCoordinate (ORSModel.ors.Vector3) – the coordinates of the cursor
  • isInAdd (bool) – indicating whether the voxel index should be added or removed from the ROI
  • connectivityForLabelization (bool) – connectivity for labelization to multiroi
  • currentTime (int) – the time step index of the ROI
  • minValue (float) – the threshold range minimal value
  • maxValue (float) – the threshold range maximal value
  • outlineMode (bool) – is current state in outline mode
  • isPointAndFillMode (bool) – is current state in fill mode
  • isEnterAction (bool) – is click in enter action
draw3DCircularBrush(intersectingStructuredGrid, worldPosition)
draw3DRectangularBrush(intersectingStructuredGrid, worldPosition)
interfacemethod draw3DRegion(aROI, region, camera, t=0, remove=False, isOrtho=False)

Injects a region in a ROI

Parameters:
interfacemethod draw3DRegionIntersectingDataset(aROI, region, camera, dataset, rangeMin, rangeMax, lut, t=0, remove=False, clipBox=None, isOrtho=False)

Injects a region in a ROI intersecting a dataset

Parameters:
interfacemethod draw3DRegionIntersectingMultiROI(aROI, region, camera, aMultiROI, highlightOpacityInRange, highlightOpacityOutRange, t=0, remove=False, clipBox=None, isOrtho=False)

Injects a region in a ROI intersecting a MultiROI

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • region (ORSModel.ors.VisualRegion) – the region
  • camera (ORSModel.ors.Camera) – the view camera
  • aMultiROI (ORSModel.ors.MultiROI) [const] – the intersecting MultiROI
  • highlightOpacityInRange (float) – highlight opacity of the MultiROI labels in the selection range
  • highlightOpacityOutRange (float) – highlight opacity of the MultiROI labels out of the selection range
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • clipBox (ORSModel.ors.Box) – clip the resulting roi by this box
  • isOrtho (bool) – is the view in ortho mode
interfacemethod draw3DRegionIntersectingROI(aROI, region, camera, intersectingROI, t=0, remove=False, clipBox=None, isOrtho=False)

Injects a region in a ROI intersecting a ROI

Parameters:
interfacemethod draw3dPointAndClick(aPointClickLogic, roi, structuredGrid, worldCoordinate=None, isInAdd=False, connectivityForLabelization=False, currentTime=0, minValue=0, maxValue=0, outlineMode=False, isPointAndFillMode=False, isEnterAction=False)

Draw point and click 3D in a ROI

Parameters:
  • aPointClickLogic (transient PointClickLogic) – a PointClickLogic
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • structuredGrid (ORSModel.ors.StructuredGrid) – the structured grid to use for point and click
  • worldCoordinate (ORSModel.ors.Vector3) – the coordinates of the cursor
  • isInAdd (bool) – indicating whether the voxel index should be added or removed from the ROI
  • connectivityForLabelization (bool) – connectivity for labelization to multiroi
  • currentTime (int) – the time step index of the ROI
  • minValue (float) – the threshold range minimal value
  • maxValue (float) – the threshold range maximal value
  • outlineMode (bool) – is current state in outline mode
  • isPointAndFillMode (bool) – is current state in fill mode
  • isEnterAction (bool) – is click in enter action
interfacemethod drawCircle(roi, boundedPlane, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiToExclude: Union[List[T], NoneType] = None)

Inject a circle in a ROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the circle
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiToExclude (ORSModel.ors.ROI) [count=[0, None]] – list of additional ROIs to remove from
interfacemethod drawCircleIntersect(roi, boundedPlane, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiMasks: Union[List[T], NoneType] = None, removeFromMask=True)

Inject a circle in a ROI with intersect

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the circle
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiMasks (ORSModel.ors.ROI) [count=[0, None]] – list of ROIs to use has mask
  • removeFromMask (bool) – indicating whether the operation should remove from the masks
interfacemethod drawCube(roi, boundedPlane, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiToExclude: Union[List[T], NoneType] = None)

Inject a cube in a ROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the cube
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiToExclude (ORSModel.ors.ROI) [count=[0, None]] – list of additional ROIs to remove from
interfacemethod drawCubeIntersect(roi, boundedPlane, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiMasks: Union[List[T], NoneType] = None, removeFromMask=True)

Inject a cube in a ROI with intersect

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the cube
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiMasks (ORSModel.ors.ROI) [count=[0, None]] – list of ROIs to use has mask
  • removeFromMask (bool) – indicating whether the operation should remove from the masks
interfacemethod drawCubeOn3D(aROI, boundedPlane, worldPos, brushSize, t=0, remove=False)

Inject a cube in a ROI on 3D

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the cube
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawCubeOn3DIntersectingDataset(aROI, boundedPlane, worldPos, brushSize, dataset, rangeMin, rangeMax, lut, t=0, remove=False)

Injects a cube in a ROI in 3D intersecting a dataset

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the cube
  • brushSize (float) – the brush radius size in world coordinate
  • dataset (ORSModel.ors.Channel) [const] – the intersecting dataset
  • rangeMin (float) – minimal value of the dataset intensity to include in the ROI
  • rangeMax (float) – maximal value of the dataset intensity to include in the ROI
  • lut (ORSModel.ors.LookupTable) – a LUT
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawCubeOn3DIntersectingMultiROI(aROI, boundedPlane, worldPos, brushSize, aMultiROI, highlightOpacityInRange, highlightOpacityOutRange, t=0, remove=False)

Injects a cube in a ROI in 3D intersecting a MultiROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the cube
  • brushSize (float) – the brush radius size in world coordinate
  • aMultiROI (ORSModel.ors.MultiROI) [const] – the intersecting MultiROI
  • highlightOpacityInRange (float) – highlight opacity of the MultiROI labels in the selection range
  • highlightOpacityOutRange (float) – highlight opacity of the MultiROI labels out of the selection range
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawCubeOn3DIntersectingROI(aROI, boundedPlane, worldPos, brushSize, intersectingROI, t=0, remove=False)

Injects a cube in a ROI in 3D intersecting a ROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the cube
  • brushSize (float) – the brush radius size in world coordinate
  • intersectingROI (ORSModel.ors.ROI) [const] – the intersecting ROI
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawSmartGrid(smartGridSegmentationLogic, smartGridClickLogic, roi, inputStructuredGrid, worldCoordinate, brushSize, currentTime, isInAdd, isEnterAction, bounded_plane, gridSize, sigma)

Draw smart grid in a ROI

Parameters:
  • smartGridSegmentationLogic (transient SmartGridSegmentationLogic) – a SmartGridSegmentationLogic
  • smartGridClickLogic (transient SmartGridSegmentationClickLogic) – a SmartGridSegmentationClickLogic
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • inputStructuredGrid (ORSModel.ors.StructuredGrid) – the structured grid to use for smart grid
  • worldCoordinate (ORSModel.ors.Vector3) – the coordinates of the cursor
  • brushSize (float) – the brush radius size in world coordinate
  • currentTime (int) – the time step index of the ROI
  • isInAdd (bool) – indicating whether the voxel index should be added or removed from the ROI
  • isEnterAction (bool) – is click in enter action
  • bounded_plane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • gridSize (tuple) – smart grid size in x and y
  • sigma (float) – smart grid sigma
interfacemethod drawSnap(blowTool, roi, worldPosition, timeStep, remove)

Instantiates a Blow tool for snap

Parameters:
  • blowTool (transient BlowTool) – a BlowTool
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • worldPosition (ORSModel.ors.Vector3) – the coordinates of the cursor
  • timeStep (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawSphere(roi, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiToExclude: Union[List[T], NoneType] = None)

Inject a sphere in a ROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the sphere
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiToExclude (ORSModel.ors.ROI) [count=[0, None]] – list of additional ROIs to remove from
interfacemethod drawSphereIntersect(roi, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiMasks: Union[List[T], NoneType] = None, removeFromMask=True)

Inject a sphere in a ROI with intersect

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the sphere
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiMasks (ORSModel.ors.ROI) [count=[0, None]] – list of ROIs to use has mask
  • removeFromMask (bool) – indicating whether the operation should remove from the masks
interfacemethod drawSphereOn3D(aROI, worldPos, brushSize, t=0, remove=False)

Inject a sphere in a ROI in 3D

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the sphere
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawSphereOn3DIntersectingDataset(aROI, worldPos, brushSize, dataset, rangeMin, rangeMax, lut, t=0, remove=False)

Injects a sphere in a ROI in 3D intersecting a dataset

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the sphere
  • brushSize (float) – the brush radius size in world coordinate
  • dataset (ORSModel.ors.Channel) [const] – the intersecting dataset
  • rangeMin (float) – minimal value of the dataset intensity to include in the ROI
  • rangeMax (float) – maximal value of the dataset intensity to include in the ROI
  • lut (ORSModel.ors.LookupTable) – a LUT
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawSphereOn3DIntersectingMultiROI(aROI, worldPos, brushSize, aMultiROI, highlightOpacityInRange, highlightOpacityOutRange, t=0, remove=False)

Injects a sphere in a ROI in 3D intersecting a MultiROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the sphere
  • brushSize (float) – the brush radius size in world coordinate
  • aMultiROI (ORSModel.ors.MultiROI) [const] – the intersecting MultiROI
  • highlightOpacityInRange (float) – highlight opacity of the MultiROI labels in the selection range
  • highlightOpacityOutRange (float) – highlight opacity of the MultiROI labels out of the selection range
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawSphereOn3DIntersectingROI(aROI, worldPos, brushSize, intersectingROI, t=0, remove=False)

Injects a sphere in a ROI in 3D intersecting a ROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • aROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the sphere
  • brushSize (float) – the brush radius size in world coordinate
  • intersectingROI (ORSModel.ors.ROI) [const] – the intersecting ROI
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
interfacemethod drawSquare(roi, boundedPlane, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiToExclude: Union[List[T], NoneType] = None)

Inject a square in a ROI

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the square
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiToExclude (ORSModel.ors.ROI) [count=[0, None]] – list of additional ROIs to remove from
interfacemethod drawSquareIntersect(roi, boundedPlane, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiMasks: Union[List[T], NoneType] = None, removeFromMask=True)

Inject a square in a ROI with intersect

Deprecated since version 2021.1: Use method of dynamic brushes instead

Parameters:
  • roi (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the ROI or MultiROI to paint
  • boundedPlane (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPos (ORSModel.ors.Vector3) – the world position of the voxel at the center of the square
  • brushSize (float) – the brush radius size in world coordinate
  • t (int) – the time step index of the ROI
  • remove (bool) – indicating whether the voxel index should be added or removed from the ROI
  • rangeChannel (ORSModel.ors.Channel) [const] – the dataset to check against (if None, the range won’t be used)
  • rangeMin (float) – the threshold range minimal value (used only if rangeChannel is not None)
  • rangeMax (float) – the threshold range maximal value (used only if rangeChannel is not None)
  • oppositeROI (ORSModel.ors.ROI) – a ROI where the opposite operation will be done
  • roiMasks (ORSModel.ors.ROI) [count=[0, None]] – list of ROIs to use has mask
  • removeFromMask (bool) – indicating whether the operation should remove from the masks
enterTemporaryStatePointFillAction()
get2DConnectivity()
get3DConnectivity()
getAppropriateColorForROIManipulations(view, adding=True)
getAvailableConnectivityPointClick2d()
getAvailableConnectivityPointClick3d()
getBrushSizeForCurrentROI()
getBrushSizeForROI(aROI)
getClipBox(stucturedGrid, view)

Get the ROI clip box

getCurrentBrushForm(is3D)
getCurrentBrushRangeChannelGUID()
getCurrentBrushType(is3D)
getCurrentSelectedStructuredGrid()
getCurrentView()
getDynameBrushTitlesAndNames()
getDynamicBrushTypes()
getExcludedObjectsGUIDSList()
static getGridSizeList()
getIs2DPointClick()
getIsLowerThreshold()
getIsSingleSlicePath()
getKernelSize()
getListAvailableKernelSize()
classmethod getMainFormClass()

Gets the class of the main form

Returns:output –
getMaxBrushSizeFromView()
getMultiROI()

Get the current MultiROI

Returns:mr (ORSModel.ors.MultiROI) – The current MultiROI
getMultiROIs()

Get the current MultiROIs

Returns:mrois (ORSModel.ors.MultiROI) – list of MultiROI
Rcount mrois:[0, None]
getMultiselectExclusiveIntersection()
getRange()
getRangeChannel()
getRangeDatasetPresenter()
getSegmentationGridSize()
getSegmentationSigma()
getSelectedStructuredGridToExclude()
getShow2DChannelComboBox()
getShow3DViewTools()
getShowMultiSliceOption()
getShowRangeScopeWidgetCurrentBrush(is3d)
getShowRangeWidgetCurrentBrush(is3d)
getSmartGridSegmentationInputChannel()
getSmartGridSegmentationOutputDistanceMap()
getSmartGridSegmentationOutputLabel()
getSmartGridSliceSegmentation()
static getSnapUseLeveling()
interfacemethod getStructuredGridIntersectingWithView(bounded_plane, referenceStructuredGrid)

Get the structured grid slice if in 2d, copy the full structured grid if 3d

Parameters:
Returns:

output (ORSModel.ors.StructuredGrid) – reference structured grid
getUseRange()
getVisual()
getVolumeROI()

Get the current volume ROI

Returns:volumeROI (ORSModel.ors.ROI) – The current ROI
getVolumeROIs()

Get the current volume ROIs

Returns:rois (ORSModel.ors.ROI) – list of ROIs
Rcount rois:[0, None]
interfacemethod getWindowLevel3DMinMaxForPaintingFromGenealogicalName(layoutFullName, dataset)

Gets the dataset 3D window/level range in layout for painting

Parameters:
Returns:
  • rangeMin (float) – minimal value of the range
  • rangeMax (float) – maximal value of the range
growBrush()
handleChanged(oldHandleName, newHandleName)

This method is called when the state of the application is changed.

Parameters:
  • oldState (str) – name of the old (previous) state
  • newState (str) – name of the new (current) state
handleTriggered(event)

This method is called on every user input (mouse move, mouse click, key press, …) when the current state of the application is one of those declared by the plugin. This method can be used to perform specific tasks even if no action is currently in progress.

Parameters:eventData (OrsEvent.eventdata.InputEventData) – the event data
classmethod importAllLoggingClasses()

This method is called to make any class extension available for macro playing. It should:

  1. import all class extension;
  2. return a list of classes where logging is supported.
Returns:output (list of classes) – list of classes where logging is supported by the current plugin
initSmartGridSegmentation()
interfacemethod instantiateBlowTool()

Instantiates a Blow tool for snap

Returns:output (transient BlowTool) – a BlowTool
interfacemethod instantiatePointClickLogic()

Instantiates a PointClickLogic

Returns:output (transient PointClickLogic) – a PointClickLogic
interfacemethod instantiateSmartGridClickLogic(targetStructuredGrid, labelROI=None)

Instantiates a SmartGridLogic

Parameters:
Returns:

output (transient SmartGridSegmentationClickLogic) – a SmartGridSegmentationClickLogic
isChannelShouldBePaintOption(aChannel)
keepAlive = False
make3DBrushInvisibleAndRefreshViews()
multiple = False
orsCurrentDisplayChange()
orsDisplayUnderCursorChange()
orsSelectedObjectsChange()
interfacemethod prepareDrawSnap(blowTool, channel, rectangle, worldPosition, brushSize, timeStep, minV, maxV, useRange, onLevelling=True, filter=False)

Prepare for draw snap ROI

Parameters:
  • blowTool (transient BlowTool) – a BlowTool
  • channel (ORSModel.ors.StructuredGrid) – the structured grid to use for smart grid
  • rectangle (ORSModel.ors.Rectangle) – the drawing bounded plane
  • worldPosition (ORSModel.ors.Vector3) – the coordinates of the cursor
  • brushSize (float) – the brush radius size in world coordinate
  • timeStep (int) – the time step index of the ROI
  • minV (float) – the threshold range minimal value
  • maxV (float) – the threshold range maximal value
  • useRange (bool) – indicating whether the voxel index should be added or removed from the ROI
  • onLevelling (bool) – indicating whether the voxel index should be added or removed from the ROI
  • filter (bool) – indicating whether the voxel index should be added or removed from the ROI
Returns:

output (ORSModel.ors.VisualPath) – path
refreshOnDisplayChange()
refreshSmartGridAtCameraEvent()
classmethod regionHandlers()
removeRegion()
resetBrushSizeForROI(aROI)
savable = True
selectROIUnderCursor(event: OrsEvent.eventdata.InputEventData)
sendDataToDynamicBrushTypes(view, remove)
set2DConnectivity(connectivity)
set3DConnectivity(connectivity)
setBrushSizeForROI(aROI, brushSizeInMeters)
classmethod setControlPointPosition(anAnnotation, controlPointIndex, timeStep, position)
setCurrentBrushRangeChannelGUID(currentBrushRangeChannelGUID)
setCurrentBrushType(brushName, is3D)
setCurrentStateToTrack()
setCursor(handleName)

Sets the current cursor

Parameters:state (str) – state associated to the cursor to set
setExcludedObjectsGUIDSList(guidList)
setIs2DPointClick(is2DPointClick)
setIsLowerThreshold(isLowerThreshold)
setIsSingleSlicePath(isSingleSlicePath)
setKernelSize(kernelSize)
setMultiselectExclusiveIntersection(multiselectExclusiveIntersection)
setSegmentationGridSize(grid_size)
setSegmentationSigma(sigma)
setSelectedStructuredGrid(structuredGrid)
setShow2DChannelComboBox(isVisible)
setShow3DViewTools(isVisible)
setShowMultiSliceOption(isVisible)
setSmartGridSegmentationInputChannel(channel)
shrinkBrush()
stateDescriptors = [<ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>, <ORSServiceClass.OrsPlugin.statedescriptor.StateDescriptor object>]
switchToOrsState2DPathAddAction()
switchToOrsState2DPathRemoveAction()
switchToOrsState2DSnapAddAction()
switchToOrsState2DSnapRemoveAction()
switchToOrsStateCircularBrushAddAction()
switchToOrsStateCircularBrushRemoveAction()
switchToOrsStatePointClickAddAction()
switchToOrsStatePointClickOutlineAddAction()
switchToOrsStatePointClickOutlineRemoveAction()
switchToOrsStatePointClickRemoveAction()
switchToOrsStatePointFillAddAction()
switchToOrsStateRectangularBrushAddAction()
switchToOrsStateRectangularBrushRemoveAction()
switchToOrsStateSmartGridSegmentationAddAction()
switchToOrsStateSmartGridSegmentationRemoveAction()
switchToVolumeROIRegionEllipseAdd()
switchToVolumeROIRegionEllipseRemove()
switchToVolumeROIRegionFreehandAdd()
switchToVolumeROIRegionFreehandRemove()
switchToVolumeROIRegionPolyAdd()
switchToVolumeROIRegionPolyRemove()
switchToVolumeROIRegionRectangleAdd()
switchToVolumeROIRegionRectangleRemove()
updateOnVolumeROIChange()
updateSmartGridSegmentation()