MultiROIAnalyzer

Inheritance diagram

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

Classes

MultiROIAnalyzer

class ORSModel.ors.MultiROIAnalyzer

Bases: ORSModel.ors.Unmanaged

brief_description: Analyzer for multi-ROIs. author: Nicolas Piché. All other members of ORS participated. version: 1.0 date: May 2010

computeStatisticsFor(self, IChannel: ORSModel.ors.Channel, pTimeStep: int, IROI: ORSModel.ors.ROI, IProgress: ORSModel.ors.Progress) → None
Parameters:
getCenterOfMassMinMax(self, pXMin: float, pYMin: float, pZMin: float, pXMax: float, pYMax: float, pZMax: float) → None
Parameters:
  • pXMin (float) –
  • pYMin (float) –
  • pZMin (float) –
  • pXMax (float) –
  • pYMax (float) –
  • pZMax (float) –
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getDataHistogramInRangeForLabels(self, IChannel: ORSModel.ors.Channel, IMultiROI: ORSModel.ors.MultiROI, IListOfLabels: ORSModel.ors.ArrayUnsignedLong, tChannel: int, tLMR: int, bins: int, pMinRange: float, pMaxRange: float) → ArrayUnsignedLONGLONG
Parameters:
Returns:

output (ORSModel.ors.ArrayUnsignedLONGLONG) –

getEquivalentRadiusMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getFeretLengthMax(self) → ArrayDouble

Gets maximum feret size.

Returns:output (ORSModel.ors.ArrayDouble) – feret maximum size (an ArrayDouble)
getFeretLengthMean(self) → ArrayDouble

Gets medium feret size.

Returns:output (ORSModel.ors.ArrayDouble) – feret medium size (an ArrayDouble)
getFeretLengthMin(self) → ArrayDouble

Gets minimum feret size.

Returns:output (ORSModel.ors.ArrayDouble) – feret minimum size (an ArrayDouble)
getFeretLengthMinOrtho(self) → ArrayDouble

Gets minimum orthogonal feret diameter.

Returns:output (ORSModel.ors.ArrayDouble) – feret minimum orthogonal (an ArrayDouble)
getIndiciesCountInLabels(self) → ArrayLONGLONG
Returns:output (ORSModel.ors.ArrayLONGLONG) –
getLabelAspectRatio(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelCenterOfMass(self, pLabel: int) → Vector3
Parameters:pLabel (int) –
Returns:output (ORSModel.ors.Vector3) –
getLabelEntropy(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelEquivalentRadius(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelInertiaEigenValue(self, pLabel: int, vectorIndex: int) → float

Gets the eigenvalue of the inertia tensor for the specified label and eigenvalue index.

Parameters:
  • pLabel (int) – label (a uint32_t)
  • vectorIndex (int) – eigenvalue index (0: minimum eigenvalue; 1: medium eigenvalue; 2: maximum eigenvalue) (a uint16_t)
Returns:

output (float) – the eigenvalue (a double)
getLabelInertiaEigenValueMax(self, pLabel: int) → float

Gets the maximum eigenvalue of the inertia tensor for the specified label.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (float) – the eigenvalue (a double)
getLabelInertiaEigenValueMed(self, pLabel: int) → float

Gets the medium eigenvalue of the inertia tensor for the specified label.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (float) – the eigenvalue (a double)
getLabelInertiaEigenValueMin(self, pLabel: int) → float

Gets the minimum eigenvalue of the inertia tensor for the specified label.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (float) – the eigenvalue (a double)
getLabelInertiaEigenVector(self, pLabel: int, vectorIndex: int) → Vector3

Gets the eigenvector associated to an eigenvalue index of the inertia tensor for the specified label.

Parameters:
  • pLabel (int) – label (a uint32_t)
  • vectorIndex (int) – eigenvalue index (0: minimum eigenvalue; 1: medium eigenvalue; 2: maximum eigenvalue) (a uint16_t)
Returns:

output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)
getLabelInertiaEigenVectorWithMaxEigenValue(self, pLabel: int) → Vector3

Gets the eigenvector associated to the maximum eigenvalue of the inertia tensor for the specified label.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)
getLabelInertiaEigenVectorWithMedEigenValue(self, pLabel: int) → Vector3

Gets the eigenvector associated to the medium eigenvalue of the inertia tensor for the specified label.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)
getLabelInertiaEigenVectorWithMinEigenValue(self, pLabel: int) → Vector3

Gets the eigenvector associated to the minimum eigenvalue of the inertia tensor for the specified label.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)
getLabelInertiaEigenVectorWithMinEigenValuePhiAngle(self, pLabel: int) → float

Gets the phi angle for the eigenvector associated to the minimum eigenvalue of the inertia tensor for the specified label. It is the angle from the X axis of the projection on the XZ plane of that orientation.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (float) – the phi angle in radian (a double)
getLabelInertiaEigenVectorWithMinEigenValueThetaAngle(self, pLabel: int) → float

Gets the theta angle for the eigenvector associated to the minimum eigenvalue of the inertia tensor for the specified label. It is the angle from the X axis of the projection on the XY plane of that orientation.

Parameters:pLabel (int) – label (a uint32_t)
Returns:output (float) – the theta angle in radian (a double)
getLabelMaximumVoxel(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelMeanVoxel(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelMinimumVoxel(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelSizeMinMax(self, pMin: int, pMax: int) → None
Parameters:
  • pMin (int) –
  • pMax (int) –
getLabelSphericity(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelStandardDeviationVoxel(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelSurfaceArea(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelSurfaceXArea(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelSurfaceYArea(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelSurfaceZArea(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelVarianceVoxel(self, pLabel: int) → float
Parameters:pLabel (int) –
Returns:output (float) –
getLabelWeightedCenterOfMass(self, pLabel: int) → Vector3
Parameters:pLabel (int) –
Returns:output (ORSModel.ors.Vector3) –
getLabelsAspectRatio(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsCenterOfMassX(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsCenterOfMassY(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsCenterOfMassZ(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsContinueSurfaceArea(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsEntropy(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsEquivalentRadius(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsInertiaEigenValueMax(self) → ArrayDouble

Gets the maximum eigenvalues of the inertia tensor.

Returns:output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)
getLabelsInertiaEigenValueMed(self) → ArrayDouble

Gets the medium eigenvalues of the inertia tensor.

Returns:output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)
getLabelsInertiaEigenValueMin(self) → ArrayDouble

Gets the minimum eigenvalues of the inertia tensor.

Returns:output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)
getLabelsInertiaEigenVectorWithMinEigenValuePhiAngle(self) → ArrayDouble

Gets the phi angle for the eigenvector associated to the minimum eigenvalue of the inertia tensor for each label.

Returns:output (ORSModel.ors.ArrayDouble) – the phi angles in radian (an ArrayDouble)
getLabelsInertiaEigenVectorWithMinEigenValueThetaAngle(self) → ArrayDouble

Gets the theta angle for the eigenvector associated to the minimum eigenvalue of the inertia tensor for each label.

Returns:output (ORSModel.ors.ArrayDouble) – the theta angles in radian (an ArrayDouble)
getLabelsMaxLocationX(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMaxLocationY(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMaxLocationZ(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMaximumVoxel(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMeanVoxel(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMinLocationX(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMinLocationY(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMinLocationZ(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsMinimumVoxel(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsSphericity(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsStandardDeviationVoxel(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsSurfaceArea(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsSurfaceXArea(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsSurfaceYArea(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsSurfaceZArea(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsVarianceVoxel(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsWeightedCenterOfMassX(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsWeightedCenterOfMassY(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getLabelsWeightedCenterOfMassZ(self) → ArrayDouble
Returns:output (ORSModel.ors.ArrayDouble) –
getMaximumVoxelMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getMeanVoxelMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getMinimumVoxelMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getNumberOfROIIndiciesInLabel(self, pLabel: int) → int
Parameters:pLabel (int) –
Returns:output (int) –
getNumberOfROIIndiciesInLabelsMinMax(self, pMin: int, pMax: int) → None
Parameters:
  • pMin (int) –
  • pMax (int) –
getSphericityMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getStandardDeviationVoxelMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getSurfaceAreaFromMarchingCube(self) → ArrayDouble

Get the surfaces of labels computed from the marching cube algorithm.

Returns:output (ORSModel.ors.ArrayDouble) – surface from marching cube (an ArrayDouble)
getSurfaceAreaMax(self) → float
Returns:output (float) –
getSurfaceAreaMin(self) → float
Returns:output (float) –
getSurfaceAreaMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getSurfaceXAreaMax(self) → float
Returns:output (float) –
getSurfaceXAreaMin(self) → float
Returns:output (float) –
getSurfaceYAreaMax(self) → float
Returns:output (float) –
getSurfaceYAreaMin(self) → float
Returns:output (float) –
getSurfaceZAreaMax(self) → float
Returns:output (float) –
getSurfaceZAreaMin(self) → float
Returns:output (float) –
getTotalRoughnessFromSurfaceDistancesMax(self) → ArrayDouble

Gets the total roughness max distance based on the surface distance from the center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness range (an ArrayDouble)
getTotalRoughnessFromSurfaceDistancesMean(self) → ArrayDouble

Gets the total roughness mean distance based on the surface distance from the center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness range (an ArrayDouble)
getTotalRoughnessFromSurfaceDistancesMin(self) → ArrayDouble

Gets the total roughness min distance based on the surface distance from the center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness range (an ArrayDouble)
getTotalRoughnessFromSurfaceDistancesRange(self) → ArrayDouble

Gets the total roughness range based on the surface distance from the center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness range (an ArrayDouble)
getTotalRoughnessFromSurfaceDistancesSTD(self) → ArrayDouble

Gets the total roughness standart deviation based on the surface distance from the center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness range (an ArrayDouble)
getTotalRoughnessProxyXY(self) → ArrayDouble

Gets the total roughness of the on the XY plane from the center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness on the XY plane (an ArrayDouble)
getTotalRoughnessProxyXYZ(self) → ArrayDouble

Gets the total roughness of the on the XY,YZ, XZ plane from center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness on the XY,YZ, XZ plane (an ArrayDouble)
getTotalRoughnessProxyXZ(self) → ArrayDouble

Gets the total roughness of the on the XY plane from center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness on the XZ plane (an ArrayDouble)
getTotalRoughnessProxyYZ(self) → ArrayDouble

Gets the total roughness of the on the YZ plane from center of mass of label.

Returns:output (ORSModel.ors.ArrayDouble) – total roughness on the YZ plane (an ArrayDouble)
getVarianceVoxelMinMax(self, pMin: float, pMax: float) → None
Parameters:
  • pMin (float) –
  • pMax (float) –
getWeightedCenterOfMassMinMax(self, pXMin: float, pYMin: float, pZMin: float, pXMax: float, pYMax: float, pZMax: float) → None
Parameters:
  • pXMin (float) –
  • pYMin (float) –
  • pZMin (float) –
  • pXMax (float) –
  • pYMax (float) –
  • pZMax (float) –
initializeFor(self, IMultiROI: ORSModel.ors.MultiROI, pStats: int, pCompute2DStats: bool) → None
Parameters:
none() → MultiROIAnalyzer
Returns:output (MultiROIAnalyzer) –
class stats

Bases: enum.IntEnum

An enumeration.

basic = 1
center_of_mass = 32
continue_surface_area = 512
entropy = 128
equivalent_radius = 4
feret_length = 1024
min_max_location = 64
sphericity = 2
surface_area = 8
surface_from_marching_cube = 8192
tensor_inertia = 16
total_roughness_from_surface_distances = 4096
total_roughness_proxy = 2048

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