OrsContourPath

Active contour

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 2018.
date:Jan 26 2017 16:39
dragonflyVersion:
 2.1.0.200 (D)
UUID:274722ace41d11e682470cc47aab53c3

Class Code

class OrsPythonPlugins.OrsContourPath.OrsContourPath.OrsContourPath(varname=None, managed=True)
ORSStateDensePath = 'ORSStateDensePath'
ORSStateDensePathActivation()
ORSStateDensePathNormalsInward = 'ORSStateDensePathNormalsInward'
ORSStateDensePathNormalsInwardActivation()
ORSStateEdit = 'ORSStateEdit'
ORSStatePathRepulsor = 'ORSStatePathRepulsor'
ORSStatePathRepulsorActivation()
ORSStateSnapTool = 'ORSStateSnapTool'
ORSStateSnapToolActivation()
ORSStateSnapToolNormalsInward = 'ORSStateSnapToolNormalsInward'
ORSStateSnapToolNormalsInwardActivation()
classmethod OrsContourPath_openGUI()
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
classmethod addGroupOfPaths()
closable = True
closeWidget(name)
computeNormals()
copyCurrentPathInView()
copyPathOnCurrentSliceFromDensePatAction()
copyPathOnCurrentSliceFromEditAction()
copyPathOnCurrentSliceFromSnapToolAction()
currentViewChange()
cutMeshSingleSliceOnCurrentView()
cutWholeMeshInCurrentViewOrientation()
decreaseRepulsorRadiusAction()
deletePathsInGroupOfPaths(listOfPaths)
deletePlugin(aWidget=None)
interfacemethod editObjectFromGroupOfPaths(aGroupOfRegions, operationToPerform, IProgress=None)

Edits an object from a set of regions using a Poisson reconstruction.

The regions used in the Poisson reconstruction are only the selected objects contained in the group.

Parameters:
  • aGroupOfRegions (ORSModel.ors.Group) – group containing a list of selected regions to use in the Poisson reconstruction. At this time, the only accepted regions are instances of VisualPath.
  • operationToPerform (str) – operation to perform Should be one of: [‘add’, ‘remove’, ‘intersect’, ‘replace’].
  • IProgress (ORSModel.ors.Progress) – progress object
interfacemethod generatePreview(inputDataset, viewName, useLevelling, useGaussianFilter, gaussianFilterStd, cannyProportion, cannySigma)

Generate a dataset of preview on the slice of the specified view

Parameters:
  • inputDataset (ORSModel.ors.Channel) – input dataset
  • viewName (str) – a view genealogical name
  • useLevelling (bool) – specifies if the window levelling should be used
  • useGaussianFilter (bool) – specifies if the Gaussian filter should be used
  • gaussianFilterStd (float) – standard deviation of the Gaussian filter
  • cannyProportion (float) – pondering factor (between 0.0 and 1.0) of the Canny filter to be added to the gaussian filtered result
  • cannySigma (float) – sigma parameter (>= 0) of the Canny filter
Returns:

previewDataset (ORSModel.ors.Channel) – the dataset of the preview

generatePreviewOnCurrentView()
classmethod getBoundingBoxOfPathAlignedWithCreationPlane(aPath)
getCurrentMeshPoissonReconstruction(logging=True)
getCurrentPath()

Gets the path object for which the snake parameters are used.

Return:the path object
Rtype:ORSModel.ors.VisualPath
getCutterParameters()
getDatasetParameters()
getGaussianFilterStd()
getGroupOfPaths()
getInputDataset()
getIsMeshCutEnabled()
interfacemethod getMeshFromGroupOfPaths(aGroupOfRegions, meshTitle, meshColor, IProgress=None)

Creates a mesh from a set of regions using a Poisson reconstruction.

The regions used in the Poisson reconstruction are only the selected objects contained in the group.

Parameters:
  • aGroupOfRegions (ORSModel.ors.Group) – group containing a list of selected regions to use in the Poisson reconstruction. At this time, the only accepted regions are instances of VisualPath.
  • meshTitle (str) – the new mesh title
  • meshColor (ORSModel.ors.Color) – the new mesh color
  • IProgress (ORSModel.ors.Progress) – progress object
Returns:

newMesh (ORSModel.ors.Mesh) – created mesh obtained by the Poisson reconstruction

interfacemethod getMeshPoissonReconstruction(aGroupOfRegions, depth=8, scale=1.25, solverDivide=8, isoDivide=8, samplesPerNode=1.0, normalsEvaluation='path plane', inputDataset=None, IProgress=None)

Calls for a Poisson reconstruction on a set of regions.

The regions used in the Poisson reconstruction are only the selected objects contained in the group.

Deprecated since version 3.6: Use getMeshFromGroupOfPaths.

Parameters:
  • aGroupOfRegions (ORSModel.ors.Group) – group containing a list of selected regions to use in the Poisson reconstruction. At this time, the only accepted regions are instances of VisualPath.
  • depth (int) – Poisson reconstruction parameter depth
  • scale (float) – Poisson reconstruction parameter scale
  • solverDivide (int) – Poisson reconstruction parameter solverDivide
  • isoDivide (int) – Poisson reconstruction parameter isoDivide
  • samplesPerNode (float) – Poisson reconstruction parameter samplesPerNode
  • normalsEvaluation (str) – technique to evaluate the normals
  • inputDataset (ORSModel.ors.Channel) – dataset to be used if the normals are to be evaluated from a dataset
  • IProgress (ORSModel.ors.Progress) – progress object
Returns:

newMesh (ORSModel.ors.Mesh) – created mesh obtained by the Poisson reconstruction

getMeshToCut()
classmethod getMinMaxValueLevelling(inputDataset, aView)

Gets the window levelling values for the given dataset in the given view, in data units.

Parameters:
Returns:
  • minValueLevellingDataArray (float) – min value of window levelling in data
  • maxValueLevellingDataArray (float) – max value of window levelling in data
interfacemethod getMultiROIFromGroupOfPaths(aGroupOfRegions, structuredGridShapeOfReference, multiROITitle, IProgress=None)

Creates a MultiROI from a set of regions using a Poisson reconstruction.

The regions used in the Poisson reconstruction are only the selected objects contained in the group.

Parameters:
  • aGroupOfRegions (ORSModel.ors.Group) – group containing a list of selected regions to use in the Poisson reconstruction. At this time, the only accepted regions are instances of VisualPath.
  • structuredGridShapeOfReference (ORSModel.ors.StructuredGrid) – a structured grid of reference defining the shape of the new ROI
  • multiROITitle (str) – the new MultiROI title
  • IProgress (ORSModel.ors.Progress) – progress object
Returns:

newMultiROI (ORSModel.ors.MultiROI) – created MultiROI, equivalent of the mesh obtained by the Poisson reconstruction

getObjectToCutGUID()
getPathPointsUndoArrayExistsInAtLeastOneSelectedPath()
getPoissonReconstructionParameters()
interfacemethod getROIFromGroupOfPaths(aGroupOfRegions, structuredGridShapeOfReference, roiTitle, roiColor, IProgress=None)

Creates a ROI from a set of regions using a Poisson reconstruction.

The regions used in the Poisson reconstruction are only the selected objects contained in the group.

Parameters:
  • aGroupOfRegions (ORSModel.ors.Group) – group containing a list of selected regions to use in the Poisson reconstruction. At this time, the only accepted regions are instances of VisualPath.
  • structuredGridShapeOfReference (ORSModel.ors.StructuredGrid) – a structured grid of reference defining the shape of the new ROI
  • roiTitle (str) – the new ROI title
  • roiColor (ORSModel.ors.Color) – the new ROI color
  • IProgress (ORSModel.ors.Progress) – progress object
Returns:

newROI (ORSModel.ors.ROI) – created ROI, equivalent of the mesh obtained by the Poisson reconstruction

getRadiusRepulsor(aPath, view)
getSelectedPathsInCurrentGroupOfPaths()

Gets the selected path object(s).

Return:list of selected path object(s).
Rtype:list of ORSModel.ors.VisualPath
getSliceCount()
getSnakeParameters()
classmethod getStringItemDataForSelectionAsObjectToCut()
getTablePathsModel()
getUseGaussianFilter()
getUseLevelling()
handleChanged(oldState, newState)

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

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
increaseDecreaseRepulsorRadius(increaseRadius=True)
increaseRepulsorRadiusAction()
iterate()
iterateSelectedPathsActionAction()

Action stage of the action iterateSelectedPathsAction

iterateSelectedPathsActionEnterAction()

EnterAction stage of the action iterateSelectedPathsAction

This action uses the instance variable “_iterateSelectedPathsActionBuffer”, a buffer kept in the implementation instance.

iterateSelectedPathsActionExitAction()

ExitAction stage of the action iterateSelectedPathsAction

iterateSelectedPathsFromDensePathAction()
iterateSelectedPathsFromEditAction()
iterateSelectedPathsFromSnapToolAction()
keepAlive = False
classmethod keepPathPointsInUndoArray(aPath)
lookAtCurrentPath()
interfacemethod lookAtPath(viewName, aVisualPath)

Sets the camera to view the path

Parameters:
multiple = False
classmethod openGUI()
openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1)
savable = True
selectAndLookAtPreviousNextPath(nextPath=True)
selectNextPathInGroupFromDensePathAction()
selectNextPathInGroupFromEditAction()
selectNextPathInGroupFromSnapToolAction()
selectPreviousPathInGroupFromDensePathAction()
selectPreviousPathInGroupFromEditAction()
selectPreviousPathInGroupFromSnapToolAction()
selectedObjectsChange()
setBlockExecutionOfSelectedObjectsChange(value)
setCursor(state)

Sets the current cursor

Parameters:state (str) – state associated to the cursor to set
setCutterParameters(cutterParameters)
setDatasetParameters(datasetParameters)
setGroupOfPaths(groupOfPaths)
classmethod setPathPointsFromUndoArray(aPath)
setPoissonReconstructionParameters(poissonReconstructionParameters)
setRadiusRepulsor(aPath, view, radiusRepulsor)
setSelectionStateOfAllPathsInCurrentGroupOfPaths(newSelectionState)

Sets the selection state of all path object(s).

setSnakeParameters(snakeParameters)
showInToolbar = True
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>]
switchToDensePathStateAction()
switchToEditStateAction()
switchToSnapToolStateAction()
temporarySwitchToDensePathNormalsInwardStateFromDensePathStateAction()
temporarySwitchToPathRepulsorStateFromDensePathAction()
temporarySwitchToPathRepulsorStateFromEditAction()
temporarySwitchToPathRepulsorStateFromSnapToolAction()
temporarySwitchToSnapToolNormalsInwardStateFromSnapToolStateAction()
classmethod toolsMenu()
undoIterate()
updateSnakeForPath(snake, aPath, aView, aDatasetParameters=None)
updateSnakeParametersFromCurrentGroupOfPaths()
updateSnakeParametersWithPath(aPath, snake)
updateTableModels()
updateTablePathsModel()

This function is to actualize the table model of paths

updateUI()