OrsChannelRegistration

Manages registering a dataset against others

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:Feb 04 2016 17:25 dragonflyVersion:  3.0 UUID:f7187e82760f11e7b3a1448a5b5d70c0

Class Code

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

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

closable = True

closeWidget(name)

computeMetricSimilarity(nearestInterpolationMethod, mutualInfoRegistrationMethod)

classmethod contextualMenu(context)

getBoxAfter()

getBoxBefore()

getBoxCenterAfter()

getBoxCenterBefore()

getFixedChannelGUID()

getInitialValues()

getIsFirstTransformationOnChannel()

getMaskGUID()

getMetricSimilarity()

getMobileChannelGUID()

getTransformationMatrix()

getUseAMask()

keepAlive = False

multiple = False

classmethod openChannelRegistration(channelGUID)

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

interfacemethod register(fixedChannel, mobileChannel, useScale, useRotation, useTranslation, xScaleInitial, yScaleInitial, zScaleInitial, xRotationInitial, yRotationInitial, zRotationInitial, xTranslationInitial, yTranslationInitial, zTranslationInitial, xScaleSmallest, yScaleSmallest, zScaleSmallest, xRotationSmallest, yRotationSmallest, zRotationSmallest, xTranslationSmallest, yTranslationSmallest, zTranslationSmallest, nearestInterpolationMethod, mutualInfoRegistrationMethod, xSampling, ySampling, zSampling, mask=None, useMultiScale=True)

Register a mobile dataset with a fixed dataset.

Parameters:

• fixedChannel (ORSModel.ors.Channel) – reference dataset (fixed in space).
• mobileChannel (ORSModel.ors.Channel) – mobile dataset.
• useScale (bool) – if True, the scale factor will be used.
• useRotation (bool) – if True, the rotation factor will be used.
• useTranslation (bool) – if True, the translation factor will be used.
• xScaleInitial (float) – initial value for the scale factor in the X direction
• yScaleInitial (float) – initial value for the scale factor in the Y direction
• zScaleInitial (float) – initial value for the scale factor in the Z direction
• xRotationInitial (float) – initial value for the rotation factor in the X direction
• yRotationInitial (float) – initial value for the rotation factor in the Y direction
• zRotationInitial (float) – initial value for the rotation factor in the Z direction
• xTranslationInitial (float) – initial value for the translation factor in the X direction
• yTranslationInitial (float) – initial value for the translation factor in the Y direction
• zTranslationInitial (float) – initial value for the translation factor in the Z direction
• xScaleSmallest (float) – final value for the scale factor in the X direction
• yScaleSmallest (float) – final value for the scale factor in the Y direction
• zScaleSmallest (float) – final value for the scale factor in the Z direction
• xRotationSmallest (float) – final value for the rotation factor in the X direction
• yRotationSmallest (float) – final value for the rotation factor in the Y direction
• zRotationSmallest (float) – final value for the rotation factor in the Z direction
• xTranslationSmallest (float) – final value for the translation factor in the X direction
• yTranslationSmallest (float) – final value for the translation factor in the Y direction
• zTranslationSmallest (float) – final value for the translation factor in the Z direction
• nearestInterpolationMethod (bool) – if True, the nearest interpolation method will be used; if False, the linear interpolation will be used.
• mutualInfoRegistrationMethod (bool) – if True, the mutual information registration algorithm will be used; if False, the SSD registration algorithm will be used.
• xSampling (int) – sampling in the X direction for the similarity metric
• ySampling (int) – sampling in the Y direction for the similarity metric
• zSampling (int) – sampling in the Z direction for the similarity metric
• mask (ORSModel.ors.ROI, ORSModel.ors.VisualShape3D) – Visual Shape 3D or ROI that mask pixels of fixed dataset to make a scored registration.
• useMultiScale (bool) – Use a multiscale step in the registration

Returns:

• transformationMatrix (ORSModel.ors.Matrix4x4) – transformation matrix to go from the original location of the mobile dataset to the final location of the mobile dataset
• metricSimilarity (float) – value of the similarity obtained by the registration

registerWithFixedAndMobileChannels(useScale, useRotation, useTranslation, xScaleInitial, yScaleInitial, zScaleInitial, xRotationInitial, yRotationInitial, zRotationInitial, xTranslationInitial, yTranslationInitial, zTranslationInitial, xScaleSmallest, yScaleSmallest, zScaleSmallest, xRotationSmallest, yRotationSmallest, zRotationSmallest, xTranslationSmallest, yTranslationSmallest, zTranslationSmallest, nearestInterpolationMethod, mutualInfoRegistrationMethod, useMultiScale)

savable = False

setFixedChannel(fixedChannel)

setMask(mask)

setMaskGUID(maskGUID)

setMobileChannel(mobileChannel)

setUseAMask(bool)

undoLastTransform()