ConvolutionKernel

Inheritance diagram

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

Classes

ConvolutionKernel

class ORSModel.ors.ConvolutionKernel

Bases: ORSModel.ors.Unmanaged

createFromPythonRepresentation(aPythonRepresentation: str) → 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) → None
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) → None
Parameters:indexX (int) –
initializeAs2DKernel(self, indexX: int, indexY: int) → None
Parameters:
  • indexX (int) –
  • indexY (int) –
initializeAs3DKernel(self, indexX: int, indexY: int, indexZ: int) → None
Parameters:
  • indexX (int) –
  • indexY (int) –
  • indexZ (int) –
multiplyAllElementBy(self, aValue: float) → None
Parameters:aValue (float) –
none() → ConvolutionKernel
Returns:output (ConvolutionKernel) –
setAsGaussianWithMinimumUnnormalizedSmallestValue(self, aValue: float) → None
Parameters:aValue (float) –
setAsGaussianWithStandarDeviation(self, sigma: float) → None
Parameters:sigma (float) –
setKernelStarPoint(self, indexX: int, indexY: int, indexZ: int) → None
Parameters:
  • indexX (int) –
  • indexY (int) –
  • indexZ (int) –
setValueAt(self, indexX: int, indexY: int, indexZ: int, aValue: float) → None
Parameters:
  • indexX (int) –
  • indexY (int) –
  • indexZ (int) –
  • aValue (float) –

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