ORSModel ¶

Returns:: output (float) – the alpha parameter (a double)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getEuclideanBias(self) → float

Gets the Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm

Returns:: output (float) – the minimum distance between voxels (a double)

getGaussianPeakCenterValue(self) → float

Sets the peak position of the gaussian used if the metric == 1.

Note

Only useful when metric is set to 1.

See also

Returns:: output (float) – peak center of the gaussian (a double)

getIndexOfStopPointReach(self) → int

Note

Only useful when distance map was generated using methods createDistanceMapUntilAnyPointInTargetRoiIsReached, createDistanceMapUntilPointInWorldCoordinatesIsReached or createDistanceMapUntilPointsAreReached.

Returns:: output (int) –

getKappa(self) → float

Gets the kappa parameter for the metric == 1.

Note

Only useful when metric is set to 1.

See also

Returns:: output (float) – the kappa parameter (a double)

getMetric(self) → int

Gets the metric used by theDijkstra algorithm.

Note

If the metric chosen is 0, the metric function will be: DijkstraDistanceBetween(a,b) = (Ia-Ib)^2 + EuclideanBias*EuclideanDistance(a,b);

Note

If the metric chosen is 1, the metric function will be: DijkstraDistanceBetween(a,b) = (Ia-Ib)^2 + EuclideanBias*EuclideanDistance(a,b)

Returns:: output (int) – 0 or 1

getNeighborCount(self) → int

Gets the number of neighbors used by theDijkstra algorithm (the connectivity).

Note

Can be 6, 18 or 26

Returns:: output (int) – the number of neighbors (an unsigned char)

getROI(self, index: int) → ORSModel.ors.ROI

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:: index (int) –
Returns:: output (ORSModel.ors.ROI) –

getROICount(self) → int

Returns the number of ROIs that have been set as sources.

Note

A maximum of 10 ROI can be provided.

Returns:: output (int) – the number of ROIs that have been provided (an unsigned char)

getSigmaPow2(self) → float

Gets the variance used by the gaussian used if the metric == 1.

Note

Only useful when metric is set to 1.

See also

Returns:: output (float) – variance of the gaussian (a double)

none() → Dijkstra

Returns:: output (Dijkstra) –

resetROIs(self): Empties all the sourceROI slots.

setAlphaParameter(self, alpha: float)

Sets the alpha parameter for the metric == 1.

Note

Only useful when metric is set to 1.

See also

Parameters:: alpha (float) – the alpha parameter (a double)

setEuclideanBias(self, EuclideanBias: float)

Provides an Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm.

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm.

Parameters:: EuclideanBias (float) – the minimum distance between voxels (a double)

setGaussianPeakCenterValue(self, aPeakCenter: float)

Sets the peak position of the gaussian used if the metric == 1.

Note

Only useful when metric is set to 1.

See also

Parameters:: aPeakCenter (float) – peak center of the gaussian (a double)

setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, currentT: int)

Note

The min and max boundaries must not describe a space bigger than the input channel.

Parameters:

inputChannel (ORSModel.ors.Channel) –
minX (int) –
minY (int) –
minZ (int) –
maxX (int) –
maxY (int) –
maxZ (int) –
currentT (int) –

setInputLabelsChannel(self, aInputLabelsChannel: ORSModel.ors.Channel)

Parameters:: aInputLabelsChannel (ORSModel.ors.Channel) –

setInputMultiROI(self, anInputMultiROI: ORSModel.ors.MultiROI)

Parameters:: anInputMultiROI (ORSModel.ors.MultiROI) –

setKappa(self, kappa: float)

Sets the kappa parameter for the metric == 1.

Note

Only useful when metric is set to 1.

See also

Parameters:: kappa (float) – the kappa parameter (a double)

setMaskROI(self, IMaskROI: ORSModel.ors.ROI)

Parameters:: IMaskROI (ORSModel.ors.ROI) –

setMetric(self, metricType: int)

Selects the metric to be used by theDijkstra algorithm.

Note

If the metric chosen is 0, the metric function will be: DijkstraDistanceBetween(a,b) = (Ia-Ib)^2 + EuclideanBias*EuclideanDistance(a,b);

Note

If the metric chosen is 1, the metric function will be: DijkstraDistanceBetween(a,b) = (Ia-Ib)^2 + EuclideanBias*EuclideanDistance(a,b)

Parameters:: metricType (int) – 0 or 1

setNeighborCountTo18(self): Sets the number of neighbors used by theDijkstra algorithm to 6 ( Neighbor distance == 1).

setNeighborCountTo26(self): Sets the number of neighbors used by theDijkstra algorithm to 6 ( Neighbor distance == 1).

setNeighborCountTo6(self): Sets the number of neighbors used by theDijkstra algorithm to 6 ( Neighbor distance == 1).

setProgressObject(self, IProgress: ORSModel.ors.Progress)

Parameters:: IProgress (ORSModel.ors.Progress) –

setROI(self, index: int, aVolROI: ORSModel.ors.ROI)

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:

index (int) –
aVolROI (ORSModel.ors.ROI) –

setSigmaPow2(self, aLimit: float)

Sets the variance used by the gaussian used if the metric == 1.

Note

Only useful when metric is set to 1.

See also

ORSModel.ors.Intersection.getColor()

Parameters:: aLimit (float) – variance of the gaussian (a double)

tracebackCPU(self, aROI: ORSModel.ors.ROI, linputChannelTraceBack: ORSModel.ors.Channel, aPath: ORSModel.ors.VisualPath)

Uses a traceback channel to fill a path from aROI to the nearest source ROI.

Parameters:

aROI (ORSModel.ors.ROI) – a trace back start (an ROI)
linputChannelTraceBack (ORSModel.ors.Channel) – a trace back channel (an ROI)
aPath (ORSModel.ors.VisualPath) –

updateDistanceMapForMaxDistance(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, maxDistance: float, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel)

Parameters:

lOutputChannelDistanceMap (ORSModel.ors.Channel) –
maxDistance (float) –
lOutputChannelTraceBack (ORSModel.ors.Channel) –
lOutputChannelLabel (ORSModel.ors.Channel) –

Dijkstra2D¶

class ORSModel.ors.Dijkstra2D(self)

Bases: Unmanaged

cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel)

Removes boundaries or non reached value from a distance map channel.

Parameters:: outputChannel (ORSModel.ors.Channel) – a distance map channel (an Channel)

createDistanceMap(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel)

Parameters:

lOutputChannelDistanceMap (ORSModel.ors.Channel) –
lOutputChannelLabel (ORSModel.ors.Channel) –

createDistanceMapWithTraceBack(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel, traceBackChannel: ORSModel.ors.Channel)

Parameters:

lOutputChannelDistanceMap (ORSModel.ors.Channel) –
lOutputChannelLabel (ORSModel.ors.Channel) –
traceBackChannel (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getEuclideanBias(self) → float

Get the Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm.

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm.

Returns:: output (float) – the minimum distance between voxel (a double)

getNeighborCount(self) → int

Returns:: output (int) –

getROICount(self) → int

Returns the number of ROIs that have been set as sources.

Note

A maximum of 10 ROI can be provided.

Returns:: output (int) – the number of ROIs that have been provided (an unsigned char)

getVolumeROI(self, index: int) → ORSModel.ors.ROI

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:: index (int) –
Returns:: output (ORSModel.ors.ROI) –

none() → Dijkstra2D

Returns:: output (Dijkstra2D) –

resetVolumeROIs(self): Empties all the sourceROI slots.

setEuclideanBias(self, EuclideanBias: float)

Provides an Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm.

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm.

Parameters:: EuclideanBias (float) – the minimum distance between voxels (a double)

setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, maxX: int, maxY: int, currentT: int)

Sets the channel that will be used by the 2DDijkstra algorithm to calculate distance.

Note

The min and max boundaries must not describe a space bigger than the input channel.

Parameters:

inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
minX (int) – the minimum X index in the input channel (a uint32_t)
minY (int) – the minimum Y index in the input channel (a uint32_t) TODO DOCUMENT_ME: Should this be removed?
maxX (int) – the minimum Z index in the input channel (a uint32_t)
maxY (int) – the maximum X index in the input channel (a uint32_t)
currentT (int) – the maximum Y index in the input channel (a uint32_t) TODO DOCUMENT_ME

setNeighborCountTo4(self): Sets the number of neighbors used by the 2DDijkstra algorithm to 4.

setNeighborCountTo8(self): Sets the number of neighbors used by the 2DDijkstra algorithm to 8.

setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI)

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:

index (int) –
aVolROI (ORSModel.ors.ROI) –

traceback(self, traceBackChannel: ORSModel.ors.Channel, worldPosition: ORSModel.ors.Vector3, outArray: ORSModel.ors.Array) → ORSModel.ors.Array

Parameters:

traceBackChannel (ORSModel.ors.Channel) –
worldPosition (ORSModel.ors.Vector3) –
outArray (ORSModel.ors.Array) –

Returns:

output (ORSModel.ors.Array) –

DimensionUnit¶

class ORSModel.ors.DimensionUnit

Bases: Unmanaged

An entity describing a unit of measure used by ORS.

convertToUnit(self, aValue: float, aDimensionUnit: ORSModel.ors.DimensionUnit) → float

Converts from a unit to another unit.

Note

Conversion can be applied only between units of the same type.

Parameters:

aValue (float) –
aDimensionUnit (ORSModel.ors.DimensionUnit) –

Returns:

output (float) –

convertValuesToUnit(self, aValues: ORSModel.ors.ArrayDouble, aDimensionUnit: ORSModel.ors.DimensionUnit) → ORSModel.ors.ArrayDouble

Converts an array of values from a unit to another unit.

Note

Conversion can be applied only between units of the same type.

Note

Each value in the array is converted individually using the same conversion logic as convertToUnit.

Parameters:

aValues (ORSModel.ors.ArrayDouble) – the array of values to convert (an ArrayDouble)
aDimensionUnit (ORSModel.ors.DimensionUnit) – the target dimension unit (a DimensionUnit)

Returns:

output (ORSModel.ors.ArrayDouble) – the converted array of values (an ArrayDouble)

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

Create aDimensionUnit from a python representation a static method.

Parameters:: aPythonRepresentation (str) –
Returns:: output (ORSModel.ors.DimensionUnit) –

getAllCalibrationKeys(self) → ORSModel.ors.ArrayString

Gets all the existing calibration keys of the dictionary of calibration values.

Note

it is the responsibility of the caller to delete the returned array

Returns:: output (ORSModel.ors.ArrayString) – array of the calibration keys (an ArrayString)

getAllRegistrationKeys() → ORSModel.ors.ArrayString

Note

it is the responsibility of the caller to delete the returned array

Returns:: output (ORSModel.ors.ArrayString) – array of the registration keys (an ArrayString)

getCalibrationValue(self, sCalibrationKey: str) → float

Gets a calibration value from the dictionary of calibration values.

Parameters:: sCalibrationKey (str) – calibration key (a string)
Returns:: output (float) – calibration value (a double)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getDefault(dimensionType: int) → ORSModel.ors.DimensionUnit

Parameters:: dimensionType (int) –
Returns:: output (ORSModel.ors.DimensionUnit) –

getDescription(self) → str

Gets the description.

Returns:: output (str) – the description (a string)

getDimensionType(self) → int

Note

See the CxvUniverse_Dimension_Type enum in ORS_def.h to know the supported values.

Returns:: output (int) – a CxvUniverse_Dimension_Type describing the dimensionality of the dimension unit (an int)

getFilenameCustomDimensionUnits() → str

Gets the filename of the custom dimension units.

Returns:: output (str) – filename of the custom dimension units (a string)

getHasCalibrationKey(self, sCalibrationKey: str) → bool

Parameters:: sCalibrationKey (str) – calibration key (a string)
Returns:: output (bool) – true if the calibration key is one of those defined for the calibration, false otherwise (a bool)

getIsEqualTo(self, aDimensionUnit: ORSModel.ors.DimensionUnit) → bool

Checks for equality to anotherDimensionUnit.

Parameters:: aDimensionUnit (ORSModel.ors.DimensionUnit) – a DimensionUnit (a DimensionUnit)
Returns:: output (bool) – true if the DimensionUnits are equal, false otherwise

getIsImperialUnit(self) → bool

Returns:: output (bool) –

getReferenceUnitConvertedToUnit(self, aVolume: float) → float

Converts from MKS to another unit.

Parameters:: aVolume (float) –
Returns:: output (float) –

getReferenceUnitToUnitFactor(self) → float

Returns:: output (float) –

getRegisteredUnit(registrationKey: str) → ORSModel.ors.DimensionUnit

Gets theDimensionUnit associated to a registration key.

Parameters:: registrationKey (str) – registration key (a string)
Returns:: output (ORSModel.ors.DimensionUnit) – a DimensionUnit (a DimensionUnit)

getRegistrationKey(self) → str

Gets the unit registration key.

Returns:: output (str) – the unit registration key (a string)

getRegistrationKeyFromCxvDimensionUniverse(pDimension: int) → str

Note

See the CxvUniverse_Dimension enum in ORS_def.h to know the supported values.

Parameters:: pDimension (int) – a dimension index (an int)
Returns:: output (str) – registration key (a string)

getRegistrationKeysSpecificDimensionUnitType(dimensionType: int) → ORSModel.ors.ArrayString

Note

See the CxvUniverse_Dimension_Type enum in ORS_def.h to know the supported values.

Note

it is the responsibility of the caller to delete the returned array

Parameters:: dimensionType (int) – a dimension type (an int)
Returns:: output (ORSModel.ors.ArrayString) – array of the registration keys (an ArrayString)

getSquaredUnit(self) → ORSModel.ors.DimensionUnit

Gets the squared unit corresponding to this dimension unit.

Returns:: output (ORSModel.ors.DimensionUnit) – a DimensionUnit representing the squared version of this unit

getSupportsConversion(self) → bool

Gets if the unit supports conversion to another unit.

Note

Generic units don’t support conversion.

Returns:: output (bool) – true if the unit can be converted to another unit, false otherwise (a bool)

getSupportsConversionToUnit(self, aDimensionUnit: ORSModel.ors.DimensionUnit) → bool

Gets if the unit can be converted in the other unit.

Note

Generic units don’t support conversion.

Note

Conversion can be applied only between units of the same type.

Parameters:: aDimensionUnit (ORSModel.ors.DimensionUnit) –
Returns:: output (bool) – true if the unit can be converted to another unit, false otherwise (a bool)

getTypeForID(pDimension: int) → int

Deprecated since version (unknown): use getDimensionType instead

Note

See the CxvUniverse_Dimension_Type enum in ORS_def.h to know the supported values.

Parameters:: pDimension (int) – a dimension index (an int)
Returns:: output (int) – a CxvUniverse_Dimension_Type describing the dimensionality of the dimension unit (an int)

getUnitAbbreviation(self) → str

Gets the unit abbreviation.

Returns:: output (str) – the unit abbreviation (a string)

getUnitConvertedToReferenceUnit(self, aVolume: float) → float

Converts to MKS from another unit.

Parameters:: aVolume (float) –
Returns:: output (float) –

getUnitForID(pDimension: int) → ORSModel.ors.DimensionUnit

Deprecated since version (unknown): use getRegisteredUnit instead

Note

See the CxvUniverse_Dimension enum in ORS_def.h to know the supported values.

Parameters:: pDimension (int) –
Returns:: output (ORSModel.ors.DimensionUnit) –

getUnitName(self) → str

Gets the unit name.

Returns:: output (str) – the unit name (a string)

getUnitWithAbbreviation(sAbbreviation: str) → ORSModel.ors.DimensionUnit

Gets the unit that has the specified abbreviation.

Parameters:: sAbbreviation (str) – a text abbreviation (a string)
Returns:: output (ORSModel.ors.DimensionUnit) – a DimensionUnit or none

getUnitWithName(sUnitName: str) → ORSModel.ors.DimensionUnit

Gets the unit that has the specified name.

Parameters:: sUnitName (str) – a text name (a string)
Returns:: output (ORSModel.ors.DimensionUnit) – a DimensionUnit or none

none() → DimensionUnit

Returns:: output (DimensionUnit) –

removeFromRegisteredDimensionUnits(registrationKey: str) → bool

Parameters:: registrationKey (str) – registration key (a string)
Returns:: output (bool) – true if the removal from the dictionary is successful, false otherwise (a bool)

setFilenameCustomDimensionUnits(filenameCustomDimensionUnits: str) → bool

Sets the filename of the custom dimension units.

Note

the file should be accessible with reading and writing permissions

Parameters:: filenameCustomDimensionUnits (str) – filename of the custom dimension units (a string)
Returns:: output (bool) – true if the file can be used, false otherwise (a bool)

DistanceChannelAnalyzer¶

class ORSModel.ors.DistanceChannelAnalyzer(self)

Bases: Unmanaged

climbFromROI(self, lDistanceChannel: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI) → ORSModel.ors.ROI

Parameters:

lDistanceChannel (ORSModel.ors.Channel) –
inputROI (ORSModel.ors.ROI) –
outputROI (ORSModel.ors.ROI) –

Returns:

output (ORSModel.ors.ROI) –

descentPathTowardMinimum(self, lDistanceChannel: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, InputPath: ORSModel.ors.VisualPath) → ORSModel.ors.VisualPath

Parameters:

lDistanceChannel (ORSModel.ors.Channel) –
inputROI (ORSModel.ors.ROI) –
InputPath (ORSModel.ors.VisualPath) –

Returns:

output (ORSModel.ors.VisualPath) –

descentTowardMinimum(self, lDistanceChannel: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI) → ORSModel.ors.ROI

Parameters:

lDistanceChannel (ORSModel.ors.Channel) –
inputROI (ORSModel.ors.ROI) –
outputROI (ORSModel.ors.ROI) –

Returns:

output (ORSModel.ors.ROI) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

none() → DistanceChannelAnalyzer

Returns:: output (DistanceChannelAnalyzer) –

DualQuaternion¶

class ORSModel.ors.DualQuaternion

Bases: Unmanaged

A wrapper to a DualQuaternion.

add(self, aVector: ORSModel.ors.DualQuaternion)

Adds a vector to the receiver.

Parameters:: aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

copy(self) → ORSModel.ors.DualQuaternion

Returns a new vector identical to the receiver (a copy).

Returns:: output (ORSModel.ors.DualQuaternion) –

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

Parameters:: aPythonRepresentation (str) –
Returns:: output (ORSModel.ors.DualQuaternion) –

getAdditionWith(self, aVector: ORSModel.ors.DualQuaternion) → ORSModel.ors.DualQuaternion

Gets the result of adding a vector to the receiver.

Note

The receiver is not modified.

Parameters:: aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)
Returns:: output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getIsEqualTo(self, aVector: ORSModel.ors.DualQuaternion) → bool

Parameters:: aVector (ORSModel.ors.DualQuaternion) –
Returns:: output (bool) –

getLinearInterpolationWith(self, point1: ORSModel.ors.DualQuaternion, normalizePosition: float) → ORSModel.ors.DualQuaternion

Computes the lerp with another vector.

See also

getDotProductWith(), getAngleWith(), getDistanceFrom()

Parameters:

point1 (ORSModel.ors.DualQuaternion) – a vector (an Vector3)
normalizePosition (float) – a interpolation factor [0,1](a double)

Returns:

output (ORSModel.ors.DualQuaternion) – the lerp vector (an Vector3)

getNegated(self) → ORSModel.ors.DualQuaternion

Gets the receiver negated in a new vector.

Note

The receiver is not modified.

Returns:: output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

getNormalized(self) → ORSModel.ors.DualQuaternion

Returns:: output (ORSModel.ors.DualQuaternion) –

getScaledBy(self, scaleFactor: float) → ORSModel.ors.DualQuaternion

Gets the result of sacling a vector to the receiver.

Note

The receiver is not modified.

Parameters:: scaleFactor (float) – a scale a double
Returns:: output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

getSphericalInterpolationWith(self, point1: ORSModel.ors.DualQuaternion, normalizePosition: float) → ORSModel.ors.DualQuaternion

Computes the lerp with another vector.

See also

getDotProductWith(), getAngleWith(), getDistanceFrom()

Parameters:

point1 (ORSModel.ors.DualQuaternion) – a vector (an Vector3)
normalizePosition (float) – a interpolation factor [0,1](a double)

Returns:

output (ORSModel.ors.DualQuaternion) – the lerp vector (an Vector3)

getSubtractionFrom(self, aVector: ORSModel.ors.DualQuaternion) → ORSModel.ors.DualQuaternion

Gets the result of subtracting a vector from the receiver.

Note

The receiver is not modified.

Parameters:: aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)
Returns:: output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

negate(self): Negates the vector.

none() → DualQuaternion

Returns:: output (DualQuaternion) –

normalize(self): Normalizes the vector.

Note

A normalized vector has norm (length) 1.

scale(self, scaleFactor: float)

Scales the vector.

Parameters:: scaleFactor (float) – a scale factor (a double)

subtract(self, aVector: ORSModel.ors.DualQuaternion)

Subtracts a vector from the receiver.

Parameters:: aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

EuclideanDistanceMapGenerator¶

class ORSModel.ors.EuclideanDistanceMapGenerator

Bases: Unmanaged

Exact euclidean distance map generator.

createDistanceMap(self, seedChannel: ORSModel.ors.Channel, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedChannel (ORSModel.ors.Channel) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createDistanceMapFromROI(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createFLOATDistanceMap(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createFLOATDistanceMapFromROI(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createSignedDistanceMapFromROI(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createUBYTEDistanceMap(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createUBYTEDistanceMapFromROI(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createUSHORTDistanceMap(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

createUSHORTDistanceMapFromROI(self, seedVolumeROI: ORSModel.ors.ROI, outputChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress, bShowProgress: bool) → ORSModel.ors.Channel

Parameters:

seedVolumeROI (ORSModel.ors.ROI) –
outputChannel (ORSModel.ors.Channel) –
timeStep (int) –
IProgress (ORSModel.ors.Progress) –
bShowProgress (bool) –

Returns:

output (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

none() → EuclideanDistanceMapGenerator

Returns:: output (EuclideanDistanceMapGenerator) –

FaceVertexMesh¶

class ORSModel.ors.FaceVertexMesh(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Bases: Mesh

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

FaceVertexMesh.__init__(self)

copyInto(self, aDestinationUS: ORSModel.ors.UnstructuredGrid)

Copies the receiver unstructured grid into another unstructured grid.

Parameters:: aDestinationUS (ORSModel.ors.UnstructuredGrid) – a destination unstructured grid

getAsHalfEdgeMesh(self, pInOutMeshModel: ORSModel.ors.HalfEdgeMesh) → ORSModel.ors.HalfEdgeMesh

Parameters:: pInOutMeshModel (ORSModel.ors.HalfEdgeMesh) –
Returns:: output (ORSModel.ors.HalfEdgeMesh) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getTotalByteCount(self) → int

Gets the total byte count in memory of the mesh.

Returns:: output (int) –

none() → FaceVertexMesh

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (FaceVertexMesh) –

FastMarching¶

class ORSModel.ors.FastMarching(self)

Bases: Unmanaged

cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel)

Remove boundary or non reached value from a speed mapChannel.

Parameters:: outputChannel (ORSModel.ors.Channel) – a distance map Channel (an Channel)

continueDistanceMapForNBIteration(self, lOutputChannelSpeedMap: ORSModel.ors.Channel, forNbIteration: int, autoUpdateROI: bool)

Parameters:

lOutputChannelSpeedMap (ORSModel.ors.Channel) –
forNbIteration (int) –
autoUpdateROI (bool) –

createDistanceMap(self, inChannelDistanceMap: ORSModel.ors.Channel, positionTripleInSourceRef: int, nbPosition: int, lMaskChannel: ORSModel.ors.Channel, traceBackChannel: ORSModel.ors.Channel) → ORSModel.ors.Channel

Parameters:

inChannelDistanceMap (ORSModel.ors.Channel) –
positionTripleInSourceRef (int) –
nbPosition (int) –
lMaskChannel (ORSModel.ors.Channel) –
traceBackChannel (ORSModel.ors.Channel) –

Returns:

output (ORSModel.ors.Channel) –

createDistanceMapForNBIteration(self, lOutputChannelSpeedMap: ORSModel.ors.Channel, forNbIteration: int, autoUpdateROI: bool, lMaskChannel: ORSModel.ors.Channel)

Parameters:

lOutputChannelSpeedMap (ORSModel.ors.Channel) –
forNbIteration (int) –
autoUpdateROI (bool) –
lMaskChannel (ORSModel.ors.Channel) –

createDistanceMapWithMask(self, inChannelDistanceMap: ORSModel.ors.Channel, lMaskChannel: ORSModel.ors.Channel) → ORSModel.ors.Channel

Parameters:

inChannelDistanceMap (ORSModel.ors.Channel) –
lMaskChannel (ORSModel.ors.Channel) –

Returns:

output (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getEuclideanBias(self) → float

get the Euclidean bias that will be the minimumDijkstra distance between voxels

Note

Neighbor of distance 1 will have a bias of spacialTerm

Note

Neighbor of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm

Note

Neighbor of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm

Returns:: output (float) – the minimum distance between voxel (a double)

getForcedMeanValue(self) → float

Returns:: output (float) –

getIndexOfStopPointReach(self) → int

Returns:: output (int) –

getMaxValueToConsider(self) → float

Returns:: output (float) –

getMinValueToConsider(self) → float

Returns:: output (float) –

getROI(self, index: int) → ORSModel.ors.ROI

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:: index (int) –
Returns:: output (ORSModel.ors.ROI) –

getROICount(self) → int

Returns the number of ROIs that have been set as sources.

Note

A maximum of 10 ROI can be provided.

Returns:: output (int) – the number of ROIs that have been provided (an unsigned char)

getStopValue(self) → float

Returns:: output (float) –

getStopWhenValueIsEncountered(self) → bool

Returns:: output (bool) –

getUsedForcedMean(self) → bool

Returns:: output (bool) –

none() → FastMarching

Returns:: output (FastMarching) –

recomputeValueWindow(self, aVolumeROI: ORSModel.ors.ROI)

Parameters:: aVolumeROI (ORSModel.ors.ROI) –

resetROIs(self): Empties all the sourceROI slots.

setEuclideanBias(self, EuclideanBias: float)

Provides an Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm.

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm.

Parameters:: EuclideanBias (float) – the minimum distance between voxels (a double)

setForcedMeanValue(self, aVal: float)

Parameters:: aVal (float) –

setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, currentT: int)

Sets the channel that will be used by theFastMarching algorithm to calculate distance.

Note

The min and max boundaries must not describe a space bigger than the input channel.

Parameters:

inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
minX (int) – the minimum X index in the input channel (a uint32_t)
minY (int) – the minimum Y index in the input channel (a uint32_t) TODO DOCUMENT_ME: Should this be removed?
minZ (int) – the minimum Z index in the input channel (a uint32_t)
maxX (int) – the maximum X index in the input channel (a uint32_t)
maxY (int) – the maximum Y index in the input channel (a uint32_t) TODO DOCUMENT_ME
maxZ (int) – the maximum Z index in the input channel (an unsigned short)
currentT (int) – the current time point (auint32_t)

setMaxValueToConsider(self, maxValue: float)

Parameters:: maxValue (float) –

setMinValueToConsider(self, minValue: float)

Parameters:: minValue (float) –

setROI(self, index: int, aVolROI: ORSModel.ors.ROI)

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:

index (int) –
aVolROI (ORSModel.ors.ROI) –

setStopPosition(self, xP: int, yP: int, zP: int)

Parameters:

xP (int) –
yP (int) –
zP (int) –

setStopValue(self, stopValue: float)

Parameters:: stopValue (float) –

setStopWhenValueIsEncountered(self, aF: bool)

Parameters:: aF (bool) –

setUseValueWindow(self, aF: bool)

Parameters:: aF (bool) –

setUsedForcedMean(self, aF: bool)

Parameters:: aF (bool) –

useDijkstraMetric(self, aF: bool)

Parameters:: aF (bool) –

FastMarching2D¶

class ORSModel.ors.FastMarching2D(self)

Bases: Unmanaged

cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel)

Removes boundaries or non reached values from a speed map channel.

Parameters:: outputChannel (ORSModel.ors.Channel) – a distance map channel (an Channel)

createDistanceMap(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, lMaskChannel: ORSModel.ors.Channel)

Parameters:

lOutputChannelDistanceMap (ORSModel.ors.Channel) –
lMaskChannel (ORSModel.ors.Channel) –

createDistanceMapForNBIteration(self, lOutputChannelSpeedMap: ORSModel.ors.Channel, forNbIteration: int, autoUpdateROI: bool, lMaskChannel: ORSModel.ors.Channel)

Parameters:

lOutputChannelSpeedMap (ORSModel.ors.Channel) –
forNbIteration (int) –
autoUpdateROI (bool) –
lMaskChannel (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getMeanValue(self) → float

get the mean value used in the setian metric

Returns:: output (float) – float a normalized value

getROICount(self) → int

Returns the number of ROIs that have been set as sources.

Note

A maximum of 10 ROI can be provided.

Returns:: output (int) – the number of ROIs that have been provided (an unsigned char)

getVolumeROI(self, index: int) → ORSModel.ors.ROI

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:: index (int) –
Returns:: output (ORSModel.ors.ROI) –

none() → FastMarching2D

Returns:: output (FastMarching2D) –

resetVolumeROIs(self): Empties all the sourceROI slots.

setEuclideanBias(self, EuclideanBias: float)

Provides an Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm.

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm.

Parameters:: EuclideanBias (float) – the minimum distance between voxels (a float)

setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, maxX: int, maxY: int, currentT: int)

Sets the channel that will be used by the 2DFastMarching algorithm to calculate distance.

Note

The min and max boundaries must not describe a space bigger than the input channel.

Parameters:

inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
minX (int) – the minimum X index in the input channel (a uint32_t)
minY (int) – the minimum Y index in the input channel (a uint32_t)
maxX (int) – the maximum X index in the input channel (a uint32_t)
maxY (int) – the maximum Y index in the input channel (a uint32_t)
currentT (int) – the T index in the input channel (a uint32_t)

setMeanValue(self, mean: float)

Set the mean value used in the setian metric.

Parameters:: mean (float) – float a normalized value

setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI)

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:

index (int) –
aVolROI (ORSModel.ors.ROI) –

useDijkstraMetric(self, pFlag: bool)

Parameters:: pFlag (bool) –

FastMarchingWatershed2D¶

class ORSModel.ors.FastMarchingWatershed2D(self)

Bases: FastMarching2D

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getGradMinimumSearchRange(self) → int

Returns:: output (int) –

none() → FastMarchingWatershed2D

Returns:: output (FastMarchingWatershed2D) –

setGradChannel(self, gradChannel: ORSModel.ors.Channel)

Parameters:: gradChannel (ORSModel.ors.Channel) –

setGradMinimumSearchRange(self, range: int)

Parameters:: range (int) –

setLabelChannel(self, labelChannel: ORSModel.ors.Channel)

Parameters:: labelChannel (ORSModel.ors.Channel) –

FordBellmanAutomata¶

class ORSModel.ors.FordBellmanAutomata(self)

Bases: Unmanaged

cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel)

Remove boundary or non reached value from a distance mapChannel.

Parameters:: outputChannel (ORSModel.ors.Channel) – a distance map Channel (an Channel)

createDistanceMap(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel, nbIteration: int)

Parameters:

lOutputChannelDistanceMap (ORSModel.ors.Channel) –
lOutputChannelTraceBack (ORSModel.ors.Channel) –
lOutputChannelLabel (ORSModel.ors.Channel) –
nbIteration (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getEuclideanBias(self) → float

get the Euclidean bias that will be the minimumDijkstra distance between voxels

Note

Neighbor of distance 1 will have a bias of spacialTerm

Note

Neighbor of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm

Note

Neighbor of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm

Returns:: output (float) – the minimum distance between voxel (an float)

getMetric(self) → int

Returns:: output (int) –

getNeighborCount(self) → int

Returns:: output (int) –

getROI(self, index: int) → ORSModel.ors.ROI

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:: index (int) –
Returns:: output (ORSModel.ors.ROI) –

getROICount(self) → int

Returns the number of ROIs that have been set as sources.

Note

A maximum of 10 ROI can be provided.

Returns:: output (int) – the number of ROIs that have been provided (an unsigned char)

none() → FordBellmanAutomata

Returns:: output (FordBellmanAutomata) –

resetVolumeROIs(self): Empties all the sourceROI slots.

setEuclideanBias(self, EuclideanBias: float)

Provides an Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm.

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm.

Parameters:: EuclideanBias (float) – the minimum distance between voxels (a float)

setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, currentT: int)

Sets the channel that will be used by the FordBellman algorithm to calculate distance.

Note

The min and max boundaries must not describe a space bigger than the input channel.

Parameters:

inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
minX (int) – the minimum X index in the input channel (a uint32_t)
minY (int) – the minimum Y index in the input channel (a uint32_t)
minZ (int) – the minimum Z index in the input channel (a uint32_t)
maxX (int) – the maximum X index in the input channel (a uint32_t)
maxY (int) – the maximum Y index in the input channel (a uint32_t)
maxZ (int) – the maximum Z index in the input channel (a uint32_t)
currentT (int) –

setMetric(self, metricType: int)

Parameters:: metricType (int) –

setNeighborCountTo18(self)

setNeighborCountTo26(self)

setNeighborCountTo6(self)

setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI)

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:

index (int) –
aVolROI (ORSModel.ors.ROI) –

GaussianPyramid¶

class ORSModel.ors.GaussianPyramid(self)

Bases: Unmanaged

getChannelBase(self) → ORSModel.ors.Channel

Returns:: output (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getGaussianPyramid(self, firstLevelChannel: ORSModel.ors.Channel, secondLevelChannel: ORSModel.ors.Channel, thirdLevelChannel: ORSModel.ors.Channel, fourthLevelChannel: ORSModel.ors.Channel)

Parameters:

firstLevelChannel (ORSModel.ors.Channel) –
secondLevelChannel (ORSModel.ors.Channel) –
thirdLevelChannel (ORSModel.ors.Channel) –
fourthLevelChannel (ORSModel.ors.Channel) –

getHalfsizeKernel(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

getMaxLevelGaussianPyramid(self) → int

Returns:: output (int) –

getMinLevelGaussianPyramid(self) → int

Returns:: output (int) –

getOriginSubsetPixels(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

getPerformZReduction(self) → bool

Returns:: output (bool) –

getSigma(self) → float

Returns:: output (float) –

getSizeSubsetPixels(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

none() → GaussianPyramid

Returns:: output (GaussianPyramid) –

setChannelBase(self, pIInputChannel: ORSModel.ors.Channel)

Parameters:: pIInputChannel (ORSModel.ors.Channel) –

setHalfsizeKernel(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int)

Parameters:

minLevel (int) –
maxLevel (int) –

setOriginSubsetPixels(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

setPerformZReduction(self, bValue: bool)

Parameters:: bValue (bool) –

setSigma(self, value: float)

Parameters:: value (float) –

setSizeSubsetPixels(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

GeodesicDistanceMap¶

class ORSModel.ors.GeodesicDistanceMap

Bases: Unmanaged

createDistanceMap(maskROI: ORSModel.ors.ROI, seedROI: ORSModel.ors.ROI) → ORSModel.ors.Channel

Parameters:

maskROI (ORSModel.ors.ROI) –
seedROI (ORSModel.ors.ROI) –

Returns:

output (ORSModel.ors.Channel) –

Graph¶

class ORSModel.ors.Graph(self)

Bases: UnstructuredGrid

Graph.__init__(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

attachVertexToVertices(self, vertexIndex: int, arrayOfVertices: ORSModel.ors.ArrayUnsignedLong, iTIndex: int)

creates an edge between vertex index and every vertex in array

Parameters:

vertexIndex (int) – vertex index (a uint64_t)
arrayOfVertices (ORSModel.ors.ArrayUnsignedLong) – array of vertices to connect (an ArrayUnsignedLong)
iTIndex (int) – the time step (a uint32_t)

canBeRendered(self, iTIndex: int) → bool

Indicate if the graph can be rendered by the HW.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (bool) – (a bool)

computeDijkstraDistancesAndPredecessorMap(self, iTIndex: int, sourceVertexIndex: int, arrayOfDijkstraDistances: ORSModel.ors.ArrayDouble, arrayOfSourcesAndTargetsFromDijkstra: ORSModel.ors.ArrayUnsignedLong, weights: ORSModel.ors.SequenceableCollection)

Parameters:

iTIndex (int) – the time step (a uint32_t)
sourceVertexIndex (int) – the index of the vertex that dijkstra starts calculating from (a uint64_t)
arrayOfDijkstraDistances (ORSModel.ors.ArrayDouble) – the distances of the vertices from source vertex from distance map (an ArrayDouble)
arrayOfSourcesAndTargetsFromDijkstra (ORSModel.ors.ArrayUnsignedLong) – the indices of the vertices of predecessors (an ArrayUnsignedLong)
weights (ORSModel.ors.SequenceableCollection) – the weights to associate de edges (a SequenceableCollection)

findNeighbours(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayUnsignedLong) –

getAnglesCount(self, iTIndex: int) → int

Parameters:: iTIndex (int) –
Returns:: output (int) –

getAnglesForNodeType(self, iTIndex: int, NumOutEdges: int, arrayAngles: ORSModel.ors.ArrayDouble, arrayFirstEdgeOfAngles: ORSModel.ors.ArrayUnsignedLong, arraySecondEdgeOfAngles: ORSModel.ors.ArrayUnsignedLong, arrayVertexOfAngles: ORSModel.ors.ArrayUnsignedLong)

Parameters:

iTIndex (int) – the time step (a uint32_t)
NumOutEdges (int) – the number of out edges for a node which defines the required node type (a uint32_t)
arrayAngles (ORSModel.ors.ArrayDouble) – the angles associated with the specified node type (an ArrayDouble)
arrayFirstEdgeOfAngles (ORSModel.ors.ArrayUnsignedLong) – the index of the first edge of each angle (an ArrayUnsignedLong)
arraySecondEdgeOfAngles (ORSModel.ors.ArrayUnsignedLong) – the index of the second edge of each angle (an ArrayUnsignedLong)
arrayVertexOfAngles (ORSModel.ors.ArrayUnsignedLong) – the angles associated with the specified node type (an ArrayUnsignedLong)

getAsROI(self, iTIndex: int, worldTransform: ORSModel.ors.Matrix4x4, pOutputROI: ORSModel.ors.ROI, progress: ORSModel.ors.Progress) → bool

Makes a Region of Interest from the mesh.

Parameters:

iTIndex (int) – the time step (a uint32_t)
worldTransform (ORSModel.ors.Matrix4x4) – a transformation matrix (a Matrix4x4)
pOutputROI (ORSModel.ors.ROI) – a region of interest (a ROI)
progress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress

Returns:

output (bool) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getCurrentEdgeScalarValuesSlot(self) → int

gets the current edge scalar.

Note

The scalar index is zero-based, and thus should be less than getEdgeScalarValuesSlotCount().

Note

Use -1 to indicate no current scalar

Returns:: output (int) – the scalar slot index (an int32_t)

getDefaultEdgeAlphaColor(self) → float

Queries the Edge to get its default alpha color.

Returns:: output (float) – Default alpha color used for the edge (a double)

getDefaultEdgeColor(self) → ORSModel.ors.Color

Gets the edge default color.

Note

Each color value goes between 0 (none) and 1 (full).

Returns:: output (ORSModel.ors.Color) – a color (an Color)

getEdgeCount(self, iTIndex: int) → int

Returns the number of edges.

Parameters:: iTIndex (int) – the the time step (a uint32_t)
Returns:: output (int) – a uint64_t

getEdgeScalarSlotIndexForDescription(self, sValue: str, iTIndex: int) → int

Gets the scalar slot index from an edge scalar description.

Parameters:

sValue (str) – the slot description (an std::wstring)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (int) – the index or -1 if not found

getEdgeScalarValue(self, nScalarValueSlotIndex: int, scalarValueEdgeIndex: int, iTIndex: int) → float

Gets the value of an edge scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
scalarValueEdgeIndex (int) – the edge index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the value of a edge scalar (a double)

getEdgeScalarValueDescription(self, nScalarValueSlotIndex: int, iTIndex: int) → str

Gets an edge scalar description.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (str) – the description (a std::wstring)

getEdgeScalarValueDimensionUnit(self, nScalarValueSlotIndex: int, iTIndex: int) → ORSModel.ors.DimensionUnit

Gets the dimension unit of an edge scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (ORSModel.ors.DimensionUnit) – the dimension unit (a DimensionUnit)

getEdgeScalarValueMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

method getEdgeScalarValueMax

Deprecated since version (unknown): use getEdgeScalarValuesWindowMax instead

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (float) –

getEdgeScalarValueMaxs(self, iTIndex: int) → ORSModel.ors.ArrayDouble

method getEdgeScalarValueMaxs

Deprecated since version (unknown): use getEdgeScalarValuesWindowMaxs instead

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getEdgeScalarValueMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets an edge scalar min value.

Deprecated since version (unknown): use getEdgeScalarValuesWindowMin instead

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getEdgeScalarValueMins(self, iTIndex: int) → ORSModel.ors.ArrayDouble

method getEdgeScalarValueMins

Deprecated since version (unknown): use getEdgeScalarValuesWindowMins instead

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getEdgeScalarValueOffset(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets an edge scalar offset value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the scalar offset value (a double)

getEdgeScalarValueOffsets(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Get the edge scalar offset values.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayDouble) – the scalar offset values (an ArrayDouble)

getEdgeScalarValueSlope(self, scalarValueSlotIndex: int, iTIndex: int) → float

Gets an edge scalar slope value.

Parameters:

scalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the scalar slope value (a double)

getEdgeScalarValueSlopes(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Get the edge scalar slope values.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayDouble) – the scalar slope values (an ArrayDouble)

getEdgeScalarValueSlotLookUpTable(self, nScalarValueSlotIndex: int, iTIndex: int) → dict

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (dict) –

getEdgeScalarValues(self, nScalarValueSlotIndex: int, iTIndex: int) → ORSModel.ors.Array

Gets the values of an edge scalar.

Note

The array of values is of length getEdgeCount() * getEdgeScalarValuesSlotCount().

Note

The scalar value in the slot s of the edge v is located at the index (getEdgeScalarValuesSlotCount() * v) + s of the array.

Parameters:

nScalarValueSlotIndex (int) – the edge scalar value slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (ORSModel.ors.Array) – an array of values (an ArrayFloat)

getEdgeScalarValuesCollection(self) → ORSModel.ors.ScalarValuesCollection

Queries the scalar values collection of the edges.

Returns:: output (ORSModel.ors.ScalarValuesCollection) – the ScalarValuesCollection of the edges.

getEdgeScalarValuesDatatype(self, nScalarValueSlotIndex: int) → int

Parameters:: nScalarValueSlotIndex (int) –
Returns:: output (int) –

getEdgeScalarValuesId(self, nScalarValueSlotIndex: int, iTIndex: int) → str

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (str) –

getEdgeScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get an edge scalar range max boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getEdgeScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get an edge scalar range min boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getEdgeScalarValuesRangeMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get an edge scalar range max value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getEdgeScalarValuesRangeMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get an edge scalar range min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getEdgeScalarValuesSlotCount(self) → int

Gets the number of slots for edge scalar values.

Returns:: output (int) – the number of slots (a uint16_t)

getEdgeScalarValuesWindowMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (float) –

getEdgeScalarValuesWindowMaxs(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getEdgeScalarValuesWindowMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets an edge scalar window min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getEdgeScalarValuesWindowMins(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getEdges(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Get the edge array.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

getEdgesConnectedComponent(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Get the edges connected componenent number.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – an ORS::ArrayUnsignedLong

getEdgesLength(self, worldMatrix: ORSModel.ors.Matrix4x4, iTIndex: int) → ORSModel.ors.ArrayDouble

Parameters:

worldMatrix (ORSModel.ors.Matrix4x4) – the world matrix (a Matrix 4x4)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (ORSModel.ors.ArrayDouble) –

getEdgesTotalLength(self, worldMatrix: ORSModel.ors.Matrix4x4, iTIndex: int) → float

Gets the total length of the edges.

Parameters:

worldMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) –

getHideOutOfRangeEdgeScalarValues(self) → bool

Indicate if out of range values should be hidden.

Returns:: output (bool) – (a bool)

getMinMaxEdgeScalarValue(self, nScalarValueSlotIndex: int, iTIndex: int, fMinValue: float, fMaxValue: float)

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –
fMinValue (float) –
fMaxValue (float) –

getNumVertices(self, iTIndex: int) → int

Parameters:: iTIndex (int) –
Returns:: output (int) –

getOrderedEdgesArray(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayUnsignedLong) –

getTotalByteCount(self) → int

Gets the total byte count in memory of the graph.

Returns:: output (int) –

getUseDefaultEdgeAlphaColor(self) → bool

Queries the edge to see if it uses its default alpha color.

Returns:: output (bool) – true if a default alpha color is used for the edge, false otherwise

getUseDefaultEdgeColor(self) → bool

Queries the edge to see if it uses its default color.

Returns:: output (bool) – true if the edge uses its default color, false otherwise

getUseEdgeScalarValues(self) → bool

Sets the edge to have edge scalar values or not.

Returns:: output (bool) – true to use scalar values, false otherwise

getVerticeConnectivityCount(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Get the vertices connectivity count.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – an ORS::ArrayUnsignedLong

getVerticesConnectedComponent(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Get the vertices connected componenent number.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – an ORS::ArrayUnsignedLong

getVerticesPredecessorAndSuccessor(self, iTIndex: int) → ORSModel.ors.ArrayLong

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayLong) –

getVerticesWithConnectivity(self, iTIndex: int, NumOfNeighbours: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:

iTIndex (int) –
NumOfNeighbours (int) –

Returns:

output (ORSModel.ors.ArrayUnsignedLong) –

getVerticesWithIntersectionOutsideOfArray(self, arrayOfIndices: ORSModel.ors.ArrayUnsignedLong, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:

arrayOfIndices (ORSModel.ors.ArrayUnsignedLong) – the indices of the vertices (an ArrayUnsignedLong)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (ORSModel.ors.ArrayUnsignedLong) –

graphStats(self, iTIndex: int)

Parameters:: iTIndex (int) –

makeSourceIndexSmallerThanTargetIndex(self, iTIndex: int)

Parameters:: iTIndex (int) –

mapEdgeScalarValuesFromChannel(self, aReferenceChannel: ORSModel.ors.Channel, sourceScalarValuesSlotIndex: int, channelTimeStep: int, sourceTIndex: int, percentageAwayFromSourceVertex: float)

Parameters:

aReferenceChannel (ORSModel.ors.Channel) – the channel to take values at position (a Channel)
sourceScalarValuesSlotIndex (int) – scalar slot index (a uint16_t)
channelTimeStep (int) – the time step (a uint16_t)
sourceTIndex (int) – iTindex (a uint32_t)
percentageAwayFromSourceVertex (float) – fraction away from source vertex of the edge ex. 0,5 for mid edge (a double)

nodeTypeCount(self, iTIndex: int, nodeTypeArray: ORSModel.ors.ArrayDouble) → ORSModel.ors.ArrayDouble

Parameters:

iTIndex (int) –
nodeTypeArray (ORSModel.ors.ArrayDouble) –

Returns:

output (ORSModel.ors.ArrayDouble) –

nodeTypePercentage(self, iTIndex: int, nodeTypeArray: ORSModel.ors.ArrayDouble) → ORSModel.ors.ArrayDouble

Parameters:

iTIndex (int) –
nodeTypeArray (ORSModel.ors.ArrayDouble) –

Returns:

output (ORSModel.ors.ArrayDouble) –

none() → Graph

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Graph) –

removeAnEdgeScalarValuesSlot(self, nScalarValueSlotIndex: int)

Remove an edge scalar slot.

Parameters:: nScalarValueSlotIndex (int) – the index of the slot to be removed (a uint16_t)

removeDuplicateEdges(self, iTIndex: int, aProgress: ORSModel.ors.Progress)

Removes duplicate edges.

Parameters:

iTIndex (int) – the time step (a uint32_t)
aProgress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress

removeEdge(self, indiceOfEdge: int, iTInex: int)

removes edge

Parameters:

indiceOfEdge (int) – index of edge to remove (a uint32_t)
iTInex (int) – the time step (a uint32_t)

removeEdgesAttachedToVertices(self, arrayOfVertices: ORSModel.ors.ArrayUnsignedLong, iTIndex: int)

isolates vertices in given array by removing all its connected edges

Parameters:

arrayOfVertices (ORSModel.ors.ArrayUnsignedLong) – array of vertices to isolate (an ArrayUnsignedLong)
iTIndex (int) – the time step (a uint32_t)

removeIsolatedEdges(self, iTIndex: int)

Parameters:: iTIndex (int) –

removeIsolatedVertices(self, iTIndex: int)

Parameters:: iTIndex (int) –

removeSelfLoopEdges(self, iTIndex: int)

Parameters:: iTIndex (int) –

setCurrentEdgeScalarValuesSlot(self, slotIndex: int)

Sets the current edge scalar.

Note

The scalar index is zero-based, and thus should be less than getEdgeScalarValuesSlotCount().

Note

Use -1 to indicate no current scalar

Parameters:: slotIndex (int) – the current scalar slot index (an int32_t)

setDefaultEdgeAlphaColor(self, value: float)

Sets the edge its default alpha color.

Parameters:: value (float) – Alpha color (double)

setDefaultEdgeColor(self, IColor: ORSModel.ors.Color)

Sets the edge default color.

Note

Each color value goes between 0 (none) and 1 (full).

Note

You need to call setUseDefaultColor(true) for the default color to be used.

Note

You need to call initializeVisual after color changes for them to be visible on the screen.

Parameters:: IColor (ORSModel.ors.Color) – a color (an Color)

setEdgeScalarValue(self, nScalarValueSlotIndex: int, scalarValueEdgeIndex: int, aValue: float, iTIndex: int)

Sets the value of an edge scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
scalarValueEdgeIndex (int) – the edge index (a uint32_t)
aValue (float) – the value of a edge scalar to set (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValueDescription(self, nScalarValueSlotIndex: int, value: str, iTIndex: int)

Parameters:

nScalarValueSlotIndex (int) –
value (str) –
iTIndex (int) –

setEdgeScalarValueDimensionUnit(self, nScalarValueSlotIndex: int, pDimensionUnit: ORSModel.ors.DimensionUnit, iTIndex: int)

Sets the dimension unit of an edge scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
pDimensionUnit (ORSModel.ors.DimensionUnit) – the dimension unit (a DimensionUnit)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValueMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets an edge scalar max value.

Deprecated since version (unknown): use setEdgeScalarValuesWindowMax instead

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar max value (a double)
iTIndex (int) – time step (a uint32_t)

setEdgeScalarValueMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

method setEdgeScalarValueMaxs

Deprecated since version (unknown): use setEdgeScalarValuesWindowMaxs instead

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setEdgeScalarValueMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

method setEdgeScalarValueMin

Deprecated since version (unknown): use setEdgeScalarValuesWindowMin instead

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValueMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

method setEdgeScalarValueMins

Deprecated since version (unknown): use setEdgeScalarValuesWindowMins instead

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setEdgeScalarValueOffset(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets an edge scalar offset value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the scalar offset value (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValueOffsets(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Set the edge scalar offset values.

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) – scalar offset values (an ArrayDouble)
iTIndex (int) – time step (a uint32_t)

setEdgeScalarValueSlope(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Gets a edge scalar slope value.

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar slope value (a double)
iTIndex (int) – time step (a uint32_t)

setEdgeScalarValueSlopes(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Set the edge scalar slope values.

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) – scalar slope values (an ArrayDouble)
iTIndex (int) – time step (a uint32_t)

setEdgeScalarValueSlotLookUpTable(self, lookUpTable: dict, nScalarValueSlotIndex: int, iTIndex: int)

Parameters:

lookUpTable (dict) –
nScalarValueSlotIndex (int) –
iTIndex (int) –

setEdgeScalarValueUnit(self, nScalarValueSlotIndex: int, value: int, iTIndex: int)

method setEdgeScalarValueUnit

Deprecated since version (unknown): use setEdgeScalarValueDimensionUnit instead

Parameters:

nScalarValueSlotIndex (int) –
value (int) –
iTIndex (int) –

setEdgeScalarValues(self, pScalarValues: ORSModel.ors.Array, nScalarValueSlotIndex: int, iTIndex: int)

Sets the values of an edge scalar.

Note

The array of values is of length getEdgeCount() * getEdgeScalarValuesSlotCount().

Note

The scalar value in the slot s of the edge v is located at the index (getEdgeScalarValuesSlotCount() * v) + s of the array.

Parameters:

pScalarValues (ORSModel.ors.Array) – an array of values (an ArrayFloat)
nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValuesDatatype(self, iSlotIndex: int, nEdgeScalarValuesDatatype: int)

Parameters:

iSlotIndex (int) –
nEdgeScalarValuesDatatype (int) –

setEdgeScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set an edge scalar range max boundary value.

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set an edge scalar range min boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValuesRangeMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set an edge scalar range max value.

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValuesRangeMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set an edge scalar range min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValuesSlotCount(self, slotCount: int)

Sets the number of slots for edge scalar values.

Parameters:: slotCount (int) – the number of slots (a uint16_t)

setEdgeScalarValuesWindowMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets an edge scalar max value.

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar max value (a double)
iTIndex (int) – time step (a uint32_t)

setEdgeScalarValuesWindowMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setEdgeScalarValuesWindowMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

method setEdgeScalarValuesWindowMin

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setEdgeScalarValuesWindowMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setEdges(self, pEdges: ORSModel.ors.ArrayUnsignedLong, iTIndex: int)

Sets the edges.

Parameters:

pEdges (ORSModel.ors.ArrayUnsignedLong) – the edges(an ArrayUnsignedLong)
iTIndex (int) – the time step (a uint32_t)

setHideOutOfRangeEdgeScalarValues(self, value: bool)

Indicate if out of range values should be hidden.

Parameters:: value (bool) – (a bool)

setUseDefaultEdgeAlphaColor(self, value: bool)

Sets the edge to use its default alpha color.

Parameters:: value (bool) – true for using a default alpha color for the edge, false otherwise (bool)

setUseDefaultEdgeColor(self, value: bool)

Sets the edge to use its default color.

Parameters:: value (bool) – true to use the edge default color, false otherwise

setUseEdgeScalarValues(self, value: bool)

Gets the status of edge scalar values usage.

See also

getScalarValues(), getScalarValuesSlotCount()

Parameters:: value (bool) –

GraphAnalyzer¶

class ORSModel.ors.GraphAnalyzer(self)

Bases: Unmanaged

computeStatisticsFor(self, denseGraph: ORSModel.ors.Graph, aTimeStep: int, edgeSlotIndex: int, pProgress: ORSModel.ors.Progress, sourceIndex: int) → bool

Parameters:

denseGraph (ORSModel.ors.Graph) –
aTimeStep (int) –
edgeSlotIndex (int) –
pProgress (ORSModel.ors.Progress) –
sourceIndex (int) –

Returns:

output (bool) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getDijkstraDistanceMap(self) → ORSModel.ors.ArrayDouble

Returns:: output (ORSModel.ors.ArrayDouble) –

getDijkstraPredecessorMap(self) → ORSModel.ors.ArrayUnsignedLong

Returns:: output (ORSModel.ors.ArrayUnsignedLong) –

getDistancesBasedOnPredecessorMapForEdgeSlotIndex(self, anEdgeSlotIndex: int, destinationVerticesz: ORSModel.ors.ArrayUnsignedLong) → ORSModel.ors.ArrayDouble

Parameters:

anEdgeSlotIndex (int) –
destinationVerticesz (ORSModel.ors.ArrayUnsignedLong) –

Returns:

output (ORSModel.ors.ArrayDouble) –

getEdgesOfPath(self, anEdgeSlotIndex: int, lastIndexInPath: int) → ORSModel.ors.ArrayDouble

Parameters:

anEdgeSlotIndex (int) –
lastIndexInPath (int) –

Returns:

output (ORSModel.ors.ArrayDouble) –

getFirstAndLastVertexIndicesOfPathFromPredecessorMap(self, firstAndLastVertexIndicesInPath: ORSModel.ors.ArrayUnsignedLong) → ORSModel.ors.ArrayUnsignedLong

Parameters:: firstAndLastVertexIndicesInPath (ORSModel.ors.ArrayUnsignedLong) –
Returns:: output (ORSModel.ors.ArrayUnsignedLong) –

getTimeStep(self) → int

Returns:: output (int) –

initializeFor(self, denseGraph: ORSModel.ors.Graph)

Parameters:: denseGraph (ORSModel.ors.Graph) –

none() → GraphAnalyzer

Returns:: output (GraphAnalyzer) –

Group¶

class ORSModel.ors.Group(*args, **kwargs)

Bases: Node

A container object for managed objects.

add(self, pObject: ORSModel.ors.Managed)

Adds an object to the group.

Note

This container behaves like a set, i.e. objects can only appear once.

Parameters:: pObject (ORSModel.ors.Managed) – object to add (a Managed)

addAtKey(self, sKey: str, pObject: ORSModel.ors.Managed)

Adds an object to the group, at a specific key.

Note

This container behaves like a set, i.e. objects can only appear once.

Parameters:

sKey (str) – a key (a string)
pObject (ORSModel.ors.Managed) – object to add (a Managed)

addGroup(self, IInputGroup: ORSModel.ors.Group)

Appends the objects found in the supplied group to the group.

Note

This container behaves like a set, i.e. objects can only appear once.

Parameters:: IInputGroup (ORSModel.ors.Group) – another group (a Group)

empty(self): Empties the group.

getAllContainedInstancesOf(self, pProgId: str) → ORSModel.ors.List

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – a class name (a string)
Returns:: output (ORSModel.ors.List) – a list of objects (a List)

getAllContainedObjects(self) → ORSModel.ors.List

Returns all the objects found in the group.

Returns:: output (ORSModel.ors.List) – a list of objects (a List)

getAllContainedObjectsOfClassAndPrivateTitle(self, pProgId: str, pPrivateTitle: str) → ORSModel.ors.List

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:

pProgId (str) – a class name (a string)
pPrivateTitle (str) – a private title (a string)

Returns:

output (ORSModel.ors.List) – a list of objects (a List)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getCount(self) → int

Returns the count of objects in the group.

Returns:: output (int) – object count (a uint32_t)

getIncludes(self, pObject: ORSModel.ors.Managed) → bool

Checks to see if an object is in the group.

Parameters:: pObject (ORSModel.ors.Managed) – object to check (a Managed)
Returns:: output (bool) – true if object is in the group, false otherwise

getIncludesGUID(self, sGUID: str) → bool

Checks to see if an object is in the group, via its GUID.

Parameters:: sGUID (str) – guid to check (a string)
Returns:: output (bool) – true if guid is in the group, false otherwise

getIndexOf(self, pObject: ORSModel.ors.Managed) → int

Returns the index of the supplied object in the group.

Parameters:: pObject (ORSModel.ors.Managed) – an object (a Managed)
Returns:: output (int) – an index (an int), or -1 if the object is not in the group

getIntersectionWith(self, IInputGroup: ORSModel.ors.Group, IInOutGroup: ORSModel.ors.Group) → ORSModel.ors.Group

Note

The output group can be the same as the receiver group (i.e. can intersect another group into itself) or the same as the intersection group (i.e. can intersect another group into the intersection group).

Note

The output group is initialized as the set of objects of the receiver with their original keys, then all the objects absent from the intersection group are removed (independently of their associated keys).

Parameters:

IInputGroup (ORSModel.ors.Group) –
IInOutGroup (ORSModel.ors.Group) –

Returns:

output (ORSModel.ors.Group) –

getKeysOfObject(self, pObject: ORSModel.ors.Managed) → List[str]

Returns the keys associated to an object in the group.

Parameters:: pObject (ORSModel.ors.Managed) – an object (a Managed)
Returns:: output (List[str]) – a list of keys (a list of strings)

getObjectAt(self, pos: int) → ORSModel.ors.Managed

Returns the Nth object in the group.

Parameters:: pos (int) – an index (a uint32_t)
Returns:: output (ORSModel.ors.Managed) – an object (a Managed)

getObjectsAtKey(self, sKey: str) → ORSModel.ors.List

Returns the objects found at the given key.

Parameters:: sKey (str) – a key (a string)
Returns:: output (ORSModel.ors.List) – a list of objects (a List)

getSubtractionFrom(self, IInputGroup: ORSModel.ors.Group, IInOutGroup: ORSModel.ors.Group) → ORSModel.ors.Group

Note

If a target group is supplied, data is written to it and returned, otherwise a new group is created.

Note

The output group can be the same as the receiver group (i.e. can subtract another group into itself) or the same as the subtraction group (i.e. can subtract another group into the subtraction group).

Note

The output group is initialized as the set of objects of the receiver with their original keys, then all the objects present from the subtraction group are removed (independently of their associated keys).

Parameters:

IInputGroup (ORSModel.ors.Group) – the group to subtract (a Group)
IInOutGroup (ORSModel.ors.Group) – the output group (a Group), see note below

Returns:

output (ORSModel.ors.Group) – the subtracted group

getUnionWith(self, IInputGroup: ORSModel.ors.Group, IInOutGroup: ORSModel.ors.Group) → ORSModel.ors.Group

Note

The output group can be the same as the receiver group (i.e. can merge with another group into itself) or the same as the union group (i.e. can merge another group in the union group).

Note

The output group is initialized as the set of objects of the receiver with their original keys, then all the objects present in the union group are added with their associated keys.

Parameters:

IInputGroup (ORSModel.ors.Group) –
IInOutGroup (ORSModel.ors.Group) –

Returns:

output (ORSModel.ors.Group) –

none() → Group

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Group) –

remove(self, pObject: ORSModel.ors.Managed)

Removes an object from the group.

Parameters:: pObject (ORSModel.ors.Managed) – object to remove (a Managed)

removeAtKey(self, sKey: str, pObject: ORSModel.ors.Managed)

Removes an object from the group, at a specific key.

Note

This container behaves like a set, i.e. objects can only appear once.

Parameters:

sKey (str) – a key (a string)
pObject (ORSModel.ors.Managed) – object to remove (a Managed)

removeGroup(self, IInputGroup: ORSModel.ors.Group)

Removes all the objects found in the supplied group from the group.

Parameters:: IInputGroup (ORSModel.ors.Group) – another group (a Group)

HalfEdgeMesh¶

class ORSModel.ors.HalfEdgeMesh(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Bases: Mesh

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

HalfEdgeMesh.__init__(self)

copyInto(self, aDestinationUnstructuredGrid: ORSModel.ors.Node)

Copies the receiver unstructured grid into another unstructured grid.

Parameters:: aDestinationUnstructuredGrid (ORSModel.ors.Node) – a destination unstructured grid

getAsFaceVertexMesh(self, pInOutMeshModel: ORSModel.ors.FaceVertexMesh) → ORSModel.ors.FaceVertexMesh

Parameters:: pInOutMeshModel (ORSModel.ors.FaceVertexMesh) –
Returns:: output (ORSModel.ors.FaceVertexMesh) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getEdgesInFaceVertexTopology(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayUnsignedLong) –

getFacesAdjacencyArray(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

getTotalByteCount(self) → int

Gets the total byte count in memory of the mesh.

Returns:: output (int) –

getVerticesAdjacencyArray(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

none() → HalfEdgeMesh

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (HalfEdgeMesh) –

setEdgesInFaceVertexTopology(self, pEdges: ORSModel.ors.ArrayUnsignedLong, iTIndex: int)

Parameters:

pEdges (ORSModel.ors.ArrayUnsignedLong) –
iTIndex (int) –

HistogramAnalyzer¶

class ORSModel.ors.HistogramAnalyzer(self)

Bases: Unmanaged

fillHistogram1DFromChannel(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, tChannel: int, IROI: ORSModel.ors.ROI, tROI: int)

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 1D histogram to fill (an HistogramData)
IChannel1 (ORSModel.ors.Channel) – the channel (an Channel)
tChannel (int) – the t index of the channel (an unsigned int)
IROI (ORSModel.ors.ROI) – the ROI specifying what channel voxels to include (an ROI). If this parameter is given as nullptr, all channel voxels will be used.
tROI (int) – the t index of the ROI (an unsigned int)

fillHistogram1DFromChannelSubset(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, tChannel: int, xmin: int, ymin: int, zmin: int, xmax: int, ymax: int, zmax: int)

Fill a 1D histogram from the channel values, over a subset of the volume.

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 1D histogram to fill (an HistogramData)
IChannel1 (ORSModel.ors.Channel) – the channel (an Channel)
tChannel (int) – the t index of the channel (an unsigned int)
xmin (int) – the minimal x index of the channel to use (an unsigned int)
ymin (int) – the minimal y index of the channel to use (an unsigned int)
zmin (int) – the minimal z index of the channel to use (an unsigned int)
xmax (int) – the maximal x index of the channel to use (an unsigned int)
ymax (int) – the maximal y index of the channel to use (an unsigned int)
zmax (int) – the maximal z index of the channel to use (an unsigned int)

fillHistogram1DFromCollection(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, IFilterCollection: ORSModel.ors.SequenceableCollection, IArrayBinIndexes: ORSModel.ors.ArrayUnsignedLONGLONG)

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 1D histogram to fill (an HistogramData)
ICollection1 (ORSModel.ors.SequenceableCollection) – the collection values (a SequenceableCollection)
IFilterCollection (ORSModel.ors.SequenceableCollection) – the filter collection (a SequenceableCollection). If this parameter is given as nullptr, all elements of the collection values will be used.
IArrayBinIndexes (ORSModel.ors.ArrayUnsignedLONGLONG) – an array filled with the bin index of each element. If this parameter is given as nullptr, these indexes won’t be returned.

fillHistogram1DFromCollectionSubset(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, indexStart: int, indexEnd: int)

Fill a 1D histogram from the collection values, over a subset of the collection.

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 1D histogram to fill (an HistogramData)
ICollection1 (ORSModel.ors.SequenceableCollection) – the collection (a SequenceableCollection)
indexStart (int) – the first index of the collection to use (an uint64_t)
indexEnd (int) – the last index of the collection to use (an uint64_t)

fillHistogram2DFromChannels(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel1: int, tChannel2: int, IROI: ORSModel.ors.ROI, tROI: int, IProgress: ORSModel.ors.Progress)

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram to fill (an HistogramData)
IChannel1 (ORSModel.ors.Channel) – the channel of the first dimension (an Channel)
IChannel2 (ORSModel.ors.Channel) – the channel of the second dimension (an Channel)
tChannel1 (int) – the t index of the channel of the first dimension (an unsigned int)
tChannel2 (int) – the t index of the channel of the second dimension (an unsigned int)
IROI (ORSModel.ors.ROI) – the ROI specifying what channel voxels to include (an ROI). If this parameter is given as nullptr, all channel voxels will be used.
tROI (int) – the t index of the ROI (an unsigned int)
IProgress (ORSModel.ors.Progress) –

fillHistogram2DFromChannelsSubset(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel: int, xmin: int, ymin: int, zmin: int, xmax: int, ymax: int, zmax: int)

Fill a 2D histogram from the channels values, over a subset of the volume.

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram to fill (an HistogramData)
IChannel1 (ORSModel.ors.Channel) – the channel of the first dimension (an Channel)
IChannel2 (ORSModel.ors.Channel) – the channel of the second dimension (an Channel)
tChannel (int) – the t index of the channels (an unsigned int)
xmin (int) – the minimal x index of the channels to use (an unsigned int)
ymin (int) – the minimal y index of the channels to use (an unsigned int)
zmin (int) – the minimal z index of the channels to use (an unsigned int)
xmax (int) – the maximal x index of the channels to use (an unsigned int)
ymax (int) – the maximal y index of the channels to use (an unsigned int)
zmax (int) – the maximal z index of the channels to use (an unsigned int)

fillHistogram2DFromCollections(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, ICollection2: ORSModel.ors.SequenceableCollection, IFilterCollection: ORSModel.ors.SequenceableCollection, IArrayBinIndexes: ORSModel.ors.ArrayUnsignedLONGLONG)

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram to fill (an HistogramData)
ICollection1 (ORSModel.ors.SequenceableCollection) – the collection values of the first dimension (a SequenceableCollection)
ICollection2 (ORSModel.ors.SequenceableCollection) – the collection values of the second dimension (a SequenceableCollection)
IFilterCollection (ORSModel.ors.SequenceableCollection) – the filter collection (a SequenceableCollection). If this parameter is given as nullptr, all elements of the collections values will be used.
IArrayBinIndexes (ORSModel.ors.ArrayUnsignedLONGLONG) – an array filled with the linear bin index of each element. If this parameter is given as nullptr, these indexes won’t be returned.

fillHistogram2DFromCollectionsSubset(self, IHistogramData: ORSModel.ors.HistogramData, ICollection1: ORSModel.ors.SequenceableCollection, ICollection2: ORSModel.ors.SequenceableCollection, indexStart: int, indexEnd: int)

Fill a 2D histogram from the collections values, over a subset of the collection.

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram to fill (an HistogramData)
ICollection1 (ORSModel.ors.SequenceableCollection) – the collection of the first dimension (a SequenceableCollection)
ICollection2 (ORSModel.ors.SequenceableCollection) – the collection of the second dimension (a SequenceableCollection)
indexStart (int) – the first index of the collections to use (an uint64_t)
indexEnd (int) – the last index of the collections to use (an uint64_t)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getOtsuThreshold(self, IHistogramData: ORSModel.ors.HistogramData, dimension: int) → float

Computes the Otsu threshold value along a dimension.

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the ND histogram (an HistogramData)
dimension (int) – the dimension along which the threshold is computed (an unsigned int)

Returns:

output (float) –

mapHistogram2DLabels(self, IHistogramData: ORSModel.ors.HistogramData, ILMRHistogramLabels: ORSModel.ors.MultiROI, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel1: int, tChannel2: int, IROI: ORSModel.ors.ROI, tROI: int, ILMROutput: ORSModel.ors.MultiROI, tLMR: int)

Parameters:

IHistogramData (ORSModel.ors.HistogramData) – the 2D histogram (an HistogramData)
ILMRHistogramLabels (ORSModel.ors.MultiROI) – the LMR of labels (histogram classification) (an MultiROI)
IChannel1 (ORSModel.ors.Channel) – the channel of the first dimension (an Channel)
IChannel2 (ORSModel.ors.Channel) – the channel of the second dimension (an Channel)
tChannel1 (int) – the t index of the channel of the first dimension (an unsigned int)
tChannel2 (int) – the t index of the channel of the second dimension (an unsigned int)
IROI (ORSModel.ors.ROI) – the ROI specifying what channel voxels to include (an ROI). If this parameter is given as nullptr, all channel voxels will be used.
tROI (int) – the t index of the ROI (an unsigned int)
ILMROutput (ORSModel.ors.MultiROI) – the LMR receiving the labels (volume segmentation) (an MultiROI)
tLMR (int) – the t index of the LMR (an unsigned int)

none() → HistogramAnalyzer

Returns:: output (HistogramAnalyzer) –

HistogramData¶

class ORSModel.ors.HistogramData(*args, **kwargs)

Bases: Node

An object that contains histogram data.

addCountAtIndex1D(self, iIndex: int, countToAdd: int)

Add a number of counts at the given indexes.

Parameters:

iIndex (int) – bin index of the dimension 0
countToAdd (int) – number of counts to add

addCountAtIndex2D(self, iIndex0: int, iIndex1: int, countToAdd: int)

Add a number of counts at the given indexes.

Parameters:

iIndex0 (int) – bin index of the dimension 0
iIndex1 (int) – bin index of the dimension 1
countToAdd (int) – number of counts to add

addCountAtValue1D(self, dValue: float, countToAdd: int, pBinIndex: int)

Parameters:

dValue (float) – value in dimension 0
countToAdd (int) – number of counts to add
pBinIndex (int) – returned value of the linear bin index where the count is added

addCountAtValue2D(self, dValue0: float, dValue1: float, countToAdd: int, pLinearBinIndex: int)

Parameters:

dValue0 (float) – value in dimension 0
dValue1 (float) – value in dimension 1
countToAdd (int) – number of counts to add
pLinearBinIndex (int) – returned value of the linear bin index where the count is added

computeMax(self, dimension: int) → float

Computes the maximum, which is the greatest value of i such that histogram[i] > 0.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – maximum value (a double)

computeMean(self, dimension: int) → float

Computes the mean.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – mean value (a double)

computeMin(self, dimension: int) → float

Computes the minimum, which is the least value of i such that histogram[i] > 0.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – minimum value (a double)

computeMode(self, dimension: int) → float

Computes the mode.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – mode value (a double)

computeNthMoment(self, dimension: int, moment: int) → float

Computes the Nth moment.

Parameters:

dimension (int) – index of the dimension (starting at 0)
moment (int) – the moment to compute (starting at 1)

Returns:

output (float) – the Nth moment value (a double)

computeOtsu(self, dimension: int) → float

Computes the otsu.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – otsu threshold (a double)

computeStd(self, dimension: int) → float

Computes the standard deviation.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – standard deviation value (a double)

copyInto(self, destination: ORSModel.ors.HistogramData)

Copies the current histogram data in to the destination.

Parameters:: destination (ORSModel.ors.HistogramData) – destination Histogram

downSample(self, dimension: int, dStart: float, dEnd: float, nBins: int) → ORSModel.ors.HistogramData

Returns a downsampled histogram.

Parameters:

dimension (int) – index of the dimension (starting at 0)
dStart (float) – start of the bin edge
dEnd (float) – end of the bin edge
nBins (int) – number of bins for the new histogram

Returns:

output (ORSModel.ors.HistogramData) – ORS::HistogramData

HistogramData.downSample(self, dimension: int, nBins: int) -> ORSModel.ors.HistogramData

Returns a downsampled histogram.

Parameters:

dimension (int) – index of the dimension (starting at 0)
nBins (int) – number of bins for the new histogram

Returns:

output (ORSModel.ors.HistogramData) – ORS::HistogramData

getBinCount(self, dimension: int) → int

Get the number of bins in a given dimension.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (int) – The number of bins

getBinCounts(self) → ORSModel.ors.ArrayUnsignedLong

Get the number of bins in each dimension.

Returns:: output (ORSModel.ors.ArrayUnsignedLong) – An array with the number of bins in each dimension (an ArrayUnsignedLong)

getBinEdges(self, dimension: int) → ORSModel.ors.ArrayDouble

Get the bin edges of the range in a given dimension.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (ORSModel.ors.ArrayDouble) – An array with the bin edges (the number of edges is 1 more than the number of bins)

getBinEdgesEnd(self, dimension: int) → float

Get the ending value of the range in a given dimension.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – The ending value of the range

getBinEdgesStart(self, dimension: int) → float

Get the starting value of the range in a given dimension.

Parameters:: dimension (int) – index of the dimension (starting at 0)
Returns:: output (float) – The starting value of the range

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getCountAtIndex1D(self, iIndex: int) → int

Get the number of counts at the given index.

Parameters:: iIndex (int) – bin index
Returns:: output (int) – Number of counts

getCountAtIndex2D(self, iIndex0: int, iIndex1: int) → int

Get the number of counts at the given index.

Parameters:

iIndex0 (int) – bin index
iIndex1 (int) –

Returns:

output (int) – Number of counts

getCumulativeDistribution(self, dimension: int) → ORSModel.ors.HistogramData

Computes the cumulative distribution along one dimension.

Parameters:: dimension (int) – dimension along which the cumulation is made
Returns:: output (ORSModel.ors.HistogramData) – New histogramData

getData(self) → ArrayUnsignedLONGLONG

Returns:: output (ArrayUnsignedLONGLONG) –

getDimensionCount(self) → int

Get the number of dimensions.

Returns:: output (int) – The number of dimensions (a uint32_t)

getIndexAtValue1D(self, dValue: float) → int

Parameters:: dValue (float) – value
Returns:: output (int) – bin index

getIndexAtValueForDimension(self, dimension: int, dValue: float) → int

Parameters:

dimension (int) – index of the dimension (starting at 0)
dValue (float) – value

Returns:

output (int) – bin index

getIsDataInitialized(self) → bool

Get the status of the data.

Returns:: output (bool) – TRUE if the data is initialized, FALSE otherwise

getIsHistogramDegenerated(self) → bool

Returns:: output (bool) – TRUE if the histogram is degenerated, FALSE otherwise

getIsSparse(self) → bool

Get the sparse representation state.

Returns:: output (bool) – true if using a sparse representation, false if using a dense representation

initializeData(self) → bool

Returns:: output (bool) – TRUE if successful, FALSE otherwise

isValueInsideRangeLimits(self, dimension: int, dValue: float) → bool

Determines if the given value is in the range.

Parameters:

dimension (int) – index of the dimension (starting at 0)
dValue (float) – value to test

Returns:

output (bool) – TRUE if the value is inside the range, FALSE otherwise

none() → HistogramData

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (HistogramData) –

setBinEdgesFromArray(self, dimension: int, dValues: ORSModel.ors.ArrayDouble)

Parameters:

dimension (int) – array of bin edges (the number of bins is 1 less than the number of edges specified)
dValues (ORSModel.ors.ArrayDouble) –

setBinEdgesFromRange(self, dimension: int, dStart: float, dEnd: float, nbBins: int)

Parameters:

dimension (int) – index of the dimension (starting at 0)
dStart (float) – range start
dEnd (float) – range end
nbBins (int) – number of bins

setBinEdgesFromWidth(self, dimension: int, dStart: float, dWidth: float, nbBins: int)

Parameters:

dimension (int) – index of the dimension (starting at 0)
dStart (float) – range start
dWidth (float) – bin width
nbBins (int) – number of bins

setCountAtIndex1D(self, iIndex: int, countToSet: int)

Set the number of counts at the given index.

Parameters:

iIndex (int) – bin index in which the count should be set (a uint32_t)
countToSet (int) – number of counts to set

setCountAtIndex2D(self, iIndex0: int, iIndex1: int, countToSet: int)

Set the number of counts at the given index.

Parameters:

iIndex0 (int) – bin index in which the count should be set
iIndex1 (int) – number of counts to set
countToSet (int) –

setDimensionCount(self, nbDimensions: int)

Sets the number of dimensions.

Parameters:: nbDimensions (int) – number of dimensions (a uint32_t)

setUseSparse(self, bUseSparse: bool)

Specifies if a sparse representation should be used internally.

Parameters:: bUseSparse (bool) – true to use a sparse representation, false to use a dense representation

sumAlongDimension(self, dimension: int) → ORSModel.ors.HistogramData

Parameters:: dimension (int) – dimension along which the sum is made
Returns:: output (ORSModel.ors.HistogramData) – New histogramData

Image¶

class ORSModel.ors.Image(self)

Bases: Node

copyDataFromChannel(self, aChannel: ORSModel.ors.Channel, timeStep: int)

Parameters:

aChannel (ORSModel.ors.Channel) –
timeStep (int) –

copyDataFromChannelWithLookupTable(self, aChannel: ORSModel.ors.Channel, timeStep: int, levelingMinValue: float, levelingMaxValue: float, slabThickness: float, aLUT: ORSModel.ors.LookupTable, alpha: float, gamma: float)

Parameters:

aChannel (ORSModel.ors.Channel) –
timeStep (int) –
levelingMinValue (float) –
levelingMaxValue (float) –
slabThickness (float) –
aLUT (ORSModel.ors.LookupTable) –
alpha (float) –
gamma (float) –

exportToFile(filename)

Exports an image to a file

Parameters:: filename (file saving) – fully qualified file name
Returns:: exportSuccess (bool) – True if succeeded, False otherwise

flipImageDataHorizontally(self)

flipImageDataVertically(self)

getAllocatedSize(self) → int

Returns:: output (int) –

getBoundedPlane(self) → ORSModel.ors.Rectangle

Returns:: output (ORSModel.ors.Rectangle) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getComponentCountPerPixel(self) → int

Gets the number of components per pixel.

Returns:: output (int) – a count (an unsigned short)

getDataOffsetForPixelComponent(self, componentIndex: int) → float

Parameters:: componentIndex (int) –
Returns:: output (float) –

getDataSlopeForPixelComponent(self, componentIndex: int) → float

Parameters:: componentIndex (int) –
Returns:: output (float) –

getDataType(self) → int

Gets the image data type.

Note

See CxvChannel_Data_Type (in ORS_def.h) for supported types.

See also

CxvChannel_Data_Type, setDataType()

Returns:: output (int) – a type (a int32_t*)

getIsDataInitialized(self) → bool

Checks if the internal data is initialized.

Note

The channel must be initialized before you start using the channel.

See also

initializeData()

Returns:: output (bool) – true if initialized correctly, false otherwise

getMaxU(self) → float

Returns:: output (float) –

getMaxV(self) → float

Returns:: output (float) –

getMinU(self) → float

Returns:: output (float) –

getMinV(self) → float

Returns:: output (float) –

getRawImageData(self)

getXSize(self) → int

Gets the X size of the image.

Returns:: output (int) – the X size (a uint32_t)

getYSize(self) → int

Gets the Y size of the image.

Returns:: output (int) – the Y size (a uint32_t)

initialize(self, aDataType: int, componentPerPixelCount: int, aBoundedPlane: ORSModel.ors.Rectangle) → bool

Initializes the image.

Note

See CxvChannel_Data_Type (in ORS_def.h) for supported data types.

Parameters:

aDataType (int) – the datatype (a int32_t*, see note below)
componentPerPixelCount (int) – the number of components per pixel (an unsigned short)
aBoundedPlane (ORSModel.ors.Rectangle) – the image size (a Rectangle)

Returns:

output (bool) – TRUE if successful, FALSE otherwise

loadFromFile(filename)

Loads an image from a file

Parameters:: filename (file) – fully qualified file name
Returns:: exportSuccess (bool) – True if succeeded, False otherwise

none() → Image

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Image) –

setBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle)

Parameters:: aBoundedPlane (ORSModel.ors.Rectangle) –

setDataOffsetForPixelComponent(self, offset: float, componentIndex: int)

Parameters:

offset (float) –
componentIndex (int) –

setDataSlopeForPixelComponent(self, slope: float, componentIndex: int)

Parameters:

slope (float) –
componentIndex (int) –

setDirections(self, direction0: ORSModel.ors.Vector3, direction1: ORSModel.ors.Vector3)

Parameters:

direction0 (ORSModel.ors.Vector3) –
direction1 (ORSModel.ors.Vector3) –

setMaxU(self, aValue: float)

Parameters:: aValue (float) –

setMaxV(self, aValue: float)

Parameters:: aValue (float) –

setMinU(self, aValue: float)

Parameters:: aValue (float) –

setMinV(self, aValue: float)

Parameters:: aValue (float) –

setOrigin(self, origin: ORSModel.ors.Vector3)

Parameters:: origin (ORSModel.ors.Vector3) –

setSpacings(self, xSpacing: float, ySpacing: float)

Parameters:

xSpacing (float) –
ySpacing (float) –

transform(self, aTransformationMatrix: ORSModel.ors.Matrix4x4)

Parameters:: aTransformationMatrix (ORSModel.ors.Matrix4x4) –

ImageCollection¶

class ORSModel.ors.ImageCollection(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Bases: Node

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

ImageCollection.__init__(self)

deleteAllImages(self): Deletes all images.

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getImageAtIndex(self, imageIndex: int) → ORSModel.ors.Image

Gets the image at an index position.

Parameters:: imageIndex (int) – the image index (an uint32_t)
Returns:: output (ORSModel.ors.Image) – an image (an Image or NULL if index is invalid)

getImageCount(self) → int

Gets the image count.

Returns:: output (int) – the count of images (an uint32_t)

getIndexOfImage(self, anImage: ORSModel.ors.Image) → int

Gets the index position of an image.

Note

Returns -1 if image is not present.

Parameters:: anImage (ORSModel.ors.Image) – an image (an Image)
Returns:: output (int) – the image index (an int)

insertImageAtIndex(self, imageIndex: int, anImage: ORSModel.ors.Image)

Inserts an image at a given index.

Parameters:

imageIndex (int) – the image index (an uint32_t)
anImage (ORSModel.ors.Image) – an image (an Image)

insertImageFirst(self, anImage: ORSModel.ors.Image)

Inserts an image at start of list.

Parameters:: anImage (ORSModel.ors.Image) – an image (an Image)

insertImageLast(self, anImage: ORSModel.ors.Image)

Inserts an image at end of list.

Parameters:: anImage (ORSModel.ors.Image) – an image (an Image)

none() → ImageCollection

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (ImageCollection) –

removeAllImages(self): Removes all images.

removeImage(self, anImage: ORSModel.ors.Image)

Removes an image.

Parameters:: anImage (ORSModel.ors.Image) – an image (an Image)

removeImageAtIndex(self, imageIndex: int)

Removes the image at given index.

Parameters:: imageIndex (int) – the image index (an uint32_t)

ImageCollectionPresenter¶

class ORSModel.ors.ImageCollectionPresenter(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Bases: DatasetPresenter

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

ImageCollectionPresenter.__init__(self)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getImageIndexForView(self, aView: ORSModel.ors.View) → int

Parameters:: aView (ORSModel.ors.View) –
Returns:: output (int) –

getNodeVisibleForAllImage(self, aNode: ORSModel.ors.Node) → bool

Parameters:: aNode (ORSModel.ors.Node) –
Returns:: output (bool) –

getNodeVisibleForImage(self, aNode: ORSModel.ors.Node, anImage: ORSModel.ors.Image) → bool

Parameters:

aNode (ORSModel.ors.Node) –
anImage (ORSModel.ors.Image) –

Returns:

output (bool) –

getPresentationBoundedPlane(self) → ORSModel.ors.Rectangle

Returns:: output (ORSModel.ors.Rectangle) –

none() → ImageCollectionPresenter

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (ImageCollectionPresenter) –

setImageIndexForView(self, aView: ORSModel.ors.View, imageIndex: int)

Parameters:

aView (ORSModel.ors.View) –
imageIndex (int) –

setNodeNotVisibleForAllImage(self, aNode: ORSModel.ors.Node)

Parameters:: aNode (ORSModel.ors.Node) –

setNodeNotVisibleForImage(self, aNode: ORSModel.ors.Node, anImage: ORSModel.ors.Image)

Parameters:

aNode (ORSModel.ors.Node) –
anImage (ORSModel.ors.Image) –

setNodeVisibleForAllImage(self, aNode: ORSModel.ors.Node)

Parameters:: aNode (ORSModel.ors.Node) –

setNodeVisibleForImage(self, aNode: ORSModel.ors.Node, anImage: ORSModel.ors.Image)

Parameters:

aNode (ORSModel.ors.Node) –
anImage (ORSModel.ors.Image) –

setPresentationBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle)

Parameters:: aBoundedPlane (ORSModel.ors.Rectangle) –

Intersection¶

class ORSModel.ors.Intersection

Bases: Unmanaged

Represents a ray pick result.

See also

View::pick(), Node::pick()

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getClosestVisual(self) → ORSModel.ors.Visual

See also

getHighlightedVisual(), ORSModel.ors.Intersection.getFarthestVisual()

Returns:: output (ORSModel.ors.Visual) –

getClosestVisualOfClass(self, pProgId: str) → ORSModel.ors.Visual

See also

getHighlightedVisual(), ORSModel.ors.Intersection.getFarthestVisual()

Parameters:: pProgId (str) –
Returns:: output (ORSModel.ors.Visual) –

getColor(self) → ORSModel.ors.Color

Returns the color value of the intersection.

Returns:: output (ORSModel.ors.Color) – a color (a Color)

getColorInPhysicalUnits(self) → ORSModel.ors.Color

Gets the color value, adjusted to physical units (slope and offset).

See also

Returns:: output (ORSModel.ors.Color) – the color (a Color)

getControlPointIndexHit(self) → int

Returns:: output (int) –

getDataUnit(self) → str

Returns:: output (str) –

getDistance(self) → float

Returns the distance from the ray pick origin to the intersection.

Note

Distances are calculated in pixels.

Returns:: output (float) – a double

getFarthestVisual(self) → ORSModel.ors.Visual

See also

getHighlightedVisual(), ORSModel.ors.Intersection.getClosestVisual()

Returns:: output (ORSModel.ors.Visual) –

getFarthestVisualOfClass(self, pProgId: str) → ORSModel.ors.Visual

See also

getHighlightedVisual(), ORSModel.ors.Intersection.getClosestVisual()

Parameters:: pProgId (str) –
Returns:: output (ORSModel.ors.Visual) –

getHit(self) → bool

Checks if the ray pick intersects something.

Returns:: output (bool) – true if the intersection is valid, false otherwise

getHitCount(self) → int

Returns:: output (int) –

getMeshFace(self) → int

When picking a mesh, returns the face index of the triangle being picked.

Returns:: output (int) – a face index in the mesh (a int32_t*)

getMeshFaceBary1(self) → float

See also

getBary2()

Returns:: output (float) –

getMeshFaceBary2(self) → float

See also

getBary2()

Returns:: output (float) –

getMeshVertexIndex0(self) → int

When picking a mesh, returns the index 1 of the vertex being picked.

Returns:: output (int) – a vertex index 1 (a int32_t*)

getMeshVertexIndex1(self) → int

When picking a mesh, returns the index 1 of the vertex being picked.

Returns:: output (int) – a vertex index 1 (a int32_t*)

getMeshVertexIndex2(self) → int

When picking a mesh, returns the index 1 of the vertex being picked.

Returns:: output (int) – a vertex index 1 (a int32_t*)

getNearestMeshVertexIndex(self) → int

When picking a mesh, returns the vertex index nearest to the point being picked.

Returns:: output (int) – a vertex index in the mesh (a int32_t*)

getNthDistance(self, nth: int) → float

Parameters:: nth (int) –
Returns:: output (float) –

getNthLabel(self, nth: int) → int

Parameters:: nth (int) –
Returns:: output (int) –

getNthMeshFace(self, nth: int) → int

Parameters:: nth (int) –
Returns:: output (int) –

getNthMeshFaceBary1(self, nth: int) → float

Parameters:: nth (int) –
Returns:: output (float) –

getNthMeshFaceBary2(self, nth: int) → float

Parameters:: nth (int) –
Returns:: output (float) –

getNthMeshVertexIndex0(self, nth: int) → int

Parameters:: nth (int) –
Returns:: output (int) –

getNthMeshVertexIndex1(self, nth: int) → int

Parameters:: nth (int) –
Returns:: output (int) –

getNthMeshVertexIndex2(self, nth: int) → int

Parameters:: nth (int) –
Returns:: output (int) –

getNthNearestMeshVertexIndex(self, nth: int) → int

Parameters:: nth (int) –
Returns:: output (int) –

getNthPositionInLocalCoordinates(self, nth: int) → ORSModel.ors.Vector3

Parameters:: nth (int) –
Returns:: output (ORSModel.ors.Vector3) –

getNthPositionInWorldCoordinates(self, nth: int) → ORSModel.ors.Vector3

Parameters:: nth (int) –
Returns:: output (ORSModel.ors.Vector3) –

getNthScalarValue(self, nth: int) → float

Parameters:: nth (int) –
Returns:: output (float) –

getOffset(self) → float

Gets the intersection offset, which is the offset of the channel being picked.

See also

ORSModel.ors.Intersection.getSlope()

Returns:: output (float) – the offset (a double)

getPickDirection(self) → ORSModel.ors.Vector3

Returns:: output (ORSModel.ors.Vector3) –

getPickOrigin(self) → ORSModel.ors.Vector3

Returns:: output (ORSModel.ors.Vector3) –

getPixelPositionInView(self) → ORSModel.ors.Vector3

Returns the position of the intersection in screen coordinates.

Returns:: output (ORSModel.ors.Vector3) – a point (an Vector3)

getPositionInLocalCoordinates(self) → ORSModel.ors.Vector3

Returns the position of the intersection in local coordinates.

Returns:: output (ORSModel.ors.Vector3) – a point (a Vector3)

getPositionInVoxelIndex(self) → ORSModel.ors.Vector3

Returns the position of the intersection as X/Y/Z indicies.

Note

The point vector will contain X/Y/Z indicies.

Returns:: output (ORSModel.ors.Vector3) – a point (an Vector3)

getPositionInWorldCoordinates(self) → ORSModel.ors.Vector3

Returns the position of the intersection in world coordinates.

Returns:: output (ORSModel.ors.Vector3) – a point (an Vector3)

getScalarValue(self) → float

Returns the scalar value of the picked triangle.

Returns:: output (float) – the scalar value (a double)

getSlope(self) → float

Gets the intersection slope, which is the slope of the channel being picked.

See also

ORSModel.ors.Intersection.getOffset()

Returns:: output (float) – the slope (a double)

getStructuredGridAtIndex(self, iIndex: int) → ORSModel.ors.StructuredGrid

Note

Since more than one visual can be found by the pick ray, either because visuals are superimposed or because they are found within the pick tolerance, this method returns the Nth visual.

Parameters:: iIndex (int) – the structured grid index (an unsigned short, zero based)
Returns:: output (ORSModel.ors.StructuredGrid) – a structured grid (a StructuredGrid), or NULL if the index given is invalid

getStructuredGridCount(self) → int

Returns:: output (int) –

getTimeStep(self) → int

Returns the T value of the intersection.

Returns:: output (int) – a uint32_t

getVisualAtIndex(self, iIndex: int) → ORSModel.ors.Visual

Note

Since more than one visual can be found by the pick ray, either because visuals are superimposed or because they are found within the pick tolerance, this method returns the Nth visual.

Parameters:: iIndex (int) – the visual index (an unsigned short, zero based)
Returns:: output (ORSModel.ors.Visual) – a visual (a Visual), or NULL if the index given is invalid

getVisualCount(self) → int

Returns:: output (int) –

getVoxelIndex(self) → int

Returns:: output (int) –

getWindowLeveledNormalizedValue(self) → float

Returns the value with window leveling applied, normalized between 0 and 1.

Returns:: output (float) – a double between 0 and 1

getXIndexInCurvedChannel(self) → float

Returns:: output (float) –

getYIndexInCurvedChannel(self) → float

Returns:: output (float) –

none() → Intersection

Returns:: output (Intersection) –

Layout¶

class ORSModel.ors.Layout(*args, **kwargs)

Bases: Managed

object used to describe a view layout

addFirst(self, aLayout: ORSModel.ors.Layout)

Parameters:: aLayout (ORSModel.ors.Layout) –

addLast(self, aLayout: ORSModel.ors.Layout)

Parameters:: aLayout (ORSModel.ors.Layout) –

getAllChildLayout(self) → ORSModel.ors.List

Returns:: output (ORSModel.ors.List) –

getAllChildViews(self) → ORSModel.ors.List

Returns:: output (ORSModel.ors.List) –

getAllLeaves(self) → ORSModel.ors.List

Returns:: output (ORSModel.ors.List) –

getBottomRight(self) → ORSModel.ors.Vector3

Returns:: output (ORSModel.ors.Vector3) –

getBottomRightPositionOfChildren(self, aLayout: ORSModel.ors.Layout) → ORSModel.ors.Vector3

Parameters:: aLayout (ORSModel.ors.Layout) –
Returns:: output (ORSModel.ors.Vector3) –

getChildWithPrivateTitle(self, privateTitle: str) → ORSModel.ors.Layout

Parameters:: privateTitle (str) –
Returns:: output (ORSModel.ors.Layout) –

getChildren(self) → ORSModel.ors.List

Returns:: output (ORSModel.ors.List) –

getChildrenAtIndex(self, index: int) → ORSModel.ors.Layout

Parameters:: index (int) –
Returns:: output (ORSModel.ors.Layout) –

getChildrenCount(self) → int

Returns:: output (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getEnabled(self) → bool

Returns:: output (bool) –

getEnabledChildrenCount(self) → int

Returns:: output (int) –

getGenealogicalName(self) → str

Returns:: output (str) –

getHasChildren(self) → bool

Returns:: output (bool) –

getIsLayoutMyDescendent(self, aLayout: ORSModel.ors.Layout) → bool

Parameters:: aLayout (ORSModel.ors.Layout) –
Returns:: output (bool) –

getIsLinear(self) → bool

Returns:: output (bool) –

getIsMyChildren(self, aLayout: ORSModel.ors.Layout) → bool

Parameters:: aLayout (ORSModel.ors.Layout) –
Returns:: output (bool) –

getIsVertical(self) → bool

Returns:: output (bool) –

getLayoutClass(self) → str

Returns:: output (str) –

getLeaveEmpty(self) → bool

Returns:: output (bool) –

getParent(self) → ORSModel.ors.Layout

Returns:: output (ORSModel.ors.Layout) –

getTopLeft(self) → ORSModel.ors.Vector3

Returns:: output (ORSModel.ors.Vector3) –

getTopLeftPositionOfChildren(self, aLayout: ORSModel.ors.Layout) → ORSModel.ors.Vector3

Parameters:: aLayout (ORSModel.ors.Layout) –
Returns:: output (ORSModel.ors.Vector3) –

getViewGUID(self) → str

Returns:: output (str) –

getWeight(self) → float

Returns:: output (float) –

none() → Layout

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Layout) –

normalizeChildrenWeights(self)

propagateLayoutUpdated(self) → bool

Returns:: output (bool) –

removeAllChildren(self)

removeChildren(self, aLayout: ORSModel.ors.Layout)

Parameters:: aLayout (ORSModel.ors.Layout) –

replaceChildren(self, aLayoutToBeReplace: ORSModel.ors.Layout, aLayoutReplacement: ORSModel.ors.Layout) → bool

Parameters:

aLayoutToBeReplace (ORSModel.ors.Layout) –
aLayoutReplacement (ORSModel.ors.Layout) –

Returns:

output (bool) –

setBottomRight(self, aVector: ORSModel.ors.Vector3)

Parameters:: aVector (ORSModel.ors.Vector3) –

setEnabled(self, bEnabled: bool)

Parameters:: bEnabled (bool) –

setIsLinear(self, aValue: bool)

Parameters:: aValue (bool) –

setIsVertical(self, aValue: bool)

Parameters:: aValue (bool) –

setLayoutClass(self, aClass: str)

Parameters:: aClass (str) –

setLeaveEmpty(self, aValue: bool)

Parameters:: aValue (bool) –

setTopLeft(self, aVector: ORSModel.ors.Vector3)

Parameters:: aVector (ORSModel.ors.Vector3) –

setViewGUID(self, aGUID: str)

Parameters:: aGUID (str) –

setWeight(self, aValue: float)

Parameters:: aValue (float) –

Line¶

class ORSModel.ors.Line

Bases: Shape2D

Line manipulation services.

copy(self) → ORSModel.ors.Line

Gets a copy of the receiver.

Returns:: output (ORSModel.ors.Line) – a line (an Line)

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

Create aUnmanaged Object from a python representation a static method.

Parameters:: aPythonRepresentation (str) –
Returns:: output (ORSModel.ors.Line) –

fromOriginAndOrientation(self, origin: ORSModel.ors.Vector3, orientation: ORSModel.ors.Vector3)

Sets the the origin and orientation of the line.

Note

The orientation vector will be normalized.

Parameters:

origin (ORSModel.ors.Vector3) – a point (an Vector3)
orientation (ORSModel.ors.Vector3) – an orientation (an Vector3)

fromTwoPoints(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3)

Sets the the origin and orientation of the line based on the two provided points.

Parameters:

point0 (ORSModel.ors.Vector3) – a point (an Vector3)
point1 (ORSModel.ors.Vector3) – a point (an Vector3)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getClosestPointOnLineFromPoint(self, aPoint: ORSModel.ors.Vector3) → ORSModel.ors.Vector3

Parameters:: aPoint (ORSModel.ors.Vector3) –
Returns:: output (ORSModel.ors.Vector3) –

getDistanceFromLine(self, aLine: ORSModel.ors.Line) → float

Parameters:: aLine (ORSModel.ors.Line) –
Returns:: output (float) –

getDistanceFromPoint(self, pVect: ORSModel.ors.Vector3) → float

Gets the distance from the receiver to the provided point.

Parameters:: pVect (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:: output (float) – the distance (a double)

getIsEqualTo(self, aLine: ORSModel.ors.Line) → bool

Parameters:: aLine (ORSModel.ors.Line) –
Returns:: output (bool) –

getIsIntersectingShape(self, aShape: ORSModel.ors.Shape) → bool

Gets if the receiver intersects the given shape.

Parameters:: aShape (ORSModel.ors.Shape) – a shape to intersect with the receiver (a Shape)
Returns:: output (bool) – TRUE if the receiver intersects the shape, FALSE otherwise (a bool)

getOrientation(self) → ORSModel.ors.Vector3

Gets the receiver orientation.

Note

The orientation vector is normalized.

Returns:: output (ORSModel.ors.Vector3) – a vector (an Vector3)

getOrigin(self) → ORSModel.ors.Vector3

Gets the receiver origin position.

Note

The origin is in world coordinates.

Returns:: output (ORSModel.ors.Vector3) – the origin (an Vector3)

none() → Line

Returns:: output (Line) –

setOrientation(self, pVect: ORSModel.ors.Vector3)

Sets the receiver orientation.

Note

The orientation vector will be normalized.

Parameters:: pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

setOrigin(self, pVect: ORSModel.ors.Vector3)

Sets the receiver origin position.

Note

The origin should be in world coordinates.

Parameters:: pVect (ORSModel.ors.Vector3) – a poing (an Vector3)

LineSegment¶

class ORSModel.ors.LineSegment

Bases: Shape2D

Line segment manipulation services.

copy(self) → ORSModel.ors.LineSegment

Gets a copy of the receiver.

Returns:: output (ORSModel.ors.LineSegment) – a box (an LineSegment)

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

Create aUnmanaged Object from a python representation a static method.

Parameters:: aPythonRepresentation (str) –
Returns:: output (ORSModel.ors.LineSegment) –

fromOriginAndDirectionAndLength(self, origin: ORSModel.ors.Vector3, direction: ORSModel.ors.Vector3, length: float)

Parameters:

origin (ORSModel.ors.Vector3) –
direction (ORSModel.ors.Vector3) –
length (float) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getDistanceFromPoint(self, pVect: ORSModel.ors.Vector3) → float

Gets the distance from the receiver to the provided point,.

Parameters:: pVect (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:: output (float) – the distance (a double)

getEnd(self) → ORSModel.ors.Vector3

Gets the receiver end point.

Returns:: output (ORSModel.ors.Vector3) – a point (an Vector3)

getEndProvidingOutput(self, pVect: ORSModel.ors.Vector3)

Parameters:: pVect (ORSModel.ors.Vector3) –

getIsEqualTo(self, aLineSegment: ORSModel.ors.LineSegment) → bool

Parameters:: aLineSegment (ORSModel.ors.LineSegment) –
Returns:: output (bool) –

getIsIntersectingShape(self, aShape: ORSModel.ors.Shape) → bool

Gets if the receiver intersects the given shape.

Parameters:: aShape (ORSModel.ors.Shape) – a shape to intersect with the receiver (a Shape)
Returns:: output (bool) – TRUE if the receiver intersects the shape, FALSE otherwise (a bool)

getLength(self) → float

Gets the receiver length.

Returns:: output (float) – a length (a double)

getPointInBetween(self, aRatio: float) → ORSModel.ors.Vector3

Parameters:: aRatio (float) –
Returns:: output (ORSModel.ors.Vector3) –

getStart(self) → ORSModel.ors.Vector3

Gets the receiver start point.

Returns:: output (ORSModel.ors.Vector3) – a point (an Vector3)

getStartProvidingOutput(self, pVect: ORSModel.ors.Vector3)

Parameters:: pVect (ORSModel.ors.Vector3) –

none() → LineSegment

Returns:: output (LineSegment) –

setEnd(self, pVect: ORSModel.ors.Vector3)

Sets the receiver end point.

Parameters:: pVect (ORSModel.ors.Vector3) – a point (an Vector3)

setStart(self, pVect: ORSModel.ors.Vector3)

Set the receiver start point.

Parameters:: pVect (ORSModel.ors.Vector3) – a point (an Vector3)

List¶

class ORSModel.ors.List

Bases: ORSBaseClass

A list of Managed instances.

See also

Managed, Node A list of Managed instances.

Several methods in the SDK return lists of objects. Some typecasts are necessary to convert Object instances to their correct type

because all services of List take or return only Managed instances.

add(self, pObject: ORSModel.ors.Managed)

Adds an object to the list.

Parameters:: pObject (ORSModel.ors.Managed) – an object (an Object)

appendAllObjects(self, pList: ORSModel.ors.List)

Note

All objects are taken from the appended list, whether or not they are already in the receiver list.

See also

ORSModel.ors.List.add()

Parameters:: pList (ORSModel.ors.List) –

appendNonPresentObjects(self, pList: ORSModel.ors.List)

Note

Only the objects not already in the receiver are taken from the appended list.

See also

ORSModel.ors.List.add()

Parameters:: pList (ORSModel.ors.List) –

getAllElementsOfClass(self, pProgId: str) → ORSModel.ors.List

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the class name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list (a List)

getClassNameStatic() → str

Returns:: output (str) –

getCount(self) → int

Returns the count of objects in the list.

Returns:: output (int) – object count (an uint32_t)

getIncludes(self, pObject: ORSModel.ors.Managed) → bool

Verifies if an object is present in the list.

See also

ORSModel.ors.List.getObjectAt()

Parameters:: pObject (ORSModel.ors.Managed) – an object (an Object)
Returns:: output (bool) – true if object is in the list, false otherwise

getIndexOf(self, pObject: ORSModel.ors.Managed) → int

Returns the index of an object in the list or -1 if not found.

Parameters:: pObject (ORSModel.ors.Managed) –
Returns:: output (int) –

getIntersectionWith(self, pList: ORSModel.ors.List) → ORSModel.ors.List

Returns the intersection of the list with another list.

Note

Objects duplicated in both lists only appear once in the intersected list.

Parameters:: pList (ORSModel.ors.List) – a list (a List)
Returns:: output (ORSModel.ors.List) – a new list (a List)

getObjectAt(self, pos: int) → ORSModel.ors.Managed

Gets an object from the list at the specified index.

Note

Index starts at zero (zero-based).

Note

When the type of the object is known, you can pre-type it as it will automatically typecast to the correct type, for example: Channel chan = someList.getObjectAt(0). If the object at index 0 is not a channel, chan will be none.

See also

ORSModel.ors.List.getIncludes()

Parameters:: pos (int) – an index (an uint32_t)
Returns:: output (ORSModel.ors.Managed) – an object (a Managed)

getPythonRepresentation(self) → str

Returns the python representation of the list.

Returns:: output (str) – std::wstring

getSubtractionFrom(self, pList: ORSModel.ors.List) → ORSModel.ors.List

Note

The subtraction results in a list of objects only in the receiver (union of both lists is removed from the list, or A - (A U B)).

Parameters:: pList (ORSModel.ors.List) –
Returns:: output (ORSModel.ors.List) –

getUnionWith(self, pList: ORSModel.ors.List) → ORSModel.ors.List

Returns the union of the list with another list.

Note

Objects duplicated in both lists only appear once in the unionized list.

Parameters:: pList (ORSModel.ors.List) – a list (a List)
Returns:: output (ORSModel.ors.List) – a new list (a List)

isNone(self) → bool

Checks if the object is none.

Returns:: output (bool) –

isNotNone(self) → bool

Checks if the object is not none.

Returns:: output (bool) –

loadEmptyObjectsFromFile(self, sFilename: str, classNames: List[str])

Note

This is meant to quickly analyze an object or session file to know what types of objects are within. An empty object of the correct class will be created for every object defined in the file.

Note

Once you’re done with the list, you need to send deleteObject() to all objects within.

Note

The filter list should be a list of class names to filter on, for example, to load only ROI and MultiROI objects, one would specify ROI::getClassNameStatic() and MultiROI::getClassNameStatic().

Parameters:

sFilename (str) – an input filename (a string)
classNames (List[str]) – list of class names (see note)

loadFromFile(self, sFilename: str, preserveIdentity: bool, progress: ORSModel.ors.Progress)

Note

This illustrates the meaning of the “preserve identity” argument: if you load a file that has the same object twice in a row, if you preserve identity you’ll obtain 1 object, if you don’t preserve identity you’ll obtain 2 objects (both having the same internal state).

Parameters:

sFilename (str) – true to preserve identity, false otherwise (see note)
preserveIdentity (bool) – an optional progress object
progress (ORSModel.ors.Progress) –

loadFromFileFiltered(self, sFilename: str, preserveIdentity: bool, classNames: List[str], progress: ORSModel.ors.Progress)

Note

This illustrates the meaning of the “preserve identity” argument: if you load a file that has the same object twice in a row, if you preserve identity you’ll obtain 1 object, if you don’t preserve identity you’ll obtain 2 objects (both having the same internal state).

Note

The filter list should be a list of class names to filter on, for example, to load only ROI and MultiROI objects, one would specify ROI::getClassNameStatic() and MultiROI::getClassNameStatic().

Parameters:

sFilename (str) – an input filename (a string)
preserveIdentity (bool) – true to preserve identity, false otherwise (see note)
classNames (List[str]) – list of class names (see note)
progress (ORSModel.ors.Progress) – a progress object

loadSpecificObjectsFromFile(self, sFilename: str, preserveIdentity: bool, guids: List[str], progress: ORSModel.ors.Progress)

Note

This illustrates the meaning of the “preserve identity” argument: if you load a file that has the same object twice in a row, if you preserve identity you’ll obtain 1 object, if you don’t preserve identity you’ll obtain 2 objects (both having the same internal state).

Parameters:

sFilename (str) – an input filename (a string)
preserveIdentity (bool) – true to preserve identity, false otherwise (see note)
guids (List[str]) – list of GUIDs to load
progress (ORSModel.ors.Progress) – a progress object

none() → List

Returns:: output (List) –

remove(self, pObject: ORSModel.ors.Managed) → bool

Removes an object from the list.

Parameters:: pObject (ORSModel.ors.Managed) – an object (an Object)
Returns:: output (bool) – true if object was removed, false otherwise (it wasn’t in the list)

saveToFile(self, sFilename: str, iCompressionEngine: int = 1) → int

Saves all the objects in the list to a file.

See also

ORSModel.ors.List.loadFromFile()

Parameters:

sFilename (str) – an output filename (a string)
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – a result (an int, 0 for no error, otherwise an error code)

saveToFileToLegacyFormat(self, sFilename: str, iCompressionEngine: int = 1) → int

Saves all the objects in the list to a file in the legacy (2022.2) format.

See also

ORSModel.ors.List.loadFromFile()

Parameters:

sFilename (str) – an output filename (a string)
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – a result (an int, 0 for no error, otherwise an error code)

Loader¶

class ORSModel.ors.Loader(*args, **kwargs)

Bases: Managed

Allows to load previously saved ORS objects.

See also

Saver Allows to load previously saved ORS objects. ORS objects are saved in XML format,

so this loader uses internally the msxml framework (hence the frequent mention of DOM). Can be used to load and parse any XML (i.e. not only to load objects).

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getCurrentNodeAttributeValue(self, attributeName: str) → str

Parameters:: attributeName (str) –
Returns:: output (str) –

getCurrentNodeBoolAttributeValue(self, sAttributeName: str) → bool

Gets a boolean attribute from the current node in an XML tree being parsed.

Note

Return is false if attribute name is not found.

Parameters:: sAttributeName (str) – the attribute name (a string)
Returns:: output (bool) – the value (a bool)

getCurrentNodeBoolValue(self) → bool

Gets the current node boolean value in an XML tree being parsed.

Returns:: output (bool) – the node value (a bool)

getCurrentNodeCompletePath(self) → str

Gets the current node’s complete path from the document root.

Returns:: output (str) – the path (a string)

getCurrentNodeDoubleAttributeValue(self, sAttributeName: str) → float

Gets a double attribute from the current node in an XML tree being parsed.

Note

Return is 0.0 if attribute name is not found.

Parameters:: sAttributeName (str) – the attribute name (a string)
Returns:: output (float) – the value (a double)

getCurrentNodeDoubleValue(self) → float

Gets the current node double value in an XML tree being parsed.

Returns:: output (float) – the node value (a double)

getCurrentNodeFloatAttributeValue(self, sAttributeName: str) → float

Gets a float attribute from the current node in an XML tree being parsed.

Note

Return is 0.0f if attribute name is not found.

Parameters:: sAttributeName (str) – the attribute name (a string)
Returns:: output (float) – the value (a float)

getCurrentNodeFloatValue(self) → float

Gets the current node float value in an XML tree being parsed.

Returns:: output (float) – the node value (a float)

getCurrentNodeIntAttributeValue(self, sAttributeName: str) → int

Gets an int attribute from the current node in an XML tree being parsed.

Note

Return is 0 if attribute name is not found.

Parameters:: sAttributeName (str) – the attribute name (a string)
Returns:: output (int) – the value (an int)

getCurrentNodeIntValue(self) → int

Gets the current node int value in an XML tree being parsed.

Returns:: output (int) – the node value (an int)

getCurrentNodeLONGLONGValue(self) → int

Gets the current node int64_t value in an XML tree being parsed.

Returns:: output (int) – the node value (a int64_t)

getCurrentNodeName(self) → str

Gets the current node’s name.

Returns:: output (str) – the name (a string)

getCurrentNodeShortAttributeValue(self, sAttributeName: str) → int

Gets a short attribute from the current node in an XML tree being parsed.

Note

Return is 0 if attribute name is not found.

Parameters:: sAttributeName (str) – the attribute name (a string)
Returns:: output (int) – the value (a short)

getCurrentNodeShortValue(self) → int

Gets the current node short value in an XML tree being parsed.

Returns:: output (int) – the node value (a short)

getCurrentNodeULONGLONGValue(self) → int

Gets the current node uint64_t value in an XML tree being parsed.

Returns:: output (int) – the node value (an uint64_t)

getCurrentNodeUnsignedIntAttributeValue(self, sAttributeName: str) → int

Gets an unsigned int attribute from the current node in an XML tree being parsed.

Note

Return is 0 if attribute name is not found.

Parameters:: sAttributeName (str) – the attribute name (a string)
Returns:: output (int) – the value (an unsigned int)

getCurrentNodeUnsignedIntValue(self) → int

Gets the current node unsigned int value in an XML tree being parsed.

Returns:: output (int) – the node value (an unsigned int)

getCurrentNodeUnsignedShortAttributeValue(self, sAttributeName: str) → int

Gets an unsigned short attribute from the current node in an XML tree being parsed.

Note

Return is 0 if attribute name is not found.

Parameters:: sAttributeName (str) – the attribute name (a string)
Returns:: output (int) – the value (an unsigned short)

getCurrentNodeUnsignedShortValue(self) → int

Gets the current node unsigned short value in an XML tree being parsed.

Returns:: output (int) – the node value (an unsigned short)

getCurrentNodeValue(self) → str

Returns:: output (str) –

getDataOffset(self, pXpath: str) → int

Gets the data position of a given node.

Parameters:: pXpath (str) – an XPath (a string)
Returns:: output (int) – the offset value (an uint64_t)

getFileValidity(self, filename: str) → int

Validates a given file, returning a result code.

Note

Return is 0 if file is valid, otherwise an error code.

Parameters:: filename (str) – a filename (a string)
Returns:: output (int) – a result code (an int64_t)

getNodeBoolValueFromCurrentNode(self, sElementName: str) → bool

Gets a boolean element from the current node in an XML tree being parsed.

Note

Return is false if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (bool) – the value (a bool)

getNodeCount(self, pXpath: str) → int

Returns the nodes count according to an XPATH.

Parameters:: pXpath (str) – the XPATH to search for (a string)
Returns:: output (int) – the number of nodes found (an int)

getNodeDoubleValueFromCurrentNode(self, sElementName: str) → float

Gets a double element from the current node in an XML tree being parsed.

Note

Return is 0.0 if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (float) – the value (a double)

getNodeFloatValueFromCurrentNode(self, sElementName: str) → float

Gets a float element from the current node in an XML tree being parsed.

Note

Return is 0.0f if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (float) – the value (a float)

getNodeIntValueFromCurrentNode(self, sElementName: str) → int

Gets an int element from the current node in an XML tree being parsed.

Note

Return is 0 if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (int) – the value (an int)

getNodeLONGLONGValueFromCurrentNode(self, sElementName: str) → int

Gets a int64_t element from the current node in an XML tree being parsed.

Note

Return is 0 if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (int) – the value (a int64_t)

getNodeShortValueFromCurrentNode(self, sElementName: str) → int

Gets a short element from the current node in an XML tree being parsed.

Note

Return is 0 if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (int) – the value (a short)

getNodeULONGLONGValueFromCurrentNode(self, sElementName: str) → int

Gets a uint64_t element from the current node in an XML tree being parsed.

Note

Return is 0 if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (int) – the value (an uint64_t)

getNodeUnsignedIntValueFromCurrentNode(self, sElementName: str) → int

Gets an unsigned int element from the current node in an XML tree being parsed.

Note

Return is 0 if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (int) – the value (an unsigned int)

getNodeUnsignedShortValueFromCurrentNode(self, sElementName: str) → int

Gets an unsigned short element from the current node in an XML tree being parsed.

Note

Return is 0 if element name is not valid nor found.

Parameters:: sElementName (str) – the element name (a string)
Returns:: output (int) – the value (an unsigned short)

getNodeValueFromCurrentNode(self, pXpath: str) → str

Parameters:: pXpath (str) –
Returns:: output (str) –

getVersionFromFile(self, filename: str) → str

Returns the version number stored in a session file.

Parameters:: filename (str) – the file name (a string)
Returns:: output (str) – the version number (a string)

getXML(self) → str

Returns the underlying XML string.

Returns:: output (str) – An XML string

isCurrentFileCompressed(self) → bool

Verifies if current file is compressed or not.

Returns:: output (bool) – true if compressed, false otherwise

loadObjectsFromFile(self, filename: str)

Loads objects from a file.

Note

All ORS objects can save themselves to file, in an XML format.

Parameters:: filename (str) – the file name (a string)

loadObjectsFromXML(self, anXML: str)

Loads objects from an XML string.

Note

All ORS objects can save themselves in an XML format.

Parameters:: anXML (str) – the XML (a string)

none() → Loader

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Loader) –

pop(self): Goes up one level in an XML tree being parsed.

setCurrentNode(self, pXpath: str) → bool

Selects a node in an XML tree being parsed.

Parameters:: pXpath (str) – an XPath (a string)
Returns:: output (bool) – true if successful, false otherwise

setCurrentNodeFromCurrentNode(self, pXpath: str) → bool

Selects a node in an XML tree, under the current node.

Note

The node is only searched under the current node of the tree.

See also

ORSModel.ors.Loader.pop(), Saver::addAttributeToCurrentNode()

Parameters:: pXpath (str) – the node name (a string)
Returns:: output (bool) – true if successful, false otherwise

setCurrentNodeToCurrentNodeNextSibling(self) → bool

Moves to the next node equivalent to the current node, in an XML tree being parsed.

See also

ORSModel.ors.Loader.pop()

Returns:: output (bool) – true if successful, false otherwise

setXMLString(self, aXMLString: str) → bool

Gives an XML string to the loader and DOMifies it.

Parameters:: aXMLString (str) – an XML string (a string)
Returns:: output (bool) – true if the XML is valid, false otherwise

setXMLStringFromFilename(self, filename: str) → bool

Gives an XML string from a file to the loader and DOMifies it.

Parameters:: filename (str) – a filename containing the XML string (a string)
Returns:: output (bool) – true if the XML is valid, false otherwise

LookupTable¶

class ORSModel.ors.LookupTable(*args, **kwargs)

Bases: Node

A Lookup Table that can adopt predefined and/or custom looks.

See also

VisualMesh::setLookupTable(), Vector3::setLookupTable()

appendColor(self, IColor: ORSModel.ors.Color)

Add a color at the end of the table.

Parameters:: IColor (ORSModel.ors.Color) –

build(self): Builds the LUT according to its settings.

See also

ORSModel.ors.LookupTable.setRampRainbow(), ORSModel.ors.LookupTable.setRampGrayScale(), ORSModel.ors.LookupTable.setRampUserDefined()

buildDiscreteLUT(self): Build Discrete lut color and alpha control point arrays from color table.

Note

User-defined LUTs use color and alpha control points.

copyColorSettingsFrom(self, ILookupTable: ORSModel.ors.LookupTable)

Copy color settings from the given lookup table.

Note

Copies only the color settings, leaving the object attributes unchanged.

See also

ORSModel.ors.LookupTable.copyFrom()

Parameters:: ILookupTable (ORSModel.ors.LookupTable) –

copyFrom(self, ILookupTable: ORSModel.ors.LookupTable)

Copy internal parameters from the given lookup table.

Note

Copies everything (color settings and object attributes).

Parameters:: ILookupTable (ORSModel.ors.LookupTable) –

fillColorFromMultiROI(self, aMultiROI: ORSModel.ors.MultiROI)

Fill a LUT fromMultiROI label Color.

Parameters:: aMultiROI (ORSModel.ors.MultiROI) – a MultiROI (a MultiROI)

fillRGBAColorArray(self, startIndex: int, endIndex: int, colorsArray: bytes, subtractFactors: bytes)

Dump the lut in arrays.

Parameters:

startIndex (int) – startIndex
endIndex (int) – endIndex
colorsArray (bytes) – colorsArray an unsigned char* array of size 4*getTableSize()
subtractFactors (bytes) – subtractFactors an unsigned char* array of size getTableSize()

findAlphaControlPointIndexForPosition(self, pX: float) → int

Note

The returned value may be used to determine the insertion index of a new control point at a given position.

Parameters:: pX (float) –
Returns:: output (int) –

findColorControlPointIndexForPosition(self, pX: float) → int

Note

The returned value may be used to determine the insertion index of a new control point at a given position.

Parameters:: pX (float) –
Returns:: output (int) –

getAlphaControlPointAlphaValueHigh(self, index: int) → float

Parameters:: index (int) – the alpha control point index (a uint32_t)
Returns:: output (float) – the alpha value (a double)

getAlphaControlPointAlphaValueLow(self, index: int) → float

Parameters:: index (int) – the alpha control point index (a uint32_t)
Returns:: output (float) – the alpha value (a double)

getAlphaControlPointCount(self) → int

Retrieves the total number of alpha control points in the LUT.

Returns:: output (int) – the number of alpha control points (a uint32_t)

getAlphaControlPointIsSplit(self, index: int) → bool

Retrieves if the alpha control point is split.

Parameters:: index (int) – the alpha control point index (a uint32_t)
Returns:: output (bool) – the split value (a bool)

getAlphaControlPointPositionX(self, index: int) → float

Retrieves the X coordinate of an alpha control point.

Parameters:: index (int) – the alpha control point index (a uint32_t)
Returns:: output (float) – the X coordinate of the alpha control point (a double)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getColorAtIndex(self, inValue: int) → ORSModel.ors.Color

Get color at a given index.

Parameters:: inValue (int) – the color index (in range [0, getTableSize()-1] ) (a uint32_t)
Returns:: output (ORSModel.ors.Color) –

getColorAtPosition(self, position: float) → ORSModel.ors.Color

Note

This method returns a color at a position normalized between 0 and 1. If the position does not exactly match an existing color control point, the returned color will be an interpolation of the two closest colors.

Parameters:: position (float) –
Returns:: output (ORSModel.ors.Color) – the color (a Color)

getColorControlPointColorHigh(self, index: int) → ORSModel.ors.Color

Parameters:: index (int) – the color control point index (a uint32_t)
Returns:: output (ORSModel.ors.Color) – the color (an Color)

getColorControlPointColorLow(self, index: int) → ORSModel.ors.Color

Parameters:: index (int) – the color control point index (a uint32_t)
Returns:: output (ORSModel.ors.Color) – the color (an Color)

getColorControlPointCount(self) → int

Retrieves the total number of color control points in the LUT.

Returns:: output (int) – the number of color control points (a uint32_t)

getColorControlPointIsSplit(self, index: int) → bool

Retrieves if the color control point is split.

Parameters:: index (int) – the color control point index (a uint32_t)
Returns:: output (bool) – the split value (a bool)

getColorControlPointPositionX(self, index: int) → float

Retrieves the X coordinate of a color control point.

Parameters:: index (int) – the color control point index (a uint32_t)
Returns:: output (float) – the X coordinate of the color control point (a double)

getColorFromPosition(self, position: float, aColor: ORSModel.ors.Color)

Parameters:

position (float) –
aColor (ORSModel.ors.Color) –

getIsDiscrete(self) → bool

Gets if the lookup table is discrete.

Returns:: output (bool) –

getQtLinearGradientFromORSLut(rangeInPixelMin, rangeInPixelMax, isXGradient=True, useAlphaValue=True)

Creates and return a QtGui.QLinearGradient object from the current lookupTable

Parameters:

rangeInPixelMin (float) – starting value (pixel value) of the interpolation area
rangeInPixelMax (float) – final value (pixel value) of the interpolation area
isXGradient (bool) – if True, the linear the gradient will be along x direction, False for y. X gradient by default
useAlphaValue (bool) – if True, alpha value will be considered, false to not playing with the opacity.

getRampUsesControlPoints(self) → bool

Gets if the LUT is using control points to build his ramp.

Returns:: output (bool) – true if the LUTs uses color and alpha control points, false otherwise (a bool)

getTableSize(self) → int

Get the table size.

See also

getDiscreteD3DColorAt()

Returns:: output (int) – the table size (a uint32_t)

insertAlphaControlPointAt(self, index: int, x: float, alphaValueL: float, alphaValueH: float, bIsSplit: bool)

Parameters:

index (int) – the split value (a bool)
x (float) –
alphaValueL (float) –
alphaValueH (float) –
bIsSplit (bool) –

insertColorControlPointAt(self, index: int, x: float, IColorLow: ORSModel.ors.Color, IColorHigh: ORSModel.ors.Color, bIsSplit: bool)

Parameters:

index (int) – the split value (a bool)
x (float) –
IColorLow (ORSModel.ors.Color) –
IColorHigh (ORSModel.ors.Color) –
bIsSplit (bool) –

none() → LookupTable

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (LookupTable) –

removeAllAlphaControlPoints(self): Removes all LUT alpha control points.

removeAllColorControlPoints(self): Removes all LUT color control points.

removeAllControlPoints(self): Removes all LUT control points (color and alpha).

removeAlphaControlPointAt(self, index: int)

Removes an alpha control point.

Parameters:: index (int) – the alpha control point index (a uint32_t)

removeColorAtIndex(self, nIndex: int) → bool

Removes the color at the given index.

Parameters:: nIndex (int) –
Returns:: output (bool) –

removeColorControlPointAt(self, index: int)

Removes a color control point.

Parameters:: index (int) – the color control point index (a uint32_t)

setAlphaControlPointAlphaValueHigh(self, index: int, alphaValue: float)

Changes the alpha value of an alpha control point (higher portion).

Parameters:

index (int) – the alpha control point index (a uint32_t)
alphaValue (float) – the alpha value (a double). Should be in the range [0, 1].

setAlphaControlPointAlphaValueLow(self, index: int, alphaValue: float)

Changes the alpha value of an alpha control point (lower portion).

Parameters:

index (int) – the alpha control point index (a uint32_t)
alphaValue (float) – the alpha value (a double). Should be in the range [0, 1].

setAlphaControlPointIsSplit(self, index: int, bIsSplit: bool)

Parameters:

index (int) – the alpha control point index (a uint32_t)
bIsSplit (bool) – the split value (a bool)

setAlphaControlPointPosition(self, index: int, pX: float)

Changes the position of an alpha control point.

Parameters:

index (int) – the alpha control point index (a uint32_t)
pX (float) – the new X coordinate of the alpha control point (a double)

setColorAtIndex(self, nIndex: int, IColor: ORSModel.ors.Color)

Sets the color at the given index.

Parameters:

nIndex (int) –
IColor (ORSModel.ors.Color) –

setColorAtPosition(self, position: float, IColor: ORSModel.ors.Color)

Parameters:

position (float) –
IColor (ORSModel.ors.Color) –

setColorControlPointColorHigh(self, index: int, IColor: ORSModel.ors.Color)

Changes the color of a color control point (higher portion).

Parameters:

index (int) – the color control point index (a uint32_t)
IColor (ORSModel.ors.Color) – the color (a Color)

setColorControlPointColorLow(self, index: int, IColor: ORSModel.ors.Color)

Changes the color of a color control point (lower portion).

Parameters:

index (int) – the color control point index (a uint32_t)
IColor (ORSModel.ors.Color) – the color (a Color)

setColorControlPointIsSplit(self, index: int, bIsSplit: bool)

Parameters:

index (int) – the color control point index (a uint32_t)
bIsSplit (bool) – the split value (a bool)

setColorControlPointPosition(self, index: int, pX: float)

Changes the position of a color control point.

Parameters:

index (int) – the color control point index (a uint32_t)
pX (float) – the new X coordinate of the color control point (a double)

setColorForIndexRange(self, nStartIndex: int, nEndIndex: int, IColor: ORSModel.ors.Color)

Set color at a given index range.

Parameters:

nStartIndex (int) – the color start index (in range [0, getTableSize()-1] ) (a uint32_t)
nEndIndex (int) – the color end index (in range [0, getTableSize()-1] ) (a uint32_t)
IColor (ORSModel.ors.Color) – the color (a Color)

setIsDiscrete(self, bDiscrete: bool)

Sets the lookup table as discrete.

Parameters:: bDiscrete (bool) –

setRampBMPFile(self, filepath: str)

Sets the LUT to BMP file.

Parameters:: filepath (str) –

setRampGrayScale(self): Sets the LUT to be gray scale.

Note

Gray scale LUTs divide the color range in 256 gray tones.

setRampRainbow(self): Sets the LUT to be rainbow.

Note

Rainbow LUTs divide the color range in 4 sections.

setRampUserDefined(self): Sets the LUT to be user-defined.

Note

User-defined LUTs use color and alpha control points.

setTableSize(self, size: int)

Sets the table size.

Parameters:: size (int) –

Managed¶

class ORSModel.ors.Managed(*args, **kwargs)

Bases: ORSBaseClass

An abstract class that implements all the default behavior of managed objects.

addCallbackToEvent(self, anEventName: str, sCallbackName: str, callbackData: int) → bool

Adds a callback subscription to an event.

Note

The callback name for a given event needs to be unique for that event, i.e. no two callbacks for a given event can have the same name.

Parameters:

anEventName (str) – name of the event to subscribe to (a string)
sCallbackName (str) – callback name (a string)
callbackData (int) – a pointer to a ORS_EVENT_CALLBACK_INFO structure

Returns:

output (bool) – true if subscription succeeded, false otherwise

addToDeleteSet(self, anIObject: ORSModel.ors.Managed)

Add an object to the delete set.

Note

All objects have a delete set, which designates those objects that should also be deleted when the receiver gets deleted.

Parameters:: anIObject (ORSModel.ors.Managed) – an object (a Managed)

addToSelection(contextInstance)

Adds the instance to the selection of a context

Parameters:: contextInstance (plugin instance) – context instance

Note

Only representable object can be selected

applyPreferences(): Helper for setting the attribute of the object following the preferences

atomicLoad(sFilename: str, bPreserveIdentity: bool) → Managed

Creates an object from a file where an object was saved.

Parameters:

sFilename (str) – path of the file to load
bPreserveIdentity (bool) – if true, preserves the identity of the object, false otherwise

Returns:

output (Managed) – a managed object, or none() if the load fails

atomicLoadFrom(self, anXML: str)

Loads an object from an XML string.

Parameters:: anXML (str) – an XML (a string)

Managed.atomicLoadFrom(self, buffer: bytes, nBytes: int)

Loads an object from a memory buffer. Used for python pickling.

Parameters:

buffer (bytes) – the buffer
nBytes (int) – the number of bytes in the buffer (a uint64_t)

Managed.atomicLoadFrom(self, stream: ORSModel.ors.Stream) -> int

Loads an object from a stream (using callback).

Parameters:: stream (ORSModel.ors.Stream) – the stream to read data from
Returns:: output (int) – 0 if successful, otherwise an error code

atomicLoadSpecificNode(self, aFilename: str, aXPathOfTheNodeToLoad: str) → bool

Loads an object from a file containing several objects.

Parameters:

aFilename (str) – The file name, including entire path (a string)
aXPathOfTheNodeToLoad (str) – The XPath specification to find the node

Returns:

output (bool) – true if node was found and loaded, false otherwise

atomicSave(self, aFilename: str, isTemporary: bool = False, iCompressionEngine: int = 1) → int

Saves the object to a file.

Parameters:

aFilename (str) – path of the file to save
isTemporary (bool) – if true, try to keep file in memory
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – 0 if successful, otherwise an error code

atomicSaveToLegacyFormat(self, aFilename: str, isTemporary: bool = False, iCompressionEngine: int = 1) → int

Saves the object to a file in the legacy (2022.2) format.

Parameters:

aFilename (str) – path of the file to save
isTemporary (bool) – if true, try to keep file in memory
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – 0 if successful, otherwise an error code

atomicSaveToStream(self, stream: ORSModel.ors.Stream, iCompressionEngine: int = 1) → int

Saves the object to a stream (through callback).

Parameters:

stream (ORSModel.ors.Stream) – stream object to save current object in
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – 0 if successful, otherwise an error code

copy(self) → ORSModel.ors.Managed

Returns a copy of the managed.

Note

Only the immediate attributes of the managed are copied. The graph surrounding the new managed is the same one as the source managed.

Note

You can type the return value of this method to any subclass of Managed, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Returns:: output (ORSModel.ors.Managed) – a new managed (a Managed)

createScalarValuesCollection(self): method createScalarValuesCollection

deleteObject(self): Explicitly deletes the core object wrapped by this Interface object.

deleteObjectAndAllItsChildren(self): Explicitly deletes the core object wrapped by this Interface object, along with all its children.

ensureInitialization(self): This is for the Python interface.

getAllGroupsContaining(self, anIObject: ORSModel.ors.Managed) → ORSModel.ors.List

Gets all the groups that contain the given object.

Parameters:: anIObject (ORSModel.ors.Managed) –
Returns:: output (ORSModel.ors.List) –

getAllInstancesOf(pProgId: str) → ORSModel.ors.List

Gathers all existing objects of the specified class.

Parameters:: pProgId (str) –
Returns:: output (ORSModel.ors.List) –

getAllObjectsOfClassAndPrivateTitle(pProgId: str, pPrivateTitle: str) → ORSModel.ors.List

Gathers all existing objects of the specified class, that have a matching private title.

Parameters:

pProgId (str) – name of the class (a string)
pPrivateTitle (str) – private title to search for (a string)

Returns:

output (ORSModel.ors.List) – all the objects that match the search criteria (a List)

getAllObjectsOfClassAndTitle(pProgId: str, pTitle: str) → ORSModel.ors.List

Gathers all existing objects of the specified class, that have a matching title.

Parameters:

pProgId (str) – name of the class (a string)
pTitle (str) – title to search for (a string)

Returns:

output (ORSModel.ors.List) – all the objects that match the search criteria (a List)

getAllObjectsOfClassAndUserData(pProgId: str, userDataKey: str, userDataValue: str) → ORSModel.ors.List

Gathers all existing objects of the specified class, that have a matching user data.

Parameters:

pProgId (str) – name of the class (a string)
userDataKey (str) – key of the user data (a string)
userDataValue (str) – value to look for (a string)

Returns:

output (ORSModel.ors.List) – all the objects that match the search criteria (a List)

getAllRepresentableInstancesOf(pProgId: str) → ORSModel.ors.List

Gathers all existing objects of the specified class that are representable.

Parameters:: pProgId (str) –
Returns:: output (ORSModel.ors.List) –

getAllRepresentableObjects() → ORSModel.ors.List

Gets all the representable objects of the world.

Returns:: output (ORSModel.ors.List) – a list containing all the representable objects

getAtomicTextRepresentation(self, bSelfContained: bool) → str

Retrieves the object’s atomic text representation.

Parameters:: bSelfContained (bool) –
Returns:: output (str) –

getAutoDelete(self) → bool

Gets the autodelete value.

See also

ORSModel.ors.Managed.setAutoDelete()

Returns:: output (bool) –

getBinaryUserInfo(self, pTag: str)

Retrieves a user defined binary value. Typed as void* for sip, but it’s in reality an unsigned char*.

Note

If the key doesn’t exist, nullptr is returned

Parameters:: pTag (str) – key of the data (a string)

getBinaryUserInfoSize(self, pTag: str) → int

Retrieves the size of a user defined binary value.

Note

If the key doesn’t exist, 0 is returned

Parameters:: pTag (str) – key of the data (a string)
Returns:: output (int) – the size of the data (a uint32_t)

getCallbacksEnabled(self) → bool

Queries the object to know if its callbacks are enabled or disabled.

Returns:: output (bool) – true if callbacks are enabled, false otherwise

getChildrenNodesOrganizationDirtySignature()

Gets the current dirty signature for the flag OrsChildrenNodesOrganizationDirty

Returns:: childrenNodesOrganizationDirtySignature (int) – the dirty signature

getClassName(self) → str

Retrieves the class name of the core object wrapped by this Interface object.

Returns:: output (str) – the class name (a string)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getCreationTime(self) → int

Returns the time Number of seconds since Jan 1 2000 of creation of this object.

Returns:: output (int) – a uint32_t

getDataChecksum(self) → str

Returns the computed checksum of the data.

Returns:: output (str) –

getDataDirtySignature()

Gets the current dirty signature for the flag OrsDataDirty

Returns:: dataDirtySignature (int) – the dirty signature

getDirtySignature(self, dirtyFlag: str) → int

Gets the current dirty signature.

Note

Objects can be dirty for several aspects, see the ors_def.h file for the different dirty aspects.

Parameters:: dirtyFlag (str) – dirty flag name (a string, see note below)
Returns:: output (int) – dirty signature (a uint64_t)

getEntireDirtySignature(self) → int

Gets the current dirty signature for all aspects, added up.

Note

Objects can be dirty for several aspects, see the ors_def.h file for the different dirty aspects.

Returns:: output (int) – entire dirty signature (a uint64_t)

getEventCallbackEnabled(self, sEventName: str, sCallbackName: str) → bool

Gets the enabled state of a callback subscription to an event.

Parameters:

sEventName (str) – event name (a string)
sCallbackName (str) – callback name (a string)

Returns:

output (bool) – true if callback is enabled, false if disabled or if the callback subscription did not exist

getGUID(self) → str

Retrieves the GUID of the core object.

Note

The GUID is the unique identifier of the object. No two objects can have the same GUID. Once you have an object’s GUID, at any time you can obtain a reference to that object via its GUID, given that the object is still alive.

Returns:: output (str) –

getGeometryDirtySignature()

Gets the current dirty signature for the flag OrsGeometryDirty

Returns:: geometryDirtySignature (int) – the dirty signature

getHasCallbacksForEvent(self, anEventName: str) → bool

Checks if the receiver has any callbacks for an event.

Parameters:: anEventName (str) – name of the event (a string)
Returns:: output (bool) – true if callbacks exist for the event, false otherwise

getHighlightDirtySignature()

Gets the current dirty signature for the flag OrsHighlightDirty

Returns:: highlightDirtySignature (int) – the dirty signature

getIsDirty(self, dirtyFlag: str) → bool

Gets if the object is dirty for a specific dirty flag.

Parameters:: dirtyFlag (str) – dirty flag name (a string, see note below)
Returns:: output (bool) – true if object is dirty, false otherwise

getIsDirtyAnyDirtyFlag(self) → bool

Gets if the object is dirty for any of the dirty flags.

Returns:: output (bool) – true if object is dirty, false otherwise

getIsEqualTo(self, aManaged: ORSModel.ors.Managed) → bool

Checks if the two objects are equal.

Parameters:: aManaged (ORSModel.ors.Managed) – an object to compare with (a Managed)
Returns:: output (bool) – true if the receiver and the argument are equal (class dependent), false otherwise

getIsIdentityPreservedForPickling(self) → bool

Returns True if the GUID is preserved when pickling and unpickling an object.

Returns:: output (bool) – Returns True if the GUID is preserved when pickling and unpickling an object

getIsInDeleteSet(self, anIObject: ORSModel.ors.Managed) → bool

Gets if an object is included in the receiver delete set.

Note

The delete set is a list of objects that are to be deleted when the receiver is deleted.

Parameters:: anIObject (ORSModel.ors.Managed) – object to look for in the receiver delete set (a Managed)
Returns:: output (bool) – true if the object is in the delete set of the receiver, false otherwise

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

getIsRepresentable(self) → bool

Queries the object to know if it is representable.

Returns:: output (bool) –

getIsSameObjectAs(self, anObject: ORSModel.ors.Managed) → bool

Checks to see if the receiver wraps the same underlying object as the supplied argument.

Parameters:: anObject (ORSModel.ors.Managed) – an object to compare with (a Managed)
Returns:: output (bool) – true if underlying object is the same for both the receiver and the argument, false otherwise

getIsToBeKeptAliveUntilExit(self) → bool

Queries the object to know if it is permanent for the life of the application.

Note

Permanent objects survive a new session, i.e. they live until the application is terminated.

Returns:: output (bool) – true if object is permanent, false otherwise

getIsToBeSaved(self) → bool

Queries the object to know if it should be saved in a session file.

Returns:: output (bool) – true if object should be saved, false otherwise

getMetadataChecksum(self) → str

Returns the computed checksum of the metadata.

Returns:: output (str) –

getObjectWithGUID(guid: str) → ORSModel.ors.Managed

Retrieves an object from its GUID.

Parameters:: guid (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Managed) – An object or none if object is not found

getObjectWithGUIDasPointer(guid: str) → ORSModel.ors.Managed

Retrieves an object from its GUID.

Parameters:: guid (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Managed) – An object or nullptr if object is not found

getPrivateTitle(self) → str

Gets the private title of the object.

Note

The private title is never shown in the application, but is a means by which an object can be found (getAllObjectsOfClassAndPrivateTitle for example).

Returns:: output (str) – private title of the object (a string)

getPropertyDirtySignature()

Gets the current dirty signature for the flag OrsPropertyDirty

Returns:: propertyDirtySignature (int) – the dirty signature

getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:: output (str) – The object’s representation (a string)

getReferenceCount(self) → int

Returns the count of references to the object.

Returns:: output (int) – the count of references (an int)

getScalarValuesCollection(self) → ORSModel.ors.ScalarValuesCollection

method getScalarValuesCollection

Returns:: output (ORSModel.ors.ScalarValuesCollection) –

getTitle(self) → str

Gets the title of the object.

Returns:: output (str) – the title (a string)

getUserInfo(self, pTag: str) → str

Retrieves a user defined value.

Note

If the key doesn’t exist an empty string is returned.

Parameters:: pTag (str) – key of the data (a string)
Returns:: output (str) – the data (a string)

getUserInfoAsArray(self) → ORSModel.ors.ArrayString

Retrieves the user info as a string array.

Note

The user info data is flattened into an array of string pairs, for the key and the value.

Returns:: output (ORSModel.ors.ArrayString) – the data (an ArrayString, see note below)

getUserInfoAsDictionary()

User info copy of Managed in a easy way for manipulation

return a copy of the object user info as a dictionary

getUserInfoMatchingPattern(self, pattern: str, case_sensitive_search: bool) → List[str]

Searches the user info dictionary based on a pattern matching.

Note

The pattern matching is done via regex.

Parameters:

pattern (str) – a search pattern (a string)
case_sensitive_search (bool) – true to search case-sensitive, false otherwise (a bool)

Returns:

output (List[str]) – a list of keys and values pairs, for all matching keys (a list of strings)

getVisibilityDirtySignature()

Gets the current dirty signature for the flag OrsVisibilityDirty

Returns:: visibilityDirtySignature (int) – the dirty signature

isManaged(self) → bool

Returns:: output (bool) –

isNone(self) → bool

Checks if the underlying core object is None.

Note

Interface objects hold references to core objects, so this method checks to see if a core object is truly referred to.

Returns:: output (bool) – true if the core object is non-existent, false otherwise.

isNotNone(self) → bool

Checks if the underlying core object is not None.

Note

Interface objects hold references to core objects, so this method checks to see if a core object is truly referred to.

Returns:: output (bool) – true if the core object is existent, false otherwise.

none() → Managed

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Managed) –

publish(): Sets an object as representable and notifies the Dragonfly UI of a new available object

removeBinaryUserInfo(self, pTag: str)

Removes a user defined binary value.

Parameters:: pTag (str) – key name of the binary value (a string)

removeCallbackFromEvent(guid: str, sEventName: str, sCallbackName: str, bRemoveInDeletedObject: bool) → bool

Removes a callback subscription to an event.

Parameters:

guid (str) – object GUID (a string)
sEventName (str) – name of the callback event (a string)
sCallbackName (str) – name of the callback (a string)
bRemoveInDeletedObject (bool) – if true, the callback will be removed from the object even if that object is in the process of being deleted (a boolean)

Returns:

output (bool) – true callback existed, false otherwise

removeFromDeleteSet(self, anIObject: ORSModel.ors.Managed)

Remove an object from the delete set.

Note

The delete set is a list of objects that are to be deleted when the receiver is deleted.

Parameters:: anIObject (ORSModel.ors.Managed) – object to be removed from the delete set (a Managed)

removeUserInfo(self, pTag: str)

Removes a user defined value.

Parameters:: pTag (str) – key of the data (a string)

selectExclusively(contextInstance)

Selects only the current instance for a context

Parameters:: contextInstance (plugin instance) – context instance

Note

Only representable object can be selected

setAsTemporaryObject(isTemporaryObject=True)

Helper for setting useful properties when marking an object as a (non-)temporary object.

Parameters:: isTemporaryObject (bool) – if True, the object will be set as temporary (not representable, not to be saved, callbacks disabled). Otherwise, these properties are set as the opposite.

setAutoDelete(self, value: bool)

When set to true, the interface object will call deleteObject on its core object when it is being deleted.

Parameters:: value (bool) –

setBinaryUserInfo(self, pTag: str, pValue: bytes, iDataSize: int)

Sets a user defined binary value.

Note

Objects can carry user defined data in the form of strings or binary data.

Parameters:

pTag (str) – key of the data (a string)
pValue (bytes) – the data (an unsigned char* buffer)
iDataSize (int) – the size of the data (a uint32_t)

setCallbacksEnabled(self, enabled: bool)

Sets the object’s callbacks to be enabled or not.

Note

When an object’s callbacks are disabled, absolutely no callbacks are triggered from the receiver.

Parameters:: enabled (bool) – true to enable callbacks, false otherwise

setChildrenNodesOrganizationDirty(): Calls for a setDirty with the flag OrsChildrenNodesOrganizationDirty

setDataDirty(): Calls for a setDirty with the flag OrsDataDirty

setDirty(self, dirtyFlag: str)

Sets the object as being dirty for a given aspect.

Note

A dirty object is an object that has changed, giving its observers a chance to refresh their view on the object. Several aspects of an object can be dirty, see ORS_def.h for dirty signature flags.

Parameters:: dirtyFlag (str) – dirty flag name (a string)

setEventCallbackEnabled(self, sEventName: str, sCallbackName: str, bValue: bool) → bool

Enables/disables a callback subscription to an event.

Note

Works for all callback types (object, class and global)

Parameters:

sEventName (str) – event name (a string)
sCallbackName (str) – callback name (a string)
bValue (bool) – true to enable the callback, false to disable it

Returns:

output (bool) – true if callback subscription existed, false otherwise

setGeometryDirty(): Calls for a setDirty with the flag OrsGeometryDirty

setHighlightDirty(): Calls for a setDirty with the flag OrsHighlightDirty

setIdentityIsPreservedForPickling(self, value: bool)

Set to True if the GUID is to be preserved when pickling and unpickling an object.

Parameters:: value (bool) –

setIsNotDirty(self): Sets the object as not being dirty for all dirty flags.

setIsRepresentable(self, isRepresentable: bool)

Sets the object to be representable or not.

Note

Non representable objects don’t appear in lists and such, the implicit meaning is that these objects are transient and temporary.

Parameters:: isRepresentable (bool) – true to make the object representable, false otherwise

setIsToBeKeptAliveUntilExit(self, pFlag: bool)

Sets the object to be permanent for the life of the application.

Note

Permanent objects survive a new session, i.e. they live until the application is terminated.

Parameters:: pFlag (bool) – true to make the object permanent, false otherwise

setIsToBeSaved(self, pIsToBeSaved: bool)

Sets the object to be saved to session files or not.

Parameters:: pIsToBeSaved (bool) – true to cause the object to be saved to session files, false otherwise

setPrivateTitle(self, newPrivateTitle: str)

Sets the private title of the object.

Note

The private title can later be used to find a reference to that object, given that it’s still alive.

Parameters:: newPrivateTitle (str) – a title (a string)

setPropertyDirty(): Calls for a setDirty with the flag OrsPropertyDirty

setTitle(self, newVal: str)

Sets the title of the object.

Dirty flags: OrsPropertyDirty

Anonymize newVal:: True
Parameters:: newVal (str) – new title (a string)

setUserInfo(self, pTag: str, pValue: str)

Parameters:

pTag (str) –
pValue (str) –

setUserInfoFromDictionary(aDic)

Add key value pair to the user Info of the Object. an str call are done on the key and values to insure that we respect the UserInfo protocol of Managed Object

Parameters:: aDic (dict) – a dictionary of information to add to the user information

setVisibilityDirty(): Calls for a setDirty with the flag OrsVisibilityDirty

switchAvailabilityToContext(oldContextID, newContextID)

Switches the availability of the object from an old context to a new context. This will be done only if the old context ID is found in the set of available contexts and the new context ID is not already in the set of available contexts. The availability for all other contexts remains unchanged.

The arguments oldContextID and newContextID are used as strings instead of plugin instances to support the situation where the old or new context is not existing (for example, to perform a copy of the objects).

Parameters:

oldContextID (str) – old context ID
newContextID (str) – new context ID

triggerClassEvent(self, sEventName: str) → bool

Triggers a class event.

Parameters:: sEventName (str) –
Returns:: output (bool) –

unpublish(): Sets an object as non-representable and notifies the Dragonfly UI of a loss of the availability of the object.

unselect(contextInstance)

Unselects the instance for a context

Parameters:: contextInstance (plugin instance) – context instance

MassiveMarchingAutomata¶

class ORSModel.ors.MassiveMarchingAutomata(self)

Bases: Unmanaged

cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel)

Removes boundaries or non reached value from a Speed map channel.

Parameters:: outputChannel (ORSModel.ors.Channel) – a distance map channel (an Channel)

createDistanceMap(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel, nbIteration: int)

Parameters:

lOutputChannelDistanceMap (ORSModel.ors.Channel) –
lOutputChannelTraceBack (ORSModel.ors.Channel) –
lOutputChannelLabel (ORSModel.ors.Channel) –
nbIteration (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getEuclideanBias(self) → float

Gets the Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm

Note

Neighbors of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm

Returns:: output (float) – the minimum distance between voxels (a double)

getNeighborCount(self) → int

Returns:: output (int) –

getROICount(self) → int

Returns the number of ROIs that have been set as sources.

Note

A maximum of 10 ROI can be provided.

Returns:: output (int) – the number of ROIs that have been provided (an unsigned char)

getVolumeROI(self, index: int) → ORSModel.ors.ROI

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:: index (int) –
Returns:: output (ORSModel.ors.ROI) –

none() → MassiveMarchingAutomata

Returns:: output (MassiveMarchingAutomata) –

resetVolumeROIs(self): Empties all the sourceROI slots.

setEuclideanBias(self, EuclideanBias: float)

Provides an Euclidean bias that will be the minimumDijkstra distance between voxels.

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

Neighbors of distance sqrt(2) will have a bias of sqrt(2)*spacialTerm.

Note

Neighbor of distance sqrt(3) will have a bias of sqrt(3)*spacialTerm.

Parameters:: EuclideanBias (float) – the minimum distance between voxels (a double)

setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, currentT: int)

Note

The min and max boundaries must not describe a space bigger than the input channel.

Parameters:

inputChannel (ORSModel.ors.Channel) – the input channel (an Channel) *
minX (int) – the minimum X index in the input channel (a uint32_t) *
minY (int) – the minimum Y index in the input channel (a uint32_t)
minZ (int) – the minimum Z index in the input channel (a uint32_t)
maxX (int) – the maximum X index in the input channel (a uint32_t)
maxY (int) – the maximum Y index in the input channel (a uint32_t)
maxZ (int) – the maximum Z index in the input channel (a uint32_t)
currentT (int) – the T index (a uint32_t)

setNeighborCountTo18(self)

setNeighborCountTo26(self)

setNeighborCountTo6(self)

setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI)

Note

A maximum of 10 ROIs can be provided. The ROIs provided must be of the same shape as the input channel.

Parameters:

index (int) –
aVolROI (ORSModel.ors.ROI) –

Material¶

class ORSModel.ors.Material(*args, **kwargs)

Bases: Node

Represents the material of a visual (Visual).

See also

Visual::setMaterial(), Visual::getMaterial()

getAmbiant(self) → ORSModel.ors.Color

Gets the ambiant color of the material.

See also

ORSModel.ors.Material.setAmbiant()

Returns:: output (ORSModel.ors.Color) – ambiant (a Color)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getDiffuse(self) → ORSModel.ors.Color

Gets the diffuse color of the material.

See also

ORSModel.ors.Material.setDiffuse()

Returns:: output (ORSModel.ors.Color) – diffuse (a Color)

getEmissive(self) → ORSModel.ors.Color

Gets the emissive color of the material.

See also

ORSModel.ors.Material.setEmissive()

Returns:: output (ORSModel.ors.Color) – an emissive (a Color)

getPower(self) → float

Gets the power property of the material.

See also

ORSModel.ors.Material.setPower()

Returns:: output (float) – power value (a float)

getShadowIntensity(self) → float

Gets the shadow intensity.

Note

Should be between 0.0 and 1.0.

Returns:: output (float) – an intensity factor (a float)

getSpecular(self) → ORSModel.ors.Color

Gets the specular color of the material.

See also

ORSModel.ors.Material.setSpecular()

Returns:: output (ORSModel.ors.Color) – specular (a Color)

getTexture(self, stage: int) → str

Parameters:: stage (int) –
Returns:: output (str) –

getTextureScale(self) → float

Gets the texture scale factor.

Returns:: output (float) – the scale factor (a float)

none() → Material

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Material) –

setAmbiant(self, IColor: ORSModel.ors.Color)

Sets the ambiant color, in Red-Green-Blue.

Note

Each color value goes between 0 (none) and 1 (full).

See also

ORSModel.ors.Material.setAmbiant()

Parameters:: IColor (ORSModel.ors.Color) – a color object (a Color)

setDiffuse(self, IColor: ORSModel.ors.Color)

Sets the diffuse color, in Red-Green-Blue.

Note

Each color value goes between 0 (none) and 1 (full).

See also

ORSModel.ors.Material.setDiffuse()

Parameters:: IColor (ORSModel.ors.Color) – a color object (a Color)

setEmissive(self, IColor: ORSModel.ors.Color)

Sets the emissive color, in Red-Green-Blue.

Note

Each color value goes between 0 (none) and 1 (full).

See also

ORSModel.ors.Material.setEmissive()

Parameters:: IColor (ORSModel.ors.Color) – a color object (a Color)

setPower(self, value: float)

Sets the power property of the material.

See also

ORSModel.ors.Material.getPower()

Parameters:: value (float) – a power value (a float)

setShadowIntensity(self, value: float)

Sets the shadow intensity.

Note

Should be between 0.0 and 1.0.

Parameters:: value (float) – an intensity factor (a float)

setSpecular(self, IColor: ORSModel.ors.Color)

Sets the specular color, in Red-Green-Blue.

Note

Each color value goes between 0 (none) and 1 (full).

See also

ORSModel.ors.Material.setSpecular()

Parameters:: IColor (ORSModel.ors.Color) – a color object (a Color)

setTexture(self, filename: str, stage: int)

Sets the texture from a texture file.

Note

Stages are valued between 0 and 7.

Parameters:

filename (str) – a file name (a string)
stage (int) – a stage (a LONG)

setTextureScale(self, value: float)

Sets the texture scale factor.

Parameters:: value (float) – a scale factor (a float)

Matrix4x4¶

class ORSModel.ors.Matrix4x4

Bases: Unmanaged

A wrapper to a 3D matrix.

asRotationMatrix(self, inputVector: ORSModel.ors.Vector3)

As rotation matrix from quaternion.

Parameters:: inputVector (ORSModel.ors.Vector3) –

copy(self) → ORSModel.ors.Matrix4x4

Gets a copy.

Returns:: output (ORSModel.ors.Matrix4x4) –

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

Create a ORS::Matrix from a python representation static method.

Parameters:: aPythonRepresentation (str) – aPythonRepresentation (an wstring)
Returns:: output (ORSModel.ors.Matrix4x4) – a Matrix4x4 (ORS::Matrix4x4)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getInverted(self) → ORSModel.ors.Matrix4x4

Gets an inverted matrix.

Note

The receiver is not affected.

Returns:: output (ORSModel.ors.Matrix4x4) – an inverted matrix (an Matrix4x4)

getIsEqualTo(self, aMatrix4x4: ORSModel.ors.Matrix4x4) → bool

Checks for equality to another matrix.

Parameters:: aMatrix4x4 (ORSModel.ors.Matrix4x4) – a matrix (a Matrix4x4)
Returns:: output (bool) – TRUE if the matrices are equal, FALSE otherwise

getIsIdentity(self) → bool

Tests for identity.

Returns:: output (bool) –

getMultiply(self, IMatrix: ORSModel.ors.Matrix4x4) → ORSModel.ors.Matrix4x4

Matrix4x4 product.

Parameters:: IMatrix (ORSModel.ors.Matrix4x4) –
Returns:: output (ORSModel.ors.Matrix4x4) –

getScale(self) → ORSModel.ors.Vector3

Returns:: output (ORSModel.ors.Vector3) –

getTransformedBoundedPlane(self, inputBoundedPlane: ORSModel.ors.Rectangle) → ORSModel.ors.Rectangle

Applies a matrix transformation to a bounded plane.

Parameters:: inputBoundedPlane (ORSModel.ors.Rectangle) –
Returns:: output (ORSModel.ors.Rectangle) –

getTransformedBox(self, inputBox: ORSModel.ors.Box) → ORSModel.ors.Box

Applies a matrix transformation to a box.

Parameters:: inputBox (ORSModel.ors.Box) –
Returns:: output (ORSModel.ors.Box) –

getTransformedCoordinate(self, inputCoordinate: ORSModel.ors.Vector3) → ORSModel.ors.Vector3

Applies a matrix transformation to an augmented vector ([x, y, z, 1]).

Parameters:: inputCoordinate (ORSModel.ors.Vector3) –
Returns:: output (ORSModel.ors.Vector3) –

getTransformedLine(self, inputLine: ORSModel.ors.Line) → ORSModel.ors.Line

Applies a matrix transformation to a line.

Parameters:: inputLine (ORSModel.ors.Line) –
Returns:: output (ORSModel.ors.Line) –

getTransformedLineSegment(self, inputLineSegment: ORSModel.ors.LineSegment) → ORSModel.ors.LineSegment

Applies a matrix transformation to a line segment.

Parameters:: inputLineSegment (ORSModel.ors.LineSegment) –
Returns:: output (ORSModel.ors.LineSegment) –

getTransformedOrientedPlane(self, inputOrientedPlane: ORSModel.ors.OrientedPlane) → ORSModel.ors.OrientedPlane

Applies a matrix transformation to an oriented plane.

Parameters:: inputOrientedPlane (ORSModel.ors.OrientedPlane) –
Returns:: output (ORSModel.ors.OrientedPlane) –

getTransformedPlane(self, inputPlane: ORSModel.ors.Plane) → ORSModel.ors.Plane

Applies a matrix transformation to a plane.

Parameters:: inputPlane (ORSModel.ors.Plane) –
Returns:: output (ORSModel.ors.Plane) –

getTransformedVector(self, inputVector: ORSModel.ors.Vector3) → ORSModel.ors.Vector3

Applies a matrix transformation to an augmented vector ([x, y, z, 0]).

Parameters:: inputVector (ORSModel.ors.Vector3) –
Returns:: output (ORSModel.ors.Vector3) –

getTranslation(self) → ORSModel.ors.Vector3

Gets the translation vector.

Returns:: output (ORSModel.ors.Vector3) –

getTransposed(self) → ORSModel.ors.Matrix4x4

Gets the transpose of the matrix.

Returns:: output (ORSModel.ors.Matrix4x4) –

getValue(self, row: int, column: int) → float

Gets a value from the matrix.

Note

Row and column are both between 0 and 3.

See also

ORSModel.ors.Matrix4x4.setValue()

Parameters:

row (int) – row (an int)
column (int) – column (an int)

Returns:

output (float) – a double

multiply(self, IMatrix: ORSModel.ors.Matrix4x4)

Multiplies the matrix by another matrix.

Note

The receiver is modified.

Parameters:: IMatrix (ORSModel.ors.Matrix4x4) – a matrix to multiply with (an Matrix4x4)

none() → Matrix4x4

Returns:: output (Matrix4x4) –

setAsRotation(self, axisOfRotation: ORSModel.ors.Vector3, angleInRadian: float)

As rotation matrix from rotation axis and angle.

Parameters:

axisOfRotation (ORSModel.ors.Vector3) –
angleInRadian (float) –

setScale(self, scaleVector: ORSModel.ors.Vector3)

Sets the scale vector.

Parameters:: scaleVector (ORSModel.ors.Vector3) –

setTranslation(self, translation: ORSModel.ors.Vector3)

Sets the translation vector.

Parameters:: translation (ORSModel.ors.Vector3) –

setValue(self, row: int, column: int, value: float)

Sets a value in the matrix.

Note

Row and column are both between 0 and 3.

See also

ORSModel.ors.Matrix4x4.getValue()

Parameters:

row (int) – row (an int)
column (int) – column (an int)
value (float) – a double value

setValues(self, values: float)

Sets the matrix values from an array of doubles.

Note

The array of doubles should contain 16 double (4 rows X 4 colums).

Parameters:: values (float) – an array of 16 float values (a doublePtr)

setupAsIdentity(self): Initializes the matrix.

Mesh¶

class ORSModel.ors.Mesh(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Bases: UnstructuredGrid

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

cleanMeshWinding(iTIndex)

all cell of the mesh generated by the scipy spatial convexhull does not have the same winding so make sure they are all in same order. vtkPolyDataNormals filter is used here to clean the mesh.

Parameters:: iTIndex (int) – Time index of the target mesh to be cleaned.
Return:: Returns True if the mesh was successfully cleaned, otherwise returns False.
Rtype:: bool

computeAnisotropyMappingFromSurfaceNormals(self, iTIndex: int, channelToFill: ORSModel.ors.Channel, vectorFieldEigenvectorMax: ORSModel.ors.VectorField, channelToFillNormOfGradient: ORSModel.ors.Channel, channelToFillDivergence: ORSModel.ors.Channel, vectorFieldCurl: ORSModel.ors.VectorField, channelToFillNormOfCurl: ORSModel.ors.Channel, radiusOfInfluence: float, useProjectionBasedAnisotropy: bool, IProgress: ORSModel.ors.Progress) → bool

Note

The vector field object will be cleared before being filled with the current information.

Parameters:

iTIndex (int) – the T index (a uint32_t)
channelToFill (ORSModel.ors.Channel) – the channel (anisotropy) to fill at each voxel location (a Channel)
vectorFieldEigenvectorMax (ORSModel.ors.VectorField) – the vector field (eigenvector associated to the highest eigenvalue) to fill at each voxel location of the given channel (a VectorField)
channelToFillNormOfGradient (ORSModel.ors.Channel) – the channel (norm of the gradient of the orientation) to fill at each voxel location (a Channel)
channelToFillDivergence (ORSModel.ors.Channel) – the channel (divergence of the orientation) to fill at each voxel location (a Channel)
vectorFieldCurl (ORSModel.ors.VectorField) – the vector field (curl of the orientation) to fill at each voxel location of the given channel (a VectorField)
channelToFillNormOfCurl (ORSModel.ors.Channel) – the channel (norm of the curl of the orientation) to fill at each voxel location (a Channel)
radiusOfInfluence (float) – distance from the analysis point to the last considered anisotropy element (a double)
useProjectionBasedAnisotropy (bool) – anisotropy computation method. If true, the projection based method is used; if false, the eigenvalues from the tensor of inertia are taken (a bool)
IProgress (ORSModel.ors.Progress) – an optional progress object (a Progress)

Returns:

output (bool) – true if the computation was completed successfully, false otherwise

dilateWithVerticesNormal(self, distanceToDilate: float, iTIndex: int)

Parameters:

distanceToDilate (float) –
iTIndex (int) –

findMeshContourPointsAndConnectionOnAPlane(self, cuttingPlane: ORSModel.ors.Plane, anOctreeBox: ORSModel.ors.Octree, iTIndex: int, oPoints: ORSModel.ors.ArrayDouble, oPointsConnection: ORSModel.ors.ArrayUnsignedLONGLONG, oNbOfPts: int, oNbOfConnection: int)

Find points of the mesh on a plane and all connection between those points.

Parameters:

cuttingPlane (ORSModel.ors.Plane) – a cutting plane (ORS::Plane)
anOctreeBox (ORSModel.ors.Octree) – an octree, if the octree is none a default one will be created (ORS::Octree)
iTIndex (int) – the time step (a uint32_t)
oPoints (ORSModel.ors.ArrayDouble) – output points collection (ORS::ArrayDouble)
oPointsConnection (ORSModel.ors.ArrayUnsignedLONGLONG) – output points connection (edges with size = 2) collection (ORS::ArrayUnsignedLongLong)
oNbOfPts (int) – number of point that make the contour on plane (int)
oNbOfConnection (int) – number of edges that make the contour on plane (int)

getArea(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, IProgress: ORSModel.ors.Progress) → float

Gets the one sided area from closed mesh.

Note

Result for an open mesh is undefined.

Parameters:

iTIndex (int) – the T index to compute (a uint32_t)
aWorldTransformMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4)
IProgress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress

Returns:

output (float) – the area (a double)

getAsMeshProjectedOnPlane(self, aPlane: ORSModel.ors.Plane, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, inMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Parameters:

aPlane (ORSModel.ors.Plane) –
iTIndex (int) –
aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –
inMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) –

getAsMeshWithEdgesDecimatedSmallerThan(self, value: float, IProgress: ORSModel.ors.Progress, worldTransform: ORSModel.ors.Matrix4x4, inoutMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Decimates all edges with a length smaller than a threshold value.

Note

This method is recursive and will decimate edges until all edges length are greater than the supplied threshold value.

Parameters:

value (float) – the threshold value (a double)
IProgress (ORSModel.ors.Progress) –
worldTransform (ORSModel.ors.Matrix4x4) –
inoutMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) –

getAsROI(self, iTIndex: int, worldTransform: ORSModel.ors.Matrix4x4, pOutputROI: ORSModel.ors.ROI, progress: ORSModel.ors.Progress)

Parameters:

iTIndex (int) –
worldTransform (ORSModel.ors.Matrix4x4) –
pOutputROI (ORSModel.ors.ROI) –
progress (ORSModel.ors.Progress) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getContourAreaForPlane(self, nax: float, nby: float, ncz: float, nd: float, iTIndex: int) → float

Note

Results for an open contour is undefined.

Note

Only works for triangular primitive type mesh.

Note

The algorithm uses winding to find the inside part of faces. Thus the result for meshes with wrong winding is undefined.

Parameters:

nax (float) – the a value of the plane (a float)
nby (float) – the b value of the plane (a float)
ncz (float) – the c value of the plane (a float)
nd (float) – the d value of the plane (a float)
iTIndex (int) –

Returns:

output (float) – the area (a float)

getContourMeshForPlane(self, nax: float, nby: float, ncz: float, nd: float, iTIndex: int, inoutMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Returns a mesh representing the contour of the mesh intersecting the specifed plane.

Note

If a target mesh is supplied, data is written to it and returned, otherwise a new mesh is created.

Note

The general plane equation is ax + by + cz + dw = 0.

Parameters:

nax (float) – The a coefficient of the plane (a float)
nby (float) – The b coefficient of the plane (a float)
ncz (float) – The c coefficient of the plane (a float)
nd (float) – The d coefficient of the plane (a float)
iTIndex (int) – the target mesh (a Mesh, see note below)
inoutMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) – the resulting mesh (an VisualMesh)

getCurrentFaceScalarValuesSlot(self) → int

gets the current face scalar.

Note

The scalar index is zero-based, and thus should be less than getFaceScalarValuesSlotCount().

Note

Use -1 to indicate no current scalar

Returns:: output (int) – the scalar slot index (a int32_t, see not)

getCurrentLabelScalarValuesSlot(self) → int

gets the current label scalar.

Note

The scalar index is zero-based, and thus should be less than getLabelScalarValuesSlotCount().

Note

Use -1 to indicate no current scalar

Returns:: output (int) – the scalar slot index (a int32_t, see not)

getDefaultColor(self) → ORSModel.ors.Color

Gets the mesh default color.

Note

Each color value goes between 0 (none) and 1 (full).

Returns:: output (ORSModel.ors.Color) – a color (an Color)

getDefaultFaceAlphaColor(self) → float

Queries the face to get its default alpha color.

Returns:: output (float) – Default alpha color used for the face (a double)

getDefaultFaceColor(self) → ORSModel.ors.Color

Gets the face default color.

Note

Each color value goes between 0 (none) and 1 (full).

Returns:: output (ORSModel.ors.Color) – a color (an Color)

getDefaultMeshAlphaColor(self) → float

Queries the mesh to get its default alpha color.

Deprecated since version (unknown): Use

Returns:: output (float) – Default alpha color used for the mesh (a double)

getDistanceFromRays(self, aLineSegment: ORSModel.ors.LineSegment, rotationAxis: ORSModel.ors.Vector3, rayCount: int, timeStep: int, octree: ORSModel.ors.Octree, outputArray: ORSModel.ors.ArrayDouble) → ORSModel.ors.ArrayDouble

Get the unsigned distance between theLineSegment, rotated around rotationAxis arayCount number of times, a and the surface of the mesh. If the ray does not collide a triangle (for instance the start member of the line segmenet is out of the mesh) return 0.

Parameters:

aLineSegment (ORSModel.ors.LineSegment) – the line segment (ORS::LineSegment )
rotationAxis (ORSModel.ors.Vector3) – rotation Axis (ORS::Vector3)
rayCount (int) – ray Count arount the axis (a uint32_t)
timeStep (int) – timeStep of the receiving Mesh to considered (a uint32_t)
octree (ORSModel.ors.Octree) – the octree (optional), useful when calling more than once on the same mesh(ORS::octree)
outputArray (ORSModel.ors.ArrayDouble) –

Returns:

output (ORSModel.ors.ArrayDouble) – the Output Array Double (ORS::ArrayDouble)

getDistanceFromRaysWithFibonaciDistristributionOnSphere(self, centerOfTheSphere: ORSModel.ors.Vector3, rayCount: int, timeStep: int, octree: ORSModel.ors.Octree, outputArray: ORSModel.ors.ArrayDouble) → ORSModel.ors.ArrayDouble

Get the distance then center of the provided sphere and rayCount points on it surface. The points are distributed using the Fibonacci algorithm (http://extremelearning.com.au/evenly-distributing-points-on-a-sphere/)

Parameters:

centerOfTheSphere (ORSModel.ors.Vector3) – the center of the sphere (ORS::Vector3 )
rayCount (int) – number of point on the surface (ORS::Vector3)
timeStep (int) – ray Count arount the axis (a uint32_t)
octree (ORSModel.ors.Octree) – timeStep of the receiving Mesh to considered (a uint32_t)
outputArray (ORSModel.ors.ArrayDouble) – the octree (optional), useful when calling more than once on the same mesh(ORS::octree)

Returns:

output (ORSModel.ors.ArrayDouble) – the Output Array Double (ORS::ArrayDouble)

getEdgeCount(self, iTIndex: int) → int

Returns the number of edges.

Parameters:: iTIndex (int) – the the time step (a uint32_t)
Returns:: output (int) – an uint64_t

getEdgeCountPerFace(self) → int

Returns:: output (int) –

getEdges(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Get the edge array.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

getEdgesForLabel(self, pLabel: int, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:

pLabel (int) –
iTIndex (int) –

Returns:

output (ORSModel.ors.ArrayUnsignedLong) –

getEulerCharacteristicNumber(self, iTIndex: int) → int

Get euler characteristic number to describe shape of mesh.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (int) – a int64_t

getExtractedSubMesh(IMeshROI: ORSModel.ors.MeshFacesROI, IOutputMesh: ORSModel.ors.Mesh, bExtractSubMeshROI: bool) → ORSModel.ors.Mesh

Parameters:

IMeshROI (ORSModel.ors.MeshFacesROI) –
IOutputMesh (ORSModel.ors.Mesh) –
bExtractSubMeshROI (bool) –

Returns:

output (ORSModel.ors.Mesh) –

getFace(self, nFaceId: int, iTIndex: int, nVertex0: int, nVertex1: int, nVertex2: int)

Gets the face at index.

Parameters:

nFaceId (int) – faceIndex
iTIndex (int) – time Index
nVertex0 (int) –
nVertex1 (int) –
nVertex2 (int) –

getFaceCount(self, iTIndex: int) → int

Gets the number of faces.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (int) – an uint64_t

getFaceScalarSlotIndexForDescription(self, sValue: str, iTIndex: int) → int

Gets the scalar slot index from a face scalar description.

Parameters:

sValue (str) – the slot description (an std::wstring)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (int) – the index or -1 if not found

getFaceScalarValue(self, nScalarValueSlotIndex: int, scalarValueFaceIndex: int, iTIndex: int) → float

Gets the value of a face scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
scalarValueFaceIndex (int) – the face index (a uint32_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the value of a face scalar (a double)

getFaceScalarValueDescription(self, nScalarValueSlotIndex: int, iTIndex: int) → str

Gets a face scalar description.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (str) – the description (a std::wstring)

getFaceScalarValueDimensionUnit(self, nScalarValueSlotIndex: int, iTIndex: int) → ORSModel.ors.DimensionUnit

Gets the dimension unit of a face scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (ORSModel.ors.DimensionUnit) – the dimension unit (a DimensionUnit)

getFaceScalarValueMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

method getFaceScalarValueMax

Deprecated since version (unknown): use getFaceScalarValuesWindowMax instead

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (float) –

getFaceScalarValueMaxs(self, iTIndex: int) → ORSModel.ors.ArrayDouble

method getFaceScalarValueMaxs

Deprecated since version (unknown): use getFaceScalarValuesWindowMaxs instead

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getFaceScalarValueMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets a face scalar min value.

Deprecated since version (unknown): use getFaceScalarValuesWindowMin instead

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getFaceScalarValueMins(self, iTIndex: int) → ORSModel.ors.ArrayDouble

method getFaceScalarValueMins

Deprecated since version (unknown): use getFaceScalarValuesWindowMins instead

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getFaceScalarValueOffset(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets a face scalar offset value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the scalar offset value (a double)

getFaceScalarValueOffsets(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Get the face scalar offset values.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayDouble) – the scalar offset values (an ArrayDouble)

getFaceScalarValueSlope(self, scalarValueSlotIndex: int, iTIndex: int) → float

Gets a face scalar slope value.

Parameters:

scalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the scalar slope value (a double)

getFaceScalarValueSlopes(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Get the face scalar slope values.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayDouble) – the scalar slope values (an ArrayDouble)

getFaceScalarValueSlotLookUpTable(self, nScalarValueSlotIndex: int, iTIndex: int) → dict

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (dict) –

getFaceScalarValues(self, nScalarValueSlotIndex: int, iTIndex: int) → ORSModel.ors.Array

Gets the values of a face scalar.

Note

The array of values is of length getFaceCount() * getFaceScalarValuesSlotCount().

Note

The scalar value in the slot s of the face v is located at the index (getFaceScalarValuesSlotCount() * v) + s of the array.

Parameters:

nScalarValueSlotIndex (int) – the face scalar value slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (ORSModel.ors.Array) – an array of values (an ArrayFloat)

getFaceScalarValuesCollection(self) → ORSModel.ors.ScalarValuesCollection

Queries the scalar values collection of the faces.

Returns:: output (ORSModel.ors.ScalarValuesCollection) – the ScalarValuesCollection of the faces.

getFaceScalarValuesDatatype(self, nScalarValueSlotIndex: int) → int

Parameters:: nScalarValueSlotIndex (int) –
Returns:: output (int) –

getFaceScalarValuesId(self, nScalarValueSlotIndex: int, iTIndex: int) → str

Gets the scalar slot id from a face scalar values slot.

Parameters:

nScalarValueSlotIndex (int) – the index of the slot (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (str) –

getFaceScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a face scalar range max boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getFaceScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a face scalar range min boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getFaceScalarValuesRangeMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a face scalar range max value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getFaceScalarValuesRangeMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a face scalar range min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getFaceScalarValuesSlotCount(self) → int

Gets the number of slots for face scalar values.

Returns:: output (int) – the number of slots (a uint16_t)

getFaceScalarValuesWindowMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (float) –

getFaceScalarValuesWindowMaxs(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getFaceScalarValuesWindowMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets a face scalar window min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getFaceScalarValuesWindowMins(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getHideOutOfRangeFaceScalarValues(self) → bool

Indicate if out of range values should be hiden.

Returns:: output (bool) – (a bool)

getHideOutOfRangeLabelScalarValues(self) → bool

Indicate if out of range values should be hiden.

Returns:: output (bool) – (a bool)

getLabelCount(self, iTIndex: int) → int

Gets the number of labels.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (int) – an uint64_t

getLabelScalarSlotIndexForDescription(self, sValue: str, iTIndex: int) → int

Gets the scalar slot index from a label scalar description.

Parameters:

sValue (str) – the slot description (an std::wstring)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (int) – the index or -1 if not found

getLabelScalarValue(self, nScalarValueSlotIndex: int, scalarValueLabelIndex: int, iTIndex: int) → float

Gets the value of a label scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
scalarValueLabelIndex (int) – the label index (a uint32_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the value of a label scalar (a double)

getLabelScalarValueDescription(self, nScalarValueSlotIndex: int, iTIndex: int) → str

Gets a label scalar description.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (str) – the description (a std::wstring)

getLabelScalarValueDimensionUnit(self, nScalarValueSlotIndex: int, iTIndex: int) → ORSModel.ors.DimensionUnit

Gets the dimension unit of a label scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (ORSModel.ors.DimensionUnit) – the dimension unit (a DimensionUnit)

getLabelScalarValueOffset(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets a label scalar offset value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the scalar offset value (a double)

getLabelScalarValueOffsets(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Get the label scalar offset values.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayDouble) – the scalar offset values (an ArrayDouble)

getLabelScalarValueOrNull(self, nValueIndex: int, nSlotIndex: int, iTIndex: int) → Optional[float]

Parameters:

nValueIndex (int) –
nSlotIndex (int) –
iTIndex (int) –

Returns:

output (Optional[float]) –

getLabelScalarValueSlope(self, scalarValueSlotIndex: int, iTIndex: int) → float

Gets a label scalar slope value.

Parameters:

scalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – the scalar slope value (a double)

getLabelScalarValueSlopes(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Get the label scalar slope values.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayDouble) – the scalar slope values (an ArrayDouble)

getLabelScalarValueSlotLookUpTable(self, nScalarValueSlotIndex: int, iTIndex: int) → dict

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (dict) –

getLabelScalarValues(self, nScalarValueSlotIndex: int, iTIndex: int) → ORSModel.ors.Array

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (ORSModel.ors.Array) –

getLabelScalarValuesCollection(self) → ORSModel.ors.ScalarValuesCollection

Queries the scalar values collection of the labels.

Returns:: output (ORSModel.ors.ScalarValuesCollection) – the ScalarValuesCollection of the labels.

getLabelScalarValuesDatatype(self, nScalarValueSlotIndex: int) → int

Parameters:: nScalarValueSlotIndex (int) –
Returns:: output (int) –

getLabelScalarValuesId(self, nScalarValueSlotIndex: int, iTIndex: int) → str

Gets the scalar slot id from a label scalar values slot.

Parameters:

nScalarValueSlotIndex (int) – the index of the slot (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (str) –

getLabelScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a label scalar range max boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getLabelScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a label scalar range min boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getLabelScalarValuesRangeMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a label scalar range max value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getLabelScalarValuesRangeMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Get a label scalar range min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getLabelScalarValuesSlotCount(self) → int

Gets the number of slots for label scalar values.

Returns:: output (int) – the number of slots (a uint16_t)

getLabelScalarValuesWindowMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –

Returns:

output (float) –

getLabelScalarValuesWindowMaxs(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getLabelScalarValuesWindowMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

Gets a label scalar window min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

Returns:

output (float) – a double

getLabelScalarValuesWindowMins(self, iTIndex: int) → ORSModel.ors.ArrayDouble

Parameters:: iTIndex (int) –
Returns:: output (ORSModel.ors.ArrayDouble) –

getMeshContourOnPlane(self, aPlane: ORSModel.ors.Plane, iTIndex: int, pResultEdgesMap: ORSModel.ors.ArrayUnsignedLong) → ORSModel.ors.ArrayDouble

Parameters:

aPlane (ORSModel.ors.Plane) –
iTIndex (int) –
pResultEdgesMap (ORSModel.ors.ArrayUnsignedLong) –

Returns:

output (ORSModel.ors.ArrayDouble) –

getMeshThicknessOnGPU(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, iTIndex: int, pProgress: ORSModel.ors.Progress, lowerBound: float, upperBound: float, thicknessType: int) → ORSModel.ors.ArrayFloat

Get absolute distance between vertices of two meshes, along the normal of the vertices of the receiving mesh.

Parameters:

target (ORSModel.ors.Mesh) – mesh target (ORS::Mesh )
targetOctree (ORSModel.ors.Octree) – targetOctree(ORS::Octree)
iTIndex (int) – iTIndex (a uint32_t)
pProgress (ORSModel.ors.Progress) – pProgress (ORS::Progress)
lowerBound (float) –
upperBound (float) –
thicknessType (int) –

Returns:

output (ORSModel.ors.ArrayFloat) –

getMinMaxFaceScalarValue(self, nScalarValueSlotIndex: int, iTIndex: int, fMinValue: float, fMaxValue: float)

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –
fMinValue (float) –
fMaxValue (float) –

getMinMaxLabelScalarValue(self, nScalarValueSlotIndex: int, iTIndex: int, fMinValue: float, fMaxValue: float)

Parameters:

nScalarValueSlotIndex (int) –
iTIndex (int) –
fMinValue (float) –
fMaxValue (float) –

getMinimumAndMaximumDistanceOnPlaneFromCenterOf(self, anOrientedPlane: ORSModel.ors.OrientedPlane, iTIndex: int, minValue: float, maxValue: float)

Parameters:

anOrientedPlane (ORSModel.ors.OrientedPlane) –
iTIndex (int) –
minValue (float) –
maxValue (float) –

getModifiedLabelScalarValuesCollection(self) → ORSModel.ors.ScalarValuesCollection

Queries the scalar values collection of the labels reordered by label.

Returns:: output (ORSModel.ors.ScalarValuesCollection) – a new rearranged ScalarValuesCollection of the labels-should be deleted accordingly.

getNormalsMomentOfInertia(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → ORSModel.ors.Matrix4x4

Parameters:

iTIndex (int) –
aWorldTransform (ORSModel.ors.Matrix4x4) –

Returns:

output (ORSModel.ors.Matrix4x4) –

getSignedVerticesDistance(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, maxSearchDistance: float, iTIndex: int, pProgress: ORSModel.ors.Progress) → ORSModel.ors.ArrayFloat

Get signed distance between vertices of two meshes, vertices of the receiveing mesh to the target faces.

Parameters:

target (ORSModel.ors.Mesh) – mesh target (ORS::Mesh )
targetOctree (ORSModel.ors.Octree) – targetOctree(ORS::Octree)
maxSearchDistance (float) – maxSearchDistance( a double)
iTIndex (int) – iTIndex (a uint32_t)
pProgress (ORSModel.ors.Progress) – pProgress (ORS::Progress)

Returns:

output (ORSModel.ors.ArrayFloat) –

getSignedVerticesNormalDistance(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, iTIndex: int, pProgress: ORSModel.ors.Progress) → ORSModel.ors.ArrayFloat

Get signed distance between vertices of two meshes, along the normal of the vertices of the receiving mesh.

Parameters:

target (ORSModel.ors.Mesh) – mesh target (ORS::Mesh )
targetOctree (ORSModel.ors.Octree) – targetOctree(ORS::Octree)
iTIndex (int) – iTIndex (a uint32_t)
pProgress (ORSModel.ors.Progress) – pProgress (ORS::Progress)

Returns:

output (ORSModel.ors.ArrayFloat) –

getSphericalEquiRectangularHeightProjection(self, aSphere: ORSModel.ors.Sphere, xSize: int, ySize: int, timeStep: int, aChannel: ORSModel.ors.Channel) → ORSModel.ors.Channel

Get the signed distance between the sphere and the surface of the mesh, in a Equirectangular projection.

Parameters:

aSphere (ORSModel.ors.Sphere) – aSphere target (ORS::Sphere )
xSize (int) – xSize of the output Channel (a uint32_t)
ySize (int) – ySize of the output Channel (a uint32_t)
timeStep (int) – timeStep of the receiving Mesh to considered (a uint32_t)
aChannel (ORSModel.ors.Channel) – output Channel, can be None (ORS::Channel)

Returns:

output (ORSModel.ors.Channel) – the Output Channel (ORS::Channel)

getTransformed(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, pInOutMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Parameters:

aTransformationMatrix (ORSModel.ors.Matrix4x4) –
pInOutMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) –

getTriangleIndicesContainedInSphere(self, centerOfTheSphere: ORSModel.ors.Vector3, radiusOfSphere: float, iTIndex: int, IProgress: ORSModel.ors.Progress) → ORSModel.ors.ArrayUnsignedLong

Get triangles indices that are contained in sphere.

Parameters:

centerOfTheSphere (ORSModel.ors.Vector3) – the sphere center (a Vector3)
radiusOfSphere (float) – the sphere radius (a double)
iTIndex (int) – the time step (a uint32_t)
IProgress (ORSModel.ors.Progress) – a progress object (a Progress) or NULL for no progress

Returns:

output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

getUVs(self, iTIndex: int) → ORSModel.ors.ArrayFloat

Gets the UV values.

See also

setUVs()

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayFloat) – an array of float (an ArrayFloat)

getUseDefaultFaceAlphaColor(self) → bool

Queries the face to see if it uses its default alpha color.

Returns:: output (bool) – true if a default alpha color is used for the face, false otherwise

getUseDefaultFaceColor(self) → bool

Queries the face to see if it uses its default color.

Returns:: output (bool) – true if the face uses its default color, false otherwise

getUseDefaultLabelColor(self) → bool

Queries the label to see if it uses its default color.

Returns:: output (bool) – true if the label uses its default color, false otherwise

getUseDefaultMeshAlphaColor(self) → bool

Queries the mesh to see if it uses its default alpha color.

Deprecated since version (unknown): use getUseDefaultVertexAlphaColor instead

Returns:: output (bool) – true if a default alpha color is used for the mesh, false otherwise

getUseDefaultMeshColor(self) → bool

Queries the mesh to see if it uses its default color.

Deprecated since version (unknown): use getUseDefaultVertexColor instead

Returns:: output (bool) – true if the mesh uses its default color, false otherwise

getUseFaceScalarValues(self) → bool

Sets the mesh to have face scalar values or not.

Returns:: output (bool) – TRUE to use scalar values, FALSE otherwise

getUseLabelScalarValues(self) → bool

Sets the mesh to have label scalar values or not.

Returns:: output (bool) – TRUE to use scalar values, FALSE otherwise

getVerticesClosestFacesId(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, iTIndex: int, pProgress: ORSModel.ors.Progress, oMapping: ORSModel.ors.ArrayLong, oCollisionPoints: ORSModel.ors.ArrayDouble)

Get for each vertex of a mesh the closest faces id of an other mesh.

Parameters:

target (ORSModel.ors.Mesh) – mesh target (ORS::Mesh )
targetOctree (ORSModel.ors.Octree) – targetOctree(ORS::Octree)
iTIndex (int) – iTIndex (a uint32_t)
pProgress (ORSModel.ors.Progress) – pProgress (ORS::Progress)
oMapping (ORSModel.ors.ArrayLong) – pProgress (ORS::ArrayLong)
oCollisionPoints (ORSModel.ors.ArrayDouble) – pProgress (ORS::ArrayDouble)

getVerticesCoordinatesWhereNormalIsAlignedWithDirection(self, direction: ORSModel.ors.Vector3, angle: float, iTIndex: int) → ORSModel.ors.ArrayFloat

Parameters:

direction (ORSModel.ors.Vector3) –
angle (float) –
iTIndex (int) –

Returns:

output (ORSModel.ors.ArrayFloat) –

getVerticesDistance(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, maxSearchDistance: float, iTIndex: int, pProgress: ORSModel.ors.Progress) → ORSModel.ors.ArrayFloat

Get distance between vertices of two meshes, vertices of the receiveing mesh to the target faces.

Parameters:

target (ORSModel.ors.Mesh) – mesh target (ORS::Mesh )
targetOctree (ORSModel.ors.Octree) – targetOctree(ORS::Octree)
maxSearchDistance (float) – maxSearchDistance( a double)
iTIndex (int) – iTIndex (a uint32_t)
pProgress (ORSModel.ors.Progress) – pProgress (ORS::Progress)

Returns:

output (ORSModel.ors.ArrayFloat) –

getVerticesForLabel(self, pLabel: int, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:

pLabel (int) –
iTIndex (int) –

Returns:

output (ORSModel.ors.ArrayUnsignedLong) –

getVerticesNormalDistance(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, iTIndex: int, pProgress: ORSModel.ors.Progress) → ORSModel.ors.ArrayFloat

Get absolute distance between vertices of two meshes, along the normal of the vertices of the receiving mesh.

Parameters:

target (ORSModel.ors.Mesh) – mesh target (ORS::Mesh )
targetOctree (ORSModel.ors.Octree) – targetOctree(ORS::Octree)
iTIndex (int) – iTIndex (a uint32_t)
pProgress (ORSModel.ors.Progress) – pProgress (ORS::Progress)

Returns:

output (ORSModel.ors.ArrayFloat) –

getVerticesNormals(self, iTIndex: int) → ORSModel.ors.ArrayFloat

Gets the normals.

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.ArrayFloat) – the normals data (an ArrayFloat)

getVolume(self, aPlane: ORSModel.ors.Plane, timeStep: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, IProgress: ORSModel.ors.Progress) → float

Gets the volume from closed mesh.

Note

Result for an open mesh is undefined.

Note

Only works for triangular primitive type mesh.

Note

The algorithm uses winding to find the inside part of faces. Thus the result for meshes with wrong winding is undefined.

Parameters:

aPlane (ORSModel.ors.Plane) – a progress object (an Progress) or NULL for no progress
timeStep (int) –
aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –
IProgress (ORSModel.ors.Progress) –

Returns:

output (float) – the volume (a double)

getWorldTransform(timestep=0)

Get the Matrix4x4 for transforming from local to world coordinates

Parameters:: timestep (int) –
Return:
Rtype:: ORSModel.ors.Matrix4x4

isWindingSoThatFaceNormalAreOutside(self, iTIndex: int, progress: ORSModel.ors.Progress) → bool

Check if face vertex normal direction point outside of the mesh.

Parameters:

iTIndex (int) – the time step (a uint32_t)
progress (ORSModel.ors.Progress) – a progress object (a Progress) or none for no progress

Returns:

output (bool) –

labelizeVertices(self, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Labelizes mesh vertices based on connectivity.

Note

The scalar for the specified index should be already initialized.

Parameters:: iTIndex (int) – the time index (a uint16_t)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – the vertices label (an ArrayUnsignedLong)

labelizeVerticesForScalarValues(self, iTIndex: int)

Labelizes mesh vertices based on connectivity and initilizes the label scalar values if not already initialized.

Parameters:: iTIndex (int) – the time index (a uint16_t)

laplacianSmooth(self, nNbIterations: int, iTIndex: int, relaxationFactor: float)

Smooth the mesh using Laplacien algorithm.

Parameters:

nNbIterations (int) – number of smooth iteration (uint16_t)
iTIndex (int) – time step to smooth (uint32_t)
relaxationFactor (float) – relaxation factor (double) , must be between 0 and 1

laplacianSmoothWithPerVerticeRelaxationFactor(self, nNbIterations: int, iTIndex: int, relaxationFactorPerVertice: ORSModel.ors.Array)

Smooth the mesh using Laplacien algorithm applying the relaxation factors provided.

Parameters:

nNbIterations (int) – number of smooth iteration (uint16_t)
iTIndex (int) – time step to smooth (uint32_t)
relaxationFactorPerVertice (ORSModel.ors.Array) – relaxationFactorPerVertice (an Array), values should be between 0 and 1

mapScalarValuesFromAnOtherMesh(self, referenceMesh: ORSModel.ors.Mesh, mapping: ORSModel.ors.ArrayLong, collisionPoints: ORSModel.ors.ArrayDouble, referenceSlotIndex: int, sourceSlotIndex: int, referenceTIndex: int, sourceTIndex: int, defaultScalarValue: float)

Maps vertices scalar values of a reference mesh to a source mesh.

Parameters:

referenceMesh (ORSModel.ors.Mesh) – the reference mesh (a Mesh)
mapping (ORSModel.ors.ArrayLong) – an array that give which face ID of the reference mesh match with the source mesh (an ArrayLong)
collisionPoints (ORSModel.ors.ArrayDouble) – an array that give the collision point on the reference mesh (an ArrayDouble)
referenceSlotIndex (int) – the slot of the reference mesh to map (a uint32_t)
sourceSlotIndex (int) – the slot destination of the source mesh (a uint32_t)
referenceTIndex (int) – the time step of the reference mesh (a uint32_t)
sourceTIndex (int) – the time step of the soruce mesh (a uint32_t)
defaultScalarValue (float) – a default value in case that no match is found between a vertexe and a face (double)

none() → Mesh

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Mesh) –

removeAFaceScalarValuesSlot(self, nScalarValueSlotIndex: int)

Remove a scalar slot from the face scalars values slot.

Parameters:: nScalarValueSlotIndex (int) – the index of the slot to be removed (a uint16_t)

removeALabelScalarValuesSlot(self, nScalarValueSlotIndex: int)

Remove a scalar slot from the label scalars values slot.

Parameters:: nScalarValueSlotIndex (int) – the index of the slot to be removed (a uint16_t)

removeDuplicateVertices(self, fEpsilon: float, iTIndex: int, pInOutMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Removes duplicate vertices of the mesh.

Note

If a target mesh is supplied, data is written to it and returned, otherwise a new mesh is created.

Parameters:

fEpsilon (float) – an epsilon value (a double)
iTIndex (int) – the time step (a uint32_t)
pInOutMesh (ORSModel.ors.Mesh) – the output mesh (a Mesh)

Returns:

output (ORSModel.ors.Mesh) – the result mesh (a Mesh)

setCurrentFaceScalarValuesSlot(self, slotIndex: int)

Sets the current face scalar.

Note

The scalar index is zero-based, and thus should be less than getFaceScalarValuesSlotCount().

Note

Use -1 to indicate no current scalar

Parameters:: slotIndex (int) – the current scalar slot index (an int32_t)

setCurrentLabelScalarValuesSlot(self, slotIndex: int)

Parameters:: slotIndex (int) –

setDefaultColor(self, IColor: ORSModel.ors.Color)

Sets the mesh default color.

Note

Each color value goes between 0 (none) and 1 (full).

Note

You need to call setUseDefaultColor(TRUE) for the default color to be used.

Note

You need to call initializeVisual after color changes for them to be visible on the screen.

Parameters:: IColor (ORSModel.ors.Color) – a color (an Color)

setDefaultFaceAlphaColor(self, value: float)

Sets the face its default alpha color.

Parameters:: value (float) – Alpha color (double)

setDefaultFaceColor(self, IColor: ORSModel.ors.Color)

Sets the face default color.

Note

Each color value goes between 0 (none) and 1 (full).

Note

You need to call setUseDefaultColor(true) for the default color to be used.

Note

You need to call initializeVisual after color changes for them to be visible on the screen.

Parameters:: IColor (ORSModel.ors.Color) – a color (an Color)

setDefaultMeshAlphaColor(self, value: float)

Sets the mesh its default alpha color.

Deprecated since version (unknown): use

Parameters:: value (float) – Alpha color (double)

setEdgeCountPerFace(self, value: int)

Parameters:: value (int) –

setFace(self, nFaceId: int, iTIndex: int, nVertex0: int, nVertex1: int, nVertex2: int)

Sets the face at index.

Parameters:

nFaceId (int) – faceIndex
iTIndex (int) – time Index
nVertex0 (int) – first vertex index
nVertex1 (int) – second vertex index
nVertex2 (int) – third vertex index

setFaceCount(self, faceCount: int, iTIndex: int)

Sets the number of faces.

Parameters:

faceCount (int) – the new face count (a uint32_t)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValue(self, nScalarValueSlotIndex: int, scalarValueFaceIndex: int, aValue: float, iTIndex: int)

Sets the value of a face scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
scalarValueFaceIndex (int) – the face index (an uint32_t)
aValue (float) – the value of a face scalar to set (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValueDescription(self, nScalarValueSlotIndex: int, value: str, iTIndex: int)

Parameters:

nScalarValueSlotIndex (int) –
value (str) –
iTIndex (int) –

setFaceScalarValueDimensionUnit(self, nScalarValueSlotIndex: int, pDimensionUnit: ORSModel.ors.DimensionUnit, iTIndex: int)

Sets the dimension unit of a face scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
pDimensionUnit (ORSModel.ors.DimensionUnit) – the dimension unit (a DimensionUnit)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValueMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets a face scalar max value.

Deprecated since version (unknown): use setFaceScalarValuesWindowMax instead

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar max value (a double)
iTIndex (int) – time step (a uint32_t)

setFaceScalarValueMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

method setFaceScalarValueMaxs

Deprecated since version (unknown): use setFaceScalarValuesWindowMaxs instead

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setFaceScalarValueMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

method setFaceScalarValueMin

Deprecated since version (unknown): use setFaceScalarValuesWindowMin instead

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValueMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

method setFaceScalarValueMins

Deprecated since version (unknown): use setFaceScalarValuesWindowMins instead

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setFaceScalarValueOffset(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets a face scalar offset value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the scalar offset value (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValueOffsets(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Set the face scalar offset values.

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) – scalar offset values (an ArrayDouble)
iTIndex (int) – time step (a uint32_t)

setFaceScalarValueSlope(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Gets a face scalar slope value.

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar slope value (a double)
iTIndex (int) – time step (a uint32_t)

setFaceScalarValueSlopes(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Set the face scalar slope values.

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) – scalar slope values (an ArrayDouble)
iTIndex (int) – time step (a uint32_t)

setFaceScalarValueSlotLookUpTable(self, lookUpTable: dict, nScalarValueSlotIndex: int, iTIndex: int)

Parameters:

lookUpTable (dict) –
nScalarValueSlotIndex (int) –
iTIndex (int) –

setFaceScalarValueUnit(self, nScalarValueSlotIndex: int, value: int, iTIndex: int)

method setFaceScalarValueUnit

Deprecated since version (unknown): use setFaceScalarValueDimensionUnit instead

Parameters:

nScalarValueSlotIndex (int) –
value (int) –
iTIndex (int) –

setFaceScalarValues(self, pScalarValues: ORSModel.ors.Array, nScalarValueSlotIndex: int, iTIndex: int)

Sets the values of a face scalar.

Note

The array of values is of length getFaceCount() * getFaceScalarValuesSlotCount().

Note

The scalar value in the slot s of the face v is located at the index (getFaceScalarValuesSlotCount() * v) + s of the array.

Parameters:

pScalarValues (ORSModel.ors.Array) – an array of values (an ArrayFloat)
nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValuesDatatype(self, iSlotIndex: int, nFaceScalarValuesDatatype: int)

Parameters:

iSlotIndex (int) –
nFaceScalarValuesDatatype (int) –

setFaceScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a face scalar range max boundary value.

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a face scalar range min boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValuesRangeMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a face scalar range max value.

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValuesRangeMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a face scalar range min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValuesSlotCount(self, slotCount: int)

Sets the number of slots for face scalar values.

Parameters:: slotCount (int) – the number of slots (a uint16_t)

setFaceScalarValuesWindowMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets a face scalar max value.

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar max value (a double)
iTIndex (int) – time step (a uint32_t)

setFaceScalarValuesWindowMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setFaceScalarValuesWindowMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

method setFaceScalarValuesWindowMin

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setFaceScalarValuesWindowMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setHideOutOfRangeFaceScalarValues(self, value: bool)

Indicate if out of range values should be hiden.

Parameters:: value (bool) –

setHideOutOfRangeLabelScalarValues(self, value: bool)

Indicate if out of range values should be hiden.

Parameters:: value (bool) –

setLabelCount(self, faceCount: int, iTIndex: int)

Sets the number of labels.

Parameters:

faceCount (int) – the new face count (a uint32_t)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValue(self, nScalarValueSlotIndex: int, scalarValueLabelIndex: int, aValue: float, iTIndex: int)

Sets the value of a label scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
scalarValueLabelIndex (int) – the label index (an uint32_t)
aValue (float) – the value of a label scalar to set (a double)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValueDescription(self, nScalarValueSlotIndex: int, value: str, iTIndex: int)

Parameters:

nScalarValueSlotIndex (int) –
value (str) –
iTIndex (int) –

setLabelScalarValueDimensionUnit(self, nScalarValueSlotIndex: int, pDimensionUnit: ORSModel.ors.DimensionUnit, iTIndex: int)

Sets the dimension unit of a label scalar.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
pDimensionUnit (ORSModel.ors.DimensionUnit) – the dimension unit (a DimensionUnit)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValueNull(self, nValueIndex: int, nScalarValueSlotIndex: int, iTIndex: int)

Parameters:

nValueIndex (int) –
nScalarValueSlotIndex (int) –
iTIndex (int) –

setLabelScalarValueOffset(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets a label scalar offset value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the scalar offset value (a double)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValueOffsets(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Set the label scalar offset values.

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) – scalar offset values (an ArrayDouble)
iTIndex (int) – time step (a uint32_t)

setLabelScalarValueSlope(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Gets a label scalar slope value.

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar slope value (a double)
iTIndex (int) – time step (a uint32_t)

setLabelScalarValueSlopes(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Set the label scalar slope values.

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) – scalar slope values (an ArrayDouble)
iTIndex (int) – time step (a uint32_t)

setLabelScalarValueSlotLookUpTable(self, lookUpTable: dict, nScalarValueSlotIndex: int, iTIndex: int)

Parameters:

lookUpTable (dict) –
nScalarValueSlotIndex (int) –
iTIndex (int) –

setLabelScalarValues(self, pScalarValues: ORSModel.ors.Array, nScalarValueSlotIndex: int, iTIndex: int)

Sets the values of a label scalar.

Note

The array of values is of length getVertexCount() * getLabelScalarValuesSlotCount().

Parameters:

pScalarValues (ORSModel.ors.Array) – an array of values (an ArrayFloat)
nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValuesDatatype(self, iSlotIndex: int, nLabelScalarValuesDatatype: int)

Parameters:

iSlotIndex (int) –
nLabelScalarValuesDatatype (int) –

setLabelScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a label scalar range max boundary value.

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a label scalar range min boundary value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValuesRangeMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a label scalar range max value.

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValuesRangeMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Set a label scalar range min value.

Parameters:

nScalarValueSlotIndex (int) – the scalar slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValuesSlotCount(self, slotCount: int)

Sets the number of slots for label scalar values.

Parameters:: slotCount (int) – the number of slots (a uint16_t)

setLabelScalarValuesWindowMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

Sets a label scalar max value.

Parameters:

nScalarValueSlotIndex (int) – scalar slot index (a uint16_t)
value (float) – scalar max value (a double)
iTIndex (int) – time step (a uint32_t)

setLabelScalarValuesWindowMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setLabelScalarValuesWindowMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int)

method setLabelScalarValuesWindowMin

Parameters:

nScalarValueSlotIndex (int) – the slot index (a uint16_t)
value (float) – the value (a double)
iTIndex (int) – the time step (a uint32_t)

setLabelScalarValuesWindowMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int)

Parameters:

pScalarValues (ORSModel.ors.ArrayDouble) –
iTIndex (int) –

setUseDefaultFaceAlphaColor(self, value: bool)

Sets the face to use its default alpha color.

Parameters:: value (bool) – true for using a default alpha color for the face, false otherwise (bool)

setUseDefaultFaceColor(self, value: bool)

Sets the face to use its default color.

Parameters:: value (bool) – true to use the face default color, false otherwise

setUseDefaultLabelColor(self, value: bool)

Sets the face to use its default color.

Parameters:: value (bool) – true to use the face default color, false otherwise

setUseDefaultMeshAlphaColor(self, value: bool)

Sets the mesh to use its default alpha color.

Deprecated since version (unknown): Use

Parameters:: value (bool) – TRUE for using a default alpha color for the mesh, FALSE otherwise (bool)

setUseDefaultMeshColor(self, value: bool)

Sets the mesh to use its default color.

Deprecated since version (unknown): use setUseDefaultVertexColor instead

Parameters:: value (bool) – TRUE to use the mesh default color, FALSE otherwise

setUseFaceScalarValues(self, value: bool)

Gets the status of face scalar values usage.

See also

getScalarValues(), getSlotCount()

Parameters:: value (bool) –

setUseLabelScalarValues(self, value: bool)

Gets the status of label scalar values usage.

See also

getScalarValues(), getSlotCount()

Parameters:: value (bool) –

snapOnData(self, aDataset: ORSModel.ors.Channel, searchLength: float, iTIndex: int, relaxation: float, iteration: int, smoothIteration: int, relaxationFactor: float, pMinDisplacement: float, pMaxDisplacement: float, falloff_factor: float, mergeVertices: bool, autoAdjustFalloff: bool, negativeconst: bool, IProgress: ORSModel.ors.Progress)

Parameters:

aDataset (ORSModel.ors.Channel) –
searchLength (float) –
iTIndex (int) –
relaxation (float) –
iteration (int) –
smoothIteration (int) –
relaxationFactor (float) –
pMinDisplacement (float) –
pMaxDisplacement (float) –
falloff_factor (float) –
mergeVertices (bool) –
autoAdjustFalloff (bool) –
negativeconst (bool) –
IProgress (ORSModel.ors.Progress) –

updateVerticesNormal(self, iTIndex: int)

Parameters:: iTIndex (int) –

MeshFacesROI¶

class ORSModel.ors.MeshFacesROI(*args, **kwargs)

Bases: Node

Represents a region of interest for a mesh (Mesh).

See also

ROI

addFaceIndex(self, nFaceIndex: int, nTIndex: int)

Parameters:

nFaceIndex (int) –
nTIndex (int) –

addFacesIndexes(self, indexes: ORSModel.ors.ArrayUnsignedLong, nNbIndex: int, nTIndex: int)

Parameters:

indexes (ORSModel.ors.ArrayUnsignedLong) –
nNbIndex (int) –
nTIndex (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFaceIndexAtPosition(self, pos: int, nTIndex: int) → int

Parameters:

pos (int) –
nTIndex (int) –

Returns:

output (int) –

getFaceIndexes(self, nTimeStep: int, IInputFaceIndexes: ORSModel.ors.ArrayUnsignedLong) → ORSModel.ors.ArrayUnsignedLong

Parameters:

nTimeStep (int) –
IInputFaceIndexes (ORSModel.ors.ArrayUnsignedLong) –

Returns:

output (ORSModel.ors.ArrayUnsignedLong) –

getFaceIndexesCount(self, nTIndex: int) → int

Parameters:: nTIndex (int) –
Returns:: output (int) –

getHasFaceIndex(self, nFaceIndex: int, nTIndex: int) → bool

Parameters:

nFaceIndex (int) –
nTIndex (int) –

Returns:

output (bool) –

getIntersectionWithMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → ORSModel.ors.MeshFacesROI

Parameters:

IInputMeshROI (ORSModel.ors.MeshFacesROI) –
nTimeStep (int) –
IOutputMeshROI (ORSModel.ors.MeshFacesROI) –

Returns:

output (ORSModel.ors.MeshFacesROI) –

getInverseMeshFacesROI(self, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → ORSModel.ors.MeshFacesROI

Parameters:

nTimeStep (int) –
IOutputMeshROI (ORSModel.ors.MeshFacesROI) –

Returns:

output (ORSModel.ors.MeshFacesROI) –

getIsVisibleForAllDisplays(self) → bool

Returns:: output (bool) –

getIsVisibleForDisplay(self, IDisplay: ORSModel.ors.View) → bool

Parameters:: IDisplay (ORSModel.ors.View) –
Returns:: output (bool) –

getSubtractionFromMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → ORSModel.ors.MeshFacesROI

Parameters:

IInputMeshROI (ORSModel.ors.MeshFacesROI) –
nTimeStep (int) –
IOutputMeshROI (ORSModel.ors.MeshFacesROI) –

Returns:

output (ORSModel.ors.MeshFacesROI) –

getUnionWithMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → ORSModel.ors.MeshFacesROI

Parameters:

IInputMeshROI (ORSModel.ors.MeshFacesROI) –
nTimeStep (int) –
IOutputMeshROI (ORSModel.ors.MeshFacesROI) –

Returns:

output (ORSModel.ors.MeshFacesROI) –

none() → MeshFacesROI

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (MeshFacesROI) –

removeAllFaceIndexes(self, nTIndex: int)

Parameters:: nTIndex (int) –

removeFaceIndex(self, nFaceIndex: int, nTIndex: int)

Parameters:

nFaceIndex (int) –
nTIndex (int) –

removeFaceIndexAtPosition(self, pos: int, nTimeStep: int) → int

Parameters:

pos (int) –
nTimeStep (int) –

Returns:

output (int) –

setColor(self, aColor: ORSModel.ors.Color)

Parameters:: aColor (ORSModel.ors.Color) –

setIsVisibleForAllDisplays(self, bValue: bool)

Note

This API overrides all prior calls to setIsVisibleForDisplay(), or in other words, any display specific setting is erased.

Parameters:: bValue (bool) –

setIsVisibleForDisplay(self, IDisplay: ORSModel.ors.View, bValue: bool)

Note

This API overrides a prior call to setIsVisibleForAllDisplays(), for a given display.

Parameters:

IDisplay (ORSModel.ors.View) –
bValue (bool) –

Model¶

class ORSModel.ors.Model

Main gateway into the ORS Core library.

static addAListOfObjectsToSelection(aListOfObjects, contextInstance)

Adds a list of objects to selection for a given context.

Parameters:

aListOfObjects (ORSModel.ors.Managed) [count=[0, None]] – list of objects to add (list)
contextInstance (plugin instance) – context instance

Note

Only representable object can be un selected

addCallbackToClassEvent(aClassName: str, anEventName: str, sCallbackName: str, callbackInfo: bytes, permanent: bool) → bool

Parameters:

aClassName (str) –
anEventName (str) –
sCallbackName (str) –
callbackInfo (bytes) –
permanent (bool) –

Returns:

output (bool) – true if operation was successful, false otherwise (the callback already existed)

addCallbackToGlobalEvent(anEventName: str, sCallbackName: str, callbackInfo: bytes, permanent: bool) → bool

Parameters:

anEventName (str) –
sCallbackName (str) –
callbackInfo (bytes) –
permanent (bool) –

Returns:

output (bool) – true if operation was successful, false otherwise (the callback already existed)

canExecuteGPGPUCommand(inputGUID: str, GPGPUCommand: str) → int

verifiy if the execution for a GPGPU shader file on the object is possible

Parameters:

inputGUID (str) –
GPGPUCommand (str) –

Returns:

output (int) – true succeeded, false otherwise

deleteAllObjects(pFinalExit: bool)

Deletes every core object.

Parameters:: pFinalExit (bool) –

executeGPGPUCommand(inputGUID: str, outputGUID: str, GPGPUCommand: str, numericArgument: dict) → bool

execute an GPGPU shader file on the object in arguement.

Parameters:

inputGUID (str) –
outputGUID (str) –
GPGPUCommand (str) –
numericArgument (dict) –

Returns:

output (bool) – true succeeded, false otherwise

getActiveWorkerThreadsCount() → int

Returns the number of active worker threads.

Returns:: output (int) – a count of active worker threads (a uint32_t)

static getAllSelectedObjectsOfClass(pProgId, contextInstance)

Returns a flattened list of all representable selected object of the given class and context.

Parameters:

pProgId (str) – the ProgId of the class to test against
contextInstance (plugin instance) – context instance

Returns:

output (ORSModel.ors.Managed) [count=[0, None]] – a list of all selected objects

getAvailableCPUCount() → int

Returns:: output (int) –

getBuildNumber() → str

Returns the Core library internal build number.

Returns:: output (str) – a build number text (a string)

getClassEventCallbackEnabled(aClassName: str, sEventName: str, sCallbackName: str) → bool

Parameters:

aClassName (str) –
sEventName (str) –
sCallbackName (str) –

Returns:

output (bool) –

getCredentialsFilePath() → str

Returns:: output (str) –

getCurrentActivationFor(product: int) → str

Parameters:: product (int) –
Returns:: output (str) –

classmethod getCurrentAvailableGPUMemoryNVIDIADisplay(): Returns available GPU memory (in kb) on current NVIDIA display.

Note

This function should not be called in a run in back ground function. Also application should be running so that the OpenGL context is started.

getCurrentLicenseInformationFor(product: int) → str

Parameters:: product (int) –
Returns:: output (str) –

getDLLFilename() → str

Returns the Core library file name.

Returns:: output (str) – a fully qualified file path (a string)

getDLLVersion() → str

Returns the Core library internal version.

Returns:: output (str) – a version text (a string)

getDebugMode() → bool

Checks if the Core library is in debug mode.

Returns:: output (bool) – true if in debug mode, false otherwise

getEpsilon() → float

Returns:: output (float) –

getFontNames() → str

Gets the available font names.

Note

Return a concatenated string of all known font names, separated by a pipe character (|).

Returns:: output (str) – All the known font names (a string, see note below)

getGlobalEventCallbackEnabled(sEventName: str, sCallbackName: str) → bool

Parameters:

sEventName (str) –
sCallbackName (str) –

Returns:

output (bool) –

getIsDeployment() → bool

verifiy if the current dll is compiled for deployment or not

Returns:: output (bool) – true if deployment, false otherwise

getIsRunningInReleaseMode() → bool

Checks if the Core library is running in release mode.

Returns:: output (bool) – true if in release mode, false otherwise

getLicenseExpiry() → int

Returns:: output (int) –

getMajorVersion() → str

Returns the Core library internal major version.

Returns:: output (str) – a version text (a string)

getMaximumViewportHeight() → int

Returns:: output (int) –

getMaximumViewportWidth() → int

Returns:: output (int) –

getModelObjectsCount() → int

Returns the count of currently live objects.

Returns:: output (int) –

getPresetFileExtension() → str

Gets the extension of preset files.

Returns:: output (str) –

getStartupResultCode() → int

Returns:: output (int) –

classmethod getTotalGPUMemoryNVIDIADisplay(): Returns the total GPU memory (in kb) on current NVIDIA display.

Note

This function should not be called in a run in back ground function. Also application should be running so that the OpenGL context is started.

hasBaseFeature(iMode: int) → bool

Parameters:: iMode (int) –
Returns:: output (bool) –

hasFeature(iFeature: int, iMode: int) → bool

Parameters:

iFeature (int) –
iMode (int) –

Returns:

output (bool) –

hasGPU() → bool

Returns if a GPU is enabled.

Returns:: output (bool) –

initializeUIDeleteFramework(): Starts the UI delete framework. The UI is then responsible for periodically invokingprocessUIDelete() from the UI thread.

isAMD() → bool

Checks if an AMD dedicated GPU is present.

Returns:: output (bool) – true if an AMD GPU was detected, false otherwise

isAWS() → bool

Returns:: output (bool) –

isNVidia() → bool

Checks if an Nvidia dedicated GPU is present.

Returns:: output (bool) – true if an Nvidia GPU was detected, false otherwise

isNotNone() → bool

Returns:: output (bool) –

loadSessionFromFile(aFilename: str) → List[str]

Loads a session file.

Parameters:: aFilename (str) – a fully qualified file path (a string)
Returns:: output (List[str]) – a list of errors, or an empty list if operation was successful

processUIDelete(): Gives the UI delete sub-system some processing time. Must be invoked from the UI thread.

removeCallbackFromClassEvent(aClassName: str, sEventName: str, sCallbackName: str) → bool

Removes a callback subscription to a class event.

Parameters:

aClassName (str) – the class name (a string)
sEventName (str) – the event name (a string)
sCallbackName (str) – the callback name (a string)

Returns:

output (bool) – true if operation was successful, false otherwise (the callback was not found)

removeCallbackFromGlobalEvent(sEventName: str, sCallbackName: str) → bool

Removes a callback subscription to a global event.

Parameters:

sEventName (str) – the event name (a string)
sCallbackName (str) – the callback name (a string)

Returns:

output (bool) – true if removal was successful, false otherwise (the callback did not exist)

saveSessionToFile(pSessionName: str, aFilename: str, progress: ORSModel.ors.Progress, iCompressionEngine: int = 1) → int

Saves the current session to a file.

Parameters:

pSessionName (str) – a session name (a string)
aFilename (str) – a fully qualified file path (a string)
progress (ORSModel.ors.Progress) – a progress object or none (a Progress)
iCompressionEngine (int) – the input compression engine (0: None, 1: ZSTD)

Returns:

output (int) – 0 if operation was successful, otherwise an error code

static selectExclusivelyAListOfObjects(aListOfObjects, contextInstance)

Selects only the given objects for the context.

Parameters:

aListOfObjects (ORSModel.ors.Managed) [count=[0, None]] – list of objects to be selected exclusively (list)
contextInstance (plugin instance) – context instance

Note

Only representable object can be un selected

setAvailableCPUCount(pNbCPUs: int)

Note

Setting this value to 0 means to use all CPUs.

Parameters:: pNbCPUs (int) –

setClassEventCallbackEnabled(aClassName: str, sEventName: str, sCallbackName: str, bValue: bool) → bool

Enables/disables a callback subscription to a class event.

Parameters:

aClassName (str) – the event name (a string)
sEventName (str) – the callback name (a string)
sCallbackName (str) – true to enable the callback, false to disable it
bValue (bool) –

Returns:

output (bool) – true if operation was successful, false otherwise (the callback was not found)

setDebugMode(pState: bool)

Sets the COM’s debug mode on or off.

Parameters:: pState (bool) –

setEpsilon(anEpsilon: float)

Parameters:: anEpsilon (float) –

setGlobalEventCallbackEnabled(sEventName: str, sCallbackName: str, bValue: bool) → bool

Enables/disables a callback subscription to a global event.

Parameters:

sEventName (str) – the event name (a string)
sCallbackName (str) – the callback name (a string)
bValue (bool) – true to enable the callback, false to disable it

Returns:

output (bool) – true if operation was successful, false otherwise (the callback was not found)

setPrecision(iPrecision: int)

Sets the precision of computations when displayed.

Parameters:: iPrecision (int) –

setupForNoGPU(): Indicates that rendering is impossible because no GPU is present.

startWorkersFor(pWorkData: bytes)

Parameters:: pWorkData (bytes) –

stopWorkersWithID(id: int)

Parameters:: id (int) –

triggerGlobalEvent(anEventName: str, sData: str) → bool

Triggers a global event.

Parameters:

anEventName (str) – the event name (a string)
sData (str) – an event specific string

Returns:

output (bool) – true if event was triggered, false otherwise

static unselectAListOfObjects(aListOfObjects, contextInstance)

Removes a list of objects to selection for a given context.

Parameters:

aListOfObjects (ORSModel.ors.Managed) [count=[0, None]] – list of objects to remove (list)
contextInstance (plugin instance) – context instance

static unselectAllObjects(contextInstance)

Removes all selected object of selection for the given context.

Parameters:: contextInstance (plugin instance) – context instance

yieldUIWorker(): Gives the UI worker control to process any pending tasks that it holds.

MultiROI¶

class ORSModel.ors.MultiROI(*args, **kwargs)

Bases: MultiROIAbstract

Container for multiple ROIs.

class COLOR_SLOT(value)

Bases: IntEnum

An enumeration.

addAllUnlabeledVoxelsToLabel(self, label: int)

Adds all unlabeled voxels, giving them a specific label.

Parameters:: label (int) – the label (a uint32_t)

addIndexIntervalToLabel(self, anIndex0: int, anIndex1: int, aLabel: int)

Adds index interval to the given label.

Parameters:

anIndex0 (int) – the index0 (a uint64_t)
anIndex1 (int) – the index1 (a uint64_t)
aLabel (int) – the label (a uint32_t)

addIndexToLabel(self, anIndex: int, aLabel: int)

Adds an Index to the given label.

Parameters:

anIndex (int) – the index (a uint64_t)
aLabel (int) – the label (a uint32_t)

addToVolumeROI(self, pOutputROI: ORSModel.ors.ROI, pLabel: int)

Adds all the voxels associated to a label to a VolumeROI.

Note

The ROI is not cleared prior to adding.

See also

ORSModel.ors.StructuredGrid.getAsROI(), ORSModel.ors.MultiROIAbstract.removeROI()

Parameters:

pOutputROI (ORSModel.ors.ROI) – the output Volume ROI (a ROI)
pLabel (int) – the label to extract (a uint32_t)

addToVolumeROILabelAtIndex(self, pOutputROI: ORSModel.ors.ROI, pIndex: int)

Finds the label at a given index, then extracts the label data and adds it to a VolumeROI.

See also

addToROI(), ORSModel.ors.MultiROIAbstract.removeROI()

Parameters:

pOutputROI (ORSModel.ors.ROI) – the output Volume ROI (an ROI)
pIndex (int) – the index (an int64_t)

addToVolumeROILabelAtPosition(self, pOutputROI: ORSModel.ors.ROI, tIndex: int, pVector: ORSModel.ors.Vector3)

Finds the label at a given position, then extracts the label data and adds it to aROI.

See also

addToROI(), ORSModel.ors.MultiROIAbstract.removeROI()

Parameters:

pOutputROI (ORSModel.ors.ROI) – the output ROI (a ROI)
tIndex (int) – the T value (a uint32_t)
pVector (ORSModel.ors.Vector3) – the position (a Vector3)

addVolumeROIToLabel(self, aLabel: int, pROI: ORSModel.ors.ROI, pTOffset: int = 0) → bool

Adds anROI to the given label.

Parameters:

aLabel (int) – the label (a uint32_t)
pROI (ORSModel.ors.ROI) – the ROI to add (an ROI)
pTOffset (int) – the faculative time Offset

Returns:

output (bool) – true if succeeded, false otherwise

addVolumeROIToLabelConstrained(self, aLabel: int, pROI: ORSModel.ors.ROI, sourceLabels: ORSModel.ors.ArrayUnsignedLong, pTOffset: int = 0) → bool

Parameters:

aLabel (int) –
pROI (ORSModel.ors.ROI) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
pTOffset (int) –

Returns:

output (bool) –

appendMultiROI(self, pLabeledMultiROI: ORSModel.ors.MultiROI, pLabelArray: ORSModel.ors.ArrayUnsignedLong)

Parameters:

pLabeledMultiROI (ORSModel.ors.MultiROI) –
pLabelArray (ORSModel.ors.ArrayUnsignedLong) –

assignDefaultColors(): Helper to assign default color to an instance of a MultiROI

clear(self): Clears the entire data.

Note

All label information is lost (scalars, colors, names, etc).

clearAllLabels(self): Clears (empties) all labels for all Ts.

Note

All label information is preserved (scalars, colors, names, etc).

clearAllLabelsForTIndex(self, tIndex: int)

Clears (empties) all labels for a specific T index.

Note

All label information is preserved (scalars, colors, names, etc).

Parameters:: tIndex (int) – a timeStep (uint32_t)

clearLabel(self, pLabel: int)

Clears a label.

Parameters:: pLabel (int) – the label to clear (a uint32_t)

clearLabels(self, pLabelArray: ORSModel.ors.ArrayUnsignedLong)

Clears a set of labels.

Parameters:: pLabelArray (ORSModel.ors.ArrayUnsignedLong) – an array of labels to clear (an ArrayUnsignedLong)

clearLabelsForTIndex(self, labels: ORSModel.ors.ArrayUnsignedLong, tIndex: int)

Clears (empties) specific Labels for a specific T index.

Note

All label information is preserved (scalars, colors, names, etc).

Parameters:

labels (ORSModel.ors.ArrayUnsignedLong) – Labels to be cleared
tIndex (int) – a timeStep (uint32_t)

computeDenseGraphFromMultiROI(self, IProgress: ORSModel.ors.Progress) → ORSModel.ors.Graph

Computes the graph of theMultiROI’s connectivity.

Note

The receiver MultiROI should already be skeletonized. The receiver should be a proper skeleton without any surface

Parameters:: IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
Returns:: output (ORSModel.ors.Graph) – graph of the MultiROI’s connectivity

copyInto(self, aMultiROI: ORSModel.ors.MultiROI)

Copies the receiver into another Multi-ROI.

Parameters:: aMultiROI (ORSModel.ors.MultiROI) – a destination multiROI (an MultiROI)

copyLabelAndScalarInformationInto(self, pDestinationMultiROI: ORSModel.ors.MultiROI)

Copy scalars, labels color, opacity and title into pDestinationMultiROI.

Parameters:: pDestinationMultiROI (ORSModel.ors.MultiROI) –

copyLabelInformationInto(self, pDestinationMultiROI: ORSModel.ors.MultiROI)

Copy labels color, opacity and title into pDestinationMultiROI.

Parameters:: pDestinationMultiROI (ORSModel.ors.MultiROI) –

copyScalarInformationInto(self, pDestinationMultiROI: ORSModel.ors.MultiROI)

Copy scalars into pDestinationMultiROI.

Parameters:: pDestinationMultiROI (ORSModel.ors.MultiROI) –

crossIndexing(self, multiROIToIntersectWith: ORSModel.ors.MultiROI) → ORSModel.ors.ArrayUnsignedLong

cross-indexing with labels from another multiROI

Parameters:: multiROIToIntersectWith (ORSModel.ors.MultiROI) – the other multi ROI to cross-index with
Returns:: output (ORSModel.ors.ArrayUnsignedLong) –

emptyLabelIntersectingROI(self, pInputROI: ORSModel.ors.ROI) → bool

Empty labels that are intersecting the givenROI.

Parameters:: pInputROI (ORSModel.ors.ROI) –
Returns:: output (bool) – return true if label where removed (a bool)

emptyLabelNotIntersectingROI(self, pInputROI: ORSModel.ors.ROI) → bool

Empty labels that are not intersecting the givenROI.

Parameters:: pInputROI (ORSModel.ors.ROI) –
Returns:: output (bool) – return true if label where removed (a bool)

fillAllInnerHoles2DAlongXAxis(self, labels: ORSModel.ors.ArrayUnsignedLong, iTIndex: int, considerDiagonal: bool)

Note

This method fills the interior of a MultiROI for each 2D slice along the X axis.

Note

Only those labels specified are filled, in the order they are supplied in.

Note

This method fills a MultiROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

Parameters:

labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to fill (an ArrayUnsignedLong)
iTIndex (int) – the T index (a uint32_t)
considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)

fillAllInnerHoles2DAlongYAxis(self, labels: ORSModel.ors.ArrayUnsignedLong, iTIndex: int, considerDiagonal: bool)

Note

This method fills the interior of a MultiROI for each 2D slice along the Y axis.

Note

Only those labels specified are filled, in the order they are supplied in.

Note

This method fills a MultiROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

Parameters:

labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to fill (an ArrayUnsignedLong)
iTIndex (int) – the T index (a uint32_t)
considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)

fillAllInnerHoles2DAlongZAxis(self, labels: ORSModel.ors.ArrayUnsignedLong, iTIndex: int, considerDiagonal: bool)

Note

This method fills the interior of a MultiROI for each 2D slice along the Z axis.

Note

Only those labels specified are filled, in the order they are supplied in.

Note

This method fills a MultiROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

Parameters:

labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to fill (an ArrayUnsignedLong)
iTIndex (int) – the T index (a uint32_t)
considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)

fillInnerHoles(self, labels: ORSModel.ors.ArrayUnsignedLong, iTIndex: int, considerDiagonal: bool)

Note

This method fills a MultiROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

Note

Only those labels specified are filled, in the order they are supplied in.

Note

When trying to close a 2D MultiROI (for example a circle), you need to work with a 2D MultiROI (i.e. Z size = 1).

Parameters:

labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to fill (an ArrayUnsignedLong)
iTIndex (int) – the T index (a uint32_t)
considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)

fillWithCell(self, xCellSize: int, yCellSize: int, zCellSize: int, temporalCell: bool)

Clear the Muti-ROI and fill it with a grid of label.

Parameters:

xCellSize (int) – the cell size in X (a uint32_t)
yCellSize (int) – the cell size in Y (a uint32_t)
zCellSize (int) – the cell size in Z (a uint32_t)
temporalCell (bool) – new label per T or same label across T dimension (a bool)

fromChannel(self, pChan: ORSModel.ors.Channel)

Parameters:: pChan (ORSModel.ors.Channel) –

generateAnalyzer(self, inputChannel: ORSModel.ors.Channel, pROI: ORSModel.ors.ROI, aTimeStep: int, pStats: int, pCompute2DStats: bool, IProgress: ORSModel.ors.Progress) → ORSModel.ors.MultiROIAnalyzer

Parameters:

inputChannel (ORSModel.ors.Channel) –
pROI (ORSModel.ors.ROI) –
aTimeStep (int) –
pStats (int) –
pCompute2DStats (bool) –
IProgress (ORSModel.ors.Progress) –

Returns:

output (ORSModel.ors.MultiROIAnalyzer) –

get2DZAlignedProjection(self, iTIndex: int) → ORSModel.ors.MultiROI

flatten the z axis of a multiROI

Parameters:: iTIndex (int) – the time step (a uint32_t)
Returns:: output (ORSModel.ors.MultiROI) –

getAsArray(self, tIndex: int, pOutputArray: ORSModel.ors.ArrayUnsignedLong) → ORSModel.ors.ArrayUnsignedLong

Extracts the labels and adds them all to anArray.

Note

If an output Array is supplied, data is written to it and returned, otherwise a new Array is created.

Note

The Array is cleared prior to adding.

Parameters:

tIndex (int) – time index (a uint32_t)
pOutputArray (ORSModel.ors.ArrayUnsignedLong) – an optional output Array (an ArrayUnsignedLong)

Returns:

output (ORSModel.ors.ArrayUnsignedLong) – the resulting Array (an ArrayUnsignedLong)

getAsChannelWithLabelOffset(self, labelOffset: int, pOutputChannel: ORSModel.ors.Channel) → ORSModel.ors.Channel

Extracts the labels and adds them all to a channel.

Note

If an output channel is supplied, data is written to it and returned, otherwise a new channel is created.

Note

The channel’s data type is determined by the total number of labels within:

See also

asROI()

Parameters:

labelOffset (int) – a label offset to add to output channel values (a uint32_t)
pOutputChannel (ORSModel.ors.Channel) – an optional output channel (an Channel)

Returns:

output (ORSModel.ors.Channel) – the resulting channel (an Channel)

getAsCubicMesh(self, bWorld: bool, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Parameters:

bWorld (bool) –
IProgress (ORSModel.ors.Progress) –
IInMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) –

getAsCubicMeshForTIndex(self, bWorld: bool, timeStep: int, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Note

If a target Mesh is supplied, data is written to it and returned, otherwise a new Mesh is created.

Parameters:

bWorld (bool) – the time step to extract from the receiver (a uint32_t)
timeStep (int) – a progress object to show no progress (an Progress)
IProgress (ORSModel.ors.Progress) – an optional target mesh model (a Mesh)
IInMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) – the resulting mesh model (an Mesh)

getAsCubicMeshSubset(self, IEnabledLabel: ORSModel.ors.ArrayChar, bWorld: bool, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Parameters:

IEnabledLabel (ORSModel.ors.ArrayChar) –
bWorld (bool) –
IProgress (ORSModel.ors.Progress) –
IInMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) –

getAsGraph(self, optionalInputGraph: ORSModel.ors.Graph, IProgress: ORSModel.ors.Progress) → ORSModel.ors.Graph

Computes the graph of theMultiROI’s connectivity.

Parameters:

optionalInputGraph (ORSModel.ors.Graph) – an optional input graph to modify (a Graph)
IProgress (ORSModel.ors.Progress) – a progress object (a Progress)

Returns:

output (ORSModel.ors.Graph) – graph of the MultiROI’s connectivity

getAsMarchingCubesMesh(self, isovalue: float, bSnapToContour: bool, flipNormal: bool, timeStep: int, xSample: int, ySample: int, zSample: int, pNearest: bool, pWorld: bool, IProgress: ORSModel.ors.Progress, pMesh: ORSModel.ors.Mesh) → ORSModel.ors.Mesh

Parameters:

isovalue (float) –
bSnapToContour (bool) –
flipNormal (bool) –
timeStep (int) –
xSample (int) –
ySample (int) –
zSample (int) –
pNearest (bool) –
pWorld (bool) –
IProgress (ORSModel.ors.Progress) –
pMesh (ORSModel.ors.Mesh) –

Returns:

output (ORSModel.ors.Mesh) –

getAsNDArray(timestep=0)

Get a numpy nd array representation

Parameters:: timestep (int) – timestep to extract

getBoundingBoxOfLabel(self, pTIndex: int, iLabel: int) → ORSModel.ors.Box

Parameters:

pTIndex (int) –
iLabel (int) –

Returns:

output (ORSModel.ors.Box) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getClipBox(timestep=0, display=None)

Gets the clip box of the ROI or of the MultiROI

Parameters:

timestep (int) – the time index
display (ORSModel.ors.View) – a view

Returns:

aClipBox (ORSModel.ors.Box) – the clip box

getClipping(timestep=0, display=None)

Gets the origin and the opposite summit of the clip box of the ROI or MultiROI

Parameters:

timestep (int) – the time index
display (ORSModel.ors.View) – a view

Returns:

clipOriginSummit (ORSModel.ors.Vector3) – the origin summit of the clip box
clipOppositeSummit (ORSModel.ors.Vector3) – the origin opposite summit of the clip box

getClosedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are closed, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to close (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getClosedWithKernelOnSpecificSlices(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, axis: int, indices: ORSModel.ors.SequenceableCollection, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are closed, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to close (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
axis (int) – the axis of the specified slices (x=0,y=1,z=2) (a uint8_t)
indices (ORSModel.ors.SequenceableCollection) – the slices to work on (an SequenceableCollection)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getColorSlot(self) → int

Get the color slot index.

Returns:: output (int) –

getConvexHullAsAFilledMultiROI(binning=1)

Return the convex hull of a MultiROI as a filled MultiROI

Parameters:: binning (int) – the binning of the operation
Returns:: newMultiROI (ORSModel.ors.MultiROI) – the created MultiROI

getConvexHullMeshSurfaces(tIndex, progress=None, binning=1)

Creates a new Array Double of surface from convexHull of labels

Parameters:

self (ORSModel.ors.MultiROI) – the source MultiROI
tIndex (int) – the time index of intersest
progress (ORSModel.ors.Progress) – a progress object
binning (int) – the binning of the operation

Returns:

newArrayDouble (ORSModel.ors.ArrayDouble) – the created ArrayDouble

getCorrelatedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, threshold: float, pTimeStep: int, pROIMask: ORSModel.ors.ROI, progress: ORSModel.ors.Progress, pOutput: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Correlates theMultiROI (see note below) with a supplied 3D kernel.

Note

This method can be used to smooth the MultiROI by providing a smoothing kernel (e.g. with a gaussian distribution).

Note

Only those labels specified are correlated, in the order they are supplied in.

Note

If a mask is provided, its T size should be 1.

Note

All voxels (partipating in the labels specified) of the input MultiROI not in the mask are copied into the output MultiROI.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (an ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to correlate (an ArrayUnsignedLong)
threshold (float) – the threshold value (a double). The output MultiROI will contain this voxel if the result of the correlation at that voxel is greater than or equal to this threshold value.
pTimeStep (int) – the time step of the receiver MultiROI to smooth (a uint32_t)
pROIMask (ORSModel.ors.ROI) – an optional mask (a ROI)
progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
pOutput (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getDilatedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, progress: ORSModel.ors.Progress, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are dilated, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to dilate (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getDilatedWithKernelOnSpecificSlices(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, axis: int, indices: ORSModel.ors.SequenceableCollection, progress: ORSModel.ors.Progress, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are dilated, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to dilate (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
axis (int) – the axis of the specified slices (x=0,y=1,z=2) (a uint8_t)
indices (ORSModel.ors.SequenceableCollection) – the slices to work on (an SequenceableCollection)
progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getErodedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, progress: ORSModel.ors.Progress, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are eroded, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to erode (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getErodedWithKernelOnSpecificSlices(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, axis: int, indices: ORSModel.ors.SequenceableCollection, progress: ORSModel.ors.Progress, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are eroded, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to erode (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
axis (int) – the axis of the specified slices (x=0,y=1,z=2) (a uint8_t)
indices (ORSModel.ors.SequenceableCollection) – the slices to work on (an SequenceableCollection)
progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getFeretBox(iTIndex, iAngleSampling=5)

Gets Feret box of a MultiROI

Note

Default value for angle sampling is 5

Parameters:

iTIndex (int) – the T index
iAngleSampling (int) – the angle sampling, steps between each angle iteration

Returns:

output (ORSModel.ors.Box) – Feret box

getIntersectionWithLabeledMultiROI(self, pInputLabeledMultiROI: ORSModel.ors.MultiROI, anOutputLabeledMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Intersects theMultiROI with another MultiROI.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pInputLabeledMultiROI (ORSModel.ors.MultiROI) – the MultiROI to intersect with (a MultiROI)
anOutputLabeledMultiROI (ORSModel.ors.MultiROI) – the output MultiROI (a MultiROI), see note below

Returns:

output (ORSModel.ors.MultiROI) – the intersection result

getIntersectionWithROI(self, aROI: ORSModel.ors.ROI, anOutputMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Intersects theMultiROI with a ROI.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

aROI (ORSModel.ors.ROI) – the ROI to intersect with (an ROI)
anOutputMultiROI (ORSModel.ors.MultiROI) – the output MultiROI (a MultiROI), see note below

Returns:

output (ORSModel.ors.MultiROI) – the intersection result

getIsClipped(timestep=0, display=None)

Gets to know if there is a clip box attached to the ROI or MultiROI

Parameters:

timestep (int) – the time index
display (ORSModel.ors.View) – a view

Returns:

isClipped (bool) – if True, the clip box of the ROI or MultiROI is visible; False otherwise.

getLabelAtIndex(self, pIndex: int) → int

Gets the label value at a given index.

Note

If no label exists at the given index 0 is returned.

See also

ORSModel.ors.MultiROIAbstract.getLabelAtPosition()

Parameters:: pIndex (int) – the index (a int64_t)
Returns:: output (int) – the resulting label (a uint32_t)

getLabelColor(self, label: int) → ORSModel.ors.Color

Gets the label color (See note below)

Note

Labels have two colors: the label color and the color of the current scalar.

Parameters:: label (int) – The label (a uint32_t)
Returns:: output (ORSModel.ors.Color) – a color (an ORS::Color)

getLabelCount(self) → int

Gets the number of distinct labels within.

Returns:: output (int) – the number of labels (a uint32_t)

getLabelScalarValuesCollection(self) → ORSModel.ors.ScalarValuesCollection

Queries the scalar values collection of the labels.

Returns:: output (ORSModel.ors.ScalarValuesCollection) – the ScalarValuesCollection of the labels.

getLabelSize(self, pLabel: int) → int

Gets the size of a given label.

Parameters:: pLabel (int) – the label value (a uint32_t)
Returns:: output (int) – the size of the label (a uint64_t)

getLabelSizes(self, pLabelArray: ORSModel.ors.ArrayLONGLONG)

Parameters:: pLabelArray (ORSModel.ors.ArrayLONGLONG) –

getLockedLabel(self, label: int) → bool

Returns a bool to know if a label is locked.

Parameters:: label (int) – a Label (uint32_t)
Returns:: output (bool) – A bool (true if locked, false if unlocked)

getLockedLabels(self) → ORSModel.ors.ArrayUnsignedLong

Returns the Locked Labels.

Returns:: output (ORSModel.ors.ArrayUnsignedLong) – An array of labels

getMergedLabelsIntersectingMultiROI(self, pInputMROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Parameters:: pInputMROI (ORSModel.ors.MultiROI) –
Returns:: output (ORSModel.ors.MultiROI) –

getMergedLabelsIntersectingROI(self, inputROI: ORSModel.ors.ROI) → ORSModel.ors.MultiROI

Parameters:: inputROI (ORSModel.ors.ROI) –
Returns:: output (ORSModel.ors.MultiROI) –

getMergedWith(self, otherMultiROI: ORSModel.ors.MultiROI, outputMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Merges with the suppliedMultiROI.

Note

All the labels from the merge MultiROI are added to the receiver. If a label exists in the receiver then the two labels are merged, if not then the label is added.

Parameters:

otherMultiROI (ORSModel.ors.MultiROI) – the multiROI to merge with (a MultiROI)
outputMultiROI (ORSModel.ors.MultiROI) – an output multiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) –

getMinimalBox(self, iTIndex: int) → Box

Get miminal box (also know as Oriented BoundingBox in litterature)

Parameters:: iTIndex (int) – the T index (a uint32_t)
Returns:: output (Box) –

getNDArray(timestep=0)

Get a numpy nd array representation

Parameters:: timestep (int) – timestep to analyse

Deprecated since version 2021.1: use getAsNDArray instead

getNonEmptyLabelCount(self) → int

Gets the number of distinct labels within.

See also

ORSModel.ors.MultiROI.getLabelCount()

Returns:: output (int) – the number of non empty labels (a uint32_t)

getNonEmptyLabels(self, pOutputArray: ORSModel.ors.ArrayUnsignedLong) → ORSModel.ors.ArrayUnsignedLong

Returns an array of all non empty labels.

Note

If an output array is supplied, data is written to it and returned, otherwise a new array is created.

Note

The array is cleared prior to adding.

Parameters:: pOutputArray (ORSModel.ors.ArrayUnsignedLong) – an optional output array (an ArrayUnsignedLong)
Returns:: output (ORSModel.ors.ArrayUnsignedLong) – the resulting array (an ArrayUnsignedLong)

getOpenWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are open, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to open (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getOpenWithKernelOnSpecificSlices(self, pKernel: ORSModel.ors.ConvolutionKernel, labels: ORSModel.ors.ArrayUnsignedLong, pTimeStep: int, axis: int, indices: ORSModel.ors.SequenceableCollection, pOutMultiROI: ORSModel.ors.MultiROI) → ORSModel.ors.MultiROI

Note

Only those labels specified are open, in the order they are supplied in.

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Parameters:

pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels to open (an ArrayUnsignedLong)
pTimeStep (int) – the time step (a uint32_t)
axis (int) – the axis of the specified slices (x=0,y=1,z=2) (a uint8_t)
indices (ORSModel.ors.SequenceableCollection) – the slices to work on (an SequenceableCollection)
pOutMultiROI (ORSModel.ors.MultiROI) – an optional output MultiROI (a MultiROI)

Returns:

output (ORSModel.ors.MultiROI) – the resulting MultiROI (a MultiROI)

getProjectionIn(self, aLabeledMultiROI: ORSModel.ors.MultiROI, sourceTimeOffset: int, pProgress: ORSModel.ors.Progress) → ORSModel.ors.MultiROI

Parameters:

aLabeledMultiROI (ORSModel.ors.MultiROI) –
sourceTimeOffset (int) –
pProgress (ORSModel.ors.Progress) –

Returns:

output (ORSModel.ors.MultiROI) –

getScalarSlotAsChannel(self, scalarSlot: int) → ORSModel.ors.Channel

Extracts the labels and adds them all to a channel.

Note

If an output channel is supplied, data is written to it and returned, otherwise a new channel is created.

See also

asROI()

Parameters:: scalarSlot (int) – a scalar slot (a uint32_t)
Returns:: output (ORSModel.ors.Channel) – the resulting channel (an Channel)

getSliceAsNDArray(sliceIndex: int = 0, timestep: int = 0)

Get a numpy nd array representation

Parameters:

sliceIndex (int) – slice to extract
timestep (int) – timestep to extract

getSumOfSizesOfSelectedLabels(self) → int

Gets the total size of all selected labels.

Returns:: output (int) – the sum of all selected labels sizes (a uint64_t)

getTotalVoxelCount(self) → int

Gets the total size of all labels.

Returns:: output (int) – the total size (a uint64_t)

getUnlabeledVoxelCount(self) → int

Gets the count of unlabeled voxels.

Note

This number is the total size of the receiver (X*Y*Z*T) less the total size of all labeled voxels.

Returns:: output (int) – the count of unlabeled voxels (a uint64_t)

getVoxelCount(self, iTIndex: int) → int

Gets the size of all labels for a given T value.

Parameters:: iTIndex (int) –
Returns:: output (int) – the number of voxels in the MultiROI (an uint64_t)

grid(self, celXSize: int, celYSize: int, celZSize: int, minT: int, maxT: int)

Parameters:

celXSize (int) –
celYSize (int) –
celZSize (int) –
minT (int) –
maxT (int) –

classmethod imread(files)

Loads a MultiROI from files

Parameters:: files (file) [count=[0, None]] – fully qualified file name list
Returns:: outMultiROI (ORSModel.ors.MultiROI) – the resulting MultiROI

classmethod imreadDICOM(files)

Loads a MultiROI from files or folder contaning DICOM

Parameters:: files (file) [count=[0, None]] – fully qualified file name list
Returns:: outMultiROI (ORSModel.ors.MultiROI) – the resulting MultiROI

classmethod imreadDICOMFolder(folder)

Loads a MultiROI from folder of DICOM files

Parameters:: folder (folder) – fully qualified folder
Returns:: outMultiROI (ORSModel.ors.MultiROI) – the resulting MultiROI

classmethod imreadFolder(folder)

Loads a MultiROI from folder

Parameters:: folder (folder) – fully qualified folder
Returns:: outMultiROI (ORSModel.ors.MultiROI) – the resulting MultiROI

imsave(fileName)

Save a MultiROI to file in the type specified by the extension

Parameters:: fileName (file saving) – fully qualified file name
Return:: True or False
Rtype:: bool

imwrite(fileName)

Save a MultiROI to file in the type specified by the extension

Parameters:: fileName (file saving) – fully qualified file name
Return:: True or False
Rtype:: bool

insertLabeledMultiROI(self, pLabeledMultiROI: ORSModel.ors.MultiROI, insertionLabel: int) → bool

Insert all the labels of aMultiROI starting at an insertion label.

Parameters:

pLabeledMultiROI (ORSModel.ors.MultiROI) – the MultiROI to insert (a MultiROI)
insertionLabel (int) – the label at which the insertion begins (a uint32_t)

Returns:

output (bool) – true if the operation succeeded, false otherwise

mergeLabels(self, targetLabel: int, sourceLabel: int) → bool

Merge a label into another one.

Parameters:

targetLabel (int) – the receiving label (a uint32_t)
sourceLabel (int) – the source label (a uint32_t)

Returns:

output (bool) – true if the operation succeeded, false otherwise

MultiROI.mergeLabels(self, targetLabel: int, sourceLabels: ORSModel.ors.ArrayUnsignedLong) -> bool

Merge several labels into another one.

Parameters:

targetLabel (int) – the target label (a uint32_t)
sourceLabels (ORSModel.ors.ArrayUnsignedLong) – the source labels (an ArrayUnsignedLong)

Returns:

output (bool) – true if the operation succeeded, false otherwise

mergeLabelsIntersectingMultiROI(self, pInputMROI: ORSModel.ors.MultiROI) → bool

Parameters:: pInputMROI (ORSModel.ors.MultiROI) –
Returns:: output (bool) – return true if labels where collapse

mergeLabelsIntersectingROI(self, pInputROI: ORSModel.ors.ROI) → bool

assign the label of all intersecting labels to the smallest label intersecting

Parameters:: pInputROI (ORSModel.ors.ROI) –
Returns:: output (bool) – return true if labels where collapse

none() → MultiROI

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (MultiROI) –

paintBoxConstrained(self, pBox: ORSModel.ors.Box, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, tStep: int)

Parameters:

pBox (ORSModel.ors.Box) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
tStep (int) –

paintBoxConstrainedIfInRange(self, pBox: ORSModel.ors.Box, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Parameters:

pBox (ORSModel.ors.Box) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
tStep (int) –
fMinValue (float) –
fMaxValue (float) –
pRangeChannel (ORSModel.ors.StructuredGrid) –

paintCircleConstrainedOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, timeIndex: int)

Parameters:

pPlane (ORSModel.ors.Rectangle) –
worldPos (ORSModel.ors.Vector3) –
radius (float) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
timeIndex (int) –

paintCircleConstrainedOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, timeIndex: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Parameters:

pPlane (ORSModel.ors.Rectangle) –
worldPos (ORSModel.ors.Vector3) –
radius (float) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
timeIndex (int) –
fMinValue (float) –
fMaxValue (float) –
pRangeChannel (ORSModel.ors.StructuredGrid) –

paintRemoveBox(self, pBox: ORSModel.ors.Box, label: float, addLabel: float, tStep: int)

Removes a box (3D object) from the receiver.

Parameters:

pBox (ORSModel.ors.Box) – The box (a Box)
label (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label to add removed voxels to (or 0 to just remove voxels and not add them to any label)
tStep (int) – The T index (a uint32_t)

paintRemoveBoxIfInRange(self, pBox: ORSModel.ors.Box, eraseLabel: float, addLabel: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Removes a box (3D object) from the receiver if the data within the box is in the supplied range.

Parameters:

pBox (ORSModel.ors.Box) – The box (a Box)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label to add removed voxels to (or 0 to just remove voxels and not add them to any label)
tStep (int) – The T index (a uint32_t)
fMinValue (float) – The range lower bound (a double)
fMaxValue (float) – The range upper bound (a double)
pRangeChannel (ORSModel.ors.StructuredGrid) – The dataset where to check (a StructuredGrid)

paintRemoveBoxIntersectingChannel(self, pBox: ORSModel.ors.Box, eraseLabel: float, addLabel: float, tStep: int, intersectingChannel: ORSModel.ors.Channel, levelingMinRange: float, levelingMaxRange: float, pLUT: ORSModel.ors.LookupTable, intersectingChannelClipBox: ORSModel.ors.Box)

Removes a box (3D object) from the receiver if the box intersects with the supplied channel.

Parameters:

pBox (ORSModel.ors.Box) – The brush box (a Box)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
tStep (int) – The T index (a uint32_t)
intersectingChannel (ORSModel.ors.Channel) – The intersecting channel (a Channel)
levelingMinRange (float) – The window leveling lower bound (a double)
levelingMaxRange (float) – The window leveling upper bound(a double)
pLUT (ORSModel.ors.LookupTable) – The look up table (a LUT)
intersectingChannelClipBox (ORSModel.ors.Box) – The channel box (a Box)

paintRemoveBoxIntersectingMultiROI(self, pBox: ORSModel.ors.Box, eraseLabel: float, addLabel: float, tStep: int, intersectingMultiROI: ORSModel.ors.MultiROI, fHightlightOpacity: float, fHightlightOpacityOutRange: float, intersectingMultiROIClipBox: ORSModel.ors.Box)

Removes a box (3D object) from the receiver if the sphere intersects with the suppliedMultiROI.

Parameters:

pBox (ORSModel.ors.Box) – The brush box (a Box)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
tStep (int) – The T index (a uint32_t)
intersectingMultiROI (ORSModel.ors.MultiROI) – The intersecting MultiROI (a MultiROI)
fHightlightOpacity (float) – The highlight opacity (a double)
fHightlightOpacityOutRange (float) – The highlight opacity range (a double)
intersectingMultiROIClipBox (ORSModel.ors.Box) – The MultiROI clip box (a Box)

paintRemoveBoxIntersectingROI(self, pBox: ORSModel.ors.Box, eraseLabel: float, addLabel: float, tStep: int, intersectingROI: ORSModel.ors.ROI, intersectingROIClipBox: ORSModel.ors.Box)

Removes a box (3D object) from the receiver if the sphere intersects with the suppliedROI.

Parameters:

pBox (ORSModel.ors.Box) – The brush box (a Box)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
tStep (int) – The T index (a uint32_t)
intersectingROI (ORSModel.ors.ROI) – The intersecting ROI (a ROI)
intersectingROIClipBox (ORSModel.ors.Box) – The ROI clip box (a Box)

paintRemoveCircleOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, addLabel: float, timeIndex: int)

Removes a circle (2D object) from the receiver.

Parameters:

pPlane (ORSModel.ors.Rectangle) – The plane of the circle (a Rectangle)
worldPos (ORSModel.ors.Vector3) – The center of the circle (a Vector3)
radius (float) – The radius circle (a double)
label (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
timeIndex (int) – The T index (a uint32_t)

paintRemoveCircleOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, eraselabel: float, addLabel: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Removes a circle (2D object) from the receiver if the data within the circle is in the supplied range.

Parameters:

pPlane (ORSModel.ors.Rectangle) – The plane of the circle (a Rectangle)
worldPos (ORSModel.ors.Vector3) – The center of the circle (a Vector3)
radius (float) – The radius circle (a double)
eraselabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
timeIndex (int) – The T index (a uint32_t)
lowerThreshold (float) – The range lower bound (a double)
upperThreshold (float) – The range upper bound (a double)
pRangeChannel (ORSModel.ors.StructuredGrid) – The dataset where to check (a StructuredGrid)

paintRemoveSphere(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, addLabel: float, tStep: int)

Removes a sphere (3D object) from the receiver.

Parameters:

worldPos (ORSModel.ors.Vector3) – The center of the sphere (a Vector3)
fRadius (float) – The sphere radius (a double)
label (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label to add removed voxels to (or 0 to just remove voxels and not add them to any label)
tStep (int) – The T index (a uint32_t)

paintRemoveSphereIfInRange(self, worldPos: ORSModel.ors.Vector3, fRadius: float, eraseLabel: float, addLabel: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Removes a sphere (3D object) from the receiver if the data within the sphere is in the supplied range.

Parameters:

worldPos (ORSModel.ors.Vector3) – The center of the sphere (a Vector3)
fRadius (float) – The sphere radius (a double)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
tStep (int) – The T index (a uint32_t)
fMinValue (float) – The range lower bound (a double)
fMaxValue (float) – The range upper bound (a double)
pRangeChannel (ORSModel.ors.StructuredGrid) – The dataset where to check (a StructuredGrid)

paintRemoveSphereIntersectingChannel(self, worldPos: ORSModel.ors.Vector3, fRadius: float, eraseLabel: float, addLabel: float, tStep: int, intersectingChannel: ORSModel.ors.Channel, levelingMinRange: float, levelingMaxRange: float, ILUT: ORSModel.ors.LookupTable, intersectingChannelClipBox: ORSModel.ors.Box)

Removes a sphere (3D object) from the receiver if the sphere intersects with the supplied channel.

Parameters:

worldPos (ORSModel.ors.Vector3) – The center of the sphere (a Vector3)
fRadius (float) – The sphere radius (a double)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
tStep (int) – The T index (a uint32_t)
intersectingChannel (ORSModel.ors.Channel) – The intersecting channel (a Channel)
levelingMinRange (float) – The window leveling lower bound (a double)
levelingMaxRange (float) – The window leveling upper bound(a double)
ILUT (ORSModel.ors.LookupTable) – The look up table (a LUT)
intersectingChannelClipBox (ORSModel.ors.Box) – The channel box (a Box)

paintRemoveSphereIntersectingMultiROI(self, worldPos: ORSModel.ors.Vector3, radius: float, eraseLabel: float, addLabel: float, tStep: int, intersectingMultiROI: ORSModel.ors.MultiROI, fHightlightOpacity: float, fHightlightOpacityOutRange: float, intersectingMultiROIClipBox: ORSModel.ors.Box)

Removes a sphere (3D object) from the receiver if the sphere intersects with the suppliedMultiROI.

Parameters:

worldPos (ORSModel.ors.Vector3) – The center of the sphere (a Vector3)
radius (float) – The sphere radius (a double)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
tStep (int) – The T index (a uint32_t)
intersectingMultiROI (ORSModel.ors.MultiROI) – The intersecting MultiROI (a MultiROI)
fHightlightOpacity (float) – The highlight opacity (a double)
fHightlightOpacityOutRange (float) – The highlight opacity range (a double)
intersectingMultiROIClipBox (ORSModel.ors.Box) – The MultiROI clip box (a Box)

paintRemoveSphereIntersectingROI(self, worldPos: ORSModel.ors.Vector3, fRadius: float, eraseLabel: float, label: float, tStep: int, intersectingROI: ORSModel.ors.ROI, intersectingROIClipBox: ORSModel.ors.Box)

Removes a sphere (3D object) from the receiver if the sphere intersects with the suppliedROI.

Parameters:

worldPos (ORSModel.ors.Vector3) – The center of the sphere (a Vector3)
fRadius (float) – The sphere radius (a double)
eraseLabel (float) – The label to remove from (or 0 to remove from any label)
label (float) – The label where the removed voxels should be written (a double, see note)
tStep (int) – The T index (a uint32_t)
intersectingROI (ORSModel.ors.ROI) – The intersecting ROI (a ROI)
intersectingROIClipBox (ORSModel.ors.Box) – The ROI clip box (a Box)

paintRemoveSquareOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, addLabel: float, timeIndex: int)

Removes a square (2D object) from the receiver.

Parameters:

pPlane (ORSModel.ors.Rectangle) – The plane of the square (a Rectangle)
worldPos (ORSModel.ors.Vector3) – The center of the square (a Vector3)
radius (float) – The radius (a double)
label (float) – The label affected (a double)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
timeIndex (int) – The T index (a uint32_t)

paintRemoveSquareOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, width: float, eraselabel: float, addLabel: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Removes a square (2D object) from the receiver if the data within the square is in the supplied range.

Parameters:

pPlane (ORSModel.ors.Rectangle) – The plane of the square (a Rectangle)
worldPos (ORSModel.ors.Vector3) – The center of the square (a Vector3)
width (float) – The square width (a double)
eraselabel (float) – The label to remove from (or 0 to remove from any label)
addLabel (float) – The label where the removed voxels should be written (a double, see note)
timeIndex (int) – The T index (a uint32_t)
lowerThreshold (float) – The range lower bound (a double)
upperThreshold (float) – The range upper bound (a double)
pRangeChannel (ORSModel.ors.StructuredGrid) – The dataset where to check (a StructuredGrid)

paintSphereConstrained(self, worldPos: ORSModel.ors.Vector3, fRadius: float, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, tStep: int)

Parameters:

worldPos (ORSModel.ors.Vector3) –
fRadius (float) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
tStep (int) –

paintSphereConstrainedIfInRange(self, worldPos: ORSModel.ors.Vector3, fRadius: float, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Parameters:

worldPos (ORSModel.ors.Vector3) –
fRadius (float) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
tStep (int) –
fMinValue (float) –
fMaxValue (float) –
pRangeChannel (ORSModel.ors.StructuredGrid) –

paintSquareConstrainedOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, width: float, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, timeIndex: int)

Parameters:

pPlane (ORSModel.ors.Rectangle) –
worldPos (ORSModel.ors.Vector3) –
width (float) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
timeIndex (int) –

paintSquareConstrainedOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, width: float, destinationLabel: float, sourceLabels: ORSModel.ors.ArrayUnsignedLong, timeIndex: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid)

Parameters:

pPlane (ORSModel.ors.Rectangle) –
worldPos (ORSModel.ors.Vector3) –
width (float) –
destinationLabel (float) –
sourceLabels (ORSModel.ors.ArrayUnsignedLong) –
timeIndex (int) –
fMinValue (float) –
fMaxValue (float) –
pRangeChannel (ORSModel.ors.StructuredGrid) –

projectInShape(self, aShape: ORSModel.ors.Shape3D, sourceTime: int, destinationMROI: ORSModel.ors.MultiROI, destinationTime: int) → ORSModel.ors.MultiROI

Parameters:

aShape (ORSModel.ors.Shape3D) –
sourceTime (int) –
destinationMROI (ORSModel.ors.MultiROI) –
destinationTime (int) –

Returns:

output (ORSModel.ors.MultiROI) –

removeEmptyLabelsAndRenumber(self): Removes all empty labels and renumber the remaining labels in the same order.

removeFromVolumeROI(self, pOutputROI: ORSModel.ors.ROI, pLabel: int)

Remove all the voxels associated to a label from a VolumeROI.

See also

ORSModel.ors.StructuredGrid.getAsROI(), ORSModel.ors.MultiROIAbstract.removeROI()

Parameters:

pOutputROI (ORSModel.ors.ROI) – the output Volume ROI (an ROI)
pLabel (int) – the label to extract (a uint32_t)

removeIndex(self, anIndex: int)

Remove an Index from theMultiROI.

Parameters:: anIndex (int) – the index (a uint64_t)

removeIndexInterval(self, anIndex0: int, anIndex1: int)

Remove index interval from theMultiROI.

Parameters:

anIndex0 (int) – the index0 (a uint64_t)
anIndex1 (int) – the index1 (a uint64_t)

removeLabelAndRenumber(self, pLabel: int)

Removes the specified label and renumber the remaining labels in the same order.

Parameters:: pLabel (int) – the label to remove (a uint32_t)

removeLabelIntersectingROI(self, pInputROI: ORSModel.ors.ROI) → bool

Remove label that are intersecting the givenROI.

Parameters:: pInputROI (ORSModel.ors.ROI) –
Returns:: output (bool) – return true if label where removed (a bool)

removeLabelNotIntersectingROI(self, pInputROI: ORSModel.ors.ROI) → bool

Remove label that are not intersecting the givenROI.

Parameters:: pInputROI (ORSModel.ors.ROI) –
Returns:: output (bool) – return true if label where removed (a bool)

removeLabeledMultiROI(self, pInputLabeledMultiROI: ORSModel.ors.MultiROI)

Removes aMultiROI.

Parameters:: pInputLabeledMultiROI (ORSModel.ors.MultiROI) – the MultiROI to remove (a MultiROI)

removeLabelsAndRenumber(self, pLabelArray: ORSModel.ors.ArrayUnsignedLong)

Removes the specified labels and renumber the remaining labels in the same order.

Parameters:: pLabelArray (ORSModel.ors.ArrayUnsignedLong) – an array of labels to remove (an ArrayUnsignedLong)

removeShape3DIntersectingLabels(self, aShape: ORSModel.ors.Shape3D, labels: ORSModel.ors.ArrayUnsignedLong, destinationLabel: int, timestep: int)

Removes the intersection of the supplied shape and the list of labels.

Parameters:

aShape (ORSModel.ors.Shape3D) – a shape (a Shape3D)
labels (ORSModel.ors.ArrayUnsignedLong) – an array of labels
destinationLabel (int) – the destination label of removed voxels (0 to just remove them) (a uint32_t)
timestep (int) – the time step (a uint32_t)

removeVolumeROIFromLabel(self, aLabel: int, pROI: ORSModel.ors.ROI, pTOffset: int = 0) → bool

Parameters:

aLabel (int) –
pROI (ORSModel.ors.ROI) –
pTOffset (int) –

Returns:

output (bool) –

setColorSlot(self, colorSlot: int)

Set the color slot index.

Parameters:: colorSlot (int) –

setLabelCount(self, aCount: int)

Sets the label count.

Note

Changing the label count preserves existing label data, unless you reduce the count, in which case the data subtracted is lost.

Parameters:: aCount (int) – the label count to set (a uint32_t)

setLockedLabel(self, label: int, locked: bool)

Lock or Unlock 1 Label.

Parameters:

label (int) – An array of labels
locked (bool) – true to lock, false to unlock

setLockedLabels(self, labels: ORSModel.ors.ArrayUnsignedLong, locked: bool)

Lock or Unlock 1 or more Labels.

Parameters:

labels (ORSModel.ors.ArrayUnsignedLong) – An array of labels
locked (bool) – true to lock, false to unlock

sortAndRenumberLabelsOnSize(self, bAscending: bool, bRemoveEmptyLabels: bool)

Sorts and renumbers the labels based on their sizes (number of labels).

Parameters:

bAscending (bool) – true to sort in ascending order, false to sort in descending order
bRemoveEmptyLabels (bool) – true to remove empty labels, false to keep them

swapLabels(self, label1: int, label2: int)

Swaps two labels.

Parameters:

label1 (int) – the first label (a uint32_t)
label2 (int) – the second label (a uint32_t)

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:

IChannel (ORSModel.ors.Channel) –
pTimeStep (int) –
IROI (ORSModel.ors.ROI) –
IProgress (ORSModel.ors.Progress) –

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:

IChannel (ORSModel.ors.Channel) –
aMultiROI (ORSModel.ors.MultiROI) –
IListOfLabels (ORSModel.ors.ArrayUnsignedLong) –
tChannel (int) –
tLMR (int) –
bins (int) –
pMinRange (float) –
pMaxRange (float) –

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:

IMultiROI (ORSModel.ors.MultiROI) –
pStats (int) –
pCompute2DStats (bool) –

none() → MultiROIAnalyzer

Returns:: output (MultiROIAnalyzer) –

class stats(value)

Bases: IntEnum

An enumeration.

Node¶

class ORSModel.ors.Node(*args, **kwargs)

Bases: Managed

An abstract class for any object that can be a node in the visualization flow.

attachChild(self, anINode: ORSModel.ors.Node) → bool

Attaches a child node.

Note

Certain parent-child relationships are forbidden, hence the need to verify the result.

Note

Calling this method several times will still result in the child node only appearing once in its parent.

Parameters:: anINode (ORSModel.ors.Node) – the node to attach (a Node)
Returns:: output (bool) – true if child was attached, false otherwise

attachChildAtIndex(self, anINode: ORSModel.ors.Node, index: int) → bool

Attaches a child node at a given index.

Note

Certain parent-child relationships are forbidden, hence the need to verify the result.

Note

Calling this method several times will still result in the child node only appearing once in its parent.

Parameters:

anINode (ORSModel.ors.Node) – the node to attach (a Node)
index (int) – the index (a uint32_t)

Returns:

output (bool) – true if child was attached, false otherwise

copyGraph(self) → ORSModel.ors.Node

Returns a copy of the node, including its graph.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Returns:: output (ORSModel.ors.Node) – a new node (a Node)

detachChild(self, anINode: ORSModel.ors.Node) → bool

Detaches a child node.

Parameters:: anINode (ORSModel.ors.Node) – the node to detach (a Node)
Returns:: output (bool) – true if child was detached, false otherwise

getAllChildrenNodes(self) → ORSModel.ors.List

Returns a flattened list of the child hierarchy of the node.

Note

The child hierarchy is flattened.

Note

Expect a depth first search ordering of the nodes.

Returns:: output (ORSModel.ors.List) – a list of all nodes below the node (a List)

getAllChildrenOfClass(self, pProgId: str) → ORSModel.ors.List

Returns all the nodes of the specified class found in the child hierarchy.

Note

Result will be an empty list if no match is found.

Note

The search is done depth-first.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (a List)

getAllChildrenOfClassReachableByRenderer(self, pProgId: str) → ORSModel.ors.List

Returns a flattened list of all the child nodes, of the given class, that are renderable.

Note

The list contains only Managed objects (they will need to be typecast to the appropriate class).

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of all child nodes that can be rendered (an List)

getAllParentNodes(self) → ORSModel.ors.List

Returns a flattened list of the parent hierarchy of the node.

Note

The parent hierarchy is flattened.

Note

Expect a depth first search ordering of the nodes.

Returns:: output (ORSModel.ors.List) – a list of all nodes above the node (an List)

getAllParentsOfClass(self, pProgId: str) → ORSModel.ors.List

Returns all the nodes of the specified class found in the parent hierarchy.

Note

Result will be an empty list if no match is found.

Note

The search is done depth-first.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (an List)

getChildWithGUID(self, aGUID: str) → ORSModel.ors.Node

Gets an immediate child node with the given GUID.

Note

Only immediate children are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: aGUID (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Node) – a child node if found (a Node), none() otherwise

getChildWithTitle(self, aTitle: str) → ORSModel.ors.Node

Gets an immediate child node with the given title.

Note

Only immediate children are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: aTitle (str) – a string (a string)
Returns:: output (ORSModel.ors.Node) – a child node if found (a Node), none() otherwise

getChildrenNodes(self) → ORSModel.ors.List

Returns the list of immediate child nodes.

Returns:: output (ORSModel.ors.List) – a list of nodes (an List)

getChildrenOfClass(self, pProgId: str) → ORSModel.ors.List

Returns the nodes of the specified class found in the immediate children.

Note

Result will be an empty list if no match is found.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (an List)

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirstChildOfClass(self, pProgId: str) → ORSModel.ors.Node

Returns the first object of the specified class found in the child hierarchy.

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if one exists (a Node), none() otherwise

getFirstChildOfClassAndPrivateTitle(self, pProgId: str, privateTitle: str) → ORSModel.ors.Node

Searches the hierarchy for a child node with the specified class and private title.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:

pProgId (str) – the name of the class to test against (a string)
privateTitle (str) – some text (a string)

Returns:

output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getFirstFrameTowardsNode(self, anINode: ORSModel.ors.Node) → ORSModel.ors.ReferenceFrame

Gets the first frame found going up the hierarchy towards a given object.

Parameters:: anINode (ORSModel.ors.Node) – the target node (an Node)
Returns:: output (ORSModel.ors.ReferenceFrame) – a frame (an ReferenceFrame) or none if no frame is found

getFirstNodeWithClassNameTowardsNode(self, pProgId: str, anINode: ORSModel.ors.Node) → ORSModel.ors.Node

Searches the hierarchy for a parent node with the specified class toward a specific parent nopde.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:

pProgId (str) – the name of the class to test against (a string)
anINode (ORSModel.ors.Node) – a target node

Returns:

output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getFirstParentOfClass(self, pProgId: str) → ORSModel.ors.Node

Returns the first object of the specified class found in the parent hierarchy.

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if one exists (a Node), none() otherwise

getFirstParentOfClassAndPrivateTitle(self, pProgId: str, privateTitle: str) → ORSModel.ors.Node

Searches the hierarchy for a parent node with the specified class and private title.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:

pProgId (str) – the name of the class to test against (a string)
privateTitle (str) – some text (a string)

Returns:

output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getFrameTransformationFromNode(self, towardNode: ORSModel.ors.Node, pTimeStep: int) → ORSModel.ors.Matrix4x4

Parameters:

towardNode (ORSModel.ors.Node) –
pTimeStep (int) –

Returns:

output (ORSModel.ors.Matrix4x4) –

getImmediateChildOfClass(self, pProgId: str) → ORSModel.ors.Node

Searches for a child node with the specified class.

Note

Only the immediate children are searched, not the hierarchy.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getImmediateParentOfClass(self, pProgId: str) → ORSModel.ors.Node

Searches for a parent node with the specified class.

Note

Only the immediate parents are searched, not the hierarchy.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.Node) – a node if it exists (a Node), none() otherwise

getImmediateParentWithGUID(self, pGUID: str) → ORSModel.ors.Node

Gets a parent node with the given GUID.

Note

Only immediate parents are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: pGUID (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Node) – a parent node if found (a Node), none() otherwise

getIsNodeOneOfMyAscendants(self, anINode: ORSModel.ors.Node) → bool

Checks to see if a specified node is in the parent hierarchy of the node.

Note

The parent hierarchy is searched in its entirety for the specified node.

Note

The search is conducted depth-first.

Parameters:: anINode (ORSModel.ors.Node) –
Returns:: output (bool) – true if the specified node in the parent hierarchy, false otherwise

getIsNodeOneOfMyDescendants(self, anINode: ORSModel.ors.Node) → bool

Checks to see if a specified node is in the child hierarchy of the node.

Note

The child hierarchy is searched in its entirety for the specified node.

Note

The search is conducted depth-first.

Parameters:: anINode (ORSModel.ors.Node) –
Returns:: output (bool) – true if the specified node in the child hierarchy, false otherwise

getMaxTSizeOfChilden(self) → int

Get Maximum T Size of all children node of this node.

Returns:: output (int) –

getParentNodes(self) → ORSModel.ors.List

Gets the immediate parent nodes.

Returns:: output (ORSModel.ors.List) – a list of nodes (a List)

getParentWithGUID(self, pGUID: str) → ORSModel.ors.Node

Gets a parent node (from the hierarchy) with the given GUID.

Note

The whole parent hierarchy is searched.

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be none().

Parameters:: pGUID (str) – a GUID (a string)
Returns:: output (ORSModel.ors.Node) – a parent node if found (a Node), none() otherwise

getParentsOfClass(self, pProgId: str) → ORSModel.ors.List

Returns the nodes of the specified class found in the immediate parents.

Note

Result will be an empty list if no match is found.

Note

Use static class names to search for objects (e.g. ORS::ReferenceFrame::getClassNameStatic())).

Parameters:: pProgId (str) – the name of the class to test against (a string)
Returns:: output (ORSModel.ors.List) – a list of nodes (a List)

getVisual(self) → ORSModel.ors.Visual

Returns:: output (ORSModel.ors.Visual) – the visual of a model (a Visual)

isVisibleInView(view: View) → bool

Gets the visibility of the receiver in a given view.

Parameters:: view (ORSModel.ors.View) – The current view
Returns:: output (bool) – true if the receiver is visible, false otherwise

none() → Node

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Node) –

propagateChildrenNodesOrganizationDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsChildrenNodesOrganizationDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateDataDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsDataDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateDirty(self, dirtyFlag: str, includeSelf: bool = False)

Causes a dirty message to be sent to all children nodes.

Note

See ORS_def.h for default dirty flag (ex: ORSDataDirty).

Note

A dirty message has different results for different objects, but generally causes a refresh on the data.

Note

Message propagation is done depth-first.

Parameters:

dirtyFlag (str) – a string dirty flag (a string)
includeSelf (bool) – should set this dirty (a bool)

propagateGeometryDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsGeometryDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateHighlightDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsHighlightDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagatePropertyDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsPropertyDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

propagateVisibilityDirty(includeSelf=False)

Calls for a propagateDirty with the flag OrsVisibilityDirty

Parameters:: includeSelf (bool) – True includes the receiver in the propagation, False doesn’t

refresh(): Refreshes the views related to the current object

refreshAll2DParentViews(self): Causes all 2D views in the parent hierarchy of the node to be refreshed.

refreshAll2DParentViewsIfVisible(self): Causes all 2D views in the parent hierarchy of the node to be refreshed if it is a model and it visuals are visible in the views.

refreshAll3DParentViews(self): Causes all 3D views in the parent hierarchy of the node to be refreshed.

refreshAll3DParentViewsIfVisible(self): Causes all 3D views in the parent hierarchy of the node to be refreshed if it is a model and it visuals are visible in the views.

refreshAllParentViews(self): Causes all views in the parent hierarchy of the node to be refreshed.

refreshAllParentViewsIfVisible(self): Causes all views in the parent hierarchy of the node to be refreshed if it is a model and it visuals are visible in the views.

setAllowRenderingInAllParentViews(self, bValue: bool)

Allows or prevents rendering in the views affected by a node.

Parameters:: bValue (bool) – true to allow rendering, false to disallow it.

switchOrderOfPrecedenceOfChildrenNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool

Rearranges the order of child nodes.

Note

When child nodes are not in the desired order, they can be switched with this method (for example, the order in which they are rendered can be undesired).

Note

Both nodes are swapped in the list of nodes. For example, if nodes are A B C D and this call is made switchOrderOfPrecedenceOfChildrenNodes(A, C), the nodes are then in this order: C B A D.

Note

This method dives down in the child hierarchy until it finds a node where both arguments appear, then performs the switch at that level.

Parameters:

anINode1 (ORSModel.ors.Node) – a child node (a Node)
anINode2 (ORSModel.ors.Node) – a child node (a Node)

Returns:

output (bool) – true if successful, false otherwise

switchOrderOfPrecedenceOfParentNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool

Rearranges the ordering of immediate parent nodes.

Note

When parent nodes are not in the desired order, they can be switched with this method.

Note

Both nodes are swapped in the list of nodes. For example, if nodes are A B C D and this call is made switchOrderOfPrecedenceOfParentNodes(A, C), the nodes are then in this order: C B A D.

Note

This method acts only on immediate parent nodes, not the entire parent hierarchy.

Parameters:

anINode1 (ORSModel.ors.Node) – a parent node (a Node)
anINode2 (ORSModel.ors.Node) – a parent node (a Node)

Returns:

output (bool) – true if successful, false otherwise

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

Octree¶

class ORSModel.ors.Octree(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Bases: Node

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

Octree.__init__(self)

buildOctreeBox(self, pGrid: ORSModel.ors.UnstructuredGrid, iTIndex: int, bAppend: bool)

Parameters:

pGrid (ORSModel.ors.UnstructuredGrid) –
iTIndex (int) –
bAppend (bool) –

buildOctreeBoxMultiThread(self, pGrid: ORSModel.ors.UnstructuredGrid, iTIndex: int, bAppend: bool)

Parameters:

pGrid (ORSModel.ors.UnstructuredGrid) –
iTIndex (int) –
bAppend (bool) –

buildPointsOctreeBox(self, pCollection: ORSModel.ors.SequenceableCollection, boxThatContainTheSpheres: ORSModel.ors.Box, iTIndex: int, bAppend: bool, aProgress: ORSModel.ors.Progress)

Parameters:

pCollection (ORSModel.ors.SequenceableCollection) –
boxThatContainTheSpheres (ORSModel.ors.Box) –
iTIndex (int) –
bAppend (bool) –
aProgress (ORSModel.ors.Progress) –

buildSpheresOctreeBox(self, pCollection: ORSModel.ors.SequenceableCollection, boxThatContainTheSpheres: ORSModel.ors.Box, iTIndex: int, bAppend: bool, aProgress: ORSModel.ors.Progress)

Parameters:

pCollection (ORSModel.ors.SequenceableCollection) –
boxThatContainTheSpheres (ORSModel.ors.Box) –
iTIndex (int) –
bAppend (bool) –
aProgress (ORSModel.ors.Progress) –

getAtomsForPoint(self, x: float, y: float, z: float, iTIndex: int) → ORSModel.ors.ArrayUnsignedLong

Parameters:

x (float) –
y (float) –
z (float) –
iTIndex (int) –

Returns:

output (ORSModel.ors.ArrayUnsignedLong) –

getAtomsIntersectingBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle, iTIndex: int) → ORSModel.ors.List

Parameters:

aBoundedPlane (ORSModel.ors.Rectangle) –
iTIndex (int) –

Returns:

output (ORSModel.ors.List) –

getAtomsIntersectingBox(self, aBox: ORSModel.ors.Box, iTIndex: int) → ORSModel.ors.List

Parameters:

aBox (ORSModel.ors.Box) –
iTIndex (int) –

Returns:

output (ORSModel.ors.List) –

getAtomsIntersectingLine(self, aLine: ORSModel.ors.Line, iTIndex: int) → ORSModel.ors.List

Parameters:

aLine (ORSModel.ors.Line) –
iTIndex (int) –

Returns:

output (ORSModel.ors.List) –

getAtomsIntersectingPlane(self, a: float, b: float, c: float, d: float, iTIndex: int) → ORSModel.ors.List

Parameters:

a (float) –
b (float) –
c (float) –
d (float) –
iTIndex (int) –

Returns:

output (ORSModel.ors.List) –

getAtomsIntersectingSphere(self, aSphere: ORSModel.ors.Sphere, iTIndex: int) → ORSModel.ors.List

Parameters:

aSphere (ORSModel.ors.Sphere) –
iTIndex (int) –

Returns:

output (ORSModel.ors.List) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

isEqualTo(self, anOctree: ORSModel.ors.Octree, iTIndex: int) → bool

Parameters:

anOctree (ORSModel.ors.Octree) –
iTIndex (int) –

Returns:

output (bool) –

none() → Octree

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (Octree) –

OpticalFlow¶

class ORSModel.ors.OpticalFlow(self)

Bases: Unmanaged

computeAverageSpeedAndRotation(self, bUsePonderationByIntensityIm1: bool, pAverageSpeedX: float, pAverageSpeedY: float, pAverageSpeedZ: float, pAverageRotationAroundZ: float, pBarycenterX: float, pBarycenterY: float)

Parameters:

bUsePonderationByIntensityIm1 (bool) –
pAverageSpeedX (float) –
pAverageSpeedY (float) –
pAverageSpeedZ (float) –
pAverageRotationAroundZ (float) –
pBarycenterX (float) –
pBarycenterY (float) –

computeOpticalFlow(self)

createGaussianPyramid(self, pIOutChannelsGaussianPyramidIm1: ORSModel.ors.Channel, pIOutChannelsGaussianPyramidIm2: ORSModel.ors.Channel, pNumberOfLevels: int)

Parameters:

pIOutChannelsGaussianPyramidIm1 (ORSModel.ors.Channel) –
pIOutChannelsGaussianPyramidIm2 (ORSModel.ors.Channel) –
pNumberOfLevels (int) –

findMaximalLevelGaussianPyramid(self) → int

Returns:: output (int) –

findMaximalLevelGaussianPyramidChannelAWithChannelB(self, pIBoundingBoxSearchArea: ORSModel.ors.Box) → int

Parameters:: pIBoundingBoxSearchArea (ORSModel.ors.Box) –
Returns:: output (int) –

findMaximalLevelGaussianPyramidForThisImageSize(self, sizeX: int, sizeY: int, sizeZ: int, bPerformZReduction: bool) → int

Parameters:

sizeX (int) –
sizeY (int) –
sizeZ (int) –
bPerformZReduction (bool) –

Returns:

output (int) –

findMinimalLevelGaussianPyramidForGivenPrecision(self, pIBoundingBoxReferenceIm1: ORSModel.ors.Box, pIBoundingBoxSearchArea: ORSModel.ors.Box, minimalDistanceToStopOpticalFlow: float, minimalRotationToStopOpticalFlow: float, maximalNumberOfIterationsOpticalFlow: int, acceptableRelativeError: float) → int

Parameters:

pIBoundingBoxReferenceIm1 (ORSModel.ors.Box) –
pIBoundingBoxSearchArea (ORSModel.ors.Box) –
minimalDistanceToStopOpticalFlow (float) –
minimalRotationToStopOpticalFlow (float) –
maximalNumberOfIterationsOpticalFlow (int) –
acceptableRelativeError (float) –

Returns:

output (int) –

getChannelIm1(self) → ORSModel.ors.Channel

Returns:: output (ORSModel.ors.Channel) –

getChannelIm2(self) → ORSModel.ors.Channel

Returns:: output (ORSModel.ors.Channel) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFactorRegularizationSpeedCorrection(self) → float

Returns:: output (float) –

getLastDisplacementRegistration2DTransformation(self, pAverageSpeedX: float, pAverageSpeedY: float, pAverageRotationAroundZ: float, pBarycenterX: float, pBarycenterY: float)

Parameters:

pAverageSpeedX (float) –
pAverageSpeedY (float) –
pAverageRotationAroundZ (float) –
pBarycenterX (float) –
pBarycenterY (float) –

getMaxLevelGaussianPyramid(self) → int

Returns:: output (int) –

getMaximalConditionValueRegularizedAtransposeA(self) → float

Returns:: output (float) –

getMinLevelGaussianPyramid(self) → int

Returns:: output (int) –

getOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

getOriginPixelsIm1(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

getOriginPixelsIm2(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

getPatchWindowHalfsize(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

getPerformZReduction(self) → bool

Returns:: output (bool) –

getSizeImagesPixels(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

getSizePixelsAverageSpeed(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

getUpsampleSpeedToSameSizeAsBaseChannel(self) → bool

Returns:: output (bool) –

getUseBrightnessCorrectionFactors(self, pValueLinearFactor: bool, pValueConstantFactor: bool)

Parameters:

pValueLinearFactor (bool) –
pValueConstantFactor (bool) –

getUseRotationAroundZ(self) → bool

Returns:: output (bool) –

getUseTranslationX(self) → bool

Returns:: output (bool) –

getUseTranslationY(self) → bool

Returns:: output (bool) –

getXSpeed(self) → ORSModel.ors.Channel

Returns:: output (ORSModel.ors.Channel) –

getYSpeed(self) → ORSModel.ors.Channel

Returns:: output (ORSModel.ors.Channel) –

getZSpeed(self) → ORSModel.ors.Channel

Returns:: output (ORSModel.ors.Channel) –

none() → OpticalFlow

Returns:: output (OpticalFlow) –

registration2DTransformation(self, pIBoundingBoxReferenceIm1: ORSModel.ors.Box, pIBoundingBoxSearchArea: ORSModel.ors.Box, minimalDistanceToStopOpticalFlow: float, minimalRotationToStopOpticalFlow: float, maximalNumberOfIterationsOpticalFlow: int, bApplyTransformation: bool, IProgress: ORSModel.ors.Progress) → ORSModel.ors.Matrix4x4

Parameters:

pIBoundingBoxReferenceIm1 (ORSModel.ors.Box) –
pIBoundingBoxSearchArea (ORSModel.ors.Box) –
minimalDistanceToStopOpticalFlow (float) –
minimalRotationToStopOpticalFlow (float) –
maximalNumberOfIterationsOpticalFlow (int) –
bApplyTransformation (bool) –
IProgress (ORSModel.ors.Progress) –

Returns:

output (ORSModel.ors.Matrix4x4) –

setChannelIm1(self, pIInputChannel: ORSModel.ors.Channel)

Parameters:: pIInputChannel (ORSModel.ors.Channel) –

setChannelIm2(self, pIInputChannel: ORSModel.ors.Channel)

Parameters:: pIInputChannel (ORSModel.ors.Channel) –

setFactorRegularizationSpeedCorrection(self, value: float)

Parameters:: value (float) –

setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int)

Parameters:

minLevel (int) –
maxLevel (int) –

setMaximalConditionValueRegularizedAtransposeA(self, value: float)

Parameters:: value (float) –

setOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

setOriginPixelsIm1(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

setOriginPixelsIm2(self, x: int, y: int, z: int, t: int)

Parameters:

x (int) –
y (int) –
z (int) –
t (int) –

setPatchWindowHalfsize(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

setPerformZReduction(self, bValue: bool)

Parameters:: bValue (bool) –

setSizeImagesPixels(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

setSizePixelsAverageSpeed(self, x: int, y: int, z: int)

Parameters:

x (int) –
y (int) –
z (int) –

setUpsampleSpeedToSameSizeAsBaseChannel(self, bValue: bool)

Parameters:: bValue (bool) –

setUseBrightnessCorrectionFactors(self, bValueLinearFactor: bool, bValueConstantFactor: bool)

Parameters:

bValueLinearFactor (bool) –
bValueConstantFactor (bool) –

setUseRotationAroundZ(self, bValue: bool)

Parameters:: bValue (bool) –

setUseTranslationX(self, bValue: bool)

Parameters:: bValue (bool) –

setUseTranslationY(self, bValue: bool)

Parameters:: bValue (bool) –

OrderedCollection¶

class ORSModel.ors.OrderedCollection(*args, **kwargs)

Bases: SequenceableCollection

Abstraction class for ordered collections.

addAll(self, aSequenceableCollection: ORSModel.ors.SequenceableCollection)

Parameters:: aSequenceableCollection (ORSModel.ors.SequenceableCollection) –

addAllFirst(self, aSequenceableCollection: ORSModel.ors.SequenceableCollection)

Parameters:: aSequenceableCollection (ORSModel.ors.SequenceableCollection) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

none() → OrderedCollection

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollection) –

OrderedCollectionChar¶

class ORSModel.ors.OrderedCollectionChar(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionChar.__init__(self)

add(self, pValue: int)

Parameters:: pValue (int) –

addBeforeIndex(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

addFirst(self, pValue: int)

Parameters:: pValue (int) –

at(self, index: int) → int

Parameters:: index (int) –
Returns:: output (int) –

atPut(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → int

Returns:: output (int) –

getLast(self) → int

Returns:: output (int) –

getOccurrencesOf(self, pValue: int) → int

Parameters:: pValue (int) –
Returns:: output (int) –

includes(self, pValue: int) → bool

Return if the array includes a given value.

Parameters:: pValue (int) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

none() → OrderedCollectionChar

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionChar) –

removeAllOccurrencesOf(self, pValue: int)

Parameters:: pValue (int) –

OrderedCollectionDouble¶

class ORSModel.ors.OrderedCollectionDouble(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionDouble.__init__(self)

add(self, pValue: float)

Parameters:: pValue (float) –

addBeforeIndex(self, index: int, pValue: float)

Parameters:

index (int) –
pValue (float) –

addFirst(self, pValue: float)

Parameters:: pValue (float) –

at(self, index: int) → float

Parameters:: index (int) –
Returns:: output (float) –

atPut(self, index: int, pValue: float)

Parameters:

index (int) –
pValue (float) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → float

Returns:: output (float) –

getLast(self) → float

Returns:: output (float) –

getOccurrencesOf(self, pValue: float) → int

Parameters:: pValue (float) –
Returns:: output (int) –

includes(self, pValue: float) → bool

Return if the array includes a given value.

Parameters:: pValue (float) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: float)

Parameters:

index (int) –
pValue (float) –

none() → OrderedCollectionDouble

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionDouble) –

removeAllOccurrencesOf(self, pValue: float)

Parameters:: pValue (float) –

OrderedCollectionFloat¶

class ORSModel.ors.OrderedCollectionFloat(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionFloat.__init__(self)

add(self, pValue: float)

Parameters:: pValue (float) –

addBeforeIndex(self, index: int, pValue: float)

Parameters:

index (int) –
pValue (float) –

addFirst(self, pValue: float)

Parameters:: pValue (float) –

at(self, index: int) → float

Parameters:: index (int) –
Returns:: output (float) –

atPut(self, index: int, pValue: float)

Parameters:

index (int) –
pValue (float) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → float

Returns:: output (float) –

getLast(self) → float

Returns:: output (float) –

getOccurrencesOf(self, pValue: float) → int

Parameters:: pValue (float) –
Returns:: output (int) –

includes(self, pValue: float) → bool

Return if the array includes a given value.

Parameters:: pValue (float) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: float)

Parameters:

index (int) –
pValue (float) –

none() → OrderedCollectionFloat

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionFloat) –

removeAllOccurrencesOf(self, pValue: float)

Parameters:: pValue (float) –

OrderedCollectionLONGLONG¶

class ORSModel.ors.OrderedCollectionLONGLONG(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionLONGLONG.__init__(self)

add(self, pValue: int)

Parameters:: pValue (int) –

addBeforeIndex(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

addFirst(self, pValue: int)

Parameters:: pValue (int) –

at(self, index: int) → int

Parameters:: index (int) –
Returns:: output (int) –

atPut(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → int

Returns:: output (int) –

getLast(self) → int

Returns:: output (int) –

getOccurrencesOf(self, pValue: int) → int

Parameters:: pValue (int) –
Returns:: output (int) –

includes(self, pValue: int) → bool

Return if the array includes a given value.

Parameters:: pValue (int) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

none() → OrderedCollectionLONGLONG

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionLONGLONG) –

removeAllOccurrencesOf(self, pValue: int)

Parameters:: pValue (int) –

OrderedCollectionLong¶

class ORSModel.ors.OrderedCollectionLong(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionLong.__init__(self)

add(self, pValue: int)

Parameters:: pValue (int) –

addBeforeIndex(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

addFirst(self, pValue: int)

Parameters:: pValue (int) –

at(self, index: int) → int

Parameters:: index (int) –
Returns:: output (int) –

atPut(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → int

Returns:: output (int) –

getLast(self) → int

Returns:: output (int) –

getOccurrencesOf(self, pValue: int) → int

Parameters:: pValue (int) –
Returns:: output (int) –

includes(self, pValue: int) → bool

Return if the array includes a given value.

Parameters:: pValue (int) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

none() → OrderedCollectionLong

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionLong) –

removeAllOccurrencesOf(self, pValue: int)

Parameters:: pValue (int) –

OrderedCollectionShort¶

class ORSModel.ors.OrderedCollectionShort(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionShort.__init__(self)

add(self, pValue: int)

Parameters:: pValue (int) –

addBeforeIndex(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

addFirst(self, pValue: int)

Parameters:: pValue (int) –

at(self, index: int) → int

Parameters:: index (int) –
Returns:: output (int) –

atPut(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → int

Returns:: output (int) –

getLast(self) → int

Returns:: output (int) –

getOccurrencesOf(self, pValue: int) → int

Parameters:: pValue (int) –
Returns:: output (int) –

includes(self, pValue: int) → bool

Return if the array includes a given value.

Parameters:: pValue (int) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

none() → OrderedCollectionShort

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionShort) –

removeAllOccurrencesOf(self, pValue: int)

Parameters:: pValue (int) –

OrderedCollectionUnsignedChar¶

class ORSModel.ors.OrderedCollectionUnsignedChar(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionUnsignedChar.__init__(self)

add(self, pValue: int)

Parameters:: pValue (int) –

addBeforeIndex(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

addFirst(self, pValue: int)

Parameters:: pValue (int) –

at(self, index: int) → int

Parameters:: index (int) –
Returns:: output (int) –

atPut(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → int

Returns:: output (int) –

getLast(self) → int

Returns:: output (int) –

getOccurrencesOf(self, pValue: int) → int

Parameters:: pValue (int) –
Returns:: output (int) –

includes(self, pValue: int) → bool

Return if the array includes a given value.

Parameters:: pValue (int) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

none() → OrderedCollectionUnsignedChar

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionUnsignedChar) –

removeAllOccurrencesOf(self, pValue: int)

Parameters:: pValue (int) –

OrderedCollectionUnsignedLONGLONG¶

class ORSModel.ors.OrderedCollectionUnsignedLONGLONG(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionUnsignedLONGLONG.__init__(self)

add(self, pValue: int)

Parameters:: pValue (int) –

addBeforeIndex(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

addFirst(self, pValue: int)

Parameters:: pValue (int) –

at(self, index: int) → int

Parameters:: index (int) –
Returns:: output (int) –

atPut(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → int

Returns:: output (int) –

getLast(self) → int

Returns:: output (int) –

getOccurrencesOf(self, pValue: int) → int

Parameters:: pValue (int) –
Returns:: output (int) –

includes(self, pValue: int) → bool

Return if the array includes a given value.

Parameters:: pValue (int) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

none() → OrderedCollectionUnsignedLONGLONG

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionUnsignedLONGLONG) –

removeAllOccurrencesOf(self, pValue: int)

Parameters:: pValue (int) –

OrderedCollectionUnsignedLong¶

class ORSModel.ors.OrderedCollectionUnsignedLong(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)

Parameters:

buffer (bytes) –
nBytes (int) –
bPreserveIdentity (bool) –

OrderedCollectionUnsignedLong.__init__(self)

add(self, pValue: int)

Parameters:: pValue (int) –

addBeforeIndex(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

addFirst(self, pValue: int)

Parameters:: pValue (int) –

at(self, index: int) → int

Parameters:: index (int) –
Returns:: output (int) –

atPut(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

getClassNameStatic() → str

getClassNameStatic

Returns:: output (str) –

getFirst(self) → int

Returns:: output (int) –

getLast(self) → int

Returns:: output (int) –

getOccurrencesOf(self, pValue: int) → int

Parameters:: pValue (int) –
Returns:: output (int) –

includes(self, pValue: int) → bool

Return if the array includes a given value.

Parameters:: pValue (int) – the value to look for
Returns:: output (bool) – true or false

insertAt(self, index: int, pValue: int)

Parameters:

index (int) –
pValue (int) –

none() → OrderedCollectionUnsignedLong

Returns a none object, equivalent to a non-existent object (or null).

Returns:: output (OrderedCollectionUnsignedLong) –

removeAllOccurrencesOf(self, pValue: int)

Parameters:: pValue (int) –

OrderedCollectionUnsignedShort¶

class ORSModel.ors.OrderedCollectionUnsignedShort(self, buffer: bytes, nBytes: int, bPreserveIdentity: bool = False)