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:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved 2019. date:Jun 10 2015 13:37 dragonflyVersion:  3.1.0.286 (D) UUID:1d3fb7ba761e11e7a73e448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsVolumeROIPainter.OrsVolumeROIPainter.OrsVolumeROIPainter(varname=None, managed=True)

OrsState2DPath = 'OrsState2DPath'

OrsState2DPathAction()

OrsState2DPathAdd = 'OrsState2DPathAdd'

OrsState2DPathAddAction()

OrsState2DPathRemove = 'OrsState2DPathRemove'

OrsState2DPathRemoveAction()

OrsState2DSnap = 'OrsState2DSnap'

OrsState2DSnapAction()

OrsState2DSnapAdd = 'OrsState2DSnapAdd'

OrsState2DSnapAddAction()

OrsState2DSnapRemove = 'OrsState2DSnapRemove'

OrsState2DSnapRemoveAction()

OrsStateBrush = 'OrsStateBrush'

OrsStateCircularBrush = 'OrsStateCircularBrush'

OrsStateCircularBrushAction()

OrsStateCircularBrushAdd = 'OrsStateCircularBrushAdd'

OrsStateCircularBrushAddAction()

OrsStateCircularBrushRemove = 'OrsStateCircularBrushRemove'

OrsStateCircularBrushRemoveAction()

OrsStatePointClick = 'OrsStatePointClick'

OrsStatePointClickAction()

OrsStatePointClickAdd = 'OrsStatePointClickAdd'

OrsStatePointClickAddAction()

OrsStatePointClickRemove = 'OrsStatePointClickRemove'

OrsStatePointClickRemoveAction()

OrsStateRectangularBrush = 'OrsStateRectangularBrush'

OrsStateRectangularBrushAction()

OrsStateRectangularBrushAdd = 'OrsStateRectangularBrushAdd'

OrsStateRectangularBrushAddAction()

OrsStateRectangularBrushRemove = 'OrsStateRectangularBrushRemove'

OrsStateRectangularBrushRemoveAction()

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()

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)

closable = False

closeWidget(name)

deletePlugin(aWidget=None)

deleteSmartGridSegmentation()

draw2DCircularBrush(world_pos, display, remove)

interfacemethod draw2DPath(aROI, path, transformationMatrix, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0)

Inject a path in a ROI

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI to paint
• path (ORSModel.ors.VisualPath) – the path
• transformationMatrix (ORSModel.ors.Matrix4x4) – the transformation matrix from the display 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) – 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)

draw2DRectangularBrush(world_pos, display, remove)

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) – the ROI to paint
• region (ORSModel.ors.VisualRegion) – the region
• transformationMatrix (ORSModel.ors.Matrix4x4) – the transformation matrix from the display 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) – 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)

draw3DCircularBrush(world_pos, display, remove, intersectingStructuredGrid)

draw3DRectangularBrush(world_pos, display, remove, intersectingStructuredGrid)

interfacemethod draw3DRegion(aROI, region, camera, t=0, remove=False, isOrtho=False)

Injects a region in a ROI

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI to paint
• region (ORSModel.ors.VisualRegion) – the region
• camera (ORSModel.ors.Camera) – the display camera
• t (int) – the time step index of the ROI
• remove (bool) – indicating whether the voxel index should be added or removed from the ROI
• isOrtho (bool) – is the view in ortho mode

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:

• aROI (ORSModel.ors.ROI) – the ROI to paint
• region (ORSModel.ors.VisualRegion) – the region
• camera (ORSModel.ors.Camera) – the display camera
• dataset (ORSModel.ors.Channel) – 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
• clipBox (ORSModel.ors.Box) – clip the resulting roi by this box
• isOrtho (bool) – is the display in ortho mode

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) – the ROI to paint
• region (ORSModel.ors.VisualRegion) – the region
• camera (ORSModel.ors.Camera) – the display camera
• aMultiROI (ORSModel.ors.MultiROI) – 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 display 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:

• aROI (ORSModel.ors.ROI) – the ROI to paint
• region (ORSModel.ors.VisualRegion) – the region
• camera (ORSModel.ors.Camera) – the display camera
• intersectingROI (ORSModel.ors.ROI) – 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
• clipBox (ORSModel.ors.Box) – clip the resulting roi by this box
• isOrtho (bool) – is the display in ortho mode

interfacemethod drawCircle(roi, boundedPlane, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiToExclude=[])

Inject a circle in a ROI

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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=[], removeFromMask=True)

Inject a circle in a ROI with intersect

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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 operatoin 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=[])

Inject a cube in a ROI

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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=[], removeFromMask=True)

Inject a cube in a ROI with intersect

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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 operatoin should remove from the masks

interfacemethod drawCubeOn3D(aROI, boundedPlane, worldPos, brushSize, t=0, remove=False)

Inject a cube in a ROI on 3D

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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) – 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

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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) – 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

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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) – 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 drawSphere(roi, worldPos, brushSize, t=0, remove=False, rangeChannel=None, rangeMin=0.0, rangeMax=0.0, oppositeROI=None, roiToExclude=[])

Inject a sphere in a ROI

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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=[], removeFromMask=True)

Inject a sphere in a ROI with intersect

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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 operatoin should remove from the masks

interfacemethod drawSphereOn3D(aROI, worldPos, brushSize, t=0, remove=False)

Inject a sphere in a ROI in 3D

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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) – 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

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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) – 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

Parameters:

• aROI (ORSModel.ors.ROI) – the ROI 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) – 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=[])

Inject a square in a ROI

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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=[], removeFromMask=True)

Inject a square in a ROI with intersect

Parameters:

• roi (ORSModel.ors.ROI) – the ROI 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) – 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 operatoin should remove from the masks

getBrushSizeForROI(aROI)

getBushSizeForCurrentROI()

getClipBox(stucturedGrid, view)

Get the ROI clip box if visible, None otherwise

getCurrentSelectedStructuredGrid()

getCurrentView()

getGridSizeList()

getMultiselectExclusiveIntersection()

getRange()

getRangeChannel()

getSegmentationGridSize()

getSegmentationSigma()

getSmartGridSegmentationOutputDistanceMap()

getSmartGridSegmentationOutputLabel()

getSnapUseLeveling()

getUseRange()

getVisual()

getVolumeROI()

Get the current volume ROI

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

getVolumeROIs()

Get the current volume ROI

Parameters:rois (ORSModel.ors.ROI) – list of ROIs Count rois:[0, None]

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

initSmartGridSegmentation()

keepAlive = False

multiple = False

openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1)

orsCurrentDisplayChange()

orsDisplayUnderCursorChange()

orsSelectedObjectsChange()

refreshOnDisplayChange()

classmethod regionHandlers()

removeRegion()

savable = True

setBrushSizeForROI(aROI, aSizeInMeter)

setCursor(handleName)

Sets the current cursor

Parameters:state (str) – state associated to the cursor to set

setMultiselectExclusiveIntersection(multiselectExclusiveIntersection)

setSegmentationGridSize(grid_size)

setSegmentationSigma(sigma)

setSelectedStructuredGrid(structuredGrid)

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>]

switchToOrsState2DPathAddAction()

switchToOrsState2DPathRemoveAction()

switchToOrsState2DSnapAddAction()

switchToOrsState2DSnapRemoveAction()

switchToOrsStateCircularBrushAddAction()

switchToOrsStateCircularBrushRemoveAction()

switchToOrsStatePointClickAddAction()

switchToOrsStatePointClickRemoveAction()

switchToOrsStateRectangularBrushAddAction()

switchToOrsStateRectangularBrushRemoveAction()

switchToOrsStateSmartGridSegmentationAddAction()

switchToOrsStateSmartGridSegmentationRemoveAction()

switchToVolumeROIRegionEllipseAdd()

switchToVolumeROIRegionEllipseRemove()

switchToVolumeROIRegionFreehandAdd()

switchToVolumeROIRegionFreehandRemove()

switchToVolumeROIRegionPolyAdd()

switchToVolumeROIRegionPolyRemove()

switchToVolumeROIRegionRectangleAdd()

switchToVolumeROIRegionRectangleRemove()

updateOnVolumeROIChange()

updateSmartGridSegmentation()