ROIAnalyzer

Inheritance diagram

Classes

ROIAnalyzer

class ORSModel.ors.ROIAnalyzer

Bases: Unmanaged

Analyzer for ROIs.

geVolumeWasComputed(self) → bool

Returns:

output (bool)

getCenterOfMass(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3)

getCenterOfMassWasComputed(self) → bool

Returns:

output (bool)

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str)

getInertiaTensorPrincipalComponent(self) → ORSModel.ors.Vector3

Returns:

output (ORSModel.ors.Vector3)

getInertiaTensorPrincipalComponentWasComputed(self) → bool

Returns:

output (bool)

getLongestDistance(self) → float

Returns:

output (float)

getLongestDistanceWasComputed(self) → bool

Returns:

output (bool)

getLongestLineSegment(self) → ORSModel.ors.LineSegment

Returns:

output (ORSModel.ors.LineSegment)

getLongestSegmentWasComputed(self) → bool

Returns:

output (bool)

getMax(self) → float

Returns:

output (float)

getMaxInPhysicalUnits(self) → float

Returns:

output (float)

getMean(self) → float

Returns:

output (float)

getMeanInPhysicalUnits(self) → float

Returns:

output (float)

getMeanWasComputed(self) → bool

Returns:

output (bool)

getMin(self) → float

Returns:

output (float)

getMinInPhysicalUnits(self) → float

Returns:

output (float)

getMinMaxWasComputed(self) → bool

Returns:

output (bool)

getMode(self) → float

Returns:

output (float)

getModeInPhysicalUnits(self) → float

Returns:

output (float)

getStandardDeviation(self) → float

Returns:

output (float)

getStandardDeviationInPhysicalUnits(self) → float

Returns:

output (float)

getStandardDeviationWasComputed(self) → bool

Returns:

output (bool)

getSurfaceArea(self) → float

Returns:

output (float)

getSurfaceAreaInPhysicalUnits(self) → float

Returns:

output (float)

getSurfaceAreaWasComputed(self) → bool

Returns:

output (bool)

getTimeStep(self) → int

Returns:

output (int)

getVoxelCount(self) → int

Gets the voxel count of theROI.

Note

Only the voxels inside the channel are considered.

Returns:

output (int) – the voxel count (an uint64_t)

none() → ROIAnalyzer

Returns:

output (ROIAnalyzer)

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)