OrsDatasetSlicesRegistration

To register slices within a dataset

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 2020. date:Dec 23 2015 15:22 dragonflyVersion:  3.0 UUID:b815e24c761111e79c36448a5b5d70c0

Class Code

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

OrsStateMoveRotateHandleSliceRegistration = 'OrsStateMoveRotateHandleSliceRegistration'

OrsStateMoveRotateHandleSliceRegistrationActivation()

OrsStateMoveRotatePivotSliceRegistration = 'OrsStateMoveRotatePivotSliceRegistration'

OrsStateMoveRotatePivotSliceRegistrationActivation()

OrsStateMoveSliceRegistration = 'OrsStateMoveSliceRegistration'

OrsStateMoveSliceRegistrationActivation()

OrsStateMoveTranslateSliceRegistration = 'OrsStateMoveTranslateSliceRegistration'

OrsStateMoveTranslateSliceRegistrationActivation()

PLUGIN_ORSBASICMANIPULATE = 'OrsBasicManipulate'

PLUGIN_ORSBUSYNESSMANAGER = 'OrsBusynessManager'

PLUGIN_ORSCLIPBOXMANIPULATOR = 'OrsClipBoxManipulator'

PLUGIN_ORSHIGHLIGHTMANAGER = 'OrsHighlightManager'

PLUGIN_ORSLEGENDMANIPULATOR = 'OrsLegendManipulator'

PLUGIN_ORSSTATESELECTOR = 'OrsStateSelector'

PLUGIN_ORSTEXTPRESENTERMANAGER = 'OrsTextPresenterManager'

PLUGIN_ORSWLFORDATASETSLICESREGISTRATION = 'OrsWLForDatasetSlicesRegistration'

UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]

XDirection = 0

YDirection = 1

ZDirection = 2

addAppliedRegistrationToStack(aRegistration, aDescription=None, refresh=True)

addDummyRegistrationToAffectDataset(translateX, translateY, rotate, aTitle=None, patern=None, debugMode=True)

addGlobalXMLRegistrationToRegistrationList(globalRegistrationXML)

allDirection = (0, 1, 2)

applyToAnotherDataset(aDataset, outputShape)

buildGlobalXMLRegistration()

canBeGenericallyOpened = False

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.

clearAllRegistrationInStack()

clearListUnappliedRegistrations()

closable = True

closeWidget(name)

classmethod contextualMenu(context)

datasetIsForSliceDisplayOnly(dataset)

deleteAllDatasetsForSlicesDisplay()

deleteGlobalXMLRegistration(fileName, path=None)

displayLateralView(value)

classmethod generateTestChannelOne(square=True, offsetInPixel=2)

getActualRegistration()

getActuelRegistrationDescription()

getAppliedRegistration(index)

getClipBox()

classmethod getContextName()

getCropOutputBox()

getCurrentSliceIndex(dataset, display=None, dimensionIdx=None)

getCurrentSliceTransformationForRegistrationsAdded(dataset, numberRegistrationAdded)

getCurrentXMLRegistration(registrationXML)

getDescriptionFromAppliedRegistration(index)

getDescriptionFromOldRegistration(index)

getDescriptionFromUnappliedRegistration(index)

getDisplay(directionIdx)

getGlobalRegistrationKeyDataFromXML(globalRegistrationXML, key)

getLayout(directionIdx)

getListAppliedRegistrations()

getMainDisplay()

classmethod getMainFormClass()

getMainSliceDataset()

getMainSliceVolume()

getMaxSliceIndex(dataset, dimensionIdx=None)

getNbAppliedRegistrationsInStack()

getNbOldRegistrations()

getNbRegistrationsInDatasetUserInfo(aDataset)

getNbTotalRegistrations()

getNbUnappliedRegistrationsInStack()

getRegisteredBox(workingDataset, updateActualRegistration=False)

getRegistrationKeyDataFromXML(registrationXML, key)

getSliceDataset(directionIdx, create=True)

getSliceVolume(directionIdx)

getUnappliedRegistration(index)

getUseBox()

getWorkingDataset() → ORSModel.ors.Channel

getWorkingDisplay()

getWorkingLayout()

getWorkingVolume()

getXZDisplay()

getYZDisplay()

getZSliceFromXML(globalRegistrationXML)

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

initSliceChannel(directionIdx)

keepAlive = False

loadGlobalXMLRegistration(fileName, path=None)

loadOldRegistrationsFromUserInfo()

modalContext = True

multiple = False

onMainSliceChange(display, directionIdx)

onSecondarySliceChange(display, directionIdx)

onSliceChange(display, directionIdx)

popLastAppliedRegistrationInStack()

printAllRegistrationSliceMatrix(workingDataset)

privateObjects = False

refreshDisplayWithRegistration(aDirection)

refreshLateralViews()

refreshOnRegistrationChange()

reloadLastUnappliedRegistrationInStack()

removeRegistrationInStack(aRegistration)

restrictPlugins = True

savable = False

saveDataset(createNewDatasetTitle=None)

saveGlobalXMLRegistration(filepath, fileName)

setWorkingDataset(dataset)

classmethod startup(channelGUID, openMainForm=True)

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

storeSliceRegistrationToDatasetUserInfo(aDataset=None)

updateRegistrationInStack(aRegistration)