OpticalFlow

Inheritance diagram

Classes

OpticalFlow

class ORSModel.ors.OpticalFlow

Bases: ORSModel.ors.Unmanaged

computeAverageSpeedAndRotation(self, bUsePonderationByIntensityIm1: bool, pAverageSpeedX: float, pAverageSpeedY: float, pAverageSpeedZ: float, pAverageRotationAroundZ: float, pBarycenterX: float, pBarycenterY: float) → None

Parameters:

• bUsePonderationByIntensityIm1 (bool) –
• pAverageSpeedX (float) –
• pAverageSpeedY (float) –
• pAverageSpeedZ (float) –
• pAverageRotationAroundZ (float) –
• pBarycenterX (float) –
• pBarycenterY (float) –

computeOpticalFlow(self) → None

createGaussianPyramid(self, pIOutChannelsGaussianPyramidIm1: ORSModel.ors.Channel, pIOutChannelsGaussianPyramidIm2: ORSModel.ors.Channel, pNumberOfLevels: int) → None

Parameters:

• pIOutChannelsGaussianPyramidIm1 (ORSModel.ors.Channel) –
• pIOutChannelsGaussianPyramidIm2 (ORSModel.ors.Channel) –
• pNumberOfLevels (int) –

findMaximalLevelGaussianPyramid(self) → int

Returns:output (int) –

findMaximalLevelGaussianPyramidChannelAWithChannelB(self, pIBoundingBoxSearchArea: ORSModel.ors.Box) → int

Parameters:pIBoundingBoxSearchArea (ORSModel.ors.Box) – Returns:output (int) –

findMaximalLevelGaussianPyramidForThisImageSize(self, sizeX: int, sizeY: int, sizeZ: int, bPerformZReduction: bool) → int

Parameters:

• sizeX (int) –
• sizeY (int) –
• sizeZ (int) –
• bPerformZReduction (bool) –

Returns:

output (int) –

findMinimalLevelGaussianPyramidForGivenPrecision(self, pIBoundingBoxReferenceIm1: ORSModel.ors.Box, pIBoundingBoxSearchArea: ORSModel.ors.Box, minimalDistanceToStopOpticalFlow: float, minimalRotationToStopOpticalFlow: float, maximalNumberOfIterationsOpticalFlow: int, acceptableRelativeError: float) → int

Parameters:

• pIBoundingBoxReferenceIm1 (ORSModel.ors.Box) –
• pIBoundingBoxSearchArea (ORSModel.ors.Box) –
• minimalDistanceToStopOpticalFlow (float) –
• minimalRotationToStopOpticalFlow (float) –
• maximalNumberOfIterationsOpticalFlow (int) –
• acceptableRelativeError (float) –

Returns:

output (int) –

getChannelIm1(self) → Channel

Returns:output (ORSModel.ors.Channel) –

getChannelIm2(self) → Channel

Returns:output (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –

getFactorRegularizationSpeedCorrection(self) → float

Returns:output (float) –

getLastDisplacementRegistration2DTransformation(self, pAverageSpeedX: float, pAverageSpeedY: float, pAverageRotationAroundZ: float, pBarycenterX: float, pBarycenterY: float) → None

Parameters:

• pAverageSpeedX (float) –
• pAverageSpeedY (float) –
• pAverageRotationAroundZ (float) –
• pBarycenterX (float) –
• pBarycenterY (float) –

getMaxLevelGaussianPyramid(self) → int

Returns:output (int) –

getMaximalConditionValueRegularizedAtransposeA(self) → float

Returns:output (float) –

getMinLevelGaussianPyramid(self) → int

Returns:output (int) –

getOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

getOriginPixelsIm1(self, x: int, y: int, z: int, t: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –
• t (int) –

getOriginPixelsIm2(self, x: int, y: int, z: int, t: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –
• t (int) –

getPatchWindowHalfsize(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

getPerformZReduction(self) → bool

Returns:output (bool) –

getSizeImagesPixels(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

getSizePixelsAverageSpeed(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

getUpsampleSpeedToSameSizeAsBaseChannel(self) → bool

Returns:output (bool) –

getUseBrightnessCorrectionFactors(self, pValueLinearFactor: bool, pValueConstantFactor: bool) → None

Parameters:

• pValueLinearFactor (bool) –
• pValueConstantFactor (bool) –

getUseRotationAroundZ(self) → bool

Returns:output (bool) –

getUseTranslationX(self) → bool

Returns:output (bool) –

getUseTranslationY(self) → bool

Returns:output (bool) –

getXSpeed(self) → Channel

Returns:output (ORSModel.ors.Channel) –

getYSpeed(self) → Channel

Returns:output (ORSModel.ors.Channel) –

getZSpeed(self) → Channel

Returns:output (ORSModel.ors.Channel) –

none() → OpticalFlow

Returns:output (OpticalFlow) –

registration2DTransformation(self, pIBoundingBoxReferenceIm1: ORSModel.ors.Box, pIBoundingBoxSearchArea: ORSModel.ors.Box, minimalDistanceToStopOpticalFlow: float, minimalRotationToStopOpticalFlow: float, maximalNumberOfIterationsOpticalFlow: int, bApplyTransformation: bool, IProgress: ORSModel.ors.Progress) → Matrix4x4

Parameters:

• pIBoundingBoxReferenceIm1 (ORSModel.ors.Box) –
• pIBoundingBoxSearchArea (ORSModel.ors.Box) –
• minimalDistanceToStopOpticalFlow (float) –
• minimalRotationToStopOpticalFlow (float) –
• maximalNumberOfIterationsOpticalFlow (int) –
• bApplyTransformation (bool) –
• IProgress (ORSModel.ors.Progress) –

Returns:

output (ORSModel.ors.Matrix4x4) –

setChannelIm1(self, pIInputChannel: ORSModel.ors.Channel) → None

Parameters:pIInputChannel (ORSModel.ors.Channel) –

setChannelIm2(self, pIInputChannel: ORSModel.ors.Channel) → None

Parameters:pIInputChannel (ORSModel.ors.Channel) –

setFactorRegularizationSpeedCorrection(self, value: float) → None

Parameters:value (float) –

setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int) → None

Parameters:

• minLevel (int) –
• maxLevel (int) –

setMaximalConditionValueRegularizedAtransposeA(self, value: float) → None

Parameters:value (float) –

setOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

setOriginPixelsIm1(self, x: int, y: int, z: int, t: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –
• t (int) –

setOriginPixelsIm2(self, x: int, y: int, z: int, t: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –
• t (int) –

setPatchWindowHalfsize(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

setPerformZReduction(self, bValue: bool) → None

Parameters:bValue (bool) –

setSizeImagesPixels(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

setSizePixelsAverageSpeed(self, x: int, y: int, z: int) → None

Parameters:

• x (int) –
• y (int) –
• z (int) –

setUpsampleSpeedToSameSizeAsBaseChannel(self, bValue: bool) → None

Parameters:bValue (bool) –

setUseBrightnessCorrectionFactors(self, bValueLinearFactor: bool, bValueConstantFactor: bool) → None

Parameters:

• bValueLinearFactor (bool) –
• bValueConstantFactor (bool) –

setUseRotationAroundZ(self, bValue: bool) → None

Parameters:bValue (bool) –

setUseTranslationX(self, bValue: bool) → None

Parameters:bValue (bool) –

setUseTranslationY(self, bValue: bool) → None

Parameters:bValue (bool) –

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSModel.ors.ORSBaseClass

brief_description: Abstract class for objects that are not managed by the core library. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

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) – a managed 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) → 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)

classmethod getAllSubclasses(outputCollection=None)

classmethod getClassDenomination()

static getClassFromProgId(progId)

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) –

classmethod getIsSubclassOf(parentClass)

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

brief_description: An abstract class from which all objects issued from the author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

getPythonTraceBack() → typing.List[str]

Set the python traceback for a call from python.

Returns:output (typing.List[str]) –

isManaged(self) → bool

Returns:output (bool) –

isNone(self) → bool

Returns:output (bool) –

setPythonTraceBack(tb: ORSModel.ors.typing.List[str]) → None

Set the python traceback for a call from python.

Parameters:tb (typing.List[str]) –