ChannelRegistrationHelper

Inheritance diagram

Classes

ChannelRegistrationHelper

class ORSModel.ors.ChannelRegistrationHelper(self)

Bases: Unmanaged

applyTransformationDegreeOfFreedomOnChannel(self, kindOfDegreeOfFreedom: int, numeroDirection: int, backward: bool)

Parameters:

• kindOfDegreeOfFreedom (int) –

• numeroDirection (int) –

• backward (bool) –

getChannelA(self) → ORSModel.ors.Channel

Returns:

output (ORSModel.ors.Channel) –

getChannelB(self) → ORSModel.ors.Channel

Returns:

output (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getCurrentSimilarity(self) → float

Returns:

output (float) –

getEpsilonRotation(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3) –

getEpsilonScaleFactor(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3) –

getEpsilonTranslation(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3) –

getFactorOfCompressionHistogramA(self) → int

Returns:

output (int) –

getFactorOfCompressionHistogramB(self) → int

Returns:

output (int) –

getHistogramASize(self) → int

Returns:

output (int) –

getHistogramBSize(self) → int

Returns:

output (int) –

getMaxSimilarityMetric(self) → float

Returns:

output (float) –

getMutualInformationFor(self, p_entropyA: float, p_entropyB: float, p_entropyAB: float, histoASize: int, histoBSize: int, fractionOfChannelConsidered: float) → float

Parameters:

• p_entropyA (float) –

• p_entropyB (float) –

• p_entropyAB (float) –

• histoASize (int) –

• histoBSize (int) –

• fractionOfChannelConsidered (float) –

Returns:

output (float) –

getNearestInterpolation(self) → bool

Returns:

output (bool) –

getRegistration3DTransformation(self, bApplyTransformation: bool, IProgress: ORSModel.ors.Progress) → ORSModel.ors.Matrix4x4

Parameters:

• bApplyTransformation (bool) –

• IProgress (ORSModel.ors.Progress) –

Returns:

output (ORSModel.ors.Matrix4x4) –

getRotationScaleCenter(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3) –

getRotationScaleCenterAlwaysAtCenter(self) → bool

Returns:

output (bool) –

getSearchDeltaRotation(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3) –

getSearchDeltaScaleFactor(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3) –

getSearchDeltaTranslation(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3) –

getSuggestedHistogramSizesSturgesRule(self, pIChannelA: ORSModel.ors.Channel, pIChannelB: ORSModel.ors.Channel) → int

Parameters:

• pIChannelA (ORSModel.ors.Channel) –

• pIChannelB (ORSModel.ors.Channel) –

Returns:

output (int) –

getTimeA(self) → int

Returns:

output (int) –

getTimeB(self) → int

Returns:

output (int) –

getUseMultiScale(self) → bool

Returns:

output (bool) –

getUseMutualInfo(self) → bool

Returns:

output (bool) –

getXSampling(self) → int

Returns:

output (int) –

getYSampling(self) → int

Returns:

output (int) –

getZSampling(self) → int

Returns:

output (int) –

none() → ChannelRegistrationHelper

Returns:

output (ChannelRegistrationHelper) –

resetRotationScaleCenter(self)

setChannelA(self, pIChannel: ORSModel.ors.Channel)

Parameters:

pIChannel (ORSModel.ors.Channel) –

setChannelAB(self, pIChannelA: ORSModel.ors.Channel, pIChannelB: ORSModel.ors.Channel)

Parameters:

• pIChannelA (ORSModel.ors.Channel) –

• pIChannelB (ORSModel.ors.Channel) –

setChannelB(self, pIChannel: ORSModel.ors.Channel)

Parameters:

pIChannel (ORSModel.ors.Channel) –

setEpsilonRotation(self, pVector: ORSModel.ors.Vector3)

Parameters:

pVector (ORSModel.ors.Vector3) –

setEpsilonScaleFactor(self, pVector: ORSModel.ors.Vector3)

Parameters:

pVector (ORSModel.ors.Vector3) –

setEpsilonTranslation(self, pVector: ORSModel.ors.Vector3)

Parameters:

pVector (ORSModel.ors.Vector3) –

setFactorOfCompressionHistogramA(self, factor: int)

Parameters:

factor (int) –

setFactorOfCompressionHistogramB(self, factor: int)

Parameters:

factor (int) –

setHistogramASize(self, value: int)

Parameters:

value (int) –

setHistogramBSize(self, value: int)

Parameters:

value (int) –

setMask(self, pROiMask: ORSModel.ors.ROI)

Parameters:

pROiMask (ORSModel.ors.ROI) –

setNearestInterpolation(self, aFlag: bool)

Parameters:

aFlag (bool) –

setRotationScaleCenter(self, pVect: ORSModel.ors.Vector3)

Parameters:

pVect (ORSModel.ors.Vector3) –

setRotationScaleCenterAlwaysAtCenter(self, aFlag: bool)

Parameters:

aFlag (bool) –

setSearchDeltaEpsilonRotation(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float)

Parameters:

• pIInputChannel (ORSModel.ors.Channel) –

• searchDelta (float) –

• epsilon (float) –

setSearchDeltaEpsilonScaleFactor(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float)

Parameters:

• pIInputChannel (ORSModel.ors.Channel) –

• searchDelta (float) –

• epsilon (float) –

setSearchDeltaEpsilonTranslation(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float)

Parameters:

• pIInputChannel (ORSModel.ors.Channel) –

• searchDelta (float) –

• epsilon (float) –

setSearchDeltaRotation(self, pVector: ORSModel.ors.Vector3)

Parameters:

pVector (ORSModel.ors.Vector3) –

setSearchDeltaScaleFactor(self, pVector: ORSModel.ors.Vector3)

Parameters:

pVector (ORSModel.ors.Vector3) –

setSearchDeltaTranslation(self, pVector: ORSModel.ors.Vector3)

Parameters:

pVector (ORSModel.ors.Vector3) –

setSearchDirectionBox(self, pIChannelBox: ORSModel.ors.Box)

Parameters:

pIChannelBox (ORSModel.ors.Box) –

setSearchDirectionChannel(self, pIChannel: ORSModel.ors.Channel)

Parameters:

pIChannel (ORSModel.ors.Channel) –

setTimeA(self, time: int)

Parameters:

time (int) –

setTimeB(self, time: int)

Parameters:

time (int) –

setUseMultiScale(self, aFlag: bool)

Parameters:

aFlag (bool) –

setUseMutualInfo(self, aFlag: bool)

Parameters:

aFlag (bool) –

setXSampling(self, aSampling: int)

Parameters:

aSampling (int) –

setYSampling(self, aSampling: int)

Parameters:

aSampling (int) –

setZSampling(self, aSampling: int)

Parameters:

aSampling (int) –

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSBaseClass

Abstract class for objects that are not managed by the core library. Unmanaged objects are transient objects.

atomicLoad(sFilename: str) → Unmanaged

Creates an object from a file where an object was saved.

Parameters:

sFilename (str) – path of the file to load

Returns:

output (Unmanaged) – an unmanaged object, or none() if the load fails

atomicSave(self, aFilename: str) → int

Saves the object to a file.

Parameters:

aFilename (str) – path of the file to save

Returns:

output (int) – 0 if successful, otherwise an error code

createFromPythonRepresentation(aPythonRepresentation: str) → ORSModel.ors.Unmanaged

Create aUnmanaged Object from a python representation a static method.

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.Unmanaged) –

fromPythonRepresentation(self, aPythonRepresentation: str) → bool

Create aUnmanaged object from a Python string representation.

Parameters:

aPythonRepresentation (str) – a Python evaluable string representation (a string)

Returns:

output (bool) – true if parsing worked, false otherwise (a bool)

getClassName(self) → str

Retrieves the class name of the core object wrapped by this Interface object.

Returns:

output (str) –

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getDataChecksum(self) → str

Returns:

output (str) –

getIsInstanceOf(self, pProgId: str) → bool

Queries the object to know if it is an instance of a certain class.

Parameters:

pProgId (str) –

Returns:

output (bool) –

getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:

output (str) –

isNone(self) → bool

Checks if the receiver is none.

Returns:

output (bool) –

isNotNone(self) → bool

Checks if the receiver is not none.

Returns:

output (bool) –

none() → Unmanaged

Returns:

output (Unmanaged) –

ORSBaseClass

class ORSModel.ors.ORSBaseClass

An abstract class from which all objects issued from the ORS Core Library inherit.

getPythonTraceBack() → List[str]

Set the python traceback for a call from python.

Returns:

output (List[str]) –

isManaged(self) → bool

Returns:

output (bool) –

isNone(self) → bool

Returns:

output (bool) –

setPythonTraceBack(tb: List[str])

Set the python traceback for a call from python.

Parameters:

tb (List[str]) –