MultiROIAnalyzer

Inheritance diagram

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

Classes

MultiROIAnalyzer

class ORSModel.ors.MultiROIAnalyzer

Bases: Unmanaged

Analyzer for multi-ROIs.

computeStatisticsFor(self, IChannel: ORSModel.ors.Channel, pTimeStep: int, IROI: ORSModel.ors.ROI, IProgress: ORSModel.ors.Progress)
Parameters:
getCenterOfMassIndexXCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the the center of mass X index.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getCenterOfMassIndexYCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the the center of mass Y index.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getCenterOfMassIndexZCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the the center of mass Z index.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getCenterOfMassMinMax(self, pXMin: float, pYMin: float, pZMin: float, pXMax: float, pYMax: float, pZMax: float)
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, aMultiROI: ORSModel.ors.MultiROI, IListOfLabels: ORSModel.ors.ArrayUnsignedLong, tChannel: int, tLMR: int, bins: int, pMinRange: float, pMaxRange: float) → ORSModel.ors.ArrayUnsignedLONGLONG
Parameters:
Returns:

output (ORSModel.ors.ArrayUnsignedLONGLONG) –

getEquivalentRadiusMinMax(self, pMin: float, pMax: float)
Parameters:

  • pMin (float) –

  • pMax (float) –

getFeretLengthMax(self) → ORSModel.ors.ArrayDouble

Gets maximum feret size.

Returns:

output (ORSModel.ors.ArrayDouble) – feret maximum size (an ArrayDouble)

getFeretLengthMean(self) → ORSModel.ors.ArrayDouble

Gets medium feret size.

Returns:

output (ORSModel.ors.ArrayDouble) – feret medium size (an ArrayDouble)

getFeretLengthMin(self) → ORSModel.ors.ArrayDouble

Gets minimum feret size.

Returns:

output (ORSModel.ors.ArrayDouble) – feret minimum size (an ArrayDouble)

getFeretLengthMinOrtho(self) → ORSModel.ors.ArrayDouble

Gets minimum orthogonal feret diameter.

Returns:

output (ORSModel.ors.ArrayDouble) – feret minimum orthogonal (an ArrayDouble)

getIndiciesCountInLabels(self) → ORSModel.ors.ArrayLONGLONG
Returns:

output (ORSModel.ors.ArrayLONGLONG) –

getLabelAspectRatio(self, pLabel: int) → float
Parameters:

pLabel (int) –

Returns:

output (float) –

getLabelCenterOfMass(self, pLabel: int) → ORSModel.ors.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) → ORSModel.ors.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) → ORSModel.ors.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)

getLabelInertiaEigenVectorWithMaxEigenValueInWorld(self, pLabel: int) → ORSModel.ors.Vector3

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

Parameters:

pLabel (int) – label (a uint32_t)

Returns:

output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)

getLabelInertiaEigenVectorWithMedEigenValue(self, pLabel: int) → ORSModel.ors.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)

getLabelInertiaEigenVectorWithMedEigenValueInWorld(self, pLabel: int) → ORSModel.ors.Vector3

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

Parameters:

pLabel (int) – label (a uint32_t)

Returns:

output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)

getLabelInertiaEigenVectorWithMinEigenValue(self, pLabel: int) → ORSModel.ors.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)

getLabelInertiaEigenVectorWithMinEigenValueInWorld(self, pLabel: int) → ORSModel.ors.Vector3

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

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)

getLabelInertiaEigenVectorWithMinEigenValuePhiInWorldAngle(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 in world.

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)

getLabelInertiaEigenVectorWithMinEigenValueThetaInWorldAngle(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 in world.

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)
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) → ORSModel.ors.Vector3
Parameters:

pLabel (int) –

Returns:

output (ORSModel.ors.Vector3) –

getLabelsAspectRatio(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsCenterOfMassX(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsCenterOfMassY(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsCenterOfMassZ(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsContinueSurfaceArea(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsEntropy(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsEquivalentRadius(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsInertiaEigenValueMax(self) → ORSModel.ors.ArrayDouble

Gets the maximum eigenvalues of the inertia tensor.

Returns:

output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)

getLabelsInertiaEigenValueMed(self) → ORSModel.ors.ArrayDouble

Gets the medium eigenvalues of the inertia tensor.

Returns:

output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)

getLabelsInertiaEigenValueMin(self) → ORSModel.ors.ArrayDouble

Gets the minimum eigenvalues of the inertia tensor.

Returns:

output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)

getLabelsInertiaEigenVectorWithMaxEigenValuePhiAngle(self) → ORSModel.ors.ArrayDouble

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

Returns:

output (ORSModel.ors.ArrayDouble) – the phi angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMaxEigenValuePhiInWorldAngle(self) → ORSModel.ors.ArrayDouble

Gets the phi angle for the eigenvector associated to the maximum eigenvalue of the inertia tensor for each label in world.

Returns:

output (ORSModel.ors.ArrayDouble) – the phi angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMaxEigenValueThetaAngle(self) → ORSModel.ors.ArrayDouble

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

Returns:

output (ORSModel.ors.ArrayDouble) – the theta angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMaxEigenValueThetaInWorldAngle(self) → ORSModel.ors.ArrayDouble

Gets the theta angle for the eigenvector associated to the maximum eigenvalue of the inertia tensor for each label in world.

Returns:

output (ORSModel.ors.ArrayDouble) – the theta angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMedEigenValuePhiAngle(self) → ORSModel.ors.ArrayDouble

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

Returns:

output (ORSModel.ors.ArrayDouble) – the phi angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMedEigenValuePhiInWorldAngle(self) → ORSModel.ors.ArrayDouble

Gets the phi angle for the eigenvector associated to the middle eigenvalue of the inertia tensor for each label in world.

Returns:

output (ORSModel.ors.ArrayDouble) – the phi angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMedEigenValueThetaAngle(self) → ORSModel.ors.ArrayDouble

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

Returns:

output (ORSModel.ors.ArrayDouble) – the theta angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMedEigenValueThetaInWorldAngle(self) → ORSModel.ors.ArrayDouble

Gets the theta angle for the eigenvector associated to the middle eigenvalue of the inertia tensor for each label in world.

Returns:

output (ORSModel.ors.ArrayDouble) – the theta angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMinEigenValuePhiAngle(self) → ORSModel.ors.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)

getLabelsInertiaEigenVectorWithMinEigenValuePhiInWorldAngle(self) → ORSModel.ors.ArrayDouble

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

Returns:

output (ORSModel.ors.ArrayDouble) – the phi angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMinEigenValueThetaAngle(self) → ORSModel.ors.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)

getLabelsInertiaEigenVectorWithMinEigenValueThetaInWorldAngle(self) → ORSModel.ors.ArrayDouble

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

Returns:

output (ORSModel.ors.ArrayDouble) – the theta angles in radian (an ArrayDouble)

getLabelsMaxLocationX(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMaxLocationY(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMaxLocationZ(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMaximumVoxel(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMeanVoxel(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMinLocationX(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMinLocationY(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMinLocationZ(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsMinimumVoxel(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsSphericity(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsStandardDeviationVoxel(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsSurfaceArea(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsSurfaceXArea(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsSurfaceYArea(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsSurfaceZArea(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsVarianceVoxel(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsWeightedCenterOfMassX(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsWeightedCenterOfMassY(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getLabelsWeightedCenterOfMassZ(self) → ORSModel.ors.ArrayDouble
Returns:

output (ORSModel.ors.ArrayDouble) –

getMaxLocationIndexXCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated x index of the labels maximum position.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMaxLocationIndexYCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated y index of the labels maximum position.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMaxLocationIndexZCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated z index of the labels maximum position.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMaximumValueIndexXCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated x index of the maximum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMaximumValueIndexYCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated y index of the maximum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMaximumValueIndexZCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated z index of the maximum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMaximumValueXLocationCollection(self) → ORSModel.ors.ArrayDouble

Get the associated x position in world coordinate of the maximum value of labels.

Returns:

output (ORSModel.ors.ArrayDouble) – return 0 if the label is empty

getMaximumValueYLocationCollection(self) → ORSModel.ors.ArrayDouble

Get the associated y position in world coordinate of the maximum value of labels.

Returns:

output (ORSModel.ors.ArrayDouble) – return 0 if the label is empty

getMaximumValueZLocationCollection(self) → ORSModel.ors.ArrayDouble

Get the associated z position in world coordinate of the maximum value of labels.

Returns:

output (ORSModel.ors.ArrayDouble) – return 0 if the label is empty

getMaximumVoxelIndexCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated index of the maximum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – index of maximum, if label is empty value is -1 (an ArrayLONGLONG)

getMaximumVoxelMinMax(self, pMin: float, pMax: float)
Parameters:

  • pMin (float) –

  • pMax (float) –

getMeanVoxelMinMax(self, pMin: float, pMax: float)
Parameters:

  • pMin (float) –

  • pMax (float) –

getMinLocationIndexXCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated x index of the labels minimum position.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMinLocationIndexYCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated y index of the labels minimum position.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMinLocationIndexZCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated z index of the labels minimum position.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMinimumValueIndexXCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated x index of the minimum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMinimumValueIndexYCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated y index of the minimum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMinimumValueIndexZCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated z index of the minimum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getMinimumValueXLocationCollection(self) → ORSModel.ors.ArrayDouble

Get the associated x position in world coordinate of the minimum value of labels.

Returns:

output (ORSModel.ors.ArrayDouble) – return 0 if the label is empty

getMinimumValueYLocationCollection(self) → ORSModel.ors.ArrayDouble

Get the associated y position in world coordinate of the minimum value of labels.

Returns:

output (ORSModel.ors.ArrayDouble) – return 0 if the label is empty

getMinimumValueZLocationCollection(self) → ORSModel.ors.ArrayDouble

Get the associated z position in world coordinate of the minimum value of labels.

Returns:

output (ORSModel.ors.ArrayDouble) – return 0 if the label is empty

getMinimumVoxelIndexCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the associated index of the minimum value of labels.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – index of minimum, if label is empty value is -1 (an ArrayLONGLONG)

getMinimumVoxelMinMax(self, pMin: float, pMax: float)
Parameters:

  • pMin (float) –

  • pMax (float) –

getNumberOfROIIndiciesInLabel(self, pLabel: int) → int
Parameters:

pLabel (int) –

Returns:

output (int) –

getNumberOfROIIndiciesInLabelsMinMax(self, pMin: int, pMax: int)
Parameters:

  • pMin (int) –

  • pMax (int) –

getSphericityMinMax(self, pMin: float, pMax: float)
Parameters:

  • pMin (float) –

  • pMax (float) –

getStandardDeviationVoxelMinMax(self, pMin: float, pMax: float)
Parameters:

  • pMin (float) –

  • pMax (float) –

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

  • pMin (float) –

  • pMax (float) –

getWeightedCenterOfMassIndexXCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the the weighted center of mass X index.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getWeightedCenterOfMassIndexYCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the the weighted center of mass Y index.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getWeightedCenterOfMassIndexZCollection(self) → ORSModel.ors.ArrayLONGLONG

Get the the weighted center of mass Z index.

Returns:

output (ORSModel.ors.ArrayLONGLONG) – return values equal -1 if the label is empty

getWeightedCenterOfMassMinMax(self, pXMin: float, pYMin: float, pZMin: float, pXMax: float, pYMax: float, pZMax: float)
Parameters:

  • pXMin (float) –

  • pYMin (float) –

  • pZMin (float) –

  • pXMax (float) –

  • pYMax (float) –

  • pZMax (float) –

initializeFor(self, IMultiROI: ORSModel.ors.MultiROI, pStats: int, pCompute2DStats: bool)
Parameters:
none() → MultiROIAnalyzer
Returns:

output (MultiROIAnalyzer) –

class stats(value)

Bases: IntEnum

An enumeration.

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