OpticalFlow

Inheritance diagram

Inheritance diagram of ORSModel.ors.OpticalFlow, ORSModel.ors.Unmanaged, ORSModel.ors.ORSBaseClass

Classes

OpticalFlow

class ORSModel.ors.OpticalFlow(self)

Bases: Unmanaged

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

  • bUsePonderationByIntensityIm1 (bool)

  • pAverageSpeedX (float)

  • pAverageSpeedY (float)

  • pAverageSpeedZ (float)

  • pAverageRotationAroundZ (float)

  • pBarycenterX (float)

  • pBarycenterY (float)

computeOpticalFlow(self)
createGaussianPyramid(self, pIOutChannelsGaussianPyramidIm1: ORSModel.ors.Channel, pIOutChannelsGaussianPyramidIm2: ORSModel.ors.Channel, pNumberOfLevels: int)
Parameters:
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) → ORSModel.ors.Channel
Returns:

output (ORSModel.ors.Channel)

getChannelIm2(self) → ORSModel.ors.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)
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)
Parameters:

  • x (int)

  • y (int)

  • z (int)

getOriginPixelsIm1(self, x: int, y: int, z: int, t: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

  • t (int)

getOriginPixelsIm2(self, x: int, y: int, z: int, t: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

  • t (int)

getPatchWindowHalfsize(self, x: int, y: int, z: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

getPerformZReduction(self) → bool
Returns:

output (bool)

getSizeImagesPixels(self, x: int, y: int, z: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

getSizePixelsAverageSpeed(self, x: int, y: int, z: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

getUpsampleSpeedToSameSizeAsBaseChannel(self) → bool
Returns:

output (bool)

getUseBrightnessCorrectionFactors(self, pValueLinearFactor: bool, pValueConstantFactor: bool)
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) → ORSModel.ors.Channel
Returns:

output (ORSModel.ors.Channel)

getYSpeed(self) → ORSModel.ors.Channel
Returns:

output (ORSModel.ors.Channel)

getZSpeed(self) → ORSModel.ors.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) → ORSModel.ors.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)
Parameters:

pIInputChannel (ORSModel.ors.Channel)

setChannelIm2(self, pIInputChannel: ORSModel.ors.Channel)
Parameters:

pIInputChannel (ORSModel.ors.Channel)

setFactorRegularizationSpeedCorrection(self, value: float)
Parameters:

value (float)

setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int)
Parameters:

  • minLevel (int)

  • maxLevel (int)

setMaximalConditionValueRegularizedAtransposeA(self, value: float)
Parameters:

value (float)

setOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

setOriginPixelsIm1(self, x: int, y: int, z: int, t: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

  • t (int)

setOriginPixelsIm2(self, x: int, y: int, z: int, t: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

  • t (int)

setPatchWindowHalfsize(self, x: int, y: int, z: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

setPerformZReduction(self, bValue: bool)
Parameters:

bValue (bool)

setSizeImagesPixels(self, x: int, y: int, z: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

setSizePixelsAverageSpeed(self, x: int, y: int, z: int)
Parameters:

  • x (int)

  • y (int)

  • z (int)

setUpsampleSpeedToSameSizeAsBaseChannel(self, bValue: bool)
Parameters:

bValue (bool)

setUseBrightnessCorrectionFactors(self, bValueLinearFactor: bool, bValueConstantFactor: bool)
Parameters:

  • bValueLinearFactor (bool)

  • bValueConstantFactor (bool)

setUseRotationAroundZ(self, bValue: bool)
Parameters:

bValue (bool)

setUseTranslationX(self, bValue: bool)
Parameters:

bValue (bool)

setUseTranslationY(self, bValue: bool)
Parameters:

bValue (bool)

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.

isManaged(self) → bool
Returns:

output (bool)

isNone(self) → bool
Returns:

output (bool)