ConvolutionKernel

Inheritance diagram

Classes

ConvolutionKernel

class ORSModel.ors.ConvolutionKernel(self, pythonRepresentation: str, isPythonRepresentation: bool)

Bases: Unmanaged

Parameters:

• pythonRepresentation (str) –

• isPythonRepresentation (bool) –

ConvolutionKernel.__init__(self)

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

Create aConvolutionKernel from a python representation a static method.

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.ConvolutionKernel) –

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getElementSummation(self) → float

Returns:

output (float) –

getIs1DKernel(self) → bool

Returns:

output (bool) –

getIs2DKernel(self) → bool

Returns:

output (bool) –

getIs3DKernel(self) → bool

Returns:

output (bool) –

getIsEqualTo(self, aConvolutionKernel: ORSModel.ors.ConvolutionKernel) → bool

Checks for equality to another kernel.

Parameters:

aConvolutionKernel (ORSModel.ors.ConvolutionKernel) – a kernel (a ConvolutionKernel)

Returns:

output (bool) – TRUE if the kernels are equal, FALSE otherwise

getKernelStarPoint(self, pIndexX: int, pIndexY: int, pIndexZ: int)

Parameters:

• pIndexX (int) –

• pIndexY (int) –

• pIndexZ (int) –

getKernelXSize(self) → int

Returns:

output (int) –

getKernelYSize(self) → int

Returns:

output (int) –

getKernelZSize(self) → int

Returns:

output (int) –

getValueAt(self, indexX: int, indexY: int, indexZ: int) → float

Parameters:

• indexX (int) –

• indexY (int) –

• indexZ (int) –

Returns:

output (float) –

initializeAs1DKernel(self, indexX: int)

Parameters:

indexX (int) –

initializeAs2DKernel(self, indexX: int, indexY: int)

Parameters:

• indexX (int) –

• indexY (int) –

initializeAs3DKernel(self, indexX: int, indexY: int, indexZ: int)

Parameters:

• indexX (int) –

• indexY (int) –

• indexZ (int) –

multiplyAllElementBy(self, aValue: float)

Parameters:

aValue (float) –

none() → ConvolutionKernel

Returns:

output (ConvolutionKernel) –

setAsGaussianWithMinimumUnnormalizedSmallestValue(self, aValue: float)

Parameters:

aValue (float) –

setAsGaussianWithStandarDeviation(self, sigma: float)

Parameters:

sigma (float) –

setKernelStarPoint(self, indexX: int, indexY: int, indexZ: int)

Parameters:

• indexX (int) –

• indexY (int) –

• indexZ (int) –

setValueAt(self, indexX: int, indexY: int, indexZ: int, aValue: float)

Parameters:

• indexX (int) –

• indexY (int) –

• indexZ (int) –

• aValue (float) –

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