OrsHistographicSegmentation

Segmentation tool based on bidimensional analysis of data

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:Dec 03 2015 11:23
dragonflyVersion:
 3.0
UUID:a18c801a761411e78ddd448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsHistographicSegmentation.OrsHistographicSegmentation.OrsHistographicSegmentation(varname=None)
OrsHistographicSegmentationBrushAddOnHistogramAction()
OrsHistographicSegmentationBrushGrowInAddMode()
OrsHistographicSegmentationBrushGrowInRemoveMode()
OrsHistographicSegmentationBrushRemoveOnHistogramAction()
OrsHistographicSegmentationBrushShrinkInAddMode()
OrsHistographicSegmentationBrushShrinkInRemoveMode()
OrsStateHSBrush = 'OrsStateHistographicSegmentationBrushOnDisplay'
OrsStateHSBrushAdd = 'OrsStateHistographicSegmentationBrushAddOnDisplay'
OrsStateHSBrushAddActivation()
OrsStateHSBrushRemove = 'OrsStateHistographicSegmentationBrushRemoveOnDisplay'
OrsStateHSBrushRemoveActivation()
OrsStateHSHistogramBrush = 'OrsStateHistographicSegmentationBrushOnHistogram'
OrsStateHSHistogramBrushAdd = 'OrsStateHistographicSegmentationBrushAddOnHistogram'
OrsStateHSHistogramBrushRemove = 'OrsStateHistographicSegmentationBrushRemoveOnHistogram'
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
addClass(className, alpha)
addHistogramIndexToLabel(pythonListHistogramIndex, label, refreshPreviousLMR=True, refreshOverlay=False)
canClusteringAlgorithm(clusteringAlgorithmName)
canSegmentationAlgorithm(segmentationAlgorithmName)
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.

computeHistogram()
createInRange(title, xmin, ymin, zmin, xmax, ymax, zmax, useMask, listLabels, createROI, createLMR)
createROIAndLMRToExport(axisXDataset, axisYDataset, histogramData, LMRHistogramPainting, LMRSegmentation, ROIRangeToApplySegmentation, LMRCreateSegmentationInRange, aListOfROIToExport, listLabels, LMRToExport, IProgress)
draw2DBrushInDisplay(worldPos, display, remove, brushKind)
getAheadLMRHistogramPaintingGUID()
getAxisXDatasetGUID()
getAxisXDatasetTIndex()
getAxisYDatasetGUID()
getAxisYDatasetTIndex()
getBinCount()
getBrushSize()
getClassName(label)
getClusteringAlgorithmDict()
getClusteringAlgorithmsNames()
getHistogramGUID()
getIsMaskUsed()
getLMRHistogramPaintingGUID()
getLMRSegmentationGUID()
classmethod getMainFormClass()

Gets the class of the main form

Returns:output –
classmethod getPluginStates()
getPreviousLMRHistogramPaintingGUID()
getROIGUID()
getROIHistogramRangeGUID()
getROITIndex()
getSegmentationAlgorithmDict()
getSegmentationAlgorithmsNames()
getSobel2DAxisXDatasetGUID()
getSobel3DAxisXDatasetGUID()
growBrush()
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
importROI(importedROI, label, refreshPreviousLMR=True)
initializeBrushSize()
keepAlive = False
multiple = False
orsDisplayUnderCursorChange()
redoLastOperationOnLMRHistogramPaintingOverlay()
refreshSegmentationPreviewArea()
removeClass(labelToRemove)
removeHistogramIndex(pythonListHistogramIndex, label, refreshPreviousLMR=True, refreshOverlay=False)
renameClass(newClassName, label)
resetPlugin()
savable = False
setBinCount(binCount)
setBrushSize(aSizeInMeter)
setClassColor(labelIdx, orsColor)
setCursor(handleName)

Sets the current cursor

Parameters:state (str) – state associated to the cursor to set
setDatasets(axisXDatasetGUID, axisYDatasetGUID, axisXDatasetTIndex, axisYDatasetTIndex, ROIGUID, ROITIndex)
setSobel2DAxisXDatasetGUID(sobel2DAxisXDatasetGUID)
setSobel3DAxisXDatasetGUID(sobel3DAxisXDatasetGUID)
showInToolbar = True
shrinkBrush()
startUIClusteringAlgorithm(clusteringAlgorithmName, threshold)
startUISegmentationAlgorithm(segmentationAlgorithmName)
classmethod startupDefault(openMainForm=True)

Creates an instance of the plugin class and opens the main form (if required) at the default position.

Returns:output (AbstractPlugin) – plugin instance
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>]
switchToHistographicSegmentationBrushAddAction()
switchToHistographicSegmentationBrushRemoveAction()
classmethod toolsMenu()
undoLastOperationOnLMRHistogramPaintingOverlay()
updateROIHistogramRange(visibility, minThresholdValue=0, maxThresholdValue=100, histogramData=[])
useSobel(datasetGUID, tStep, kernel='3D')