OrsVolumeROIVisibilityManager

Plugin managing the visibility of ROIs

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.
date:July 2017
dragonflyVersion:
 3.1.0.286 (D)
UUID:865452a8761e11e7b4d5448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsVolumeROIVisibilityManager.OrsVolumeROIVisibilityManager.OrsVolumeROIVisibilityManager(varname=None, managed=True)
class StateData(node, volumeROIVisual, view)
isDirty(node, volumeROIVisual, display, includeProperty=True)
update(node, volumeROIVisual, display)
VOLUME_ROI_CHANNEL_TITLE = 'volume_roi_channel'
addGlobalCallbacks()
addROIToVolumeROIChannels(volumeROIVisual, roi)
closable = False
createVisibilityStateData(volumeROIVisual, roi, view)
deleteROILabel(volumeROIVisual, node)
classmethod findOrsObjectInList(x, iterable)
classmethod getAbout()
classmethod getDownSampleSizeForChannel(iXSize: int, iYSize: int, iZSize: int, iByte: int)

iXSize iYSize iZSize iByte

Returns:output – an OrsVector containing the new x,y,z values
getROILabel(volumeROIVisual, node)
getState()
getVisibilityStateData(volumeROIVisual, roi)
keepAlive = False
multiple = False
onChangeViewMode(displayGUID)

If a display view mode change from non 3D to 3D we must check for updates in the volume roi channel

Parameters:displayGUID – the guid of the display
onLayoutChange(layoutGUID)

If a layout change, we must check for updates in the volume roi channel if a display is in 3D view mode

Parameters:layoutGUID – the guid of the layout
onROIDataDirty(guid)
onROIDeleted(objectGUID)
onROIGeometryDirty(guid)
onROIPropertyDirty(guid)
onROIVisibilityDirty(guid)
onVisualROIDeleted(objectGUID)
onVolumeROIVisibilityUpdate(volumeROIVisual)
onVolumeROIVisualPropertyChange(guid)
removeROIFromVolumeROIChannels(volumeROIVisual, roi)
savable = True
setState(state)
setVisibilityStateData(volumeROIVisual, roi, stateData)
updateROIGeometryInVolumeROIChannels(volumeROIVisual, roi)
updateROIInVolumeROIChannels(volumeROIVisual, roi)
updateRoiLuts(volumeROIVisual, roi, updateStateData=True)

Update the lut for a given volume for the volumeROIChannel under the volumeROIVisual for a given ROI/multiROI.

Parameters:
Return:

a bool indicating that the channel had been updated

updateVisibilityStateData(volumeROIVisual, roi)
updateVolumeROIVisualLut(volumeROIVisual)