ORSModel

Classes

Annotation

class ORSModel.ors.Annotation

Bases: ORSModel.ors.Visual

brief_description: Represents image annotations. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Aug 2006

Annotation.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Annotation.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addControlPoint(self, pPoint: ORSModel.ors.Vector3, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → None

–

Adds a control point.

Parameters:
addControlPointForAllTimeStep(self, pPoint: ORSModel.ors.Vector3, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
addControlPointToHighlighted(self, controlPointIndex: int, iTIndex: int) → None

–

Parameters:
addControlPointToSelection(self, controlPointIndex: int, iTIndex: int) → None

–

Parameters:
applyTransformation(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, iTIndex: int) → None

–

Parameters:
applyTransformationOnAllTimeStep(self, aTransformationMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
copyControlPointFrom(self, aControlPointCollection: ORSModel.ors.OrderedCollectionDouble, iTIndex: int) → None

–

Parameters:
duplicateTimeStepDataAcrossAllTimeSteps(self, iTIndex: int) → None

–

Parameters:
get3DThickness(self) → float

–

Gets the thickness of lines in 3D mode.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : float

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

–

Parameters:
getAsROIForAllTimeStep(self, worldTransform: ORSModel.ors.Matrix4x4, pOutputROI: ORSModel.ors.ROI) → None

–

Parameters:
getAutoCaption(self) → bool

–

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : bool

getCaption(self) → str

–

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : str

getCaptionTextFontName(self) → str

–

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : str

getCaptionTextFontSize(self) → float

–

Gets the font size of text captions, in screen one thousandths.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : float

getCaptionTextMinimumFontSize(self) → int

–

Gets the minimum font size of text captions, in font points.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : int

getCentroid(self, iTIndex: int, worldTransform: ORSModel.ors.Matrix4x4) → Vector3

–

Gets the World centroid of the annotation.

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getControlPointAppearance(self) → int

–

Gets the control point appearance.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : int

getControlPointCaptionAtIndex(self, index: int, iTIndex: int) → str

–

Parameters:

:return : :rtype : str

getControlPointCount(self, iTIndex: int) → int

–

Gets the number of control points.

Parameters:

:return : :rtype : int

getControlPointPositionAtIndex(self, index: int, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3

–

Parameters:
getControlPoints(self, iTIndex: int) → OrderedCollectionDouble

–

Parameters:
getCreationOrientedPlane(self) → OrientedPlane

–

Retrieve the oriented plane on which the annotation is created, if it was set.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
getCreationOrientedPlaneInView(self, aView: ORSModel.ors.View) → OrientedPlane

–

Parameters:
getDistanceFromLineSegment(self, aStartPoint: ORSModel.ors.Vector3, aEndPoint: ORSModel.ors.Vector3, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → float

–

Gets the distance between this annotation and a givenLine Segment.

Parameters:

:return : :rtype : float

getDistanceFromPlane(self, aPlane: ORSModel.ors.Plane, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → float

–

Gets the distance between this priannotationmitive and a givenPlane.

Parameters:

:return : :rtype : float

getDistanceFromPoint(self, aPoint: ORSModel.ors.Vector3, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → float

–

Gets the distance between this annotation and a given Point.

Parameters:

:return : :rtype : float

getDrawTextShadow(self) → bool

–

Gets the view text shadows status.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : bool

getHighlightControlPointColor(self) → Color

–

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
getHighlightedControlPointsArray(self, iTIndex: int) → OrderedCollectionUnsignedLong

–

Parameters:
getHighlightedControlPointsCount(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getIsEditable(self) → bool

–

Sees if the annotation is editable or not.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : bool

getIsIntersectingBox(self, box: ORSModel.ors.Box, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → bool

–

Indicate if the primitive intersect with a box.

Parameters:

:return : :rtype : bool

getNormalColor(self) → Color

–

Gets the normal color of the annotation.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
getProjectionIn(self, worldTransform: ORSModel.ors.Matrix4x4) → Annotation

–

Projects the annotation in a channel’s space, returning a new annotation.

Parameters:
getSelectedColor(self) → Color

–

Gets the selected color of the annotation.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
getSelectedControlPointArray(self, iTIndex: int) → OrderedCollectionUnsignedLong

–

Parameters:
getSelectedControlPointColor(self) → Color

–

Gets the control point selected color of the annotation.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
getSelectedControlPointCount(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getShow3DIn2D(self) → bool

–

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : bool

getShowCaption(self) → bool

–

get the view status of the annotation caption.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : bool

getShowControlPoints(self) → bool

–

Sees if control points are visible.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : bool

getTextColor(self) → Color

–

Gets the text color of the annotation.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
getTextShadowColor(self) → Color

–

Gets the text shadow color of the annotation.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
getThickness(self) → float

–

Gets the thickness of lines in 2D mode.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

:return : :rtype : float

insertControlPoint(self, index: int, pPoint: ORSModel.ors.Vector3, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → None

–

Insert a control point.

Parameters:
none() → Annotation

–

removeAllControlPoints(self, iTIndex: int) → None

–

Removes all control points.

Parameters:
removeAllControlPointsForAllTimeStep(self) → None

–

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation
removeControlPoint(self, index: int, iTIndex: int) → None

–

Removes a single control point.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • index (int) – The index point index (an uint32_t)
  • iTIndex (int) –
removeControlPointForAllTimeStep(self, index: int) → None

–

Parameters:
removeControlPointFromHighlighted(self, controlPointIndex: int, iTIndex: int) → None

–

Parameters:
removeControlPointFromSelection(self, controlPointIndex: int, iTIndex: int) → None

–

Parameters:
set3DThickness(self, value: float) → None

–

Sets the thickness of lines in 3D mode.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • value (float) – the thickness, in pixel units (a double between 0 and 1)
setAutoCaption(self, aValue: bool) → None

–

Parameters:
setCaption(self, text: str) → None

–

Sets the caption of the annotation.

Parameters:
setCaptionTextFontName(self, sFontName: str) → None

–

Sets the font name of text captions.

Parameters:
setCaptionTextFontSize(self, fontSize: float) → None

–

Sets the font size of text captions, in screen one thousandths.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • fontSize (float) – the font size (a double between 0 and 1)
setCaptionTextMinimumFontSize(self, fontSize: int) → None

–

Sets the minimum font size of text captions, in font points.

Parameters:
setControlPointAppearance(self, nValue: int) → None

–

Sets the control point appearance.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • nValue (int) – The appearance (an int) 0:Circle 1:Square 2:Triangle 3:+ 4:x
setControlPointCaptionAtIndex(self, index: int, iTIndex: int, sCaption: str) → None

–

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • index (int) –
  • iTIndex (int) –
  • sCaption (str) –
setControlPointPositionAtIndex(self, index: int, iTIndex: int, anIVector: ORSModel.ors.Vector3, aTransformationMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
setControlPointPositionAtIndexForAllTimeStep(self, index: int, anIVector: ORSModel.ors.Vector3, aTransformationMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
setCreationOrientedPlane(self, anOrientedPlane: ORSModel.ors.OrientedPlane) → None

–

Set the oriented plane on which the annotation is created.

Parameters:
setCreationOrientedPlaneFromView(self, aView: ORSModel.ors.View) → None

–

Parameters:
setDrawTextShadow(self, bFlag: bool) → None

–

Toggles displaying shadows for the text.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • bFlag (bool) – true to show text shadows, false otherwise
setHighlightControlPointColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
setIsEditable(self, pFlag: bool) → None

–

Sets the annotation to be editable or not.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • pFlag (bool) – true to make the annotation editable, false otherwise
setNormalColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the normal color of the annotation.

Parameters:
setSelectedColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the selected color of the annotation.

Parameters:
setSelectedControlPointColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the control point selected color of the annotation.

Parameters:
setShow3DIn2D(self, nValue: bool) → None

–

Parameters:
setShowCaption(self, bShow: bool) → None

–

Toggles the displaying of the annotation caption.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • bShow (bool) – true to display the caption, false to hide it
setShowControlPoints(self, value: bool) → None

–

Toggles the displaying of the annotation control points.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • value (bool) – true to display the control points, false to hide them
setTextColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the text color of the annotation.

Parameters:
setTextShadowColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the text shadow color of the annotation.

Parameters:
setThickness(self, value: float) → None

–

Sets the thickness of lines in 2D mode.

Parameters:
  • self (ORSModel.ors.Annotation) – an instance of Annotation
  • value (float) – the thickness, in pixel units (a double between 0 and 1)
update(self) → None

–

Updates all visual aspects of the annotation.

Parameters:self (ORSModel.ors.Annotation) – an instance of Annotation

Array

class ORSModel.ors.Array

Bases: ORSModel.ors.SequenceableCollection

brief_description: None author: Normand Mongeau. version: 1.0 Array abstraction class. ORS arrays can shrink and grow while preserving their contents.

Array.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.Array) – an instance of Array
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Array.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

Array.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
  • self (ORSModel.ors.Array) – an instance of Array
  • iPacketSize (int) –
  • initialSize (int) –
copyFromMemory(self, pSource: int, iByteCount: int, iInsertionIndex: int) → None

–

Copies a memory buffer in the array.

Parameters:
  • self (ORSModel.ors.Array) – an instance of Array
  • pSource (bytes) – the source (a unsigned char*)
  • iByteCount (int) – the size of the source, in bytes (a uint64_t)
  • iInsertionIndex (int) – the insertion index into the array (a uint64_t, zero based)
copyIntoMemory(self, pOutput: int, iStartIndex: int, iNbElementsToCopy: int) → None

–

Copies the array to a memory buffer.

Parameters:
  • self (ORSModel.ors.Array) – an instance of Array
  • pOutput (bytes) – the target memory buffer (a unsigned char*)
  • iStartIndex (int) – the starting index of the source array (a uint64_t, zero based)
  • iNbElementsToCopy (int) – the number of array elements to copy (a uint64_t)
getClassNameStatic() → str

–

:return : :rtype : str

getOffsetBitAnd(self) → int

–

Parameters:self (ORSModel.ors.Array) – an instance of Array

:return : :rtype : int

getOffsetBitShift(self) → int

–

Parameters:self (ORSModel.ors.Array) – an instance of Array

:return : :rtype : int

getPacketCount(self) → int

–

Gets the number of packets currently in the array.

Parameters:self (ORSModel.ors.Array) – an instance of Array

:return : :rtype : int

getPacketSize(self) → int

–

Gets the packet size used by the array.

Parameters:self (ORSModel.ors.Array) – an instance of Array

:return : :rtype : int

none() → Array

–

setInitialSize(self, iPacketSize: int, initialSize: int) → None

–

Sets the initial size of the array.

Parameters:
  • self (ORSModel.ors.Array) – an instance of Array
  • iPacketSize (int) – the packet size (an unsigned short)
  • initialSize (int) – the initial array size (an uint64_t)

ArrayChar

class ORSModel.ors.ArrayChar

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type char (1 byte per value).

ArrayChar.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ArrayChar.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayChar) – an instance of ArrayChar

ArrayChar.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayChar.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (a signed char)
copyInto(self, anArray: ORSModel.ors.ArrayChar, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • anArray (ORSModel.ors.ArrayChar) – the destination array (an ORSArrayCharPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • pValue (int) – the value to search for (a signed char)

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • pValue (int) – the value to search for (a signed char)

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (bytes) – the smallest value found (a signed char*)
  • max (bytes) – the largest value found (a signed char*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (a signed char)
none() → ArrayChar

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:
  • self (ORSModel.ors.ArrayChar) – an instance of ArrayChar
  • iValue (int) – the value to set (a signed char)

ArrayDouble

class ORSModel.ors.ArrayDouble

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type double (8 bytes per value).

ArrayDouble.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ArrayDouble.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble

ArrayDouble.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayDouble.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → float

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : float

atPut(self, index: int, pValue: float) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (float) – the value to put (a double)
copyInto(self, anArray: ORSModel.ors.ArrayDouble, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • anArray (ORSModel.ors.ArrayDouble) – the destination array (an ORSArrayDoublePtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: float) → int

–

Searches the array for a given value, starting at index 0.

Parameters:

:return : :rtype : int

findLast(self, pValue: float) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → float

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : float

getMin(self, startIndex: int, endIndex: int) → float

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : float

getMinMax(self, startIndex: int, endIndex: int, min: float, max: float) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (float) – the smallest value found (a double*)
  • max (float) – the largest value found (a double*)
getOccurrencesOf(self, pValue: float) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: float) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (float) – the value to insert (a double)
none() → ArrayDouble

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: float) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayFloat

class ORSModel.ors.ArrayFloat

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type float (4 bytes per value).

ArrayFloat.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ArrayFloat.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat

ArrayFloat.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayFloat.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → float

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : float

atPut(self, index: int, pValue: float) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (float) – the value to put (a float)
copyInto(self, anArray: ORSModel.ors.ArrayFloat, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • anArray (ORSModel.ors.ArrayFloat) – the destination array (an ORSArrayFloatPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: float) → int

–

Searches the array for a given value, starting at index 0.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • pValue (float) – the value to search for (a float)

:return : :rtype : int

findLast(self, pValue: float) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • pValue (float) – the value to search for (a float)

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → float

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : float

getMin(self, startIndex: int, endIndex: int) → float

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : float

getMinMax(self, startIndex: int, endIndex: int, min: float, max: float) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (float) – the smallest value found (a float*)
  • max (float) – the largest value found (a float*)
getOccurrencesOf(self, pValue: float) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: float) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (float) – the value to insert (a float)
none() → ArrayFloat

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: float) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayLONGLONG

class ORSModel.ors.ArrayLONGLONG

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type int64_t (8 bytes per value).

ArrayLONGLONG.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ArrayLONGLONG.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG

ArrayLONGLONG.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayLONGLONG.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (a int64_t)
copyInto(self, anArray: ORSModel.ors.ArrayLONGLONG, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • anArray (ArrayLONGLONG) – the destination array (an ORSArrayLONGLONGPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (int) – the smallest value found (a int64_t*)
  • max (int) – the largest value found (a int64_t*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (a int64_t)
none() → ArrayLONGLONG

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayLong

class ORSModel.ors.ArrayLong

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type int32_t (4 bytes per value).

ArrayLong.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ArrayLong.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayLong) – an instance of ArrayLong

ArrayLong.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayLong.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (a int32_t*)
copyInto(self, anArray: ORSModel.ors.ArrayLong, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • anArray (ORSModel.ors.ArrayLong) – the destination array (an ORSArrayLongPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • pValue (int) – the value to search for (a int32_t*)

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • pValue (int) – the value to search for (a int32_t*)

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (int) – the smallest value found (a int32_t*)
  • max (int) – the largest value found (a int32_t*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayLong) – an instance of ArrayLong
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (a int32_t*)
none() → ArrayLong

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayShort

class ORSModel.ors.ArrayShort

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type short (2 bytes per value).

ArrayShort.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ArrayShort.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayShort) – an instance of ArrayShort

ArrayShort.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayShort.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (a short)
copyInto(self, anArray: ORSModel.ors.ArrayShort, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • anArray (ORSModel.ors.ArrayShort) – the destination array (an ORSArrayShortPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (int) – the smallest value found (a short*)
  • max (int) – the largest value found (a short*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayShort) – an instance of ArrayShort
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (a short)
none() → ArrayShort

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayUnsignedChar

class ORSModel.ors.ArrayUnsignedChar

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type unsigned char (1 byte per value).

ArrayUnsignedChar.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

ArrayUnsignedChar.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar

ArrayUnsignedChar.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayUnsignedChar.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (an unsigned char)
copyInto(self, anArray: ORSModel.ors.ArrayUnsignedChar, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar
  • anArray (ORSModel.ors.ArrayUnsignedChar) – the destination array (an ORSArrayUnsignedCharPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (bytes) – the smallest value found (an unsigned char*)
  • max (bytes) – the largest value found (an unsigned char*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (an unsigned char)
none() → ArrayUnsignedChar

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayUnsignedLONGLONG

class ORSModel.ors.ArrayUnsignedLONGLONG

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type uint64_t (8 bytes per value).

ArrayUnsignedLONGLONG.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

ArrayUnsignedLONGLONG.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG

ArrayUnsignedLONGLONG.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayUnsignedLONGLONG.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (a uint64_t)
copyInto(self, anArray: ORSModel.ors.ArrayUnsignedLONGLONG, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG
  • anArray (ArrayUnsignedLONGLONG) – the destination array (an ORSArrayUnsignedLONGLONGPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (int) – the smallest value found (an uint64_t*)
  • max (int) – the largest value found (an uint64_t*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (a uint64_t)
none() → ArrayUnsignedLONGLONG

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayUnsignedLong

class ORSModel.ors.ArrayUnsignedLong

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type uint32_t (4 bytes per value).

ArrayUnsignedLong.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

ArrayUnsignedLong.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong

ArrayUnsignedLong.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayUnsignedLong.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong
  • index (int) – the index of the item to retrieve (an uint64_t, zero based)

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (an uint32_t)
copyInto(self, anArray: ORSModel.ors.ArrayUnsignedLong, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong
  • anArray (ORSModel.ors.ArrayUnsignedLong) – the destination array (an ORSArrayUnsignedLongPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (int) – the smallest value found (an uint32_t*)
  • max (int) – the largest value found (an uint32_t*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (an uint32_t)
none() → ArrayUnsignedLong

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:

ArrayUnsignedShort

class ORSModel.ors.ArrayUnsignedShort

Bases: ORSModel.ors.Array

brief_description: None author: Normand Mongeau. version: 1.0 Array for numeric values of type unsigned short (2 bytes per value).

ArrayUnsignedShort.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

ArrayUnsignedShort.__init__(self) -> None –

Parameters:self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort

ArrayUnsignedShort.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

ArrayUnsignedShort.__init__(self, iPacketSize: int, initialSize: int) -> None –

Parameters:
at(self, index: int) → int

–

Retrieves a single value from the array.

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Puts a single value into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort
  • index (int) – the index of the item to modify (an uint64_t, zero based)
  • pValue (int) – the value to put (an unsigned short)
copyInto(self, anArray: ORSModel.ors.ArrayUnsignedShort, iInsertionIndex: int, iStartIndex: int, iEndIndex: int) → None

–

Copies portions of the source array in another array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort
  • anArray (ORSModel.ors.ArrayUnsignedShort) – the destination array (an ORSArrayUnsignedShortPtr)
  • iInsertionIndex (int) – the insertion index into the destination array (a uint64_t, zero based)
  • iStartIndex (int) – the start index of the source (a uint64_t, zero based)
  • iEndIndex (int) – the end index of the source (a uint64_t, zero based)
findFirst(self, pValue: int) → int

–

Searches the array for a given value, starting at index 0.

Parameters:

:return : :rtype : int

findLast(self, pValue: int) → int

–

Searches the array for a given value, starting at indexgetSize() - 1 (the end of the array).

Parameters:

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getMax(self, startIndex: int, endIndex: int) → int

–

Returns the max value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMin(self, startIndex: int, endIndex: int) → int

–

Returns the min value within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)

:return : :rtype : int

getMinMax(self, startIndex: int, endIndex: int, min: int, max: int) → None

–

Returns the min and max values within the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort
  • startIndex (int) – the start index where to search (a uint64_t, zero based, inclusive)
  • endIndex (int) – the end index where to search (a uint64_t, zero based, inclusive)
Returns:
  • min (int) – the smallest value found (an unsigned short*)
  • max (int) – the largest value found (an unsigned short*)
getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Inserts a single item into the array.

Parameters:
  • self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort
  • index (int) – the index of the item to insert (an uint64_t, zero based)
  • pValue (int) – the value to insert (an unsigned short)
none() → ArrayUnsignedShort

–

privateGetDataPacketAtIndex(self, iIndex: int) → None

–

Parameters:
setAll(self, iValue: int) → None

–

Sets all elements of the array to the same value.

Parameters:

Box

class ORSModel.ors.Box

Bases: ORSModel.ors.Shape3D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Box.__init__(self) -> None –

Parameters:self (ORSModel.ors.Box) – an instance of Box

Box.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:

Box.__init__(self, rhs: ORSModel.ors.Box) -> None –

Parameters:
clip(self, pBox: ORSModel.ors.Box) → None

–

Parameters:
getBoundedPlaneOfSlice(self, sliceIndex: int) → Rectangle

–

Parameters:
getBoxInBoxReferential(self, inRefBox: ORSModel.ors.Box) → Box

–

Gets a copy of the receiver in the argument referential.

Parameters:
getBoxToWorld(self, intVect: ORSModel.ors.Vector3) → Vector3

–

Transforms the given point (which is expressed in the box referential) in the world referential.

Parameters:
getCenter(self) → Vector3

–

Gets the geometrical middle of the box.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getCenterHalfVoxel(self) → Vector3

–

Gets the middle of the voxel in the middle of the box.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getClassNameStatic() → str

–

:return : :rtype : str

getContainsBox(self, aBox: ORSModel.ors.Box) → bool

–

Parameters:

:return : :rtype : bool

getDirection(self, index: int) → Vector3

–

Gets a box direction.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • index (int) – the side index (an unsigned short)
getDirection0(self) → Vector3

–

Gets the box direction0.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getDirection0Size(self) → float

–

Gets the box direction0 side length.

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : float

getDirection0SizeInVoxel(self) → int

–

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : unsigned int

getDirection0Spacing(self) → float

–

Gets the box direction0 spacing.

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : float

getDirection1(self) → Vector3

–

Gets the box direction1.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getDirection1Size(self) → float

–

Gets the box direction1 side length.

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : float

getDirection1SizeInVoxel(self) → int

–

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : unsigned int

getDirection1Spacing(self) → float

–

Gets the box direction1 spacing.

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : float

getDirection2(self) → Vector3

–

Gets the box direction2.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getDirection2Size(self) → float

–

Gets the box direction2 side length.

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : float

getDirection2SizeInVoxel(self) → int

–

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : unsigned int

getDirection2Spacing(self) → float

–

Gets the box direction2 spacing.

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : float

getDirectionSize(self, index: int) → float

–

Gets a box direction side length.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • index (int) – the side index (an unsigned short)

:return : :rtype : float

getDirectionSizeVector(self) → Vector3

–

Parameters:self (ORSModel.ors.Box) – an instance of Box
getDirectionSpacing(self, index: int) → float

–

Gets the box direction0 spacing.

Parameters:

:return : :rtype : float

getDirectionSpacingVector(self) → Vector3

–

Parameters:self (ORSModel.ors.Box) – an instance of Box
getEnclosingBox(self, dir0: ORSModel.ors.Vector3, dir1: ORSModel.ors.Vector3) → Box

–

Parameters:
getFace(self, faceIndex: int) → Rectangle

–

Parameters:
getFirstIntersectingFace(self, aLine: ORSModel.ors.Line) → int

–

Parameters:

:return : :rtype : int

getHasSameOrientation(self, pBox: ORSModel.ors.Box) → bool

–

Parameters:

:return : :rtype : bool

getHasSameOrthonormalBase(self, pBox: ORSModel.ors.Box) → bool

–

Parameters:

:return : :rtype : bool

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → LineSegment

–

Parameters:
getIsEqualTo(self, aBox: ORSModel.ors.Box) → bool

–

Checks for equality to another box.

Parameters:

:return : :rtype : bool

getIsIntersectingBox(self, aBox: ORSModel.ors.Box) → bool

–

Parameters:

:return : :rtype : bool

getIsIntersectingLineSegment(self, inputLineSegment: ORSModel.ors.LineSegment) → bool

–

Parameters:

:return : :rtype : bool

getIsIntersectingPlane(self, aPlane: ORSModel.ors.Plane) → bool

–

Parameters:

:return : :rtype : bool

getIsIntersectingRectangle(self, aBplane: ORSModel.ors.Rectangle) → bool

–

Parameters:

:return : :rtype : bool

getIsPointInside(self, aPosition: ORSModel.ors.Vector3) → bool

–

Verifies if a point is inside the box.

Parameters:

:return : :rtype : bool

getMostSimilarDirectionIndex(self, pVect: ORSModel.ors.Vector3) → int

–

Parameters:

:return : :rtype : int

getNearestPointOnBoxSurfaceFromLineOnPlane(self, aPlane: ORSModel.ors.Plane, aLine: ORSModel.ors.Line, insideDeep: float) → Vector3

–

Parameters:
getNearestPointOnBoxSurfaceFromPointOnPlane(self, aPlane: ORSModel.ors.Plane, aPoint: ORSModel.ors.Vector3, insideDeep: float) → Vector3

–

Parameters:
getOrigin(self) → Vector3

–

Gets the box origin position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getOriginOpposite(self) → Vector3

–

Parameters:self (ORSModel.ors.Box) – an instance of Box
getOutwardFacePlane(self, faceIndex: int) → Plane

–

Parameters:
getPlaneInBoxReferential(self, pPlane: ORSModel.ors.Plane) → Plane

–

Transforms the plane provided in the receiver referential.

Parameters:
getPlaneTranslatedSoThatItIntersect(self, aPlane: ORSModel.ors.Plane) → Plane

–

Parameters:
getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : str

getRectangleOfIntersection(self, cutPlane: ORSModel.ors.Plane, upVector: ORSModel.ors.Vector3) → Rectangle

–

Computes the bounded plane (with direction 1 vector equal to the up vector provided) of the intersection of the receiver with a plane.

Parameters:
getRotationMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSpacingInDirection(self, aDirection: ORSModel.ors.Vector3) → float

–

Parameters:

:return : :rtype : float

getSubBoxForIndex(self, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int) → Box

–

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • minX (int) –
  • minY (int) –
  • minZ (int) –
  • maxX (int) –
  • maxY (int) –
  • maxZ (int) –
getSummit(self, maxDirection0: bool, maxDirection1: bool, maxDirection2: bool) → Vector3

–

Gets the position of one of the summits of the box.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • maxDirection0 (bool) – TRUE to get maxDirection0, FALSE to get minDirection0
  • maxDirection1 (bool) – TRUE to get maxDirection1, FALSE to get minDirection1
  • maxDirection2 (bool) – TRUE to get maxDirection2, FALSE to get minDirection2
getSummitmmm(self) → Vector3

–

Gets the (minDirection0, minDirection1, minDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSummitmmp(self) → Vector3

–

Gets the (minDirection0, minDirection1, maxDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSummitmpm(self) → Vector3

–

Gets the (minDirection0, maxDirection1, minDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSummitmpp(self) → Vector3

–

Gets the (minDirection0, maxDirection1, maxDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSummitpmm(self) → Vector3

–

Gets the (maxDirection0, minDirection1, minDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSummitpmp(self) → Vector3

–

Gets the (maxDirection0, minDirection1, maxDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSummitppm(self) → Vector3

–

Gets the (maxDirection0, maxDirection1, minDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getSummitppp(self) → Vector3

–

Gets the (maxDirection0, maxDirection1, maxDirection2) summit position.

Parameters:self (ORSModel.ors.Box) – an instance of Box
getTransformationToGoTo(self, pIBox: ORSModel.ors.Box) → Matrix4x4

–

Gets the 4x4 matrix transforming the receiver into the argument.

Parameters:
getVolume(self) → float

–

Gets the volume of the receiver.

Parameters:self (ORSModel.ors.Box) – an instance of Box

:return : :rtype : float

getVoxelToWorldCoordinates(self, anIndex: ORSModel.ors.Vector3) → Vector3

–

Gets the position of a given voxel.

Parameters:
getWorldToBox(self, inVect: ORSModel.ors.Vector3) → Vector3

–

Transforms the given point in the box referential.

Parameters:
getWorldToVoxelCoordinates(self, pPointInWorld: ORSModel.ors.Vector3) → Vector3

–

Gets the position of a given world coordinate.

Parameters:
getWorldTranformation(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Box) – an instance of Box
grow(self, growSize: ORSModel.ors.Vector3) → None

–

Grows or shrinks the receiver, arount its center.

Parameters:
growToContain(self, pBox: ORSModel.ors.Box) → None

–

Grows to include a given box.

Parameters:
growToIncludePoint(self, aPoint: ORSModel.ors.Vector3) → None

–

Grows the receiver as to include the provided point.

Parameters:
makeAbleToContain(self, pBox: ORSModel.ors.Box) → None

–

Makes the box able to contain a given box.

Parameters:
moveFaceSoThatPlaneIncludesPoint(self, faceIndex: int, pVect: ORSModel.ors.Vector3) → None

–

Parameters:
none() → Box

–

setDirection(self, index: int, pVect: ORSModel.ors.Vector3) → None

–

Sets a box direction.

Parameters:
setDirection0(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the box direction0.

Parameters:
setDirection0Size(self, aSize: float) → None

–

Sets the box direction0 vector length.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • aSize (float) – the side 0 length (a double)
setDirection0Spacing(self, aSpacing: float) → None

–

Sets the box direction0 spacing.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • aSpacing (float) – the side 0 spacing (a double)
setDirection1(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the box direction1.

Parameters:
setDirection1Size(self, aSize: float) → None

–

Sets the box direction1 vector length.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • aSize (float) – the side 1 length (a double)
setDirection1Spacing(self, aSpacing: float) → None

–

Sets the box direction1 spacing.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • aSpacing (float) – the side 1 spacing (a double)
setDirection2(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the box direction2.

Parameters:
setDirection2Size(self, aSize: float) → None

–

Sets the box direction2 vector length.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • aSize (float) – the side 2 length (a double)
setDirection2Spacing(self, aSpacing: float) → None

–

Sets the box direction2 spacing.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • aSpacing (float) – the side 2 spacing (a double)
setDirectionSize(self, index: int, aSize: float) → None

–

Sets a box direction vector length.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • index (int) – the side index (an unsigned short)
  • aSize (float) – the side length (a double)
setDirectionSizeVector(self, pVect: ORSModel.ors.Vector3) → None

–

Parameters:
setDirectionSpacing(self, index: int, aSpacing: float) → None

–

Sets a box direction spacing.

Parameters:
  • self (ORSModel.ors.Box) – an instance of Box
  • index (int) – the side index (an unsigned short)
  • aSpacing (float) – the side spacing (a double)
setDirectionSpacingVector(self, pVect: ORSModel.ors.Vector3) → None

–

Parameters:
setOrigin(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the box origin position.

Parameters:
shape

Camera

class ORSModel.ors.Camera

Bases: ORSModel.ors.Unmanaged

brief_description: The camera object, i.e. the view point from which we look at objects. author: Nicolas Piché. All other members of ORS participated. version: 1.0 date: May 2010

Camera.__init__(self) -> None –

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

Camera.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → Camera

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
copyFrom(self, aCamera: ORSModel.ors.Camera) → None

–

Parameters:
getAngleOfView(self) → float

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : float

getCameraDirection(self) → Vector3

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getCameraLeft(self) → Vector3

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getCameraPivot(self) → Vector3

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getCameraPosition(self) → Vector3

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getCameraRight(self) → Vector3

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getCameraUp(self) → Vector3

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getClassNameStatic() → str

–

:return : :rtype : str

getDepthOfField(self) → float

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : float

getFarRectangle(self) → Rectangle

–

Get camera far plane.

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getFocalLength(self) → float

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : float

getIsEqualTo(self, aCamera: ORSModel.ors.Camera) → bool

–

Parameters:

:return : :rtype : bool

getLineOfSight(self, positionOnView: ORSModel.ors.Vector3) → Line

–

Get the line of sight of the camera from position on screen.

Parameters:
getLineOfSightOrtho(self) → Line

–

Get the line of sight of the camera.

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getNearRectangle(self) → Rectangle

–

Get camera near plane.

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getOrthoZoomFactor(self) → float

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : float

getRectangle(self, fDistance: float) → Rectangle

–

Get camera plane at a given distance in the frustum.

Parameters:
getRotatedAroundAxis(self, rotationAxis: ORSModel.ors.Vector3, rotationPivot: ORSModel.ors.Vector3, angle: float) → Camera

–

Parameters:
getSceneNormalizationMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getSceneNormalizationRotationMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getSceneNormalizationScaleMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getSceneNormalizationTranslationMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getScreenToWorldCoordinate(self, xCoordinate: float, yCoordinate: float) → Vector3

–

Parameters:
  • self (ORSModel.ors.Camera) – an instance of Camera
  • xCoordinate (float) –
  • yCoordinate (float) –
getScreenToWorldDirection(self, xCoordinate: float, yCoordinate: float) → Vector3

–

Parameters:
  • self (ORSModel.ors.Camera) – an instance of Camera
  • xCoordinate (float) –
  • yCoordinate (float) –
getUseOrthoProjection(self) → bool

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : bool

getViewMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera
getViewPortFar(self) → float

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : float

getViewPortHeight(self) → int

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : unsigned int

getViewPortNear(self) → float

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : float

getViewPortTopLeftX(self) → int

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : unsigned int

getViewPortTopLeftY(self) → int

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : unsigned int

getViewPortWidth(self) → int

–

Parameters:self (ORSModel.ors.Camera) – an instance of Camera

:return : :rtype : unsigned int

none() → Camera

–

rotateAroundAxis(self, rotationAxis: ORSModel.ors.Vector3, rotationPivot: ORSModel.ors.Vector3, angle: float) → None

–

Parameters:
setAngleOfView(self, aValue: float) → None

–

Parameters:
setCameraDirection(self, inputVector: ORSModel.ors.Vector3) → None

–

Parameters:
setCameraPivot(self, inputVector: ORSModel.ors.Vector3) → None

–

Parameters:
setCameraPosition(self, inputVector: ORSModel.ors.Vector3) → None

–

Parameters:
setCameraUp(self, inputVector: ORSModel.ors.Vector3) → None

–

Parameters:
setDepthOfField(self, aValue: float) → None

–

Parameters:
setFocalLength(self, aValue: float) → None

–

Parameters:
setFromViewMatrix(self, aMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
setOrthoZoomFactor(self, zoomFactor: float) → None

–

Parameters:
setSceneNormalizationRotationMatrix(self, aMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
setSceneNormalizationScaleMatrix(self, aMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
setSceneNormalizationTranslationMatrix(self, aMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
setUseOrthoProjection(self, aValue: bool) → None

–

Parameters:
setViewPortFar(self, aValue: float) → None

–

Parameters:
setViewPortHeight(self, aValue: int) → None

–

Parameters:
setViewPortNear(self, aValue: float) → None

–

Parameters:
setViewPortTopLeftX(self, aValue: int) → None

–

Parameters:
setViewPortTopLeftY(self, aValue: int) → None

–

Parameters:
setViewPortWidth(self, aValue: int) → None

–

Parameters:

Capsule

class ORSModel.ors.Capsule

Bases: ORSModel.ors.Shape3D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Capsule.__init__(self) -> None –

Parameters:self (ORSModel.ors.Capsule) – an instance of Capsule

Capsule.__init__(self, centerPoint1: ORSModel.ors.Vector3, centerPoint2: ORSModel.ors.Vector3, radius: float) -> None –

Parameters:

Capsule.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
getAxis(self) → Vector3

–

Returns the normal of theCapsule.

Parameters:self (ORSModel.ors.Capsule) – an instance of Capsule
getCap1Center(self) → Vector3

–

Parameters:self (ORSModel.ors.Capsule) – an instance of Capsule
getCap2Center(self) → Vector3

–

Parameters:self (ORSModel.ors.Capsule) – an instance of Capsule
getCenter(self) → Vector3

–

Parameters:self (ORSModel.ors.Capsule) – an instance of Capsule
getClassNameStatic() → str

–

:return : :rtype : str

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → LineSegment

–

Parameters:
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → LineSegment

–

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:
getIsEqualTo(self, Capsule: ORSModel.ors.Capsule) → bool

–

Verifies equality between the receiver and a givenCapsule.

Parameters:

:return : :rtype : bool

getRadius(self) → float

–

Parameters:self (ORSModel.ors.Capsule) – an instance of Capsule

:return : :rtype : float

none() → Capsule

–

setCap1Center(self, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setCap2Center(self, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setCenter(self, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setRadius(self, aRadius: float) → None

–

Parameters:

Channel

class ORSModel.ors.Channel

Bases: ORSModel.ors.StructuredGrid

brief_description: A container for channel data. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: CxvChannel_Description, CxvChannel_Data_Type This is used as a channel data container. Channels are used as 4D data containers, that have a depth, a description, a type, and some spacing for representation. Depth value is directly related to the channel type. To create a channel the XYZT sizes and type must be set before initializing the channel data. The channel must be initialized before the data array is set.

Channel.__init__(self, buffer: int, nBytes: int, preserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • buffer (bytes) –
  • nBytes (int) –
  • preserveIdentity (bool) –

Channel.__init__(self) -> None –

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

Channel.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addSlice(self, pSliceData: ORSModel.ors.Array) → None

–

Adds a slice of data to the channel.

Parameters:
addSuggestedWindowLevelValues(self, pWidth: float, pCenter: float) → None

–

Adds a pair of suggested window width and center values (for leveling).

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pWidth (float) – a window width (a double)
  • pCenter (float) – a window center (a double)
applyLevelingTransformationToData(self, minValue: float, maxValue: float) → None

–

Parameters:
applyLinearTransformationToData(self, slope: float, offset: float) → None

–

Parameters:
convertToType(self, datatype: int, bNormalize: bool, iLowNormalizationRange: float, iHighNormalizationRange: float, bFilter: bool, iLowFilterRange: float, iHighFilterRange: float, iReplacementValue: float, outputChannel: ORSModel.ors.Channel, IProgress: ORSModel.ors.Progress) → Channel

–

Converts the data type of the receiver.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • datatype (int) – the target data type (an unsigned short, see note below)
  • bNormalize (bool) – true to normalize the output
  • iLowNormalizationRange (float) – lower bound of normalization range (a double)
  • iHighNormalizationRange (float) – higher bound of normalization range (a double)
  • bFilter (bool) – true to filter the output
  • iLowFilterRange (float) – lower bound of filter range (a double)
  • iHighFilterRange (float) – higher bound of filter range (a double)
  • iReplacementValue (float) – replacement value for the filter (a double)
  • outputChannel (ORSModel.ors.Channel) – optional output channel. if none, a new channel will be created (a Channel). output channel must have the number of voxels as the input channel and must have the same datatype aas the target type.
  • IProgress (ORSModel.ors.Progress) – a progress object, NULL for no progress (an Progress)
copyDICOMAttributesFrom(self, pInputChannel: ORSModel.ors.Channel, bCopyPrivateAttributes: bool) → None

–

Copies the DICOM attributes from another channel.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pInputChannel (ORSModel.ors.Channel) – the source channel (an Channel)
  • bCopyPrivateAttributes (bool) – true to copy also private attributes, false to exclude them
copyDICOMDatasetForSlice(self, pInputChannel: ORSModel.ors.Channel, iTSource: int, iZSource: int, iTTarget: int, iZTarget: int) → None

–

Copies the DICOM attributes of a given slice to another channel.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pInputChannel (ORSModel.ors.Channel) – the destination channel (an Channel)
  • iTSource (int) – T source index (an unsigned short)
  • iZSource (int) – Z source index (an unsigned short)
  • iTTarget (int) – T target index (an unsigned short)
  • iZTarget (int) – Z target index (an unsigned short)
copyDataFromCommonRegionInto(self, pAChannel: ORSModel.ors.Channel, tOffset: int, nearest: bool, IProgress: ORSModel.ors.Progress, clearValue: bool) → None

–

Copies the data common with another channel into that channel.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pAChannel (ORSModel.ors.Channel) – the companion channel (an Channel)
  • tOffset (int) – the time step to use in the channel (an unsigned short)
  • nearest (bool) – true to sample to nearest value, false to sample linearly
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
  • clearValue (bool) – true to clear the companion channel before copying the channel (a boolean)
copyInto(self, aDestinationChannel: ORSModel.ors.Channel) → None

–

Copies the receiver channel into another channel.

Parameters:
copyShapeFromChannelSubset(self, pISourceChannel: ORSModel.ors.Channel, xmin: int, ymin: int, zmin: int, tmin: int, xmax: int, ymax: int, zmax: int, tmax: int) → None

–

Initializes the channel’s shape based on a subset of another channel.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pISourceChannel (ORSModel.ors.Channel) – a source channel (an Channel)
  • xmin (int) – the X lower range (an unsigned short)
  • ymin (int) – the Y lower range (an unsigned short)
  • zmin (int) – the Z lower range (an unsigned short)
  • tmin (int) – the T lower range (an unsigned short)
  • xmax (int) – the X upper range (an unsigned short)
  • ymax (int) – the Y upper range (an unsigned short)
  • zmax (int) – the Z upper range (an unsigned short)
  • tmax (int) – the T upper range (an unsigned short)
dtype
emptySuggestedWindowLevelValues(self) → None

–

Cleans the suggested window leveling values.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel
classmethod fromNDArray(data, channelGUID='', ZAxis=True, TimeAxis=False) → ORSModel.ors.Channel
getAllSliceIntersectionLength(self, arrayOfIntersectionLengthPerSlice: float, timeStep: int) → float

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • arrayOfIntersectionLengthPerSlice (float) –
  • timeStep (int) –

:return : :rtype : float

getAllSlicesHaveSameOrientation(self, pTIndex: int) → bool

–

Verifies if the channel is consistent in its slice orientations.

Parameters:

:return : :rtype : bool

getAllSlicesHaveSameSize(self) → bool

–

Verifies if the channel has uniform slice sizes.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getAreAllZSlicesDataAvailable(self) → bool

–

Gets the availability of all the Z slices’ data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getAsAbsoluteDifferenceChannel(self, pCompareChannel: ORSModel.ors.Channel, pOutputChannel: ORSModel.ors.Channel, IProgress: ORSModel.ors.Progress) → None

–

Gets a channel of the same type as the receiver containing the absolute difference between the two.

Parameters:
getAsChannelClosedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Creates a new channel wich is the receiver dialted and afterward eroded with the provided kernel.

Parameters:
getAsChannelCrossSection(self, path: ORSModel.ors.VisualPath, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, x: int, y: int, pInChannel: ORSModel.ors.Channel) → Channel

–

Samples the channel data for a given path.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • path (ORSModel.ors.VisualPath) – the path to sample (an VisualPath)
  • iTIndex (int) – an X size (an unsigned short), see note below
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) – a Y size (an unsigned short), see note below
  • x (int) – The T index to be processed (an unsigned short)
  • y (int) – an optional output channel (an Channel)
  • pInChannel (ORSModel.ors.Channel) –
getAsChannelCurved(self, pIInputChannel: ORSModel.ors.Channel, path: ORSModel.ors.VisualPath, aTransformationMatrix: ORSModel.ors.Matrix4x4, forTimeStep: int, xAxisDirectionX: float, xAxisDirectionY: float, xAxisDirectionZ: float, xSize: int, ySize: int, xSpacing: float, bestYSizeAndSpacing: bool, bNearest: bool) → Channel

–

Parameters:
getAsChannelCurvedProjected(self, pIInputChannel: ORSModel.ors.Channel, path: ORSModel.ors.VisualPath, aTransformationMatrix: ORSModel.ors.Matrix4x4, forTimeStep: int, upVect: ORSModel.ors.Vector3, rightVect: ORSModel.ors.Vector3, xSize: int, ySize: int, optimalXSizeAndSpacing: bool, optimalYSizeAndSpacing: bool, zSliceTickness: float, minProjection: bool, maxProjection: bool, averageProjection: bool, stretch: bool, bNearest: bool) → Channel

–

Parameters:
getAsChannelCurvedProjectedRotational(self, pIInputChannel: ORSModel.ors.Channel, path: ORSModel.ors.VisualPath, aTransformationMatrix: ORSModel.ors.Matrix4x4, forTimeStep: int, upVect: ORSModel.ors.Vector3, rightVect: ORSModel.ors.Vector3, xSize: int, numberOfStep: int, bNearest: bool, IProgress: ORSModel.ors.Progress) → Channel

–

Parameters:
getAsChannelCurvedRotational(self, pIInputChannel: ORSModel.ors.Channel, path: ORSModel.ors.VisualPath, aTransformationMatrix: ORSModel.ors.Matrix4x4, forTimeStep: int, normalX: float, normalY: float, normalZ: float, downX: float, downY: float, downZ: float, xSize: int, ySize: int, numberOfStep: int, xSpacing: float, bestYSizeAndSpacing: bool) → Channel

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pIInputChannel (ORSModel.ors.Channel) –
  • path (ORSModel.ors.VisualPath) –
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) –
  • forTimeStep (int) –
  • normalX (float) –
  • normalY (float) –
  • normalZ (float) –
  • downX (float) –
  • downY (float) –
  • downZ (float) –
  • xSize (int) –
  • ySize (int) –
  • numberOfStep (int) –
  • xSpacing (float) –
  • bestYSizeAndSpacing (bool) –
getAsChannelCutAlongZWithNormal(self, normal: ORSModel.ors.Vector3, timeStep: int, outXSizeInworld: float, nearest: bool, inputChannel: ORSModel.ors.Channel) → Channel

–

Parameters:
getAsChannelCutAlongZWithNormalCurved(self, InputPath: ORSModel.ors.VisualPath, aTransformationMatrix: ORSModel.ors.Matrix4x4, normal: ORSModel.ors.Vector3, timeStep: int, outXSizeInworld: float, nearest: bool, inputChannel: ORSModel.ors.Channel) → Channel

–

Parameters:
getAsChannelDilatedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Creates a new channel wich is the receiver dilated with the provided kernel.

Parameters:
getAsChannelDilatedWithKernelInRange(self, pKernel: ORSModel.ors.ConvolutionKernel, zmin: int, zmax: int, zOffsetInputToOutput: int, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Computes the dilation of the input channel in a range of slices.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pKernel (ORSModel.ors.ConvolutionKernel) – the dilatation kernel made of 0 or 1 (an ConvolutionKernel)
  • zmin (int) – the index of the first slice to compute the dilation on
  • zmax (int) – the index of the last slice to compute the dilation on
  • zOffsetInputToOutput (int) – the number of slices of offset (the dilation on the slice Z of the input channel will be written at the slice “Z-offset” in the output channel)
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress
  • pOutChannel (ORSModel.ors.Channel) – the channel to put the result in (cannot be the receiver) (an Channel)
getAsChannelEmptyCrossSection(self, path: ORSModel.ors.VisualPath, aTransformationMatrix: ORSModel.ors.Matrix4x4, x: int, y: int, z: int, timeStep: int, pInChannel: ORSModel.ors.Channel) → Channel

–

Samples the channel data for a given path.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • path (ORSModel.ors.VisualPath) – the path to sample (an VisualPath)
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) – an X size (an int), see note below
  • x (int) – a Y size (an int), see note below
  • y (int) – true to have the channel contain the voxel indicies, false to contain the voxel themselves
  • z (int) – an optional output channel (an Channel)
  • timeStep (int) –
  • pInChannel (ORSModel.ors.Channel) –
getAsChannelErodedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Creates a new channel wich is the receiver eroded with the provided kernel.

Parameters:
getAsChannelErodedWithKernelInRange(self, pKernel: ORSModel.ors.ConvolutionKernel, zmin: int, zmax: int, zOffsetInputToOutput: int, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Computes the erosion of the input channel in a range of slices.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pKernel (ORSModel.ors.ConvolutionKernel) – the erosion kernel made of 0 or 1 (an ConvolutionKernel)
  • zmin (int) – the index of the first slice to compute the erosion on
  • zmax (int) – the index of the last slice to compute the erosion on
  • zOffsetInputToOutput (int) – the number of slices of offset (the erosion on the slice Z of the input channel will be written at the slice “Z-offset” in the output channel)
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress
  • pOutChannel (ORSModel.ors.Channel) – the channel to put the result in (cannot be the receiver) (an Channel)
getAsChannelFromMean(self, pBoxSize: int, pOutChannel: ORSModel.ors.Channel) → Channel

–

Finds the mean in a box surrounding each voxel and writes it to the channel.

Parameters:
getAsChannelFromROI(self, pInputROI: ORSModel.ors.ROI, pOutChannel: ORSModel.ors.Channel) → Channel

–

Creates a new channel from a given Region of Interest.

Parameters:
Returns:

pOutChannel (ORSModel.ors.Channel) – an optional output channel (an Channel)
getAsChannelGaussianSmoothed(self, kernelSize: int, pOutChannel: ORSModel.ors.Channel) → Channel

–

Applies a 2 sigma gaussian convolution.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • kernelSize (int) – the kernel size (an unsigned char, should be an odd number)
  • pOutChannel (ORSModel.ors.Channel) – an optional output channel (an ORSChannelPtr)
getAsChannelObliqueAverageFromRectangleBetweenPlanes(self, pIInputChannel: ORSModel.ors.Channel, forTimeStep: int, aBoundedPlane: ORSModel.ors.Rectangle, startPlane: ORSModel.ors.Plane, endPlane: ORSModel.ors.Plane, xSize: int, ySize: int, nbZSlice: int, zSliceThickness: float, fitOnData: bool, uniformSpacing: bool, bOptimalSizeAndSpacingInXY: bool, bOptimalSizeAndSpacingInZ: bool, nearest: bool, IProgress: ORSModel.ors.Progress) → Channel

–

Parameters:
getAsChannelObliqueFromRectangleBetweenPlanes(self, pIInputChannel: ORSModel.ors.Channel, forTimeStep: int, aBoundedPlane: ORSModel.ors.Rectangle, startPlane: ORSModel.ors.Plane, endPlane: ORSModel.ors.Plane, xSize: int, ySize: int, nbZSlice: int, fitOnData: bool, uniformSpacing: bool, bOptimalSizeAndSpacingInXY: bool, bOptimalSizeAndSpacingInZ: bool, nearest: bool, IProgress: ORSModel.ors.Progress) → Channel

–

Parameters:
getAsChannelObliqueMaxIntensityProjectionFromRectangleBetweenPlanes(self, pIInputChannel: ORSModel.ors.Channel, forTimeStep: int, aBoundedPlane: ORSModel.ors.Rectangle, startPlane: ORSModel.ors.Plane, endPlane: ORSModel.ors.Plane, xSize: int, ySize: int, nbZSlice: int, zSliceThickness: float, fitOnData: bool, uniformSpacing: bool, bOptimalSizeAndSpacingInXY: bool, bOptimalSizeAndSpacingInZ: bool, nearest: bool, IProgress: ORSModel.ors.Progress) → Channel

–

Parameters:
getAsChannelObliqueMinIntensityProjectionFromRectangleBetweenPlanes(self, pIInputChannel: ORSModel.ors.Channel, forTimeStep: int, aBoundedPlane: ORSModel.ors.Rectangle, startPlane: ORSModel.ors.Plane, endPlane: ORSModel.ors.Plane, xSize: int, ySize: int, nbZSlice: int, zSliceThickness: float, fitOnData: bool, uniformSpacing: bool, bOptimalSizeAndSpacingInXY: bool, bOptimalSizeAndSpacingInZ: bool, nearest: bool, IProgress: ORSModel.ors.Progress) → Channel

–

Parameters:
getAsChannelOpenWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Creates a new channel wich is the receiver eroded and afterward dialted with the provided kernel.

Parameters:
getAsChannelPadded(self, xPadd: int, yPadd: int, zPadd: int, pValue: float, pOutChannel: ORSModel.ors.Channel) → Channel

–

Pads the channel with a normalized value.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • xPadd (int) – the X padding in pixels (an unsigned short, see note below)
  • yPadd (int) – the Y padding in pixels (an unsigned short, see note below)
  • zPadd (int) – the Z padding in pixels (an unsigned short, see note below)
  • pValue (float) – the padding value, normalized (a double)
  • pOutChannel (ORSModel.ors.Channel) – an optional output channel (an ORSChannelPtr)
getAsChannelSampled(self, samplingMethod: int, newXSize: int, newYSize: int, newZSize: int, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Samples the channel according to a sampling method.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • samplingMethod (int) – a CxvSamplingMethod (an unsigned short)
  • newXSize (int) – the new X size (an unsigned short)
  • newYSize (int) – the new Y size (an unsigned short)
  • newZSize (int) – the new Z size (an unsigned short)
  • IProgress (ORSModel.ors.Progress) – progress object (NULL for no progress bar)
  • pOutChannel (ORSModel.ors.Channel) – a target channel (an Channel)
getAsChannelSampledConverted(self, samplingMethod: int, newXSize: int, newYSize: int, newZSize: int, datatype: int, bNormalize: bool, iLowNormalizationRange: float, iHighNormalizationRange: float, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Samples the channel according to a sampling method, and converts its type.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • samplingMethod (int) – a CxvSamplingMethod (an unsigned char)
  • newXSize (int) – the new X size (an unsigned short)
  • newYSize (int) – the new Y size (an unsigned short)
  • newZSize (int) – the new Z size (an unsigned short)
  • datatype (int) – the target data type (an unsigned char, see note below)
  • bNormalize (bool) – true to normalize the output
  • iLowNormalizationRange (float) – lower bound of normalization range (a double)
  • iHighNormalizationRange (float) – higher bound of normalization range (a double)
  • IProgress (ORSModel.ors.Progress) – progress object (NULL for no progress bar)
  • pOutChannel (ORSModel.ors.Channel) – a target channel (an Channel)
getAsChannelSampledInterpolatedFromPlane(self, a: float, b: float, c: float, d: float, upX: float, upY: float, upZ: float, timeStep: int, pInChannel: ORSModel.ors.Channel) → Channel

–

Samples the channel data for a given plane, interpolating the voxels.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • a (float) – The bounded plane
  • b (float) – true to have the channel contain the voxel indicies, false to contain the voxel themselves
  • c (float) – an optional output channel (an Channel)
  • d (float) –
  • upX (float) –
  • upY (float) –
  • upZ (float) –
  • timeStep (int) –
  • pInChannel (ORSModel.ors.Channel) –
getAsChannelSampledInterpolatedFromPlane2(self, aBoundedPlane: ORSModel.ors.Rectangle, nearest: bool, timeStep: int, pInChannel: ORSModel.ors.Channel) → Channel

–

Samples the channel data for a given plane, interpolating the voxels.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • aBoundedPlane (ORSModel.ors.Rectangle) – The bounded plane
  • nearest (bool) – true to have the channel contain the voxel indicies, false to contain the voxel themselves
  • timeStep (int) – an optional output channel (an Channel)
  • pInChannel (ORSModel.ors.Channel) –
getAsChannelWithEqualizedHistogram(self, anHistogram: ORSModel.ors.HistogramData, normalizeData: bool, zmin: int, zmax: int, zOffsetInputToOutput: int, pIOutputChannel: ORSModel.ors.Channel) → Channel

–

Creates a new channel with the data of the receiver transformed to equalize its histogram.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • anHistogram (ORSModel.ors.HistogramData) – histogram to be used for the equalization (OPTIONAL)
  • normalizeData (bool) – true if the output has to be normalized to the total spread of the data type (unsigned char [0,255] unsigned short [0,65535] float[0,1])
  • zmin (int) – the channel to be filled with the result (can be the receiver ) (an Channel)
  • zmax (int) –
  • zOffsetInputToOutput (int) –
  • pIOutputChannel (ORSModel.ors.Channel) –
getAsChannelWithinRange(self, minValue: float, maxValue: float, lowerReplacementValue: float, upReplacementValue: float, pIInputChannel: ORSModel.ors.Channel) → Channel

–

Creates a new channel within a given range.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • minValue (float) – the lower boundary of the range (a double)
  • maxValue (float) – the upper boundary of the range (a double)
  • lowerReplacementValue (float) – the lower replacement value (a double, see note)
  • upReplacementValue (float) – the upper replacement value (a double, see note)
Returns:

pIInputChannel (ORSModel.ors.Channel) – an optional output channel (an Channel)
getAsMarchingCubeMesh(self, isovalue: float, bSnapToContour: bool, flipNormal: bool, timeStep: int, xSample: int, ySample: int, zSample: int, pNearest: bool, pWorld: bool, pProgress: ORSModel.ors.Progress, pMesh: ORSModel.ors.Mesh) → Mesh

–

Creates a marching cube from the channel.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • isovalue (float) – an isovalue (a double)
  • bSnapToContour (bool) – true to snap vertices to contour, false to interpolate
  • flipNormal (bool) – true flips normals, false doesn’t
  • timeStep (int) – the time step to use in the channel (an unsigned short)
  • xSample (int) – the X sampling (an unsigned short, 1 means no sampling)
  • ySample (int) – the Y sampling (an unsigned short, 1 means no sampling)
  • zSample (int) – the Z sampling (an unsigned short, 1 means no sampling)
  • pNearest (bool) – true to sample to nearest value, false to sample linearly (if sampling is 1 this flag is ignored)
  • pWorld (bool) – true to have the resulting mesh in world coordinates, false in local
  • pProgress (ORSModel.ors.Progress) – a progress object (an ORSProgressPtr) to show a progress bar, NULL doesn’t show one
Returns:

pMesh (ORSModel.ors.Mesh) – an optional output mesh model (an ORSMeshPtr)
getAsMultiROIInArea(self, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, IProgress: ORSModel.ors.Progress, pInputMultiROI: ORSModel.ors.MultiROI) → MultiROI

–

Creates a labeled region of interest (MultiROI) from a specified channel area, within supplied ranges.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • minX (int) – an X minimum coordinate, in pixel size (an unsigned short)
  • minY (int) – a Y minimum coordinate, in pixel size (an unsigned short)
  • minZ (int) – a Z minimum coordinate, in pixel size (an unsigned short)
  • maxX (int) – an X maximum coordinate, in pixel size (an unsigned short)
  • maxY (int) – a Y maximum coordinate, in pixel size (an unsigned short)
  • maxZ (int) – a Z maximum coordinate, in pixel size (an unsigned short)
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress
  • pInputMultiROI (ORSModel.ors.MultiROI) – a target ROI (an ROI)
getAsROIWithinRange(self, minValue: float, maxValue: float, IProgress: ORSModel.ors.Progress, pInputROI: ORSModel.ors.ROI) → ROI

–

Creates a region of interest (ROI) from all the channel data within a given range.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • minValue (float) – the lower range, a normalized value (a double)
  • maxValue (float) – the upper range, a normalized value (a double)
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress
  • pInputROI (ORSModel.ors.ROI) – a target ROI (an ROI)
getAsROIWithinRangeInArea(self, minValue: float, maxValue: float, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, IProgress: ORSModel.ors.Progress, pOutputROI: ORSModel.ors.ROI) → ROI

–

Creates a region of interest (ROI) from a specified channel area, within a range.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • minValue (float) – the lower range, a normalized value (a double)
  • maxValue (float) – the upper range, a normalized value (a double)
  • minX (int) – an X minimum coordinate, in pixel size (an unsigned short)
  • minY (int) – a Y minimum coordinate, in pixel size (an unsigned short)
  • minZ (int) – a Z minimum coordinate, in pixel size (an unsigned short)
  • maxX (int) – an X maximum coordinate, in pixel size (an unsigned short)
  • maxY (int) – a Y maximum coordinate, in pixel size (an unsigned short)
  • maxZ (int) – a Z maximum coordinate, in pixel size (an unsigned short)
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress
  • pOutputROI (ORSModel.ors.ROI) – a target ROI (an ROI)
getAsROIWithinRanges(self, rangeDuplets: float, nbRangeDuplets: int, IProgress: ORSModel.ors.Progress, pInputROI: ORSModel.ors.ROI) → ROI

–

Creates a region of interest (ROI) from all the channel data within the given ranges.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • rangeDuplets (float) – the pairs of ranges (a double*)
  • nbRangeDuplets (int) – number of pairs (an unsigned short), so rangeDuplet size should be nbRangeDuplet*2
  • IProgress (ORSModel.ors.Progress) – a target ROI (an ROI)
  • pInputROI (ORSModel.ors.ROI) – a progress object (an Progress) or NULL for no progress
getAsROIWithinRangesInArea(self, rangeDuplet: float, nbRangeDuplet: int, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, IProgress: ORSModel.ors.Progress, pInputROI: ORSModel.ors.ROI) → ROI

–

Creates a region of interest (ROI) from a specified channel area, within supplied ranges.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • rangeDuplet (float) – the pairs of ranges (a double*)
  • nbRangeDuplet (int) – number of pairs (an unsigned short), so rangeDuplet size should be nbRangeDuplet*2
  • minX (int) – an X minimum coordinate, in pixel size (an unsigned short)
  • minY (int) – a Y minimum coordinate, in pixel size (an unsigned short)
  • minZ (int) – a Z minimum coordinate, in pixel size (an unsigned short)
  • maxX (int) – an X maximum coordinate, in pixel size (an unsigned short)
  • maxY (int) – a Y maximum coordinate, in pixel size (an unsigned short)
  • maxZ (int) – a Z maximum coordinate, in pixel size (an unsigned short)
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress
  • pInputROI (ORSModel.ors.ROI) – a target ROI (an ROI)
getBitCount(self) → int

–

Gets the number of bits used to represent one pixel.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getByteCountPerSample(self) → int

–

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getChannelLocalMaxAsROI(self, pKernel: ORSModel.ors.ConvolutionKernel, fMinValue: float, fMaxValue: float, pOutROI: ORSModel.ors.ROI) → ROI

–

Find the local maximum of a dataset and returns it into a volumeROI.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pKernel (ORSModel.ors.ConvolutionKernel) – a minimum thresholdValue under which the localMax found are ignored (double)
  • fMinValue (float) – a maximum thresholdValue over which the localMax found are ignored (double)
  • fMaxValue (float) – an output ROI
  • pOutROI (ORSModel.ors.ROI) –
getChannelLocalMinAsROI(self, pKernel: ORSModel.ors.ConvolutionKernel, fMinValue: float, fMaxValue: float, pOutROI: ORSModel.ors.ROI) → ROI

–

Find the local minimum of a dataset and returns it into a volumeROI.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pKernel (ORSModel.ors.ConvolutionKernel) – a minimum thresholdValue under which the localMin found are ignored (double)
  • fMinValue (float) – a maximum thresholdValue over which the localMin found are ignored (double)
  • fMaxValue (float) – an output ROI
  • pOutROI (ORSModel.ors.ROI) –
classmethod getClassDenomination()
getClassNameStatic() → str

–

:return : :rtype : str

getClassicalStandardDeviation(self) → float

–

Computes the standard deviation.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getClipBox(timestep=0, display=None)

Gets the clip box of the channel

Parameters:
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 channel

Parameters:
Returns:
getDICOMAttribute(self, iTIndex: int, iZIndex: int, pGroup: int, pElement: int, bSearchSubs: bool) → str

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) –
  • iZIndex (int) –
  • pGroup (int) –
  • pElement (int) –
  • bSearchSubs (bool) –

:return : :rtype : str

getDICOMAttributeAsDouble(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bSearchSubs: bool) → float

–

Retrieves a DICOM attribute as a double.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : float

getDICOMAttributeAsFloat(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bSearchSubs: bool) → float

–

Retrieves a DICOM attribute as a float.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : float

getDICOMAttributeAsInt(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bSearchSubs: bool) → int

–

Retrieves a DICOM attribute as a signed 32 bit number.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : int

getDICOMAttributeAsShort(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bSearchSubs: bool) → int

–

Retrieves a DICOM attribute as a signed 16 bit number.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : int

getDICOMAttributeAsUnsignedChar(self, iTIndex: int, iZIndex: int, pGroup: int, pElement: int, iIndex: int, bSearchSubs: bool) → int

–

Retrieves a DICOM attribute as an unsigned 8 bit number.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • pGroup (int) – the group number (an unsigned short)
  • pElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : int

getDICOMAttributeAsUnsignedInt(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bSearchSubs: bool) → int

–

Retrieves a DICOM attribute as an unsigned 32 bit number.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : unsigned int

getDICOMAttributeAsUnsignedShort(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bSearchSubs: bool) → int

–

Retrieves a DICOM attribute as an unsigned 16 bit number.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : int

getDICOMAttributeFromSequence(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iItemNo: int, iElementGroup: int, iElementElement: int) → str

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) –
  • iZIndex (int) –
  • iGroup (int) –
  • iElement (int) –
  • iItemNo (int) –
  • iElementGroup (int) –
  • iElementElement (int) –

:return : :rtype : str

getDICOMContainer(self, iTIndex: int, iZIndex: int) → str

–

Parameters:

:return : :rtype : str

getDataDescription(self) → int

–

Gets the channel description.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getDataRange(self) → float

–

Gets the size of the spread of data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getDataType(self) → int

–

Gets the channel data type.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getDataUnit(self) → str

–

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : str

getHasDICOMAttributes(self) → bool

–

Checks to see if the channel has DICOM attributes.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getHasOverlayData(self, iTIndex: int, iZIndex: int) → bool

–

Checks to see if overlay data exists at a given Z slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the Z slice index (an unsigned short)

:return : :rtype : bool

getHasSliceOrientationAndPosition(self) → bool

–

Queries the channel to know if it has slice orientation and position.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getInitialWindowLevelCenter(self) → float

–

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getInitialWindowLevelWidth(self) → float

–

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getInterpolatedLineSegment(self, pLineSegment: ORSModel.ors.LineSegment, nTIndex: int, fSpacing: float, nInterpolationMethod: int, values: ORSModel.ors.Array) → Array

–

Parameters:
getInterpolatedPositionOnSlice(self, pTIndex: int, pZSlice: float, xPos: float, yPos: float) → Vector3

–

Gets the interpolated position of a point on a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (float) – the Z slice index (a double)
  • xPos (float) – the X voxel position (a double)
  • yPos (float) – the Y voxel position (a double)
getInterpolatedValuesAtPositions(self, aWorldCoordinate: ORSModel.ors.ArrayDouble, tIndex: int, nInterpolationMethod: int, values: ORSModel.ors.Array) → Array

–

Parameters:
getInterpolatedValuesAtPositionsConvertedToPhysicalUnits(self, aWorldCoordinate: ORSModel.ors.ArrayDouble, tIndex: int, nInterpolationMethod: int, values: ORSModel.ors.ArrayDouble) → ArrayDouble

–

Parameters:
getIsClipped(timestep=0, display=None)

Gets to know if the clip box of the channel is active

Parameters:
Returns:

isClipped (bool) – if True, the clip box of the channel is visible; False otherwise.
getIsData3D(self) → bool

–

Verifies if the channel holds 3D data or not.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getIsDataInitialized(self) → bool

–

Checks if the internal data is initialized.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getIsLossy(self) → bool

–

Verifies if the channel is lossy or not.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getIsMarkedSlice(self, pTIndex: int, pZSlice: int) → bool

–

Checks to see if a slice is marked or not.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)

:return : :rtype : bool

getIsZSliceDataAvailable(self, pTIndex: int, pZSlice: int) → bool

–

Gets the availability of a Z slice’s data.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)

:return : :rtype : bool

getLabelization(self, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, iTIndex: int, min: float, max: float, considerDiagonal: bool, IProgress: ORSModel.ors.Progress, pInVolumeROI: ORSModel.ors.ROI, pOutData: ORSModel.ors.MultiROI) → MultiROI

–

Labels the channel data.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • minX (int) – the minimum X range (an unsigned short)
  • minY (int) – the minimum Y range (an unsigned short)
  • minZ (int) – the minimum Z range (an unsigned short)
  • maxX (int) – the maximum X range (an unsigned short)
  • maxY (int) – the maximum Y range (an unsigned short)
  • maxZ (int) – the maximum Z range (an unsigned short)
  • iTIndex (int) – the T index (an unsigned short)
  • min (float) – the minimum data range (a double)
  • max (float) – the maximum data range (a double)
  • considerDiagonal (bool) – true to consider diagonals, false otherwise
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress
  • pInVolumeROI (ORSModel.ors.ROI) – an optional input mask (an ROI)
  • pOutData (ORSModel.ors.MultiROI) – an optional output object (an MultiROI)
getLineBoundedDoublePlane(self, pT: int, iZSlice: int, iYLine: int) → Rectangle

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pT (int) –
  • iZSlice (int) –
  • iYLine (int) –
getMarkedSlicesCount(self) → int

–

Gets the count of marked slices.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getMaximumValue(self) → float

–

Gets the maximum value found in the data array, always returned as a double.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getMeanValue(self) → float

–

Gets the mean value computed with the data array, always returned as a double.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getMinMaxSubsetAsVector(self, xmin: int, ymin: int, zmin: int, tmin: int, xmax: int, ymax: int, zmax: int, tmax: int) → Vector3

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • xmin (int) –
  • ymin (int) –
  • zmin (int) –
  • tmin (int) –
  • xmax (int) –
  • ymax (int) –
  • zmax (int) –
  • tmax (int) –
getMinimumValue(self) → float

–

Gets the minimum value found in the channel, always returned as a double.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getNDArray(timestep=0)
getNormalizedMaxPossibleValue(self) → float

–

Gets the normalized maximum possible value, according to the channel’s data type.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getNormalizedMinPossibleValue(self) → float

–

Gets the normalized minimum possible value, according to the channel’s data type.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getNormalizedValueAt(self, x: int, y: int, z: int, t: int) → float

–

Gets the normalized data value at the specified coordinate.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • x (int) – X coordinate (an unsigned short)
  • y (int) – Y coordinate (an unsigned short)
  • z (int) – Z coordinate (an unsigned short)
  • t (int) – T coordinate (an unsigned short)

:return : :rtype : float

getNumberOfSuggestedWindowLevelValues(self) → int

–

Returns the number of known pairs of suggested window width and center values (for leveling).

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getOffset(self) → float

–

Gets the channel offset.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getOrientationComparisonPrecision(self) → float

–

Gets the channel’s orientation comparison precision.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getOverlayData(self, iTIndex: int, iZIndex: int, pStartRow: int, pStartCol: int, pOverlayRows: int, pOverlayCols: int) → ArrayUnsignedChar

–

Gets the overlay data for a given Z slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the Z slice index (an unsigned short)
Returns:
  • pStartRow (int) – the starting row of the overlay data (a short, see note)
  • pStartCol (int) – the starting column of the overlay data (a short, see note)
  • pOverlayRows (int) – the number of rows of overlay data (a short)
  • pOverlayCols (int) – the number of colums of overlay data (a short)
getPhysicalMax(self) → float

–

Gets the maximum value found in the data array, always returned as a float.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getPhysicalMin(self) → float

–

Gets the minimum value found in the data array, always returned as a float.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getPositionOnLine(self, pT: int, iZSlice: int, iYLine: int, xIndex: float) → Vector3

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pT (int) –
  • iZSlice (int) –
  • iYLine (int) –
  • xIndex (float) –
getPositionOnSlice(self, pTIndex: int, pZSlice: int, xPos: int, yPos: int) → Vector3

–

Gets the position of a point on a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
  • xPos (int) – the X voxel position (an unsigned short)
  • yPos (int) – the Y voxel position (an unsigned short)
getRawDataChunk(self, iLevel1: int, iLevel2: int) → None

–

Gets a portion of the channel’s data.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iLevel1 (int) – the T index (an unsigned short)
  • iLevel2 (int) – the Z index (an unsigned short)
getSampledLine(self, pPoint1: ORSModel.ors.Vector3, pPoint2: ORSModel.ors.Vector3, timeStep: int) → ArrayDouble

–

Samples the channel data between two points.

Parameters:
getSampledLineOfNPoints(self, pPoint1: ORSModel.ors.Vector3, pPoint2: ORSModel.ors.Vector3, timeStep: int, nbOutputPoint: int) → ArrayDouble

–

Samples the channel data between two points.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pPoint1 (ORSModel.ors.Vector3) – a starting coordinate (an ORSVector3Ptr)
  • pPoint2 (ORSModel.ors.Vector3) – an ending coordinate (an ORSVector3Ptr)
  • timeStep (int) – the timestep (an unsigned short)
  • nbOutputPoint (int) – the number of points required (an int)
getSavePixelDataWhileSavingNode(self) → int

–

Gets if and how the channel should save its pixel data to XML.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getSerieHasBeenModified(self) → bool

–

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getSliceDirection0Size(self, timeStep: int, sliceIndex: int) → float

–

Parameters:

:return : :rtype : float

getSliceDirection0Spacing(self, timeStep: int, sliceIndex: int) → float

–

Parameters:

:return : :rtype : float

getSliceDirection1Size(self, timeStep: int, sliceIndex: int) → float

–

Parameters:

:return : :rtype : float

getSliceDirection1Spacing(self, timeStep: int, sliceIndex: int) → float

–

Parameters:

:return : :rtype : float

getSliceIntersectionLength(self, timeStep: int, sliceIndex: int) → float

–

Parameters:

:return : :rtype : float

getSliceOrientation(self, pTIndex: int, pZSlice: int, index: int) → float

–

Gets the orientation of a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
  • index (int) – an index (from 0 to 9)

:return : :rtype : float

getSlicePosition(self, pTIndex: int, pZSlice: int) → Vector3

–

Gets the position of a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
getSliceRectangle(self, timeStep: int, sliceIndex: int) → Rectangle

–

Parameters:
getSliceSize(self, pTIndex: int, pZSlice: int, iXSize: int, iYSize: int) → None

–

Gets the size of a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
Returns:
  • iXSize (int) – slice X size (an unsigned short)
  • iYSize (int) – slice Y size (an unsigned short)
getSlope(self) → float

–

Gets the channel slope.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : float

getSpacingXValidity(self) → bool

–

Checks if X spacing is valid.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getSpacingYValidity(self) → bool

–

Checks if Y spacing is valid.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getSpacingZValidity(self) → bool

–

Checks if Z spacing is valid.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

getSuggestedWindowLevelCenterAt(self, pIndex: int) → float

–

Gets the Nth suggested window venter value (for leveling).

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pIndex (int) – the index (an unsigned short)

:return : :rtype : float

getSuggestedWindowLevelWidthAt(self, pIndex: int) → float

–

Gets the Nth suggested window width value (for leveling).

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pIndex (int) – the index (an unsigned char)

:return : :rtype : float

getTRawDataChunk(self, iLevel1: int) → int

–

Gets a T portion of the channel’s data.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iLevel1 (int) – the T index (an unsigned short)

:return : :rtype : int

getTimeFrame(self, pTimeStep: int, pYear: int, pMonth: int, pDay: int, pHour: int, pMinutes: int, pSeconds: int, pMicroSeconds: int) → None

–

Gets the value of a time frame.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTimeStep (int) – the T index (an unsigned short)
Returns:
  • pYear (int) – the year (an unsigned short*)
  • pMonth (int) – the month (an unsigned short*)
  • pDay (int) – the day (an unsigned short*)
  • pHour (int) – the hour (an unsigned short*)
  • pMinutes (int) – the minutes (an unsigned short*)
  • pSeconds (int) – the seconds (an unsigned short*)
  • pMicroSeconds (int) – the microseconds (an unsigned int*)
getTotalByteCount(self) → int

–

Gets the total number of bytes in the internal data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : int

getTotalSliceIntersectionLength(self, timeStep: int) → float

–

Parameters:

:return : :rtype : float

getTransformationToGoTo(self, pInChannel: ORSModel.ors.Channel) → Matrix4x4

–

Parameters:
getTypeDescription(self) → str

–

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : str

getValueAsDoubleAtIndex(self, xIndex: int, yIndex: int, zIndex: int, tIndex: int) → float

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • xIndex (int) –
  • yIndex (int) –
  • zIndex (int) –
  • tIndex (int) –

:return : :rtype : float

getValueAsDoubleAtWorldCoordinateNearest(self, aWorldCoordinate: ORSModel.ors.Vector3, tIndex: int) → float

–

Parameters:

:return : :rtype : float

getValueConvertedFromPhysicalUnits(self, pInput: float) → float

–

Converts a value from physical units to channel units.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pInput (float) – the value to convert (a double)

:return : :rtype : float

getValueConvertedToPhysicalUnits(self, pInput: float) → float

–

Converts a value from channel units to physical units.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pInput (float) – the value to convert (a double)

:return : :rtype : float

hasDICOMAttribute(self, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, bSearchSubs: bool) → bool

–

Verifies the existence of a DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • bSearchSubs (bool) – true to search sequences, false otherwise

:return : :rtype : bool

initializeData(self) → bool

–

Initializes the channel’s internal data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

initializeDataForFLOAT(self) → bool

–

Initializes the channel data array for 32 bit float data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

initializeDataForUCHAR(self) → bool

–

Initializes the channel data array for 8 bit unsigned data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

initializeDataForUINT(self) → bool

–

Initializes the channel data array for 32 bit unsigned int data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

initializeDataForUSHORT(self) → bool

–

Initializes the channel data array for 16 bit unsigned integer data.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel

:return : :rtype : bool

invert(self, invertX: bool, invertY: bool, invertZ: bool, invertData: bool, axisTransformation: int, IProgress: ORSModel.ors.Progress, IOutputChannel: ORSModel.ors.Channel) → Channel

–

Inverts the receiver.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • invertX (bool) – true to invert the X axis
  • invertY (bool) – true to invert the Y axis
  • invertZ (bool) – true to invert the Z axis
  • invertData (bool) – true to invert the data
  • axisTransformation (int) – an axis transformation code (an unsigned short), between 0 and 5 (see note)
  • IProgress (ORSModel.ors.Progress) – a progress object, NULL for no progress (an Progress)
  • IOutputChannel (ORSModel.ors.Channel) – an optional output channel (an Channel)
iterateDICOMAttributes(self, iTIndex: int, iZIndex: int, callbackFunction: int, userdata: int) → None

–

Iterates through the DICOM attributes, calling a callback function.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the slice index (an unsigned short)
  • callbackFunction (int) – a callback function (the address of a ORSCHANNELDICOMATTRIBUTESITERATOR function)
  • userdata (bytes) – any user data to be supplied to the callback function
mergeWithBAndProjectInC(self, channelB: ORSModel.ors.Channel, channelC: ORSModel.ors.Channel, IProgress: ORSModel.ors.Progress) → None

–

Merges the channel with another channel, feeding a third channel.

Parameters:
moveChannelDataInto(self, otherChannel: ORSModel.ors.Channel) → bool

–

move the data from the left channel to the right channel channel

Parameters:

:return : :rtype : bool

moveSlicedata(self, zIndex: int, timeStep: int, xTranslation: int, yTranslation: int) → None

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • zIndex (int) –
  • timeStep (int) –
  • xTranslation (int) –
  • yTranslation (int) –
none() → Channel

–

ones(aShape, dtype=<class 'numpy.uint8'>)
overwriteRangeWithValue(self, minValue: float, maxValue: float, replacementValue: float) → None

–

Overwrites data within a range with a given value.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • minValue (float) – the minimum range value (a double, see note below), non-inclusive
  • maxValue (float) – the maximum range value (a double, see note below), non-inclusive
  • replacementValue (float) – the replacement value (a double, see note below)
overwriteValueAtIndicies(self, indices: int, indicesSize: int, repValue: float) → None

–

Overwrites the channel data at the specified indicies with a supplied (normalized) value.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • indices (int) – an array of data indicies (an array of int64_t)
  • indicesSize (int) – the array element count (an uint32_t)
  • repValue (float) – the replacement value (a double)
overwriteValueAtWorldCoordinates(self, positionTriplets: float, nbTriplet: int, tIndex: int, replacementValue: float) → None

–

Overwrites the values at positions specified by world triplets and time T.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • positionTriplets (float) – An array of world coordinates triplets (a double*)
  • nbTriplet (int) – The number of triplets in the above array (an uint32_t)
  • tIndex (int) – The T index to be processed (an unsigned short)
  • replacementValue (float) – The replacement value (a double)
overwriteValueWithMultiROI(self, aMultiROI: ORSModel.ors.MultiROI, labelOffset: int) → None

–

Overwrites the channel data at a givenMultiROI.

Parameters:
overwriteValueWithMultiROIConsideringOpacity(self, aMultiROI: ORSModel.ors.MultiROI, labelOffset: int, fHightlightOpacity: float, fHightlightOpacityOutRange: float, fROIOpacity: float, fROIOpacityOutRange: float) → None

–

Overwrites the channel data at a givenMultiROI.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • aMultiROI (ORSModel.ors.MultiROI) – a MultiROI (an MultiROI)
  • labelOffset (int) – the label offset (an uint32_t)
  • fHightlightOpacity (float) –
  • fHightlightOpacityOutRange (float) –
  • fROIOpacity (float) –
  • fROIOpacityOutRange (float) –
overwriteValueWithMultiROIOnSubBox(self, aVolumeROI: ORSModel.ors.MultiROI, labelOffset: int, subBox: ORSModel.ors.Box, iTIndex: int) → None

–

Overwrites the channel data at a givenMultiROI included in the given box.

Parameters:
overwriteValueWithMultiROIOnSubBoxConsideringOpacity(self, aVolumeROI: ORSModel.ors.MultiROI, labelOffset: int, subBox: ORSModel.ors.Box, fHightlightOpacity: float, fHightlightOpacityOutRange: float, fROIOpacity: float, fROIOpacityOutRange: float, iTIndex: int) → None

–

Overwrites the channel data at a givenMultiROI included in the given box.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • aVolumeROI (ORSModel.ors.MultiROI) – a MultiROI (an MultiROI)
  • labelOffset (int) – the label offset (an uint32_t)
  • subBox (ORSModel.ors.Box) – the box (a Box)
  • fHightlightOpacity (float) – the time step index (unsigned short)
  • fHightlightOpacityOutRange (float) –
  • fROIOpacity (float) –
  • fROIOpacityOutRange (float) –
  • iTIndex (int) –
overwriteValueWithROI(self, aVolumeROI: ORSModel.ors.ROI, pReplacementValue: float) → None

–

Overwrites the channel data at a given Region of Interest.

Parameters:
overwriteValueWithROIOnSubBox(self, aROI: ORSModel.ors.ROI, pReplacementValue: float, subBox: ORSModel.ors.Box, iTIndex: int) → None

–

Overwrites the channel data at a given Region of Interest included in the given box.

Parameters:
prepareForObliqueExtractionFromRectangleBetweenPlanes(self, aBoundedPlane: ORSModel.ors.Rectangle, startPlane: ORSModel.ors.Plane, endPlane: ORSModel.ors.Plane, xSize: int, ySize: int, nbZSlice: int, fitOnData: bool, uniformSpacing: bool, bOptimalSizeAndSpacingInXY: bool, bOptimalSizeAndSpacingInZ: bool, IOutChannel: ORSModel.ors.Channel) → Channel

–

Parameters:
removeAllPrivateDICOMAttributes(self) → None

–

Removes all private DICOM attributes.

Parameters:self (ORSModel.ors.Channel) – an instance of Channel
removeSlice(self, pSliceIndex: int) → None

–

Removes a slice of data from the channel.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pSliceIndex (int) – the slice number (an unsigned short, 0 based)
resize(shape, dtype=<class 'numpy.uint8'>)
setAllData(self, aValue: float) → None

–

Sets the entire channel data to a single value.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • aValue (float) – the new value (a double)
setAllDataOnSubBox(self, aValue: float, subBox: ORSModel.ors.Box, iTIndex: int) → None

–

Sets the channel data included in a box to a single value.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • aValue (float) – the new value (a double)
  • subBox (ORSModel.ors.Box) – the subBox (a Box)
  • iTIndex (int) – the T index (an unsigned short)
setAllMarkedSlices(self, pValue: bool) → None

–

Sets the boolean marker of all slices.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pValue (bool) – true to set the entire slices’ marker on, false otherwise
setAreAllZSlicesDataAvailable(self, pValue: bool) → None

–

Sets the availability of all Z slices’ data.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pValue (bool) – true to set the entire Z slices’ data as available, false otherwise
setDICOMAttribute(self, sValue: str, iTIndex: int, iZIndex: int, pGroup: int, pElement: int, bReplaceExisting: bool) → bool

–

Sets a string DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • sValue (str) – the string value (a string)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • pGroup (int) – the group number (an unsigned short)
  • pElement (int) – the element number (an unsigned short)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMAttributeDouble(self, iValue: float, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bReplaceExisting: bool) → bool

–

Sets a double DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iValue (float) – the value (a double)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMAttributeFloat(self, iValue: float, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bReplaceExisting: bool) → bool

–

Sets a float DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iValue (float) – the value (a float)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMAttributeInt(self, iValue: int, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bReplaceExisting: bool) → bool

–

Sets a signed 32 bit DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iValue (int) – the value (an int)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMAttributeShort(self, iValue: int, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bReplaceExisting: bool) → bool

–

Sets a signed 16 bit DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iValue (int) – the value (a short)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMAttributeUnsignedChar(self, iValue: int, iTIndex: int, iZIndex: int, pGroup: int, pElement: int, iIndex: int, bReplaceExisting: bool) → bool

–

Sets an unsigned 8 bit DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iValue (int) – the value (an short char)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • pGroup (int) – the group number (an unsigned short)
  • pElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMAttributeUnsignedInt(self, iValue: int, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bReplaceExisting: bool) → bool

–

Sets an unsigned 32 bit DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iValue (int) – the value (an unsigned int)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMAttributeUnsignedShort(self, iValue: int, iTIndex: int, iZIndex: int, iGroup: int, iElement: int, iIndex: int, bReplaceExisting: bool) → bool

–

Sets an unsigned 16 bit DICOM attribute.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iValue (int) – the value (an unsigned short)
  • iTIndex (int) – the T index (an int, see note)
  • iZIndex (int) – the slice index (an int, see note)
  • iGroup (int) – the group number (an unsigned short)
  • iElement (int) – the element number (an unsigned short)
  • iIndex (int) – index of the item in case of multi-valued elements (0..vm-1)
  • bReplaceExisting (bool) – true to replace an existing value, false otherwise

:return : :rtype : bool

setDICOMContainer(self, iTIndex: int, iZIndex: int, sData: int) → None

–

Private.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) –
  • iZIndex (int) –
  • sData (bytes) –
setDataDescription(self, pChannelDescriptionEnumValue: int) → None

–

Sets the channel description.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pChannelDescriptionEnumValue (int) – a description index (a int32_t*)
setDataRange(self, pValue: float) → None

–

Sets the size of the spread of data.

Parameters:
setDataType(self, pDataType: int) → None

–

Sets the channel data type.

Parameters:
setDataUnit(self, bDimensionalUnit: str) → None

–

Sets the channel data unit description.

Parameters:
setInitialWindowLevelValues(self, pWidth: float, pCenter: float) → None

–

Sets the initial window leveling value.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pWidth (float) – the window width (a double)
  • pCenter (float) – the window center (a double)
setIsData3D(self, pValue: bool) → None

–

Sets the channel to be true 3D data or not.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pValue (bool) – true if data is 3D, false otherwise
setIsLossy(self, pValue: bool) → None

–

Sets the channel to be lossy or not.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pValue (bool) – true if data is lossy, false otherwise
setIsMarkedSlice(self, pTIndex: int, pZSlice: int, pValue: bool) → None

–

Sets a slice to be marked or not.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
  • pValue (bool) – true to set the slice to be marked, false otherwise
setIsZSliceDataAvailable(self, pTIndex: int, pZSlice: int, pValue: bool) → None

–

Sets the availability of a Z slice’s data.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
  • pValue (bool) – true to set the Z slice’s data available, false otherwise
setOffset(self, pOffset: float) → None

–

Sets the channel offset.

Parameters:
setOverlayData(self, iTIndex: int, iZIndex: int, pStartRow: int, pStartCol: int, pOverlayRows: int, pOverlayCols: int, pOverlayData: int) → None

–

Sets the overlay data for a given Z slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTIndex (int) – the T index (an unsigned short)
  • iZIndex (int) – the Z slice index (an unsigned short)
  • pStartRow (int) – the starting row of the overlay data (a short, see note)
  • pStartCol (int) – the starting column of the overlay data (a short, see note)
  • pOverlayRows (int) – the number of rows of overlay data (a short)
  • pOverlayCols (int) – the number of colums of overlay data (a short)
  • pOverlayData (bytes) – the overlay data (an unsigned char*, see note)
setSavePixelDataWhileSavingNode(self, pFlag: int) → None

–

Controls if and how the channel should save its pixel data to XML.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pFlag (int) – the save mode (a short between 0 and 2, see below)
setSerieHasBeenModified(self, seriesHasBeenChangedFlag: bool) → None

–

Parameters:
setSliceDirection0Size(self, timeStep: int, sliceIndex: int, direction0Size: float) → None

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • timeStep (int) –
  • sliceIndex (int) –
  • direction0Size (float) –
setSliceDirection0Spacing(self, timeStep: int, sliceIndex: int, direction0Spacing: float) → None

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • timeStep (int) –
  • sliceIndex (int) –
  • direction0Spacing (float) –
setSliceDirection1Size(self, timeStep: int, sliceIndex: int, direction1Size: float) → None

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • timeStep (int) –
  • sliceIndex (int) –
  • direction1Size (float) –
setSliceDirection1Spacing(self, timeStep: int, sliceIndex: int, direction1Spacing: float) → None

–

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • timeStep (int) –
  • sliceIndex (int) –
  • direction1Spacing (float) –
setSliceOrientation(self, pTIndex: int, pZSlice: int, index: int, value: float) → None

–

Sets the orientation of a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
  • index (int) – an index (from 0 to 9)
  • value (float) – the orientation value (a double)
setSlicePosition(self, pTIndex: int, pZSlice: int, pPosition: ORSModel.ors.Vector3) → None

–

Sets the position of a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short
  • pPosition (ORSModel.ors.Vector3) – a position (an Vector3)
setSliceRectangle(self, timeStep: int, sliceIndex: int, pBoundedPlane: ORSModel.ors.Rectangle) → None

–

Parameters:
setSliceSize(self, pTIndex: int, pZSlice: int, iXSize: int, iYSize: int) → None

–

Sets the size of a given slice.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTIndex (int) – the T index (an unsigned short)
  • pZSlice (int) – the Z slice index (an unsigned short)
  • iXSize (int) – slice X size (an unsigned short)
  • iYSize (int) – slice Y size (an unsigned short)
setSlope(self, pSlope: float) → None

–

Sets the channel slope.

Parameters:
setSpacingValidity(self, bXSpacing: bool, bYSpacing: bool, bZSpacing: bool) → None

–

Sets if the channel has valid spacing.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • bXSpacing (bool) – validity of X spacing
  • bYSpacing (bool) – validity of Y spacing
  • bZSpacing (bool) – validity of Z spacing
setSubset(self, pSourceChannel: ORSModel.ors.Channel, xMinSource: int, yMinSource: int, zMinSource: int, tMinSource: int, xSize: int, ySize: int, zSize: int, tSize: int, xMinDestination: int, yMinDestination: int, zMinDestination: int, tMinDestination: int) → None

–

Writes a channel subset into the current channel data.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pSourceChannel (ORSModel.ors.Channel) – the channel to read the data from (the “source”) unsigned int xMinDestination, unsigned int yMinDestination, unsigned int zMinDestination, unsigned int tMinDestination
  • xMinSource (int) – the first index in X to copy from the source channel (an unsigned int)
  • yMinSource (int) – the first index in Y to copy from the source channel (an unsigned int)
  • zMinSource (int) – the first index in Z to copy from the source channel (an unsigned int)
  • tMinSource (int) – the first index in T to copy from the source channel (an unsigned int)
  • xSize (int) – the number of pixels in X to copy from the source channel (an unsigned int)
  • ySize (int) – the number of pixels in Y to copy from the source channel (an unsigned int)
  • zSize (int) – the number of pixels in Z to copy from the source channel (an unsigned int)
  • tSize (int) – the number of pixels in T to copy from the source channel (an unsigned int)
  • xMinDestination (int) – the index in X of the first pixel to copy into the current channel (an unsigned int)
  • yMinDestination (int) – the index in Y of the first pixel to copy into the current channel (an unsigned int)
  • zMinDestination (int) – the index in Z of the first pixel to copy into the current channel (an unsigned int)
  • tMinDestination (int) – the index in T of the first pixel to copy into the current channel (an unsigned int)
setTimeFrame(self, pTimeStep: int, pYear: int, pMonth: int, pDay: int, pHour: int, pMinutes: int, pSeconds: int, pMicroSeconds: int) → None

–

Sets the value of a time frame.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • pTimeStep (int) – the T index (an unsigned short)
  • pYear (int) – the year (an unsigned short)
  • pMonth (int) – the month (an unsigned short)
  • pDay (int) – the day (an unsigned short)
  • pHour (int) – the hour (an unsigned short)
  • pMinutes (int) – the minutes (an unsigned short)
  • pSeconds (int) – the seconds (an unsigned short)
  • pMicroSeconds (int) – the microseconds (an unsigned int)
shape
swapSliceData(self, iTSource: int, iZSource: int, iTTarget: int, iZTarget: int) → None

–

Swap two slices.

Parameters:
  • self (ORSModel.ors.Channel) – an instance of Channel
  • iTSource (int) – T source index (an unsigned short)
  • iZSource (int) – Z source index (an unsigned short)
  • iTTarget (int) – T target index (an unsigned short)
  • iZTarget (int) – Z target index (an unsigned short)
transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:
updateCrossSection(self, path: ORSModel.ors.VisualPath, aTransformationMatrix: ORSModel.ors.Matrix4x4, timeStep: int, pInChannel: ORSModel.ors.Channel) → None

–

Parameters:
updateSliceMatricesWithGlobalMatrixValue(self) → None

–

Parameters:self (ORSModel.ors.Channel) – an instance of Channel
zeros(shape, dtype=<class 'numpy.uint8'>)

ChannelRegistrationHelper

class ORSModel.ors.ChannelRegistrationHelper(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

ChannelRegistrationHelper.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
applyTransformationDegreeOfFreedomOnChannel(self, kindOfDegreeOfFreedom: int, numeroDirection: int, backward: bool) → None

–

Parameters:
getChannelA(self) → Channel

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getChannelB(self) → Channel

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getClassNameStatic() → str

–

:return : :rtype : str

getCurrentSimilarity(self) → float

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : float

getEpsilonRotation(self) → Vector3

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getEpsilonScaleFactor(self) → Vector3

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getEpsilonTranslation(self) → Vector3

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getFactorOfCompressionHistogramA(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : unsigned int

getFactorOfCompressionHistogramB(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : unsigned int

getHistogramASize(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : int

getHistogramBSize(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : int

getMaxSimilarityMetric(self) → float

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : float

getMutualInformationFor(self, p_entropyA: float, p_entropyB: float, p_entropyAB: float, histoASize: int, histoBSize: int, fractionOfChannelConsidered: float) → float

–

Parameters:
  • self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
  • p_entropyA (float) –
  • p_entropyB (float) –
  • p_entropyAB (float) –
  • histoASize (int) –
  • histoBSize (int) –
  • fractionOfChannelConsidered (float) –

:return : :rtype : float

getNearestInterpolation(self) → bool

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : bool

getRegistration3DTransformation(self, bApplyTransformation: bool, IProgress: ORSModel.ors.Progress) → Matrix4x4

–

Parameters:
getRotationScaleCenter(self) → Vector3

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getRotationScaleCenterAlwaysAtCenter(self) → bool

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : bool

getSearchDeltaRotation(self) → Vector3

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getSearchDeltaScaleFactor(self) → Vector3

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getSearchDeltaTranslation(self) → Vector3

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
getSuggestedHistogramSizesSturgesRule(self, pIChannelA: ORSModel.ors.Channel, pIChannelB: ORSModel.ors.Channel, pSuggestedSizeOfHistogram: int) → None

–

Parameters:
getTimeA(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : int

getTimeB(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : int

getUseMutualInfo(self) → bool

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : bool

getXSampling(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : int

getYSampling(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : int

getZSampling(self) → int

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper

:return : :rtype : int

none() → ChannelRegistrationHelper

–

resetRotationScaleCenter(self) → None

–

Parameters:self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
setChannelA(self, pIChannel: ORSModel.ors.Channel) → None

–

Parameters:
setChannelAB(self, pIChannelA: ORSModel.ors.Channel, pIChannelB: ORSModel.ors.Channel) → None

–

Parameters:
setChannelB(self, pIChannel: ORSModel.ors.Channel) → None

–

Parameters:
setEpsilonRotation(self, pVector: ORSModel.ors.Vector3) → None

–

Parameters:
setEpsilonScaleFactor(self, pVector: ORSModel.ors.Vector3) → None

–

Parameters:
setEpsilonTranslation(self, pVector: ORSModel.ors.Vector3) → None

–

Parameters:
setFactorOfCompressionHistogramA(self, factor: int) → None

–

Parameters:
setFactorOfCompressionHistogramB(self, factor: int) → None

–

Parameters:
setHistogramASize(self, value: int) → None

–

Parameters:
setHistogramBSize(self, value: int) → None

–

Parameters:
setNearestInterpolation(self, aFlag: bool) → None

–

Parameters:
setRotationScaleCenter(self, pVect: ORSModel.ors.Vector3) → None

–

Parameters:
setRotationScaleCenterAlwaysAtCenter(self, aFlag: bool) → None

–

Parameters:
setSearchDeltaEpsilonRotation(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float) → None

–

Parameters:
setSearchDeltaEpsilonScaleFactor(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float) → None

–

Parameters:
setSearchDeltaEpsilonTranslation(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float) → None

–

Parameters:
setSearchDeltaRotation(self, pVector: ORSModel.ors.Vector3) → None

–

Parameters:
setSearchDeltaScaleFactor(self, pVector: ORSModel.ors.Vector3) → None

–

Parameters:
setSearchDeltaTranslation(self, pVector: ORSModel.ors.Vector3) → None

–

Parameters:
setSearchDirectionBox(self, pIChannelBox: ORSModel.ors.Box) → None

–

Parameters:
setSearchDirectionChannel(self, pIChannel: ORSModel.ors.Channel) → None

–

Parameters:
setTimeA(self, time: int) → None

–

Parameters:
setTimeB(self, time: int) → None

–

Parameters:
setUseMutualInfo(self, aFlag: bool) → None

–

Parameters:
setXSampling(self, aSampling: int) → None

–

Parameters:
setYSampling(self, aSampling: int) → None

–

Parameters:
setZSampling(self, aSampling: int) → None

–

Parameters:

ChannelSliceRegistrationHelper

class ORSModel.ors.ChannelSliceRegistrationHelper(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:

ChannelSliceRegistrationHelper.__init__(self) -> None –

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper

ChannelSliceRegistrationHelper.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addTranslation(self, zIndex: int, tIndex: int, aVect: ORSModel.ors.Vector3) → None

–

Parameters:
applySliceRegistrationToChannel(self, pInputChannel: ORSModel.ors.Channel, iTIndex: int, IProgress: ORSModel.ors.Progress, pOutputChannel: ORSModel.ors.Channel) → Channel

–

Parameters:
composeMatrix(self, zIndex: int, tIndex: int, aMatrix: ORSModel.ors.Matrix4x4) → None

–

Compose the transformation matrix from slice (zIndex-1) registered position to slice zIndex registered position with thw given matrix.

Parameters:
copyInto(self, aDestinationRegistration: ORSModel.ors.ChannelSliceRegistrationHelper) → None

–

Parameters:
copyShapeFromChannel(self, aChannel: ORSModel.ors.Channel) → None

–

Parameters:
extractSliceChannel(self, pInputChannel: ORSModel.ors.Channel, aCutPlane: ORSModel.ors.Plane, IOutputSliceChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress) → Channel

–

Parameters:
extractZSliceChannel(self, pInputChannel: ORSModel.ors.Channel, aCutPlane: ORSModel.ors.Plane, IOutputSliceChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress) → Channel

–

Parameters:
getApplicableChannelList(self) → List

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
getClassNameStatic() → str

–

:return : :rtype : str

getComposeMatrixFromSliceIToJ(self, zIndexI: int, zIndexJ: int, tIndex: int) → Matrix4x4

–

Parameters:
getGlobalMatrix(self, zIndex: int, tIndex: int) → Matrix4x4

–

Returns the transformation matrix from channel original position to slice zIndex registered position.

Parameters:
getIsSliceUnmovable(self, zIndex: int, tIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getMatrix(self, zIndex: int, tIndex: int) → Matrix4x4

–

Returns the transformation matrix from slice (zIndex-1) registered position to slice zIndex registered position.

Parameters:
getMaxTranslation(self, tIndex: int) → Vector3

–

Parameters:
getMaximumXOffsetBetweenSlice(self) → int

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper

:return : :rtype : int

getMaximumYOffsetBetweenSlice(self) → int

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper

:return : :rtype : int

getMinTranslation(self, tIndex: int) → Vector3

–

Parameters:
getOpticalFluxMaximalLevelGaussianPyramid(self, aChannel: ORSModel.ors.Channel, nZIndex: int, nTIndex: int, pIBoundingBoxSearchArea: ORSModel.ors.Box) → int

–

Parameters:

:return : :rtype : unsigned int

getRegisteredChannelBox(self, aChannel: ORSModel.ors.Channel) → Box

–

Parameters:
getSimilarityXSampling(self) → int

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper

:return : :rtype : int

getSimilarityYSampling(self) → int

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper

:return : :rtype : int

getTSize(self) → int

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper

:return : :rtype : int

getTranslation(self, zIndex: int, tIndex: int) → Vector3

–

Parameters:
getZSize(self) → int

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper

:return : :rtype : int

mergeSliceRegistrationHelper(self, pInputRegistrationHelper: ORSModel.ors.ChannelSliceRegistrationHelper, startZ: int, endZ: int, startT: int, endT: int, pOutputRegistrationHelper: ORSModel.ors.ChannelSliceRegistrationHelper) → ChannelSliceRegistrationHelper

–

Parameters:
none() → ChannelSliceRegistrationHelper

–

registerSliceMutualInfo(self, aChannel: ORSModel.ors.Channel, startZ: int, endZ: int, tIndex: int, nbIteration: int, bResetRegistration: bool, IProgress: ORSModel.ors.Progress) → None

–

Voxel based slice registration using Mutual info algorithm.

Parameters:
  • self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
  • aChannel (ORSModel.ors.Channel) – the channel to register (a Channel)
  • startZ (int) – the slice start index (an unsigned short)
  • endZ (int) – the slice end index (an unsigned short)
  • tIndex (int) – the channel T index (an unsigned short)
  • nbIteration (int) – the maximum number of iteration(an unsigned short)
  • bResetRegistration (bool) – the progress bar (an Progress)
  • IProgress (ORSModel.ors.Progress) –
registerSliceMutualInfoSubVoxel(self, aChannel: ORSModel.ors.Channel, startZ: int, endZ: int, tIndex: int, fDeltaTranslationX: float, fDeltaTranslationY: float, fEpsilonTranslationX: float, fEpsilonTranslationY: float, fDeltaRotation: float, fEpsilonRotation: float, bResetRegistration: bool, bUseFixReferenceSlice: bool, nFixReferenceSliceIdx: int, IProgress: ORSModel.ors.Progress) → None

–

Sub-Voxel based slice registration using Mutual info algorithm.

Parameters:
  • self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
  • aChannel (ORSModel.ors.Channel) – the channel to register (a Channel)
  • startZ (int) – the slice start index (an unsigned short)
  • endZ (int) – the slice end index (an unsigned short)
  • tIndex (int) – the channel T index (an unsigned short)
  • fDeltaTranslationX (float) – the initial step on X axis is the first translation that will be applied and tested by the algorithm
  • fDeltaTranslationY (float) – the initial step on Y axis is the first translation that will be applied and tested by the algorithm
  • fEpsilonTranslationX (float) – the smallest step on X axis is the minimum distance that could be tested by the algorithm
  • fEpsilonTranslationY (float) – the smallest step on Y axis is the minimum distance that could be tested by the algorithm
  • fDeltaRotation (float) – the initial step is the first rotation that will be applied and tested by the algorithm
  • fEpsilonRotation (float) – the smallest step is the is minimum rotation that could be tested by the algorithm
  • bResetRegistration (bool) – indicate if the registration matrix should be reseted (a bool)
  • bUseFixReferenceSlice (bool) – indicate if we register on a fixed slice (a bool)
  • nFixReferenceSliceIdx (int) – indicate the fixed slice index (if we register on a fixed slice) (an unsigned short)
  • IProgress (ORSModel.ors.Progress) – the progress bar (an Progress)
registerSliceOpticalFlow(self, aChannel: ORSModel.ors.Channel, startZ: int, endZ: int, tIndex: int, bUseTranslation: bool, fMinimalDistanceToStop: float, bUseRotation: bool, fMinimalRotationToStop: float, nMaxIteration: int, nGaussianPyramid: int, bUseLinearFactor: bool, bUseConstantFactor: bool, bUseMIRegistration: bool, IInterestBox: ORSModel.ors.Box, ISearchBox: ORSModel.ors.Box, bResetRegistration: bool, IProgress: ORSModel.ors.Progress) → None

–

Sub - Voxel based slice registration using Optical Flow algorithm.

Parameters:
  • self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
  • aChannel (ORSModel.ors.Channel) – the channel to register(a Channel)
  • startZ (int) – the slice start index(an unsigned short)
  • endZ (int) – the slice end index(an unsigned short)
  • tIndex (int) – the channel T index(an unsigned short)
  • bUseTranslation (bool) – indicate that the algorithm should use translation(a bool)
  • fMinimalDistanceToStop (float) – the smallest distance in translation(from the last iteration) that should be reached to stop the iterative process(a double)
  • bUseRotation (bool) – indicate that the algorithm should use rotation(a bool)
  • fMinimalRotationToStop (float) – smallest rotation (in radians) (from the last iteration) that should be reached to stop the iterative process(a double)
  • nMaxIteration (int) – maximal number of iterations(an unsigned short)
  • nGaussianPyramid (int) – the minimal level (highest resolution) of the Gaussian pyramid to use to evaluate the transformation.A value of 0 is the resolution of the input image(and is usually a source of instability); each increment of 1 of this value reduces the resolution by half and would usually increase the stability of the result and reduce the computation time. (an int)
  • bUseLinearFactor (bool) – indicate if the linear factor of brightness correction(for stabilization) should be used(a bool)
  • bUseConstantFactor (bool) – indicate if the constant factor of brightness correction(for stabilization) should be used.This value will be considered only if the linear factor is used. (a bool)
  • bUseMIRegistration (bool) – indicate if a pass of registration by mutual information should be performed after the pass of optical flow(a bool)
  • IInterestBox (ORSModel.ors.Box) – the section of the image of reference to be detected in the other image(an Box)
  • ISearchBox (ORSModel.ors.Box) – the area where the section of the image of reference should be found in the other image(an Box)
  • bResetRegistration (bool) – indicate if the registration matrix should be reset(a bool)
  • IProgress (ORSModel.ors.Progress) – the progress bar(an Progress)
registerSliceSSD(self, aChannel: ORSModel.ors.Channel, startZ: int, endZ: int, tIndex: int, nbIteration: int, bResetRegistration: bool, IProgress: ORSModel.ors.Progress) → None

–

Voxel based slice registration using SSD algorithm.

Parameters:
  • self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
  • aChannel (ORSModel.ors.Channel) – the channel to register (a Channel)
  • startZ (int) – the slice start index (an unsigned short)
  • endZ (int) – the slice end index (an unsigned short)
  • tIndex (int) – the channel T index (an unsigned short)
  • nbIteration (int) – the maximum number of iteration(an unsigned short)
  • bResetRegistration (bool) – the progress bar (an Progress)
  • IProgress (ORSModel.ors.Progress) –
registerSliceSSDSubVoxel(self, aChannel: ORSModel.ors.Channel, startZ: int, endZ: int, tIndex: int, fDeltaTranslationX: float, fDeltaTranslationY: float, fEpsilonTranslationX: float, fEpsilonTranslationY: float, fDeltaRotation: float, fEpsilonRotation: float, bResetRegistration: bool, bUseFixReferenceSlice: bool, nFixReferenceSliceIdx: int, IProgress: ORSModel.ors.Progress) → None

–

Sub-Voxel based slice registration using SSD algorithm.

Parameters:
  • self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
  • aChannel (ORSModel.ors.Channel) – the channel to register (a Channel)
  • startZ (int) – the slice start index (an unsigned short)
  • endZ (int) – the slice end index (an unsigned short)
  • tIndex (int) – the channel T index (an unsigned short)
  • fDeltaTranslationX (float) – the initial step on X axis is the first translation that will be applied and tested by the algorithm
  • fDeltaTranslationY (float) – the initial step on Y axis is the first translation that will be applied and tested by the algorithm
  • fEpsilonTranslationX (float) – the smallest step on X axis is the minimum distance that could be tested by the algorithm
  • fEpsilonTranslationY (float) – the smallest step on Y axis is the minimum distance that could be tested by the algorithm
  • fDeltaRotation (float) – the initial step is the first rotation that will be applied and tested by the algorithm
  • fEpsilonRotation (float) – the smallest step is the is minimum rotation that could be tested by the algorithm
  • bResetRegistration (bool) – indicate if the registration matrix should be reseted (a bool)
  • bUseFixReferenceSlice (bool) – indicate if we register on a fixed slice (a bool)
  • nFixReferenceSliceIdx (int) – indicate the fixed slice index (if we register on a fixed slice) (an unsigned short)
  • IProgress (ORSModel.ors.Progress) – the progress bar (an Progress)
resetRegistration(self) → None

–

Parameters:self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
setEndOfInterestZone(self, xEnd: int, yEnd: int) → None

–

Parameters:
setIsSliceUnmovable(self, zIndex: int, tIndex: int, bUnmovable: bool) → None

–

Parameters:
setMatrix(self, zIndex: int, tIndex: int, aMatrix: ORSModel.ors.Matrix4x4) → None

–

Set the transformation matrix from slice (zIndex-1) registered position to slice zIndex registered position.

Parameters:
setMaximumXOffsetBetweenSlice(self, maxOffset: int) → None

–

Parameters:
setMaximumYOffsetBetweenSlice(self, maxOffset: int) → None

–

Parameters:
setSimilarityXSampling(self, sampling: int) → None

–

Parameters:
setSimilarityYSampling(self, sampling: int) → None

–

Parameters:
setStartOfInterestZone(self, xStart: int, yStart: int) → None

–

Parameters:
setTSize(self, tSize: int) → None

–

Parameters:
setTranslation(self, zIndex: int, tIndex: int, aVect: ORSModel.ors.Vector3) → None

–

Parameters:
setZSize(self, zSize: int) → None

–

Parameters:

ChannelSliceReplacementHelper

class ORSModel.ors.ChannelSliceReplacementHelper(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.ChannelSliceReplacementHelper) – an instance of ChannelSliceReplacementHelper

ChannelSliceReplacementHelper.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
analyzeAndReplaceMarkedSlices(self) → None

–

Parameters:self (ORSModel.ors.ChannelSliceReplacementHelper) – an instance of ChannelSliceReplacementHelper
canSliceReplacementBePerformed(self) → bool

–

Parameters:self (ORSModel.ors.ChannelSliceReplacementHelper) – an instance of ChannelSliceReplacementHelper

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

none() → ChannelSliceReplacementHelper

–

setChannel(self, pIInputChannel: ORSModel.ors.Channel) → None

–

Parameters:
setTime(self, value: int) → None

–

Parameters:

Circle

class ORSModel.ors.Circle

Bases: ORSModel.ors.Shape2D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Circle.__init__(self) -> None –

Parameters:self (ORSModel.ors.Circle) – an instance of Circle

Circle.__init__(self, center: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3, : double radius) -> None –

Parameters:

Circle.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → Circle

–

Copies aCircle.

Parameters:self (ORSModel.ors.Circle) – an instance of Circle
from3Points(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3, point2: ORSModel.ors.Vector3) → None

–

Initializes theCircle from 3 points.

Parameters:
getArea(self) → float

–

Parameters:self (ORSModel.ors.Circle) – an instance of Circle

:return : :rtype : float

getCenter(self) → Vector3

–

Returns the normal of theCircle.

Parameters:self (ORSModel.ors.Circle) – an instance of Circle
getClassNameStatic() → str

–

:return : :rtype : str

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → Vector3

–

Return the vector representing the intersection of the provided line and the receiver.

Parameters:
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → Vector3

–

Return the vector representing the intersection of the provided line and the receiver.

Parameters:
getIntersectionWithPlane(self, aPlane: ORSModel.ors.Plane) → LineSegment

–

Return the vector representing the intersection of the provided line and the receiver.

Parameters:
getIsEqualTo(self, Circle: ORSModel.ors.Circle) → bool

–

Parameters:

:return : :rtype : bool

getNormal(self) → Vector3

–

Returns the normal of theCircle.

Parameters:self (ORSModel.ors.Circle) – an instance of Circle
getPlane(self) → Plane

–

Parameters:self (ORSModel.ors.Circle) – an instance of Circle
getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Circle) – an instance of Circle

:return : :rtype : str

getRadius(self) → float

–

Parameters:self (ORSModel.ors.Circle) – an instance of Circle

:return : :rtype : float

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Circle

–

Parameters:
none() → Circle

–

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None

–

Applies a rotation to the receiver.

Parameters:
setCenter(self, aCenter: ORSModel.ors.Vector3) → None

–

Parameters:
setNormal(self, aNormal: ORSModel.ors.Vector3) → None

–

Returns the normal of theCircle.

Parameters:
setRadius(self, aRadius: float) → None

–

Parameters:

Collection

class ORSModel.ors.Collection

Bases: ORSModel.ors.Managed

brief_description: Abstraction class for collections. author: Normand Mongeau. version: 1.0 Abstraction class for collections. The main difference between collections and arrays is that with collections, you do not need to worry about the capacity, you can just add elements; while for arrays you need to manage the size yourself.

Collection.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
applyLinearTransformation(self, slope: float, offset: float) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getSize(self) → int

–

Parameters:self (ORSModel.ors.Collection) – an instance of Collection

:return : :rtype : int

none() → Collection

–

Color

class ORSModel.ors.Color

Bases: ORSModel.ors.Unmanaged

brief_description: Wraps and defines colors. author: N Mongeau All other members of ORS participated. version: 1.0 date: December 2015 Defines a color. Colors are composed of components, each stored in the form of a double between 0 and 1. Colors can have as many components as wanted, but slots 0 to 3 are reserved for red, green, blue and alpha. Any additional component should thus be stored starting at index 4.

Color.__init__(self) -> None –

Parameters:self (ORSModel.ors.Color) – an instance of Color

Color.__init__(self, red: float, green: float, blue: float, alpha: float) -> None –

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • red (float) –
  • green (float) –
  • blue (float) –
  • alpha (float) –

Color.__init__(self, red: float, green: float, blue: float) -> None –

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • red (float) –
  • green (float) –
  • blue (float) –

Color.__init__(self, RGBColor: int) -> None –

Parameters:

Color.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
fromQColor(qColor)
getAlpha(self) → float

–

Gets the alpha component of the color.

Parameters:self (ORSModel.ors.Color) – an instance of Color

:return : :rtype : float

getAsQColor()
getBlue(self) → float

–

Gets the blue component of the color.

Parameters:self (ORSModel.ors.Color) – an instance of Color

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getComponentAtIndex(self, index: int) → float

–

Gets a component of the color.

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • index (int) – the component index (an unsigned short)

:return : :rtype : float

getComponentCount(self) → int

–

Gets the number of component of the color.

Parameters:self (ORSModel.ors.Color) – an instance of Color

:return : :rtype : int

getComponents(self) → ArrayDouble

–

Gets all the components of the color.

Parameters:self (ORSModel.ors.Color) – an instance of Color
getGreen(self) → float

–

Gets the green component of the color.

Parameters:self (ORSModel.ors.Color) – an instance of Color

:return : :rtype : float

getRed(self) → float

–

Gets the red component of the color.

Parameters:self (ORSModel.ors.Color) – an instance of Color

:return : :rtype : float

none() → Color

–

setAlpha(self, alpha: float) → None

–

Sets the alpha component of the color.

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • alpha (float) – the alpha value (a double)
setBlue(self, blue: float) → None

–

Sets the blue component of the color.

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • blue (float) – the blue value (a double)
setComponentAtIndex(self, index: int, component: float) → None

–

Sets a component of the color.

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • index (int) – the component index (an unsigned short)
  • component (float) – a double value
setComponents(self, components: ORSModel.ors.ArrayDouble) → None

–

Sets all the components of the color.

Parameters:
setGreen(self, green: float) → None

–

Sets the green component of the color.

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • green (float) – the green value (a double)
setRed(self, red: float) → None

–

Sets the red component of the color.

Parameters:
  • self (ORSModel.ors.Color) – an instance of Color
  • red (float) – the red value (a double)

ConvolutionHelper

class ORSModel.ors.ConvolutionHelper(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper

ConvolutionHelper.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
fastGaussian2D(self, pInputChannel: ORSModel.ors.Channel, nMinZ: int, nMaxZ: int, nMinT: int, nMaxT: int, pKernelSize: int, standarDeviation: float, nBoarderHandling: int, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Parameters:
get1DConvolution(self, inputValues: ORSModel.ors.Array, pKernel: ORSModel.ors.ConvolutionKernel, nBorderHandling: int, values: ORSModel.ors.Array) → Array

–

Convolutes a given 1D kernel through a Float array.

Parameters:
  • self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
  • inputValues (ORSModel.ors.Array) – the input array (an Array)
  • pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (a ConvolutionKernel, see note below)
  • nBorderHandling (int) – The border handling algorithm to use(an int). One of: CXV_CONVOLUTION_BORDER_HANDLING_VALID: Use only the valid portion of the convolution. CXV_CONVOLUTION_BORDER_HANDLING_PADDED_SURROUND The image is padded at the borders with extra pixels with a value given by m_fPaddedValue. CXV_CONVOLUTION_BORDER_HANDLING_NEAREST_NEIGHBOR The nearest known pixel value is substituted for the unknown one. CXV_CONVOLUTION_BORDER_HANDLING_CYCLIC Consider the extended image to be a tiled version of the original, and then convolve the central image using portions of the adjacent tiles at the borders. CXV_CONVOLUTION_BORDER_HANDLING_MIRRORING A mirror image of the known image is created with the border for a mirroring axis. CXV_CONVOLUTION_BORDER_HANDLING_INTERPOLATION Unknown values are estimated by polynomial interpolation.
  • values (ORSModel.ors.Array) – an optional output array to fill (an Array)
get1DMedian(self, inputValues: ORSModel.ors.Array, kernelSize: int, nBorderHandling: int, values: ORSModel.ors.Array) → Array

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getConvolution(self, pInputChannel: ORSModel.ors.Channel, nMinZ: int, nMaxZ: int, nMinT: int, nMaxT: int, pKernel: ORSModel.ors.ConvolutionKernel, nBoarderHandling: int, nOutputChannelDatatype: int, bLeaveDataOfOutChannelOutsizeZRangeUnaffected: bool, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Convolutes a given 2D kernel through the channel’s data.

Parameters:
  • self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
  • pInputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • nMinZ (int) – the minimal z slice index (an int)
  • nMaxZ (int) – the maximal z slice index (an int)
  • nMinT (int) – the kernel (a double**, see note below)
  • nMaxT (int) – the convolution’s size (a short)
  • pKernel (ORSModel.ors.ConvolutionKernel) – The border handling algorithm to use(an int). One of: CXV_CONVOLUTION_BORDER_HANDLING_VALID: Use only the valid portion of the convolution. CXV_CONVOLUTION_BORDER_HANDLING_PADDED_SURROUND The image is padded at the borders with extra pixels with a value given by m_fPaddedValue. CXV_CONVOLUTION_BORDER_HANDLING_NEAREST_NEIGHBOR The nearest known pixel value is substituted for the unknown one. CXV_CONVOLUTION_BORDER_HANDLING_CYCLIC Consider the extended image to be a tiled version of the original, and then convolve the central image using portions of the adjacent tiles at the borders. CXV_CONVOLUTION_BORDER_HANDLING_MIRRORING A mirror image of the known image is created with the border for a mirroring axis. CXV_CONVOLUTION_BORDER_HANDLING_INTERPOLATION Unknown values are estimated by polynomial interpolation.
  • nBoarderHandling (int) – a progress object (an Progress)
  • nOutputChannelDatatype (int) – an optional output channel to fill(an Channel)
  • bLeaveDataOfOutChannelOutsizeZRangeUnaffected (bool) –
  • IProgress (ORSModel.ors.Progress) –
  • pOutChannel (ORSModel.ors.Channel) –
getConvolutionSubsetOnOther(self, pInputChannel: ORSModel.ors.Channel, xMinInput: int, yMinInput: int, zMinInput: int, tMinInput: int, xSize: int, ySize: int, zSize: int, tSize: int, xMinOutput: int, yMinOutput: int, zMinOutput: int, tMinOutput: int, pKernel: ORSModel.ors.ConvolutionKernel, nBorderHandling: int, nOutputChannelDatatypeIfOutputChannelIsNull: int, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Convolutes a given 1D, 2D or 3D kernel through the channel’s data.

Parameters:
  • self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
  • pInputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • xMinInput (int) – the minimal x index of the input channel to compute the convolution on (an unsigned int)
  • yMinInput (int) – the minimal y index of the input channel to compute the convolution on (an unsigned int)
  • zMinInput (int) – the minimal z (slice) index of the input channel to compute the convolution on (an unsigned int)
  • tMinInput (int) – the minimal t (time) index of the input channel to compute the convolution on (an unsigned int)
  • xSize (int) – the number of pixels to compute in x (an unsigned int)
  • ySize (int) – the number of pixels to compute in y (an unsigned int)
  • zSize (int) – the number of pixels to compute in z (an unsigned int)
  • tSize (int) – the number of time steps to compute (an unsigned int)
  • xMinOutput (int) – the minimal x index of the output channel to write the result in (an unsigned int)
  • yMinOutput (int) – the minimal y index of the output channel to write the result in (an unsigned int)
  • zMinOutput (int) – the minimal z index of the output channel to write the result in (an unsigned int)
  • tMinOutput (int) – the minimal t index of the output channel to write the result in (an unsigned int)
  • pKernel (ORSModel.ors.ConvolutionKernel) – the kernel
  • nBorderHandling (int) – The border handling algorithm to use(an int). One of: CXV_CONVOLUTION_BORDER_HANDLING_VALID: Use only the valid portion of the convolution. CXV_CONVOLUTION_BORDER_HANDLING_PADDED_SURROUND The image is padded at the borders with extra pixels with a value given by m_fPaddedValue. CXV_CONVOLUTION_BORDER_HANDLING_NEAREST_NEIGHBOR The nearest known pixel value is substituted for the unknown one. CXV_CONVOLUTION_BORDER_HANDLING_CYCLIC Consider the extended image to be a tiled version of the original, and then convolve the central image using portions of the adjacent tiles at the borders. CXV_CONVOLUTION_BORDER_HANDLING_MIRRORING A mirror image of the known image is created with the border for a mirroring axis. CXV_CONVOLUTION_BORDER_HANDLING_INTERPOLATION Unknown values are estimated by polynomial interpolation.
  • nOutputChannelDatatypeIfOutputChannelIsNull (int) – the data type of the output channel, if the output channel is not given
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
  • pOutChannel (ORSModel.ors.Channel) – an optional output channel to fill(an Channel)
getConvolutionSubsetOnSelf(self, pInputChannel: ORSModel.ors.Channel, xMinInput: int, yMinInput: int, zMinInput: int, tMinInput: int, xSize: int, ySize: int, zSize: int, tSize: int, pKernel: ORSModel.ors.ConvolutionKernel, nBorderHandling: int, IProgress: ORSModel.ors.Progress) → None

–

Convolutes a given 1D, 2D or 3D kernel through the channel’s data.

Parameters:
  • self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
  • pInputChannel (ORSModel.ors.Channel) – the input channel (an Channel), in which the result is written
  • xMinInput (int) – the minimal x index of the input channel to compute the convolution on (an unsigned int)
  • yMinInput (int) – the minimal y index of the input channel to compute the convolution on (an unsigned int)
  • zMinInput (int) – the minimal z (slice) index of the input channel to compute the convolution on (an unsigned int)
  • tMinInput (int) – the minimal t (time) index of the input channel to compute the convolution on (an unsigned int)
  • xSize (int) – the number of pixels to compute in x (an unsigned int)
  • ySize (int) – the number of pixels to compute in y (an unsigned int)
  • zSize (int) – the number of pixels to compute in z (an unsigned int)
  • tSize (int) – the number of time steps to compute (an unsigned int)
  • pKernel (ORSModel.ors.ConvolutionKernel) – the kernel
  • nBorderHandling (int) – The border handling algorithm to use(an int). One of: CXV_CONVOLUTION_BORDER_HANDLING_VALID: Use only the valid portion of the convolution. CXV_CONVOLUTION_BORDER_HANDLING_PADDED_SURROUND The image is padded at the borders with extra pixels with a value given by m_fPaddedValue. CXV_CONVOLUTION_BORDER_HANDLING_NEAREST_NEIGHBOR The nearest known pixel value is substituted for the unknown one. CXV_CONVOLUTION_BORDER_HANDLING_CYCLIC Consider the extended image to be a tiled version of the original, and then convolve the central image using portions of the adjacent tiles at the borders. CXV_CONVOLUTION_BORDER_HANDLING_MIRRORING A mirror image of the known image is created with the border for a mirroring axis. CXV_CONVOLUTION_BORDER_HANDLING_INTERPOLATION Unknown values are estimated by polynomial interpolation.
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
getMedian(self, pInputChannel: ORSModel.ors.Channel, nMinZ: int, nMaxZ: int, nMinT: int, nMaxT: int, pKernel: ORSModel.ors.ConvolutionKernel, nBoarderHandling: int, nOutputChannelDatatype: int, bLeaveDataOfOutChannelOutsizeZRangeUnaffected: bool, IProgress: ORSModel.ors.Progress, pOutChannel: ORSModel.ors.Channel) → Channel

–

Parameters:
getPaddingValue(self) → float

–

Parameters:self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper

:return : :rtype : float

getZOffsetInputToOutputWithOutsideZRangeUnaffected(self) → int

–

Parameters:self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper

:return : :rtype : int

none() → ConvolutionHelper

–

setPaddingValue(self, aValue: float) → None

–

Parameters:
setZOffsetInputToOutputWithOutsideZRangeUnaffected(self, aValue: int) → None

–

Parameters:

ConvolutionKernel

class ORSModel.ors.ConvolutionKernel(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

ConvolutionKernel.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getElementSummation(self) → float

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

:return : :rtype : float

getIs1DKernel(self) → bool

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

:return : :rtype : bool

getIs2DKernel(self) → bool

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

:return : :rtype : bool

getIs3DKernel(self) → bool

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

:return : :rtype : bool

getKernelStarPoint(self, pIndexX: int, pIndexY: int, pIndexZ: int) → None

–

Parameters:
getKernelXSize(self) → int

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

:return : :rtype : int

getKernelYSize(self) → int

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

:return : :rtype : int

getKernelZSize(self) → int

–

Parameters:self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel

:return : :rtype : int

getValueAt(self, indexX: int, indexY: int, indexZ: int) → float

–

Parameters:

:return : :rtype : float

initializeAs1DKernel(self, indexX: int) → None

–

Parameters:
initializeAs2DKernel(self, indexX: int, indexY: int) → None

–

Parameters:
initializeAs3DKernel(self, indexX: int, indexY: int, indexZ: int) → None

–

Parameters:
multiplyAllElementBy(self, aValue: float) → None

–

Parameters:
none() → ConvolutionKernel

–

setAsGaussianWithMinimumUnnormalizedSmallestValue(self, aValue: float) → None

–

Parameters:
setAsGaussianWithStandarDeviation(self, sigma: float) → None

–

Parameters:
setKernelStarPoint(self, indexX: int, indexY: int, indexZ: int) → None

–

Parameters:
setValueAt(self, indexX: int, indexY: int, indexZ: int, aValue: float) → None

–

Parameters:

Cursor3D

class ORSModel.ors.Cursor3D

Bases: ORSModel.ors.Visual

brief_description: A visual artifact used to illustrate a position in a 3D referential. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Cursor3D.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Cursor3D.__init__(self) -> None –

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

Cursor3D.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getActivePlaneColor(self) → Color

–

Gets the active plane color of the 3D cursor.

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
getAllHighlightedViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View) → List

–

Parameters:
getAllHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View) → List

–

Parameters:
getAllHighlightedViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View) → List

–

Parameters:
getAllParentViewsExcludingCurrent(self, pCurrentDisplay: ORSModel.ors.View) → List

–

Parameters:
getAllParentViewsExcludingCurrentCount(self, pCurrentDisplay: ORSModel.ors.View) → int

–

Parameters:

:return : :rtype : int

getAllShownViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View) → List

–

Parameters:
getAllShownViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View) → List

–

Parameters:
getAnyHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getColor(self) → Color

–

Gets the color of the 3D cursor.

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
getCrossHairMode(self) → int

–

Gets the crosshair mode of the 3D cursor.

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : int

getCrossHairWidth(self) → float

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : float

getHideReferenceLinesInCurrentView(self) → bool

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : bool

getHighlightedCircleInView(self, pCurrentDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getHighlightedObliqueSliderInView(self, pCurrentDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getIsHighlightedViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getIsHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getIsHighlightedViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getIsShowViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getIsShowViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getLineThickness(self) → float

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : float

getMiddleHoleSize(self) → float

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : float

getPickAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → View

–

Picks for an anchor in the given display.

Parameters:
getPickMIPAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → View

–

Parameters:
getPickMPRAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → View

–

Parameters:
getPickObliqueCircleAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → bool

–

Parameters:

:return : :rtype : bool

getPickObliqueSliderAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → int

–

Parameters:

:return : :rtype : int

getPosition(self) → Vector3

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
getShowAllSynchStudyReferenceLines(self) → bool

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : bool

getShowCircleForView(self, pCurrentDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getShowFirstLastSynchStudyReferenceLines(self) → bool

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : bool

getShowObliqueSliderForView(self, pCurrentDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getShowSynchStudyReferenceLine(self) → bool

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : bool

getSynchronizedMode(self) → bool

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

:return : :rtype : bool

getViewsDefineAValidCursorPosition(self, pCurrentDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

hideAllCircle(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
hideAllMIPLine(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
hideAllObliqueSlider(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
hideAllViewAnchors(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
none() → Cursor3D

–

setActivePlaneColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the active plane color of the 3D cursor.

Parameters:
setColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the color of the 3D cursor.

Parameters:
setCrossHairMode(self, iMode: int) → None

–

Sets the crosshair mode of the 3D cursor.

Parameters:
setCrossHairWidth(self, value: float) → None

–

Parameters:
setCursorPositionFromParentView(self, pDisplay: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

setHideReferenceLinesInCurrentView(self, value: bool) → None

–

Parameters:
setHighlightedCircleInView(self, pCurrentDisplay: ORSModel.ors.View, highlight: bool) → None

–

Parameters:
setHighlightedObliqueSliderInView(self, pCurrentDisplay: ORSModel.ors.View, highlight: bool) → None

–

Parameters:
setHighlightedViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, highlight: bool) → None

–

Parameters:
setHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, highlight: bool) → None

–

Parameters:
setHighlightedViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, highlight: bool) → None

–

Parameters:
setLineThickness(self, value: float) → None

–

Parameters:
setMiddleHoleSize(self, value: float) → None

–

Parameters:
setPosition(self, pPosition: ORSModel.ors.Vector3) → None

–

Sets the position of the 3D cursor.

Parameters:
setShowAllSynchStudyReferenceLines(self, value: bool) → None

–

Parameters:
setShowCircleInView(self, pCurrentDisplay: ORSModel.ors.View, showC: bool) → None

–

Parameters:
setShowFirstLastSynchStudyReferenceLines(self, value: bool) → None

–

Parameters:
setShowObliqueSliderInView(self, pCurrentDisplay: ORSModel.ors.View, showO: bool) → None

–

Parameters:
setShowSynchStudyReferenceLine(self, value: bool) → None

–

Parameters:
setShowViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, showA: bool) → None

–

Parameters:
setShowViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, showA: bool) → None

–

Parameters:
setSynchronizedMode(self, aBool: bool) → None

–

Parameters:
unHighlightedAllCircle(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
unHighlightedAllMIPLine(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
unHighlightedAllObliqueSlider(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
unHighlightedAllViewAnchors(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
unHighlightedAllViewLine(self) → None

–

Parameters:self (ORSModel.ors.Cursor3D) – an instance of Cursor3D

Cylinder

class ORSModel.ors.Cylinder

Bases: ORSModel.ors.Shape3D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Cylinder.__init__(self) -> None –

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder

Cylinder.__init__(self, firstCenter: ORSModel.ors.Vector3, secondCenter: ORSModel.ors.Vector3, radius: float) -> None –

Parameters:

Cylinder.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → Cylinder

–

Copies aCylinder.

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder
getAxis(self) → Vector3

–

Returns the normal of theCylinder.

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder
getCap1Center(self) → Vector3

–

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder
getCap2Center(self) → Vector3

–

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder
getCenter(self) → Vector3

–

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder
getClassNameStatic() → str

–

:return : :rtype : str

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → LineSegment

–

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → LineSegment

–

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:
getIsEqualTo(self, Cylinder: ORSModel.ors.Cylinder) → bool

–

Verifies equality between the receiver and a givenCylinder.

Parameters:

:return : :rtype : bool

getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder

:return : :rtype : str

getRadius(self) → float

–

Parameters:self (ORSModel.ors.Cylinder) – an instance of Cylinder

:return : :rtype : float

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Cylinder

–

Parameters:
none() → Cylinder

–

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None

–

Applies a rotation to the receiver.

Parameters:
setCap1Center(self, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setCap2Center(self, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setCenter(self, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setRadius(self, aRadius: float) → None

–

Parameters:

DatasetPresenter

class ORSModel.ors.DatasetPresenter(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Visual

–

Parameters:

DatasetPresenter.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
get2DWindowLevel2Center(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevel2Max(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevel2Min(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevel2Range(self, fMin: float, fMax: float) → None

–

Gets the current second level 2D window level values range.

Parameters:

self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:
  • fMin (float) – The lower range value (a double)
  • fMax (float) – The upper range value (a double)
get2DWindowLevel2Values(self, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the second 2D window level values for the double leveling mode.

Parameters:
get2DWindowLevel2Width(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevelCenterForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevelCenterForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

get2DWindowLevelMaxForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevelMaxForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

get2DWindowLevelMinForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevelMinForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

get2DWindowLevelRangeForAllViews(self, pMin: float, pMax: float) → None

–

Gets the current 2D window level range values, for all displays.

Parameters:

self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:
  • pMin (float) – The current 2D window level range lower value (a double)
  • pMax (float) – The current 2D window level range supper value (a double)
get2DWindowLevelRangeForView(self, pDisplay: ORSModel.ors.View, pMin: float, pMax: float) → None

–

Gets the current 2D window level range values.

Parameters:
Returns:
  • pDisplay (ORSModel.ors.View) – The current 2D window level range lower value (a double)
  • pMin (float) – The current 2D window level range supper value (a double)
get2DWindowLevelValuesForAllViews(self, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 3D window level values (width and center) for all displays.

Parameters:

self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:
  • pWindowWidth (float) – the window level width (a double*)
  • pWindowCenter (float) – the window level center (a double*)
get2DWindowLevelValuesForView(self, pDisplay: ORSModel.ors.View, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 2D window level values (width and center) for a given display.

Parameters:
Returns:
  • pWindowWidth (float) – the window level width (a double*)
  • pWindowCenter (float) – the window level center (a double*)
get2DWindowLevelWidthForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get2DWindowLevelWidthForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

get3DWindowLevelCenterForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get3DWindowLevelCenterForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

get3DWindowLevelMaxForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get3DWindowLevelMaxForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

get3DWindowLevelMinForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get3DWindowLevelMinForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

get3DWindowLevelRangeForAllViews(self, pMin: float, pMax: float) → None

–

Gets the current 2D window level range values, for all displays.

Parameters:

self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:
  • pMin (float) – The current 2D window level range lower value (a double)
  • pMax (float) – The current 2D window level range supper value (a double)
get3DWindowLevelRangeForView(self, IDisplay: ORSModel.ors.View, pMin: float, pMax: float) → None

–

Gets the current 2D window level range values.

Parameters:
Returns:
  • IDisplay (ORSModel.ors.View) – The current 2D window level range lower value (a double)
  • pMin (float) – The current 2D window level range supper value (a double)
get3DWindowLevelValuesForAllViews(self, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 3D window level values (width and center) for all views.

Parameters:

self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:
  • pWindowWidth (float) – the window level width (a double*)
  • pWindowCenter (float) – the window level center (a double*)
get3DWindowLevelValuesForView(self, pDisplay: ORSModel.ors.View, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 2D window level values (width and center) for a given display.

Parameters:
Returns:
  • pWindowWidth (float) – the window level width (a double*)
  • pWindowCenter (float) – the window level center (a double*)
get3DWindowLevelWidthForAllViews(self) → float

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : float

get3DWindowLevelWidthForView(self, pDisplay: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getRangeSelectionColor(self) → Color

–

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
getUseLUTAlphaIn2DForAllViews(self) → bool

–

Ask the dataset presenter to use the applied lut alpha component.

Parameters:self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter

:return : :rtype : bool

getUseLUTAlphaIn2DForView(self, pDisplay: ORSModel.ors.View) → bool

–

Ask the dataset presenter to use the applied lut alpha component.

Parameters:

:return : :rtype : bool

none() → DatasetPresenter

–

set2DIntensityRangeForViewLogged(view, minValue, maxValue, logging=True)
set2DWindowLevel2Range(self, fMin: float, fMax: float) → None

–

Sets the current second level 2D window level values range.

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • fMin (float) – The lower range value (a double)
  • fMax (float) – The upper range value (a double)
set2DWindowLevel2Values(self, pWindowWidth: float, pWindowCenter: float) → None

–

Sets the second 2D window level values for the double leveling mode.

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • pWindowWidth (float) – the window width (a float)
  • pWindowCenter (float) – the window center (a float)
set2DWindowLevelRangeForAllViews(self, iMin: float, iMax: float) → None

–

Sets the current 2D window level values via a range, for all displays.

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • iMin (float) – The lower range value (a double)
  • iMax (float) – The upper range value (a double)
set2DWindowLevelRangeForView(self, pDisplay: ORSModel.ors.View, iMin: float, iMax: float) → None

–

Sets the current 2D window level values via a range, for a given display.

Parameters:
set2DWindowLevelValuesForAllViews(self, iWindowWidth: float, iWindowCenter: float) → None

–

Sets the current 2D window level values (width and center) for all displays.

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • iWindowWidth (float) – the window width (a double)
  • iWindowCenter (float) – the window center (a double)
set2DWindowLevelValuesForView(self, pDisplay: ORSModel.ors.View, iWindowWidth: float, iWindowCenter: float) → None

–

Sets the current 3D window level values (width and center).

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • pDisplay (ORSModel.ors.View) – the display (an View)
  • iWindowWidth (float) – the window level width (a double)
  • iWindowCenter (float) – the window level center (a double)
set2DWindowLevelValuesForViewLogged(view, width, center, logging=True)
set3DIntensityRangeViewLogged(view, minValue, maxValue, logging=True)
set3DWindowLevelRangeForAllViews(self, iMin: float, iMax: float) → None

–

Sets the current 2D window level values via a range, for all displays.

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • iMin (float) – The lower range value (a double)
  • iMax (float) – The upper range value (a double)
set3DWindowLevelRangeForView(self, IDisplay: ORSModel.ors.View, iMin: float, iMax: float) → None

–

Sets the current 2D window level values via a range, for a given display.

Parameters:
set3DWindowLevelValuesForAllViews(self, iWindowWidth: float, iWindowCenter: float) → None

–

Sets the current 2D window level values (width and center) for all displays.

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • iWindowWidth (float) – the window width (a double)
  • iWindowCenter (float) – the window center (a double)
set3DWindowLevelValuesForView(self, pDisplay: ORSModel.ors.View, iWindowWidth: float, iWindowCenter: float) → None

–

Sets the current 3D window level values (width and center).

Parameters:
  • self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
  • pDisplay (ORSModel.ors.View) – the display (an View)
  • iWindowWidth (float) – the window level width (a double)
  • iWindowCenter (float) – the window level center (a double)
set3DWindowLevelValuesForViewLogged(view, width, center, logging=True)
setRangeSelectionColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
setUseLUTAlphaIn2DForAllViews(self, aFlag: bool) → None

–

Tell the dataset presenter to use the applied lut alpha componenet.

Parameters:
setUseLUTAlphaIn2DForView(self, pDisplay: ORSModel.ors.View, aFlag: bool) → None

–

Tell the dataset presenter to use the applied lut alpha componenet.

Parameters:
setUseLUTAlphaIn2DForViewLogged(view, value, logging=True)

Dijkstra

class ORSModel.ors.Dijkstra(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

Dijkstra.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel) → None

–

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

Parameters:
createDistanceMap(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel) → None

–

Creates a distance map starting from all the providedROI sources.

Parameters:
createDistanceMapForMaxDistance(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, maxDistance: float, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel, continueDijkstra: bool) → None

–

Creates a distance map until a providedDijkstra distance is reached, starting from all the provided ROI sources.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • lOutputChannelDistanceMap (ORSModel.ors.Channel) – the distance map generated by the Dijkstra algorithm (an Channel)
  • maxDistance (float) – the Dijkstra distance to reach before stopping to process new voxels (a double)
  • lOutputChannelTraceBack (ORSModel.ors.Channel) – a traceback channel, can be NULL (an Channel)
  • lOutputChannelLabel (ORSModel.ors.Channel) – a label channel, can be NULL (an Channel)
  • continueDijkstra (bool) – TRUE if it is not the first time this call is done on this instance of Dijkstra with the same distance map and that the algorithm must continue, FALSE to start over
createDistanceMapForNBIteration(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, forNbIteration: int, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel, autoUpdateROI: bool, continueDijkstra: bool) → None

–

Creates a distance map for a given number of voxels, starting from all the providedROI sources.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • lOutputChannelDistanceMap (ORSModel.ors.Channel) – the distance map generated by the Dijkstra algorithm (an Channel)
  • forNbIteration (int) – the number of voxels to be processed by the Dijkstra algorithm (an unsigned int)
  • lOutputChannelTraceBack (ORSModel.ors.Channel) – a traceback channel, can be NULL (an Channel)
  • lOutputChannelLabel (ORSModel.ors.Channel) – a label channel, can be NULL (an Channel)
  • autoUpdateROI (bool) – TRUE if the source ROIs should be updated with their diffusion result, FALSE otherwise
  • continueDijkstra (bool) – TRUE if it is not the first time this call is done on this instance of Dijkstra with the same distance map and that the algorithm must continue, FALSE to start over
createDistanceMapUntilAnyPointInTargetRoiIsReached(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, aTargetVolumeROI: ORSModel.ors.ROI, lOutputChannelTraceBack: ORSModel.ors.Channel, continueDijkstra: bool) → None

–

Creates a distance map until any stop point provided in aROI are reached, starting from all the provided ROI sources.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • lOutputChannelDistanceMap (ORSModel.ors.Channel) – the distance map generated by the Dijkstra algorithm (an Channel)
  • aTargetVolumeROI (ORSModel.ors.ROI) – TODO DOCUMENT_ME
  • lOutputChannelTraceBack (ORSModel.ors.Channel) – a traceback channel, can be None (a Channel)
  • continueDijkstra (bool) – a label channel, can be None (a Channel)
createDistanceMapUntilPointInWorldCoordinatesIsReached(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, xStopPointInWorld: float, yStopPointInWorld: float, zStopPointInWorld: float, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel, continueDijkstra: bool) → None

–

Creates a distance map until a stop point provided in world coordinates is reached, starting from all the providedROI sources.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • lOutputChannelDistanceMap (ORSModel.ors.Channel) – the distance map generated by the Dijkstra algorithm (an Channel)
  • xStopPointInWorld (float) – X position of a world coordinate
  • yStopPointInWorld (float) – Y position of a world coordinate
  • zStopPointInWorld (float) – Z position of a world coordinate
  • lOutputChannelTraceBack (ORSModel.ors.Channel) – the number of voxels to be processed after the stop condition is matched (an uint32_t)
  • lOutputChannelLabel (ORSModel.ors.Channel) – a traceback channel, can be NULL (an Channel)
  • continueDijkstra (bool) – a label channel, can be NULL (an Channel)
createDistanceMapUntilPointsAreReached(self, lOutputChannelDistanceMap: ORSModel.ors.Channel, positionTripleInSourceRef: int, nbPosition: int, waitForNIndex: int, lOutputChannelTraceBack: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel, breakForAny: bool, continueDijkstra: bool) → None

–

Creates a distance map until any or all stop points provided are reached, starting from all the providedROI sources.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • lOutputChannelDistanceMap (ORSModel.ors.Channel) – the distance map generated by the Dijkstra algorithm (an Channel)
  • positionTripleInSourceRef (int) – a collection of x,y,z triplets stop points in input channel referential (an uint32_t*)
  • nbPosition (int) – the number of triplets present in the collection of triplets stop points (an uint32_t)
  • waitForNIndex (int) – the number of voxels to be processed after the stop condition is matched (an uint32_t)
  • lOutputChannelTraceBack (ORSModel.ors.Channel) – a traceback channel, can be NULL (an Channel)
  • lOutputChannelLabel (ORSModel.ors.Channel) – a label channel, can be NULL (an Channel)
  • breakForAny (bool) – TRUE if the algorithm has to stop for any points, FALSE if all the points have to be reached to stop
  • continueDijkstra (bool) – TRUE if it is not the first time this call is done on this instance of Dijkstra with the same distance map and that the algorithm must continue, FALSE to start over
getAlphaParameter(self) → float

–

Gets the alpha parameter for the metric == 1.

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getEuclideanBias(self) → float

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : float

getGaussianPeakCenterValue(self) → float

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : float

getIndexOfStopPointReach(self) → int

–

Retrieve the index reached by theDijkstra algorithm.

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : int

getKappa(self) → float

–

Gets the kappa parameter for the metric == 1.

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : float

getMetric(self) → int

–

Gets the metric used by theDijkstra algorithm.

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : int

getNeighborCount(self) → int

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : int

getROI(self, index: int) → ROI

–

Retrieves a particularROI from the index specified slot.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • index (int) – the slot index (an unsigned char)
getROICount(self) → int

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : int

getSigmaPow2(self) → float

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra

:return : :rtype : float

none() → Dijkstra

–

resetROIs(self) → None

–

Empties all the sourceROI slots.

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
setAlphaParameter(self, alpha: float) → None

–

Sets the alpha parameter for the metric == 1.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • alpha (float) – the alpha parameter (an double)
setEuclideanBias(self, EuclideanBias: float) → None

–

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

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • EuclideanBias (float) – the minimum distance between voxels (a double)
setGaussianPeakCenterValue(self, aPeakCenter: float) → None

–

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

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • 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) → None

–

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

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • minX (int) – the minimum X index in the input channel (an unsigned short)
  • minY (int) – the minimum Y index in the input channel (an unsigned short)
  • minZ (int) – the minimum Z index in the input channel (an unsigned short)
  • maxX (int) – the maximum X index in the input channel (an unsigned short)
  • maxY (int) – the maximum Y index in the input channel (an unsigned short)
  • maxZ (int) – the maximum Z index in the input channel (an unsigned short)
  • currentT (int) –
setInputLabelsChannel(self, aInputLabelsChannel: ORSModel.ors.Channel) → None

–

Parameters:
setInputMultiROI(self, aInputMultiROI: ORSModel.ors.MultiROI) → None

–

Parameters:
setKappa(self, kappa: float) → None

–

Sets the kappa parameter for the metric == 1.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • kappa (float) – the kappa parameter (an double)
setMaskROI(self, IMaskROI: ORSModel.ors.ROI) → None

–

Parameters:
setMetric(self, metricType: int) → None

–

Selects the metric to be used by theDijkstra algorithm.

Parameters:
setNeighborCountTo18(self) → None

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
setNeighborCountTo26(self) → None

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
setNeighborCountTo6(self) → None

–

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

Parameters:self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
setProgressObject(self, IProgress: ORSModel.ors.Progress) → None

–

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

–

Fills a particularROI slot to be used as a source for the Dijkstra algorithm.

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • index (int) – the slot index (an unsigned char)
  • aVolROI (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI)
setSigmaPow2(self, aLimit: float) → None

–

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

Parameters:
  • self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
  • aLimit (float) – variance of the gaussian (an double)
tracebackCPU(self, aROI: ORSModel.ors.ROI, linputChannelTraceBack: ORSModel.ors.Channel, aPath: ORSModel.ors.VisualPath) → None

–

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

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

–

Parameters:

Dijkstra2D

class ORSModel.ors.Dijkstra2D(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D

Dijkstra2D.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel) → None

–

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

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

–

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

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getEuclideanBias(self) → float

–

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

Parameters:self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D

:return : :rtype : float

getNeighborCount(self) → int

–

Parameters:self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D

:return : :rtype : int

getROICount(self) → int

–

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

Parameters:self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D

:return : :rtype : int

getVolumeROI(self, index: int) → ROI

–

Retrieves a particularROI from the index specified slot.

Parameters:
none() → Dijkstra2D

–

resetVolumeROIs(self) → None

–

Empties all the sourceROI slots.

Parameters:self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D
setEuclideanBias(self, EuclideanBias: float) → None

–

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

Parameters:
  • self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D
  • 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) → None

–

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

Parameters:
  • self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D
  • inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • minX (int) – the minimum X index in the input channel (an integer)
  • minY (int) – the minimum Y index in the input channel (an integer) TODO DOCUMENT_ME: Should this be removed?
  • maxX (int) – the minimum Z index in the input channel (an unsigned short)
  • maxY (int) – the maximum X index in the input channel (an integer)
  • currentT (int) – the maximum Y index in the input channel (an integer) TODO DOCUMENT_ME
setNeighborCountTo4(self) → None

–

Sets the number of neighbors used by the 2DDijkstra algorithm to 4.

Parameters:self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D
setNeighborCountTo8(self) → None

–

Sets the number of neighbors used by the 2DDijkstra algorithm to 8.

Parameters:self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D
setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI) → None

–

Fills a particularROI slot to be used as a source for the Dijkstra algorithm.

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

–

Parameters:

DijkstraOnGraph

class ORSModel.ors.DijkstraOnGraph

Bases: ORSModel.ors.ORSBaseClass

generateDistanceMap(aGraph: ORSModel.ors.Graph, metric: int, startIndices: ORSModel.ors.ArrayUnsignedLong, maxDistance: float) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

DimensionUnit

class ORSModel.ors.DimensionUnit

Bases: ORSModel.ors.Managed

brief_description: An entity describing a unit of measure used by author: Eric Fournier. All other members of ORS participated. version: 1.0 date: august 2005 An entity describing a unit of measure used by the SDK. Units are predefined in the SDK.

DimensionUnit.__init__(self) -> None –

Parameters:self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit

DimensionUnit.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
convertToUnit(self, aVolume: float, anIDimensionUnit: ORSModel.ors.DimensionUnit) → float

–

Parameters:

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getDefault(self, dimensionType: int) → DimensionUnit

–

Gets the default system unit.

Parameters:
getDimensionID(self) → int

–

Gets the unit dimension ID.

Parameters:self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit

:return : :rtype : int

getDimensionType(self) → int

–

Parameters:self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit

:return : :rtype : int

getReferenceUnitConvertedToUnit(self, aVolume: float) → float

–

Parameters:

:return : :rtype : float

getReferenceUnitToUnitFactor(self) → float

–

Gets the unit factor.

Parameters:self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit

:return : :rtype : float

getUnitAbbreviation(self) → str

–

Parameters:self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit

:return : :rtype : str

getUnitConvertedToReferenceUnit(self, aVolume: float) → float

–

Parameters:

:return : :rtype : float

getUnitForID(self, pDimension: int) → DimensionUnit

–

Gets the unit for the specified index.

Parameters:
getUnitName(self) → str

–

Parameters:self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit

:return : :rtype : str

getUnitWithAbbreviation(self, sAbbreviation: str) → DimensionUnit

–

Gets the unit that has the specified abbreviation.

Parameters:
none() → DimensionUnit

–

DistanceChannelAnalyzer

class ORSModel.ors.DistanceChannelAnalyzer(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.DistanceChannelAnalyzer) – an instance of DistanceChannelAnalyzer

DistanceChannelAnalyzer.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

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

–

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

–

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

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → DistanceChannelAnalyzer

–

EuclideanDistanceMapGenerator

class ORSModel.ors.EuclideanDistanceMapGenerator

Bases: ORSModel.ors.Unmanaged

brief_description: Exact euclidean distance map generator. author: N Piche All other members of ORS participated. version: 1.0 date: December 2015 Object used to generate euclidean distance map

EuclideanDistanceMapGenerator.__init__(self) -> None –

Parameters:self (ORSModel.ors.EuclideanDistanceMapGenerator) – an instance of EuclideanDistanceMapGenerator

EuclideanDistanceMapGenerator.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

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

–

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

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → EuclideanDistanceMapGenerator

–

FaceVertexMesh

class ORSModel.ors.FaceVertexMesh(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Mesh

–

Parameters:
  • self (ORSModel.ors.FaceVertexMesh) – an instance of FaceVertexMesh
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

FaceVertexMesh.__init__(self) -> None –

Parameters:self (ORSModel.ors.FaceVertexMesh) – an instance of FaceVertexMesh

FaceVertexMesh.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
copyInto(self, aDestinationUnstructuredGrid: ORSModel.ors.Node) → None

–

Copies the receiver unstructured grid into another unstructured grid.

Parameters:
getAsHalfEdgeModelCopy(self, pInOutMeshModel: ORSModel.ors.HalfEdgeMesh) → HalfEdgeMesh

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → FaceVertexMesh

–

FastMarching

class ORSModel.ors.FastMarching(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

FastMarching.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel) → None

–

Remove boundary or non reached value from a speed mapChannel.

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

–

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

–

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

–

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

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getEuclideanBias(self) → float

–

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

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : float

getForcedMeanValue(self) → float

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : float

getIndexOfStopPointReach(self) → int

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : int

getMaxValueToConsider(self) → float

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : float

getMinValueToConsider(self) → float

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : float

getROI(self, index: int) → ROI

–

Retrieves a particularROI from the index specified slot.

Parameters:
getROICount(self) → int

–

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

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : int

getStopValue(self) → float

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : float

getStopWhenValueIsEncountered(self) → bool

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : bool

getUsedForcedMean(self) → bool

–

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching

:return : :rtype : bool

none() → FastMarching

–

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

–

Parameters:
resetROIs(self) → None

–

Empties all the sourceROI slots.

Parameters:self (ORSModel.ors.FastMarching) – an instance of FastMarching
setEuclideanBias(self, EuclideanBias: float) → None

–

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

Parameters:
  • self (ORSModel.ors.FastMarching) – an instance of FastMarching
  • EuclideanBias (float) – the minimum distance between voxels (a double)
setForcedMeanValue(self, aVal: float) → None

–

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

–

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

Parameters:
  • self (ORSModel.ors.FastMarching) – an instance of FastMarching
  • inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • minX (int) – the minimum X index in the input channel (an integer)
  • minY (int) – the minimum Y index in the input channel (an integer) TODO DOCUMENT_ME: Should this be removed?
  • minZ (int) – the minimum Z index in the input channel (an unsigned short)
  • maxX (int) – the maximum X index in the input channel (an integer)
  • maxY (int) – the maximum Y index in the input channel (an integer) TODO DOCUMENT_ME
  • maxZ (int) – the maximum Z index in the input channel (an unsigned short)
  • currentT (int) – the current time point (an unsigned short)
setMaxValueToConsider(self, maxValue: float) → None

–

Parameters:
setMinValueToConsider(self, minValue: float) → None

–

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

–

Fills a particularROI slot to be used as a source for the Dijkstra algorithm.

Parameters:
setStopPosition(self, xP: int, yP: int, zP: int) → None

–

Parameters:
setStopValue(self, stopValue: float) → None

–

Parameters:
setStopWhenValueIsEncountered(self, aF: bool) → None

–

Parameters:
setUseValueWindow(self, aF: bool) → None

–

Parameters:
setUsedForcedMean(self, aF: bool) → None

–

Parameters:
useDijkstraMetric(self, aF: bool) → None

–

Parameters:

FastMarching2D

class ORSModel.ors.FastMarching2D

Bases: ORSModel.ors.Unmanaged

author: Benjamin Provencher. All other members of ORS participated. version: 1.0 date: June 2010

FastMarching2D.__init__(self) -> None –

Parameters:self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D

FastMarching2D.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel) → None

–

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

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

–

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

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getMeanValue(self) → float

–

get the mean value used in the setian metric - float a normalized value

Parameters:self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D

:return : :rtype : float

getROICount(self) → int

–

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

Parameters:self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D

:return : :rtype : int

getVolumeROI(self, index: int) → ROI

–

Retrieves a particularROI from the index specified slot.

Parameters:
none() → FastMarching2D

–

resetVolumeROIs(self) → None

–

Empties all the sourceROI slots.

Parameters:self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D
setEuclideanBias(self, EuclideanBias: float) → None

–

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

Parameters:
  • self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D
  • 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) → None

–

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

Parameters:
  • self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D
  • inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • minX (int) – the minimum X index in the input channel (an unsigned short)
  • minY (int) – the minimum Y index in the input channel (an unsigned short)
  • maxX (int) – the minimum Z index in the input channel (an unsigned short)
  • maxY (int) – the maximum X index in the input channel (an unsigned short)
  • currentT (int) – the maximum Y index in the input channel (an unsigned short)
setMeanValue(self, mean: float) → None

–

Set the mean value used in the setian metric.

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

–

Fills a particularROI slot to be used as a source for the Dijkstra algorithm.

Parameters:
useDijkstraMetric(self, pFlag: bool) → None

–

Parameters:

FastMarchingWatershed2D

class ORSModel.ors.FastMarchingWatershed2D

Bases: ORSModel.ors.FastMarching2D

author: Nicolas Piché. All other members of ORS participated. version: 1.0 date: July 2010

FastMarchingWatershed2D.__init__(self) -> None –

Parameters:self (ORSModel.ors.FastMarchingWatershed2D) – an instance of FastMarchingWatershed2D

FastMarchingWatershed2D.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getGradMinimumSearchRange(self) → int

–

Parameters:self (ORSModel.ors.FastMarchingWatershed2D) – an instance of FastMarchingWatershed2D

:return : :rtype : int

none() → FastMarchingWatershed2D

–

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

–

Parameters:
setGradMinimumSearchRange(self, range: int) → None

–

Parameters:
setLabelChannel(self, labelChannel: ORSModel.ors.Channel) → None

–

Parameters:

FordBellmanAutomata

class ORSModel.ors.FordBellmanAutomata(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata

FordBellmanAutomata.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel) → None

–

Remove boundary or non reached value from a distance mapChannel.

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

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getEuclideanBias(self) → float

–

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

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata

:return : :rtype : float

getMetric(self) → int

–

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata

:return : :rtype : int

getNeighborCount(self) → int

–

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata

:return : :rtype : int

getROI(self, index: int) → ROI

–

Retrieves a particularROI from the index specified slot.

Parameters:
getROICount(self) → int

–

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

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata

:return : :rtype : int

none() → FordBellmanAutomata

–

resetVolumeROIs(self) → None

–

Empties all the sourceROI slots.

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
setEuclideanBias(self, EuclideanBias: float) → None

–

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

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

–

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

Parameters:
  • self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
  • inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • minX (int) – the minimum X index in the input channel (an unsigned short)
  • minY (int) – the minimum Y index in the input channel (an unsigned short)
  • minZ (int) – the minimum Z index in the input channel (an unsigned short)
  • maxX (int) – the maximum X index in the input channel (an unsigned short)
  • maxY (int) – the maximum Y index in the input channel (an unsigned short)
  • maxZ (int) – the maximum Z index in the input channel (an unsigned short)
  • currentT (int) –
setMetric(self, metricType: int) → None

–

Parameters:
setNeighborCountTo18(self) → None

–

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
setNeighborCountTo26(self) → None

–

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
setNeighborCountTo6(self) → None

–

Parameters:self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI) → None

–

Fills a particularROI slot to be used as a source for the Dijkstra algorithm.

Parameters:

GaussianPyramid

class ORSModel.ors.GaussianPyramid(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid

GaussianPyramid.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
createGaussianPyramid(self, pIOutChannelsGaussianPyramid: ORSModel.ors.Channel, pNumberOfLevels: int) → None

–

Parameters:
getChannelBase(self) → Channel

–

Parameters:self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid
getClassNameStatic() → str

–

:return : :rtype : str

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

–

Parameters:
getHalfsizeKernel(self, x: int, y: int, z: int) → None

–

Parameters:
getMaxLevelGaussianPyramid(self) → int

–

Parameters:self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid

:return : :rtype : unsigned int

getMinLevelGaussianPyramid(self) → int

–

Parameters:self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid

:return : :rtype : unsigned int

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

–

Parameters:
getPerformZReduction(self) → bool

–

Parameters:self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid

:return : :rtype : bool

getSigma(self) → float

–

Parameters:self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid

:return : :rtype : float

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

–

Parameters:
none() → GaussianPyramid

–

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

–

Parameters:
setHalfsizeKernel(self, x: int, y: int, z: int) → None

–

Parameters:
setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int) → None

–

Parameters:
setOriginSubsetPixels(self, x: int, y: int, z: int, t: int) → None

–

Parameters:
setPerformZReduction(self, bValue: bool) → None

–

Parameters:
setSigma(self, value: float) → None

–

Parameters:
setSizeSubsetPixels(self, x: int, y: int, z: int, t: int) → None

–

Parameters:

Graph

class ORSModel.ors.Graph(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:
  • self (ORSModel.ors.Graph) – an instance of Graph
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Graph.__init__(self) -> None –

Parameters:self (ORSModel.ors.Graph) – an instance of Graph

Graph.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getOutgoingEdgeCountForVertex(self, vertexIndex: int) → int

–

Parameters:

:return : :rtype : int

getOutgoingEdgeForVertex(self, vertexIndex: int, index: int) → int

–

Parameters:
  • self (ORSModel.ors.Graph) – an instance of Graph
  • vertexIndex (int) –
  • index (int) –

:return : :rtype : int

getScalarSlot(self, slotIndex: int) → ArrayDouble

–

Parameters:
getScalarSlotCount(self) → int

–

Parameters:self (ORSModel.ors.Graph) – an instance of Graph

:return : :rtype : int

getVertexCount(self) → int

–

Parameters:self (ORSModel.ors.Graph) – an instance of Graph

:return : :rtype : int

getVertexDistance(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.Graph) – an instance of Graph
none() → Graph

–

prepareScalarSlot(self) → None

–

Parameters:self (ORSModel.ors.Graph) – an instance of Graph
setScalarSlotCount(self, scalarSlotCount: int) → None

–

Parameters:

GraphBuilder

class ORSModel.ors.GraphBuilder(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.GraphBuilder) – an instance of GraphBuilder

GraphBuilder.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
addEdge(self, vertexA: int, vertexB: int) → None

–

Parameters:
addEdgesCollection(self, aCollection: int, collectionSize: int) → None

–

Parameters:
generateGraph(self) → Graph

–

Parameters:self (ORSModel.ors.GraphBuilder) – an instance of GraphBuilder
getClassNameStatic() → str

–

:return : :rtype : str

none() → GraphBuilder

–

Group

class ORSModel.ors.Group(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:
  • self (ORSModel.ors.Group) – an instance of Group
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Group.__init__(self) -> None –

Parameters:self (ORSModel.ors.Group) – an instance of Group

Group.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pObject: ORSModel.ors.Managed) → None

–

Adds an object to the group.

Parameters:
addAll(self, IInputGroup: ORSModel.ors.Group) → None

–

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

Parameters:
empty(self) → None

–

Empties the group.

Parameters:self (ORSModel.ors.Group) – an instance of Group
getAllContainedInstancesOf(self, pProgId: str) → List

–

Returns all the objects of the supplied class found in the group.

Parameters:
  • self (ORSModel.ors.Group) – an instance of Group
  • pProgId (str) – a class name (a string)
getAllContainedObjectsOfClassAndPrivateTitle(self, pProgId: str, pPrivateTitle: str) → List

–

Returns all the objects of the supplied class and private title found in the group.

Parameters:
  • self (ORSModel.ors.Group) – an instance of Group
  • pProgId (str) – a class name (a string)
  • pPrivateTitle (str) – a private title (a string)
getClassNameStatic() → str

–

:return : :rtype : str

getCount(self) → int

–

Returns the count of objects in the group.

Parameters:self (ORSModel.ors.Group) – an instance of Group

:return : :rtype : unsigned int

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

–

Checks to see if an object is in the group.

Parameters:

:return : :rtype : bool

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

–

Returns the index of the supplied object in the group.

Parameters:

:return : :rtype : int

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

–

Intersects the group with another group.

Parameters:
getObjectAt(self, pos: int) → Managed

–

Returns the Nth object in the group.

Parameters:
  • self (ORSModel.ors.Group) – an instance of Group
  • pos (int) – an index (an unsigned int)
getSubtractionFrom(self, IInputGroup: ORSModel.ors.Group, IInOutGroup: ORSModel.ors.Group) → Group

–

Subtracts another group from the group.

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

–

Merges the group with another group.

Parameters:
none() → Group

–

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

–

Removes an object from the group.

Parameters:
removeAll(self, IInputGroup: ORSModel.ors.Group) → None

–

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

Parameters:

HalfEdgeMesh

class ORSModel.ors.HalfEdgeMesh(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Mesh

–

Parameters:
  • self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

HalfEdgeMesh.__init__(self) -> None –

Parameters:self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh

HalfEdgeMesh.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
copyInto(self, aDestinationUnstructuredGrid: ORSModel.ors.Node) → None

–

Copies the receiver unstructured grid into another unstructured grid.

Parameters:
getAsFaceVertexModelCopy(self, pInOutMeshModel: ORSModel.ors.FaceVertexMesh) → FaceVertexMesh

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getEdgesInFaceVertexTopology(self, iTIndex: int) → ArrayUnsignedLong

–

Parameters:
getFacesAdjacencyArray(self, iTIndex: int) → ArrayUnsignedLong

–

Get the Faces Adjacent EdgeArray, containning, for each face f, the index e of an adjacent edge (i.e. pFaceAdjacentEdges->at(faceIdx) == edgeIdx)

Parameters:
getVerticesAdjacencyArray(self, iTIndex: int) → ArrayUnsignedLong

–

Get the Vertices Outgoing EdgeArray, containning, for each vertex v, the index e of a edge outgoing from v (i.e. pVerticesOutgoingEdges->at(vertexIdx) == outgoingEdgeIdx)

Parameters:
none() → HalfEdgeMesh

–

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

–

Parameters:

HistogramAnalyzer

class ORSModel.ors.HistogramAnalyzer(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer

HistogramAnalyzer.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

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

–

Fill a 1D histogram from the channel values, over the voxels specified by theROI.

Parameters:
  • self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer
  • 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) → None

–

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

Parameters:
  • self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer
  • 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) → None

–

Fill a 1D histogram from the collection values, over the elements specified by the filter collection.

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

–

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

Parameters:
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) → None

–

Fill a 2D histogram from the channels values, over the voxels specified by theROI.

Parameters:
  • self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer
  • 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) → None

–

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

Parameters:
  • self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer
  • 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) → None

–

Fill a 2D histogram from the collections values, over the elements specified by the filter collection.

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

–

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

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

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

–

Computes the Otsu threshold value aint32_t a dimension.

Parameters:

:return : :rtype : 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) → None

–

Map labels of a LMR having the same shape as the 2D histogram into a LMR using the channels values.

Parameters:
  • self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer
  • 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

–

HistogramData

class ORSModel.ors.HistogramData

Bases: ORSModel.ors.Node

brief_description: An object that contains histogram data. author: Thierry Côté. All other members of ORS participated. version: 1.0 date: August 2005 An object that contains histogram data. Histograms can contain multiple dimensions (ex: one dimension for each color in a multicolor volume, and another for all of them). And, it can be in 1D or 2D, based on intensity for the 1D, and on both intensity and gradient in 2D. Size of bins stays constant across dimensions, but it is possible to choose different bin sizes for 1D and 2D.

HistogramData.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

HistogramData.__init__(self) -> None –

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData

HistogramData.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addCountAtIndex1D(self, iIndex: int, countToAdd: int) → None

–

Add a number of counts at the given indexes.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • iIndex (int) – bin index of the dimension 0
  • countToAdd (int) – number of counts to add
addCountAtIndex2D(self, iIndex0: int, iIndex1: int, countToAdd: int) → None

–

Add a number of counts at the given indexes.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • iIndex0 (int) – bin index of the dimension 0
  • iIndex1 (int) – bin index of the dimension 1
  • countToAdd (int) – number of counts to add
addCountAtIndexND(self, iIndex: ORSModel.ors.ArrayUnsignedLong, countToAdd: int) → None

–

Add a number of counts at the given indexes.

Parameters:
addCountAtValue1D(self, dValue: float, countToAdd: int, pBinIndex: int) → None

–

Add a number of counts for the given values.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • 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) → None

–

Add a number of counts for the given values.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • 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
addCountAtValueND(self, dValues: ORSModel.ors.ArrayDouble, countToAdd: int, pLinearBinIndex: int) → None

–

Add a number of counts for the given values.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • dValues (ORSModel.ors.ArrayDouble) – array of values (1 value for each dimension)
  • countToAdd (int) – number of counts to add
  • pLinearBinIndex (int) – returned value of the linear bin index where the count is added
copyInto(self, destination: ORSModel.ors.HistogramData) → None

–

Copies the current histogram data in to the destination.

Parameters:
downSample(self, dimension: int, dStart: float, dEnd: float, nBins: int) → HistogramData

–

Returns a downsampled histogram.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • 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

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

Returns a downsampled histogram.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • dimension (int) – index of the dimension (starting at 0)
  • nBins (int) – number of bins for the new histogram
getBinCount(self, dimension: int) → int

–

Get the number of bins in a given dimension.

Parameters:

:return : :rtype : unsigned int

getBinCounts(self) → ArrayUnsignedLong

–

Get the number of bins in each dimension.

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData
getBinEdges(self, dimension: int) → ArrayDouble

–

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

Parameters:
getBinEdgesEnd(self, dimension: int) → float

–

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

Parameters:

:return : :rtype : float

getBinEdgesStart(self, dimension: int) → float

–

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

Parameters:

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getCountAtIndex1D(self, iIndex: int) → int

–

Get the number of counts at the given index.

Parameters:

:return : :rtype : int

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

–

Get the number of counts at the given index.

Parameters:

:return : :rtype : int

getCountAtIndexND(self, iIndex: ORSModel.ors.ArrayUnsignedLong) → int

–

Get the number of counts at the given indexes.

Parameters:

:return : :rtype : int

getCumulativeDistribution(self, dimension: int) → HistogramData

–

Computes the cumulative distribution aint32_t one dimension.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • dimension (int) – dimension aint32_t which the cumulation is made
getData(self) → ArrayUnsignedLONGLONG

–

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData
getDimensionCount(self) → int

–

Get the number of dimensions.

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData

:return : :rtype : unsigned int

getIndexAtValue1D(self, dValue: float) → int

–

Determines the bin index for a given value.

Parameters:

:return : :rtype : unsigned int

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

–

Determines the bin index for a given value in a given dimension.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • dimension (int) – index of the dimension (starting at 0)
  • dValue (float) – value

:return : :rtype : unsigned int

getIndexAtValueND(self, dValues: ORSModel.ors.ArrayDouble) → ArrayUnsignedLong

–

Determines the bin indexes for a set of values.

Parameters:
getIsDataInitialized(self) → bool

–

Get the status of the data.

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData

:return : :rtype : bool

getIsHistogramDegenerated(self) → bool

–

Get the degenerated state of the histogram.

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData

:return : :rtype : bool

getIsSparse(self) → bool

–

Get the sparse representation state.

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData

:return : :rtype : bool

getTotalCount(self) → int

–

Get the total number of counts.

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData

:return : :rtype : int

initializeData(self) → bool

–

Initialize the memory to contain the histogram data. If the data is already initialized, all values of the data are set to 0.

Parameters:self (ORSModel.ors.HistogramData) – an instance of HistogramData

:return : :rtype : bool

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

–

Determines if the given value is in the range.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • dimension (int) – index of the dimension (starting at 0)
  • dValue (float) – value to test

:return : :rtype : bool

none() → HistogramData

–

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

–

Set the range for a given dimension, with bin edges specified individually.

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

–

Set the range for a given dimension, for equally spaced bins, using the starting value, the end value and the number of bins.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • 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) → None

–

Set the range for a given dimension, for equally spaced bins, using the starting value, the bin width and the number of bins.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • 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) → None

–

Set the number of counts at the given index.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • iIndex (int) – bin index in which the count should be set
  • countToSet (int) – number of counts to set
setCountAtIndex2D(self, iIndex0: int, iIndex1: int, countToSet: int) → None

–

Set the number of counts at the given index.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • iIndex0 (int) – bin index in which the count should be set
  • iIndex1 (int) – number of counts to set
  • countToSet (int) –
setCountAtIndexND(self, iIndex: ORSModel.ors.ArrayUnsignedLong, countToSet: int) → None

–

Set the number of counts at the given indexes.

Parameters:
setDimensionCount(self, nbDimensions: int) → None

–

Sets the number of dimensions.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • nbDimensions (int) – number of dimensions (an unsigned int)
setUseSparse(self, bUseSparse: bool) → None

–

Specifies if a sparse representation should be used internally.

Parameters:
  • self (ORSModel.ors.HistogramData) – an instance of HistogramData
  • bUseSparse (bool) – TRUE to use a sparse represenation, FALSE to use a dense representation
sumAlongDimension(self, dimension: int) → HistogramData

–

Sum the counts along one dimension.

Parameters:

Image

class ORSModel.ors.Image(self) → None

Bases: ORSModel.ors.Node

–

Parameters:self (ORSModel.ors.Image) – an instance of Image

Image.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
copy(self) → Image

–

Copies the current image object.

Parameters:self (ORSModel.ors.Image) – an instance of Image
copyDataFromChannel(self, aChannel: ORSModel.ors.Channel, timeStep: int) → None

–

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

–

Parameters:
dtype
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) → None

–

Parameters:self (ORSModel.ors.Image) – an instance of Image
flipImageDataVertically(self) → None

–

Parameters:self (ORSModel.ors.Image) – an instance of Image
getAllocatedSize(self) → int

–

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : int

getBoundedPlane(self) → Rectangle

–

Parameters:self (ORSModel.ors.Image) – an instance of Image
getClassNameStatic() → str

–

:return : :rtype : str

getComponent(index)
getComponentCountPerPixel(self) → int

–

Gets the number of components per pixel.

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : int

getComponents()
getDataOffsetForPixelComponent(self, componentIndex: int) → float

–

Parameters:

:return : :rtype : float

getDataSlopeForPixelComponent(self, componentIndex: int) → float

–

Parameters:

:return : :rtype : float

getDataType(self) → int

–

Gets the image data type.

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : int

getIsDataInitialized(self) → bool

–

Checks if the internal data is initialized.

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : bool

getMaxU(self) → float

–

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : float

getMaxV(self) → float

–

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : float

getMinU(self) → float

–

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : float

getMinV(self) → float

–

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : float

getNDArray()
getRawImageData(self) → None

–

Parameters:self (ORSModel.ors.Image) – an instance of Image
getXSize(self) → int

–

Gets the X size of the image.

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : int

getYSize(self) → int

–

Gets the Y size of the image.

Parameters:self (ORSModel.ors.Image) – an instance of Image

:return : :rtype : int

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

–

Initializes the image.

Parameters:
  • self (ORSModel.ors.Image) – an instance of Image
  • 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)

:return : :rtype : bool

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

–

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

–

Parameters:
setDataOffsetForPixelComponent(self, offset: float, componentIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.Image) – an instance of Image
  • offset (float) –
  • componentIndex (int) –
setDataSlopeForPixelComponent(self, slope: float, componentIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.Image) – an instance of Image
  • slope (float) –
  • componentIndex (int) –
setDirections(self, direction0: ORSModel.ors.Vector3, direction1: ORSModel.ors.Vector3) → None

–

Parameters:
setMaxU(self, aValue: float) → None

–

Parameters:
setMaxV(self, aValue: float) → None

–

Parameters:
setMinU(self, aValue: float) → None

–

Parameters:
setMinV(self, aValue: float) → None

–

Parameters:
setOrigin(self, origin: ORSModel.ors.Vector3) → None

–

Parameters:
setSpacings(self, xSpacing: float, ySpacing: float) → None

–

Parameters:
  • self (ORSModel.ors.Image) – an instance of Image
  • xSpacing (float) –
  • ySpacing (float) –
shape
transform(self, aTransformationMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:

ImageCollection

class ORSModel.ors.ImageCollection(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:

ImageCollection.__init__(self) -> None –

Parameters:self (ORSModel.ors.ImageCollection) – an instance of ImageCollection

ImageCollection.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
deleteAllImages(self) → None

–

Deletes all images.

Parameters:self (ORSModel.ors.ImageCollection) – an instance of ImageCollection
getClassNameStatic() → str

–

:return : :rtype : str

getImageAtIndex(self, imageIndex: int) → Image

–

Gets the image at an index position.

Parameters:
getImageCount(self) → int

–

Gets the image count.

Parameters:self (ORSModel.ors.ImageCollection) – an instance of ImageCollection

:return : :rtype : int

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

–

Gets the index position of an image.

Parameters:

:return : :rtype : int

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

–

Inserts an image at a given index.

Parameters:
insertImageFirst(self, anImage: ORSModel.ors.Image) → None

–

Inserts an image at start of list.

Parameters:
insertImageLast(self, anImage: ORSModel.ors.Image) → None

–

Inserts an image at end of list.

Parameters:
none() → ImageCollection

–

removeAllImages(self) → None

–

Removes all images.

Parameters:self (ORSModel.ors.ImageCollection) – an instance of ImageCollection
removeImage(self, anImage: ORSModel.ors.Image) → None

–

Removes an image.

Parameters:
removeImageAtIndex(self, imageIndex: int) → None

–

Removes the image at given index.

Parameters:

ImageCollectionPresenter

class ORSModel.ors.ImageCollectionPresenter(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.DatasetPresenter

–

Parameters:

ImageCollectionPresenter.__init__(self) -> None –

Parameters:self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter

ImageCollectionPresenter.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

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

–

Parameters:

:return : :rtype : int

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

–

Parameters:

:return : :rtype : bool

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

–

Parameters:

:return : :rtype : bool

getPresentationBoundedPlane(self) → Rectangle

–

Parameters:self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter
none() → ImageCollectionPresenter

–

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

–

Parameters:
setNodeNotVisibleForAllImage(self, aNode: ORSModel.ors.Node) → None

–

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

–

Parameters:
setNodeVisibleForAllImage(self, aNode: ORSModel.ors.Node) → None

–

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

–

Parameters:
setPresentationBoundedPlane(self, aBoudedPlane: ORSModel.ors.Rectangle) → None

–

Parameters:

Intersection

class ORSModel.ors.Intersection

Bases: ORSModel.ors.Unmanaged

brief_description: Represents a ray pick result. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: View::pick(), Node::pick()

Intersection.__init__(self) -> None –

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

Intersection.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getClosestVisual(self) → Visual

–

Returns the picked visual object closest to the pick point.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getClosestVisualOfClass(self, pProgId: str) → Visual

–

Returns the visual object of a given class closest to the pick point.

Parameters:
getColor(self) → Color

–

Returns the color value of the intersection.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getColorInPhysicalUnits(self) → Color

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getControlPointIndexHit(self) → int

–

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getDataUnit(self) → str

–

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : str

getDistance(self) → float

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getFarthestVisual(self) → Visual

–

Returns the picked visual object farthest from the pick point.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getFarthestVisualOfClass(self, pProgId: str) → Visual

–

Returns the visual object of a given class farthest from the pick point.

Parameters:
getHit(self) → bool

–

Checks if the ray pick intersects something.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : bool

getHitCount(self) → int

–

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getMeshFace(self) → int

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getMeshFaceBary1(self) → float

–

Returns the barycentric coordinate 1.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getMeshFaceBary2(self) → float

–

Returns the barycentric coordinate 1.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getMeshVertexIndex0(self) → int

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getMeshVertexIndex1(self) → int

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getMeshVertexIndex2(self) → int

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getNearestMeshVertexIndex(self) → int

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getNthDistance(self, nth: int) → float

–

Parameters:

:return : :rtype : float

getNthLabel(self, nth: int) → int

–

Parameters:

:return : :rtype : unsigned int

getNthMeshFace(self, nth: int) → int

–

Parameters:

:return : :rtype : int

getNthMeshFaceBary1(self, nth: int) → float

–

Parameters:

:return : :rtype : float

getNthMeshFaceBary2(self, nth: int) → float

–

Parameters:

:return : :rtype : float

getNthMeshVertexIndex0(self, nth: int) → int

–

Parameters:

:return : :rtype : int

getNthMeshVertexIndex1(self, nth: int) → int

–

Parameters:

:return : :rtype : int

getNthMeshVertexIndex2(self, nth: int) → int

–

Parameters:

:return : :rtype : int

getNthNearestMeshVertexIndex(self, nth: int) → int

–

Parameters:

:return : :rtype : int

getNthPositionInLocalCoordinates(self, nth: int) → Vector3

–

Parameters:
getNthPositionInWorldCoordinates(self, nth: int) → Vector3

–

Parameters:
getNthScalarValue(self, nth: int) → float

–

Parameters:

:return : :rtype : float

getOffset(self) → float

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getPickDirection(self) → Vector3

–

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getPickOrigin(self) → Vector3

–

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getPixelPositionInView(self) → Vector3

–

Returns the position of the intersection in screen coordinates.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getPositionInLocalCoordinates(self) → Vector3

–

Returns the position of the intersection in local coordinates.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getPositionInVoxelIndex(self) → Vector3

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getPositionInWorldCoordinates(self) → Vector3

–

Returns the position of the intersection in world coordinates.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection
getScalarValue(self) → float

–

Returns the scalar value of the picked triangle.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getSlope(self) → float

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getStructuredGridAtIndex(self, iIndex: int) → StructuredGrid

–

Returns the Nth picked structured grid object.

Parameters:
  • self (ORSModel.ors.Intersection) – an instance of Intersection
  • iIndex (int) – the structured grid index (an unsigned short, zero based)
getStructuredGridCount(self) → int

–

Returns the number of structured grid objects that were intersected by the ray pick.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getTimeStep(self) → int

–

Returns the T value of the intersection.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getVisualAtIndex(self, iIndex: int) → Visual

–

Returns the Nth picked visual object.

Parameters:
  • self (ORSModel.ors.Intersection) – an instance of Intersection
  • iIndex (int) – the visual index (an unsigned short, zero based)
getVisualCount(self) → int

–

Returns the number of visual objects that were intersected by the ray pick.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getVoxelIndex(self) → int

–

Returns the index of the voxel being picked.

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : int

getWindowLeveledNormalizedValue(self) → float

–

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

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getXIndexInCurvedChannel(self) → float

–

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

getYIndexInCurvedChannel(self) → float

–

Parameters:self (ORSModel.ors.Intersection) – an instance of Intersection

:return : :rtype : float

none() → Intersection

–

Layout

class ORSModel.ors.Layout

Bases: ORSModel.ors.Managed

brief_description: object used to describe a view layout author: N Piche All other members of ORS participated. version: 1.0 date: December 2015 Object that represent a layout of views

Layout.__init__(self) -> None –

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

Layout.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addFirst(self, aLayout: ORSModel.ors.Layout) → None

–

Parameters:
addLast(self, aLayout: ORSModel.ors.Layout) → None

–

Parameters:
copy(self) → Layout

–

Returns a copy of the node.

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getAllChildLayout(self) → List

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getAllChildViews(self) → List

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getAllLeaves(self) → List

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getBottomRight(self) → Vector3

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getBottomRightPositionOfChildren(self, aLayout: ORSModel.ors.Layout) → Vector3

–

Parameters:
getChildWithPrivateTitle(self, privateTitle: str) → Layout

–

Parameters:
getChildren(self) → List

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getChildrenAtIndex(self, index: int) → Layout

–

Parameters:
getChildrenCount(self) → int

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : unsigned int

getClassNameStatic() → str

–

:return : :rtype : str

getContext()
getEnabled(self) → bool

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : bool

getEnabledChildrenCount(self) → int

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : unsigned int

getGenealogicalName(self) → str

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : str

getHasChildren(self) → bool

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : bool

getIsLayoutMyDescendent(self, aLayout: ORSModel.ors.Layout) → bool

–

Parameters:

:return : :rtype : bool

getIsLinear(self) → bool

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : bool

getIsMyChildren(self, aLayout: ORSModel.ors.Layout) → bool

–

Parameters:

:return : :rtype : bool

getIsVertical(self) → bool

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : bool

getLayoutClass(self) → str

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : str

getLeaveEmpty(self) → bool

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : bool

getParent(self) → Layout

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getTopLeft(self) → Vector3

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
getTopLeftPositionOfChildren(self, aLayout: ORSModel.ors.Layout) → Vector3

–

Parameters:
getViewGUID(self) → str

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : str

getWeight(self) → float

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : float

none() → Layout

–

normalizeChildrenWeights(self) → None

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
propagateLayoutUpdated(self) → bool

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout

:return : :rtype : bool

removeAllChildren(self) → None

–

Parameters:self (ORSModel.ors.Layout) – an instance of Layout
removeChildren(self, aLayout: ORSModel.ors.Layout) → None

–

Parameters:
replaceChildren(self, aLayoutToBeReplace: ORSModel.ors.Layout, aLayoutReplacement: ORSModel.ors.Layout) → bool

–

Parameters:

:return : :rtype : bool

setBottomRight(self, aVector: ORSModel.ors.Vector3) → None

–

Parameters:
setEnabled(self, bEnabled: bool) → None

–

Parameters:
setIsLinear(self, aValue: bool) → None

–

Parameters:
setIsVertical(self, aValue: bool) → None

–

Parameters:
setLayoutClass(self, aClass: str) → None

–

Parameters:
setLeaveEmpty(self, aValue: bool) → None

–

Parameters:
setTopLeft(self, aVector: ORSModel.ors.Vector3) → None

–

Parameters:
setViewGUID(self, aGUID: str) → None

–

Parameters:
setWeight(self, aValue: float) → None

–

Parameters:

Line

class ORSModel.ors.Line

Bases: ORSModel.ors.Shape2D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Line.__init__(self) -> None –

Parameters:self (ORSModel.ors.Line) – an instance of Line

Line.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → Line

–

Gets a copy of the receiver.

Parameters:self (ORSModel.ors.Line) – an instance of Line
fromOriginAndOrientation(self, origin: ORSModel.ors.Vector3, orientation: ORSModel.ors.Vector3) → None

–

Sets the the origin and orientation of the line.

Parameters:
fromTwoPoints(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3) → None

–

Sets the the origin and orientation of the line based on the two provided points.

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getClosestPointOnLineFromPoint(self, aPoint: ORSModel.ors.Vector3) → Vector3

–

Parameters:
getDistanceFromLine(self, aLine: ORSModel.ors.Line) → float

–

Parameters:

:return : :rtype : float

getDistanceFromPoint(self, pVect: ORSModel.ors.Vector3) → float

–

Gets the distance from the receiver to the provided point.

Parameters:

:return : :rtype : float

getIsEqualTo(self, aLine: ORSModel.ors.Line) → bool

–

Parameters:

:return : :rtype : bool

getOrientation(self) → Vector3

–

Gets the receiver orientation.

Parameters:self (ORSModel.ors.Line) – an instance of Line
getOrigin(self) → Vector3

–

Gets the receiver origin position.

Parameters:self (ORSModel.ors.Line) – an instance of Line
none() → Line

–

setOrientation(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the receiver orientation.

Parameters:
setOrigin(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the receiver origin position.

Parameters:

LineSegment

class ORSModel.ors.LineSegment

Bases: ORSModel.ors.Shape2D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

LineSegment.__init__(self) -> None –

Parameters:self (ORSModel.ors.LineSegment) – an instance of LineSegment

LineSegment.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → LineSegment

–

Gets a copy of the receiver.

Parameters:self (ORSModel.ors.LineSegment) – an instance of LineSegment
fromOriginAndDirectionAndLength(self, origin: ORSModel.ors.Vector3, direction: ORSModel.ors.Vector3, length: float) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getDistanceFromPoint(self, pVect: ORSModel.ors.Vector3) → float

–

Gets the distance from the receiver to the provided point,.

Parameters:

:return : :rtype : float

getEnd(self) → Vector3

–

Gets the receiver end point.

Parameters:self (ORSModel.ors.LineSegment) – an instance of LineSegment
getIsEqualTo(self, aLineSegment: ORSModel.ors.LineSegment) → bool

–

Parameters:

:return : :rtype : bool

getLength(self) → float

–

Gets the receiver length.

Parameters:self (ORSModel.ors.LineSegment) – an instance of LineSegment

:return : :rtype : float

getStart(self) → Vector3

–

Gets the receiver start point.

Parameters:self (ORSModel.ors.LineSegment) – an instance of LineSegment
none() → LineSegment

–

setEnd(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the receiver end point.

Parameters:
setStart(self, pVect: ORSModel.ors.Vector3) → None

–

Set the receiver start point.

Parameters:

List

class ORSModel.ors.List

Bases: ORSModel.ors.ORSBaseClass

brief_description: A list of author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: 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.

List.__init__(self) -> None –

Parameters:self (ORSModel.ors.List) – an instance of List

List.__init__(self, rhs: ORSModel.ors.List) -> None –

Parameters:

List.__init__(self, pythonListOfGUID: str) -> None –

Parameters:

List.__init__(self) -> None –

Parameters:self (ORSModel.ors.List) – an instance of List
add(self, pObject: ORSModel.ors.Managed) → None

–

Adds an object to the list.

Parameters:
appendAllObjects(self, pList: ORSModel.ors.List) → None

–

Appends a list to the list.

Parameters:
appendNonPresentObjects(self, pList: ORSModel.ors.List) → None

–

Appends a list to the list, taking only the objects not present in the receiver.

Parameters:
extend(iterable)
getAllElementsOfClass(self, sClassname: str) → List

–

Gets all the elements that beint32_t to a given class.

Parameters:
  • self (ORSModel.ors.List) – an instance of List
  • sClassname (str) – the class name of the class to test against (a string)
getClassNameStatic() → str

–

:return : :rtype : str

getCount(self) → int

–

Returns the count of objects in the list.

Parameters:self (ORSModel.ors.List) – an instance of List

:return : :rtype : unsigned int

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

–

Verifies if an object is present in the list.

Parameters:

:return : :rtype : bool

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

–

Parameters:

:return : :rtype : int

getIntersectionWith(self, pList: ORSModel.ors.List) → List

–

Returns the intersection of the list with another list.

Parameters:
getObjectAt(self, pos: int) → Managed

–

Gets an object from the list at the specified index.

Parameters:
  • self (ORSModel.ors.List) – an instance of List
  • pos (int) – an index (an unsigned int)
getPythonRepresentation(self) → str

–

Returns the python representation of the list.

Parameters:self (ORSModel.ors.List) – an instance of List

:return : :rtype : str

getSubtractionFrom(self, pList: ORSModel.ors.List) → List

–

Returns the subtraction of another list from the list.

Parameters:
getUnionWith(self, pList: ORSModel.ors.List) → List

–

Returns the union of the list with another list.

Parameters:
index(item)
isNone(self) → bool

–

Parameters:self (ORSModel.ors.List) – an instance of List

:return : :rtype : bool

isNotNone(self) → bool

–

Parameters:self (ORSModel.ors.List) – an instance of List

:return : :rtype : bool

loadFromFile(self, sFilename: str, preserveIdentity: bool, progress: ORSModel.ors.Progress) → None

–

Loads all the objects found within the file and adds them to the list.

Parameters:
  • self (ORSModel.ors.List) – an instance of List
  • sFilename (str) – an input filename (a string)
  • preserveIdentity (bool) – true to preserve identity, false otherwise (see note)
  • progress (ORSModel.ors.Progress) – a progress object
loadFromFileFiltered(self, sFilename: str, preserveIdentity: bool, classNames: ORSModel.ors.typing.List[str], progress: ORSModel.ors.Progress) → None

–

Loads all the objects found within the file and adds them to the list, keeping only specified classes.

Parameters:
  • self (ORSModel.ors.List) – an instance of List
  • sFilename (str) – an input filename (a string)
  • preserveIdentity (bool) – true to preserve identity, false otherwise (see note)
  • classNames (std::list< std::wstring >) – list of class names (see note)
  • progress (ORSModel.ors.Progress) – a progress object
none() → List

–

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

–

Removes an object from the list.

Parameters:

:return : :rtype : bool

removeDuplicates(self) → None

–

Parameters:self (ORSModel.ors.List) – an instance of List
saveToFile(self, sFilename: str) → int

–

Saves all the objects in the list to a file.

Parameters:
  • self (ORSModel.ors.List) – an instance of List
  • sFilename (str) – an output filename (a string)

:return : :rtype : int

Loader

class ORSModel.ors.Loader

Bases: ORSModel.ors.Managed

brief_description: Allows to load previously saved author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: 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).

Loader.__init__(self) -> None –

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

Loader.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getCurrentNodeAttributeValue(self, attributeName: str) → str

–

Parameters:

:return : :rtype : str

getCurrentNodeBoolAttributeValue(self, sAttributeName: str) → bool

–

Gets a boolean attribute from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sAttributeName (str) – the attribute name (a string)

:return : :rtype : bool

getCurrentNodeBoolValue(self) → bool

–

Gets the current node boolean value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : bool

getCurrentNodeDoubleAttributeValue(self, sAttributeName: str) → float

–

Gets a double attribute from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sAttributeName (str) – the attribute name (a string)

:return : :rtype : float

getCurrentNodeDoubleValue(self) → float

–

Gets the current node double value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : float

getCurrentNodeFloatAttributeValue(self, sAttributeName: str) → float

–

Gets a float attribute from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sAttributeName (str) – the attribute name (a string)

:return : :rtype : float

getCurrentNodeFloatValue(self) → float

–

Gets the current node float value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : float

getCurrentNodeIntAttributeValue(self, sAttributeName: str) → int

–

Gets an int attribute from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sAttributeName (str) – the attribute name (a string)

:return : :rtype : int

getCurrentNodeIntValue(self) → int

–

Gets the current node int value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : int

getCurrentNodeLONGLONGValue(self) → int

–

Gets the current node int64_t value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : int

getCurrentNodeName(self) → str

–

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : str

getCurrentNodeShortAttributeValue(self, sAttributeName: str) → int

–

Gets a short attribute from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sAttributeName (str) – the attribute name (a string)

:return : :rtype : int

getCurrentNodeShortValue(self) → int

–

Gets the current node short value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : int

getCurrentNodeULONGLONGValue(self) → int

–

Gets the current node uint64_t value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : int

getCurrentNodeUnsignedIntAttributeValue(self, sAttributeName: str) → int

–

Gets an unsigned int attribute from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sAttributeName (str) – the attribute name (a string)

:return : :rtype : unsigned int

getCurrentNodeUnsignedIntValue(self) → int

–

Gets the current node unsigned int value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : unsigned int

getCurrentNodeUnsignedShortAttributeValue(self, sAttributeName: str) → int

–

Gets an unsigned short attribute from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sAttributeName (str) – the attribute name (a string)

:return : :rtype : int

getCurrentNodeUnsignedShortValue(self) → int

–

Gets the current node unsigned short value in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : int

getCurrentNodeValue(self) → str

–

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : str

getNodeBoolValueFromCurrentNode(self, sElementName: str) → bool

–

Gets a boolean element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : bool

getNodeCount(self, pXpath: str) → int

–

Returns the nodes count according to an XPATH.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • pXpath (str) – the XPATH to search for (a string)

:return : :rtype : unsigned int

getNodeDoubleValueFromCurrentNode(self, sElementName: str) → float

–

Gets a double element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : float

getNodeFloatValueFromCurrentNode(self, sElementName: str) → float

–

Gets a float element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : float

getNodeIntValueFromCurrentNode(self, sElementName: str) → int

–

Gets an int element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : int

getNodeLONGLONGValueFromCurrentNode(self, sElementName: str) → int

–

Gets a int64_t element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : int

getNodeShortValueFromCurrentNode(self, sElementName: str) → int

–

Gets a short element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : int

getNodeULONGLONGValueFromCurrentNode(self, sElementName: str) → int

–

Gets a uint64_t element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : int

getNodeUnsignedIntValueFromCurrentNode(self, sElementName: str) → int

–

Gets an unsigned int element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : unsigned int

getNodeUnsignedShortValueFromCurrentNode(self, sElementName: str) → int

–

Gets an unsigned short element from the current node in an XML tree being parsed.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • sElementName (str) – the element name (a string)

:return : :rtype : int

getNodeValueFromCurrentNode(self, pXpath: str) → str

–

Parameters:

:return : :rtype : str

getVersionFromFile(self, filename: str) → str

–

Returns the version number stored in a session file.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • filename (str) – the file name (a string)

:return : :rtype : str

loadObjectsFromFile(self, filename: str) → None

–

Loads objects from a file.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • filename (str) – the file name (a string)
loadObjectsFromXML(self, anXML: str) → None

–

Loads objects from an XML string.

Parameters:
none() → Loader

–

pop(self) → None

–

Goes up one level in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader
setCurrentNode(self, pXpath: str) → bool

–

Selects a node in an XML tree being parsed.

Parameters:

:return : :rtype : bool

setCurrentNodeFromCurrentNode(self, pXpath: str) → bool

–

Selects a node in an XML tree, under the current node.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • pXpath (str) – the node name (a string)

:return : :rtype : bool

setCurrentNodeToCurrentNodeNextSibling(self) → bool

–

Moves to the next node equivalent to the current node, in an XML tree being parsed.

Parameters:self (ORSModel.ors.Loader) – an instance of Loader

:return : :rtype : bool

setXMLString(self, aXMLString: str) → bool

–

Gives an XML string to the loader and DOMifies it.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • aXMLString (str) – an XML string (a string)

:return : :rtype : bool

setXMLStringFromFilename(self, filename: str) → bool

–

Gives an XML string from a file to the loader and DOMifies it.

Parameters:
  • self (ORSModel.ors.Loader) – an instance of Loader
  • filename (str) – a filename containing the XML string (a string)

:return : :rtype : bool

LookupTable

class ORSModel.ors.LookupTable

Bases: ORSModel.ors.Node

brief_description: A Lookup Table that can adopt predefined and/or custom looks. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: August 2005 see: VisualMesh::setLookupTable(), Vector3::setLookupTable() A Lookup Table that can adopt predefined and/or custom looks. It contains the ambiant, power, diffuse, emissive and specular properties.

LookupTable.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

LookupTable.__init__(self) -> None –

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable

LookupTable.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
appendColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
build(self) → None

–

Builds the LUT according to its settings.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable
copyFrom(self, ILookupTable: ORSModel.ors.LookupTable) → None

–

Parameters:
fillRGBAColorArray(self, startIndex: int, endIndex: int, colorsArray: int, subtractFactors: int) → None

–

Dump the lut in arrays.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • 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()
findControlPointIndexForPosition(self, pX: float) → int

–

Searches for a control point according to its position.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • pX (float) – the X coordinate of the control point (a float)

:return : :rtype : unsigned int

getClassNameStatic() → str

–

:return : :rtype : str

getColorAtIndex(self, inValue: int) → Color

–

Get color at a given index.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • inValue (int) – the color index (in range [0, getTableSize()-1] ) (an int)
getColorAtPosition(self, position: float) → Color

–

Gets the color at a given position.

Parameters:
getColorFromPosition(self, position: float, aColor: ORSModel.ors.Color) → None

–

Gets the color at a given position.

Parameters:
getControlPointColor(self, index: int) → Color

–

Retrieves the color of a control point.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • index (int) – the control point index (an unsigned int)
getControlPointCount(self) → int

–

Retrieves the total number of control points in the LUT.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable

:return : :rtype : unsigned int

getControlPointPositionX(self, index: int) → float

–

Retrieves the X coordinate of a control point.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • index (int) – the control point index (an unsigned int)

:return : :rtype : float

getControlPointPositionY(self, index: int) → float

–

Retrieves the Y coordinate of a control point.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • index (int) – the control point index (an unsigned int)

:return : :rtype : float

getGamma(self) → float

–

Gets the gamma value.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable

:return : :rtype : float

getIsDiscrete(self) → bool

–

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable

:return : :rtype : bool

getTableSize(self) → int

–

Get the table size.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable

:return : :rtype : unsigned int

insertControlPointAt(self, index: int, x: float, y: float, IColor: ORSModel.ors.Color) → None

–

Inserts a control point.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • index (int) – the control point index (an unsigned int)
  • x (float) – the X coordinate of the control point (a float)
  • y (float) – the Y coordinate of the control point (a float)
  • IColor (ORSModel.ors.Color) – the color (an Color)
none() → LookupTable

–

removeAllControlPoints(self) → None

–

Removes all LUT control points.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable
removeColorAtIndex(self, nIndex: int) → bool

–

Parameters:

:return : :rtype : bool

removeControlPointAt(self, index: int) → None

–

Removes a control point.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • index (int) – the control point index (an unsigned int)
setColorAtIndex(self, nIndex: int, IColor: ORSModel.ors.Color) → None

–

Parameters:
setColorAtPosition(self, position: float, IColor: ORSModel.ors.Color) → None

–

Sets the color at a given position.

Parameters:
setColorForIndexRange(self, nStartIndex: int, nEndIndex: int, IColor: ORSModel.ors.Color) → None

–

Set color at a given index range.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • nStartIndex (int) – the color start index (in range [0, getTableSize()-1] ) (an int)
  • nEndIndex (int) – the color end index (in range [0, getTableSize()-1] ) (an int)
  • IColor (ORSModel.ors.Color) –
setControlPointColor(self, index: int, IColor: ORSModel.ors.Color) → None

–

Changes the color of a control point.

Parameters:
setControlPointPosition(self, index: int, pX: float, pY: float) → None

–

Changes the position of a control point.

Parameters:
  • self (ORSModel.ors.LookupTable) – an instance of LookupTable
  • index (int) – the control point index (an unsigned int)
  • pX (float) – the new X coordinate of the control point (a float)
  • pY (float) – the new Y coordinate of the control point (a float)
setGamma(self, value: float) → None

–

Sets the gamma value.

Parameters:
setIsDiscrete(self, bDiscrete: bool) → None

–

Parameters:
setRampBMPFile(self, filepath: str) → None

–

Sets the LUT to BMP file.

Parameters:
setRampGrayScale(self) → None

–

Sets the LUT to be gray scale.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable
setRampRainbow(self) → None

–

Sets the LUT to be rainbow.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable
setRampUserDefined(self) → None

–

Sets the LUT to be user-defined.

Parameters:self (ORSModel.ors.LookupTable) – an instance of LookupTable
setTableSize(self, size: int) → None

–

Parameters:

Managed

class ORSModel.ors.Managed

Bases: ORSModel.ors.ORSBaseClass

brief_description: The “mother” of all author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Managed.__init__(self, anXML: str) -> None –

Parameters:

Managed.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

Managed.__init__(self) -> None –

Parameters:self (ORSModel.ors.Managed) – an instance of Managed
addCallbackToEvent(self, anEventName: str, sCallbackName: str, callbackData: int) → bool

–

Parameters:
  • self (ORSModel.ors.Managed) – an instance of Managed
  • anEventName (str) –
  • sCallbackName (str) –
  • callbackData (int) –

:return : :rtype : bool

addToDeleteSet(self, anIObject: ORSModel.ors.Managed) → None

–

Parameters:
atomicLoad(sFilename: str, bPreserveIdentity: bool) → Managed

–

Parameters:
  • sFilename (str) –
  • bPreserveIdentity (bool) –
atomicLoadFrom(self, anXML: str) → None

–

Parameters:

Managed.atomicLoadFrom(self, buffer: int, nBytes: int) -> None –

Parameters:
atomicLoadSpecificNode(self, aFilename: str, aXPathOfTheNodeToLoad: str) → bool

–

Parameters:
  • self (ORSModel.ors.Managed) – an instance of Managed
  • aFilename (str) –
  • aXPathOfTheNodeToLoad (str) –

:return : :rtype : bool

atomicSave(self, aFilename: str, isTemporary: bool) → int

–

Parameters:

:return : :rtype : unsigned int

copy(self) → Managed

–

Returns a copy of the node.

Parameters:self (ORSModel.ors.Managed) – an instance of Managed
deleteObject(self) → None

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed
deleteObjectAndAllItsChildren(self) → None

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed
getAllGroupsContaining(self, anIObject: ORSModel.ors.Managed) → List

–

Parameters:
classmethod getAllInstances()
getAllInstancesOf(pProgId: str) → List

–

Parameters:pProgId (str) –
classmethod getAllObjectsOfClass(cls_name)
getAllObjectsOfClassAndPrivateTitle(pProgId: str, pPrivateTitle: str) → List

–

Parameters:
  • pProgId (str) –
  • pPrivateTitle (str) –
getAllObjectsOfClassAndUserData(pProgId: str, userDataKey: str, userDataValue: str) → List

–

Parameters:
  • pProgId (str) –
  • userDataKey (str) –
  • userDataValue (str) –
classmethod getAllSubclasses(outputCollection=None)
getAtomicTextRepresentation(self, bSelfContained: bool) → str

–

Parameters:

:return : :rtype : str

getBinaryUserInfo(self, pTag: str) → None

–

Parameters:
getBinaryUserInfoAsBytes(name)
getBinaryUserInfoSize(self, pTag: str) → int

–

Parameters:

:return : :rtype : unsigned int

getCallbacksEnabled(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

getCanBeDeleted(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

classmethod getClassDenomination()
static getClassFromProgId(progId)
getClassName(self) → str

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : str

getClassNameStatic() → str

–

:return : :rtype : str

getCreationTime(self) → int

–

Returns the time Number of seconds since Jan 1 2000 of creation of this object .

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : unsigned int

getDataDirtySignature()

Gets the current dirty signature for the flag OrsDataDirty

Returns:dataDirtySignature (int) – the dirty signature
getDirtySignature(self, dirtyFlag: str) → int

–

Parameters:

:return : :rtype : int

getGUID(self) → str

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : str

getGeometryDirtySignature()

Gets the current dirty signature for the flag OrsGeometryDirty

Returns:geometryDirtySignature (int) – the dirty signature
getHasCallbacksForEvent(self, anEventName: str) → bool

–

Parameters:

:return : :rtype : bool

getIsIdentityPreservedForPickling(self) → bool

–

Returns True if the GUID is preserved when pickling and unpickling an object.

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

getIsInstanceOf(self, pProgId: str) → bool

–

Parameters:

:return : :rtype : bool

getIsInstanceOfAtLeastOneClasses(progIdList)
getIsModified(self, dirtyFlag: str) → bool

–

Parameters:

:return : :rtype : bool

getIsModifiedAnyDirtyFlag(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

getIsRepresentable(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

getIsSameObjectAs(self, anObject: ORSModel.ors.Managed) → bool

–

Parameters:

:return : :rtype : bool

classmethod getIsSubclassOf(parentClass)
getIsToBeKeptAliveUntilExit(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

getIsToBeSaved(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

getObjectWithGUID(guid: str) → Managed

–

Parameters:guid (str) –
getPrivateTitle(self) → str

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : str

getPropertyDirtySignature()

Gets the current dirty signature for the flag OrsPropertyDirty

Returns:propertyDirtySignature (int) – the dirty signature
getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : str

getReferenceCount(self) → int

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : int

getTitle(self) → str

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : str

getUserInfo(self, pTag: str) → str

–

Parameters:

:return : :rtype : str

getVisibilityDirtySignature()

Gets the current dirty signature for the flag OrsVisibilityDirty

Returns:visibilityDirtySignature (int) – the dirty signature
isManaged(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

isNone(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

isNotNone(self) → bool

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed

:return : :rtype : bool

none() → Managed

–

publish()
removeBinaryUserInfo(self, pTag: str) → None

–

Parameters:
removeCallbackFromEvent(self, sEventName: str, sCallbackName: str) → bool

–

Parameters:
  • self (ORSModel.ors.Managed) – an instance of Managed
  • sEventName (str) –
  • sCallbackName (str) –

:return : :rtype : bool

removeFromDeleteSet(self, anIObject: ORSModel.ors.Managed) → None

–

Parameters:
removeUserInfo(self, pTag: str) → None

–

Parameters:
setBinaryUserInfo(self, pTag: str, pValue: int, iDataSize: int) → None

–

Parameters:
  • self (ORSModel.ors.Managed) – an instance of Managed
  • pTag (str) –
  • pValue (bytes) –
  • iDataSize (int) –
setCallbacksEnabled(self, enabled: bool) → None

–

Parameters:
setCanBeDeleted(self, bFlag: bool) → None

–

Parameters:
setDataDirty()

Calls for a setDirty with the flag OrsDataDirty

setDirty(self, dirtyFlag: str) → None

–

Parameters:
setEventCallbackEnabled(self, sEventName: str, sCallbackName: str, bValue: bool) → bool

–

Parameters:
  • self (ORSModel.ors.Managed) – an instance of Managed
  • sEventName (str) –
  • sCallbackName (str) –
  • bValue (bool) –

:return : :rtype : bool

setGeometryDirty()

Calls for a setDirty with the flag OrsGeometryDirty

setIdentityIsPreservedForPickling(self, value: bool) → None

–

Set to True if the GUID is to be preserved when pickling and unpickling an object.

Parameters:
setIsNotModified(self) → None

–

Parameters:self (ORSModel.ors.Managed) – an instance of Managed
setIsRepresentable(self, isRepresentable: bool) → None

–

Parameters:
setIsToBeKeptAliveUntilExit(self, pFlag: bool) → None

–

Parameters:
setIsToBeSaved(self, pIsToBeSaved: bool) → None

–

Parameters:
setPrivateTitle(self, newPrivateTitle: str) → None

–

Parameters:
setPropertyDirty()

Calls for a setDirty with the flag OrsPropertyDirty

setTitle(self, newVal: str) → None

–

Parameters:
setUserInfo(self, pTag: str, pValue: str) → None

–

Sets a user defined value.

Parameters:
  • self (ORSModel.ors.Managed) – an instance of Managed
  • pTag (str) – a key name (a string)
  • pValue (str) – a value (a string)
setVisibilityDirty()

Calls for a setDirty with the flag OrsVisibilityDirty

triggerClassEvent(self, sEventName: str) → bool

–

Parameters:

:return : :rtype : bool

triggerEvent(self, anEventName: str, pEventStruct: int) → bool

–

Triggers an event.

Parameters:
  • self (ORSModel.ors.Managed) – an instance of Managed
  • anEventName (str) – the event name (a string)
  • pEventStruct (bytes) – a pointer to an OrsEventData structure

:return : :rtype : bool

MassiveMarchingAutomata

class ORSModel.ors.MassiveMarchingAutomata(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata

MassiveMarchingAutomata.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel) → None

–

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

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

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getEuclideanBias(self) → float

–

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

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata

:return : :rtype : float

getNeighborCount(self) → int

–

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata

:return : :rtype : int

getROICount(self) → int

–

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

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata

:return : :rtype : int

getVolumeROI(self, index: int) → ROI

–

Retrieves a particularROI from the index specified slot.

Parameters:
none() → MassiveMarchingAutomata

–

resetVolumeROIs(self) → None

–

Empties all the sourceROI slots.

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata
setEuclideanBias(self, EuclideanBias: float) → None

–

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

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

–

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

Parameters:
  • self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata
  • inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • minX (int) – the minimum X index in the input channel (an unsigned short)
  • minY (int) – the minimum Y index in the input channel (an unsigned short)
  • minZ (int) – the minimum Z index in the input channel (an unsigned short)
  • maxX (int) – the maximum X index in the input channel (an unsigned short)
  • maxY (int) – the maximum Y index in the input channel (an unsigned short)
  • maxZ (int) – the maximum Z index in the input channel (an unsigned short)
  • currentT (int) –
setNeighborCountTo18(self) → None

–

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata
setNeighborCountTo26(self) → None

–

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata
setNeighborCountTo6(self) → None

–

Parameters:self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata
setVolumeROI(self, index: int, aVolROI: ORSModel.ors.ROI) → None

–

Fills a particularROI slot to be used as a source for the Dijkstra algorithm.

Parameters:

Material

class ORSModel.ors.Material

Bases: ORSModel.ors.Node

brief_description: Represents the material of a visual ( author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: Visual::setMaterial(), Visual::getMaterial() Represents a material that can be used with any Visual object. It contains the ambiant, power, diffuse, emissive and specular properties.

Material.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.Material) – an instance of Material
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Material.__init__(self) -> None –

Parameters:self (ORSModel.ors.Material) – an instance of Material

Material.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getAmbiant(self) → Color

–

Gets the ambiant color of the material.

Parameters:self (ORSModel.ors.Material) – an instance of Material
getClassNameStatic() → str

–

:return : :rtype : str

getDiffuse(self) → Color

–

Gets the diffuse color of the material.

Parameters:self (ORSModel.ors.Material) – an instance of Material
getEmissive(self) → Color

–

Gets the emissive color of the material.

Parameters:self (ORSModel.ors.Material) – an instance of Material
getPower(self) → float

–

Gets the power property of the material.

Parameters:self (ORSModel.ors.Material) – an instance of Material

:return : :rtype : float

getShadowIntensity(self) → float

–

Gets the shadow intensity.

Parameters:self (ORSModel.ors.Material) – an instance of Material

:return : :rtype : float

getSpecular(self) → Color

–

Gets the specular color of the material.

Parameters:self (ORSModel.ors.Material) – an instance of Material
getTexture(self, stage: int) → str

–

Parameters:

:return : :rtype : str

getTextureScale(self) → float

–

Gets the texture scale factor.

Parameters:self (ORSModel.ors.Material) – an instance of Material

:return : :rtype : float

none() → Material

–

setAmbiant(self, IColor: ORSModel.ors.Color) → None

–

Sets the ambiant color, in Red-Green-Blue.

Parameters:
setDiffuse(self, IColor: ORSModel.ors.Color) → None

–

Sets the diffuse color, in Red-Green-Blue.

Parameters:
setEmissive(self, IColor: ORSModel.ors.Color) → None

–

Sets the emissive color, in Red-Green-Blue.

Parameters:
setPower(self, value: float) → None

–

Sets the power property of the material.

Parameters:
setShadowIntensity(self, value: float) → None

–

Sets the shadow intensity.

Parameters:
  • self (ORSModel.ors.Material) – an instance of Material
  • value (float) – an intensity factor (a float)
setSpecular(self, IColor: ORSModel.ors.Color) → None

–

Sets the specular color, in Red-Green-Blue.

Parameters:
setTexture(self, filename: str, stage: int) → None

–

Sets the texture from a texture file.

Parameters:
  • self (ORSModel.ors.Material) – an instance of Material
  • filename (str) – a file name (a string)
  • stage (int) – a stage (a LONG)
setTextureScale(self, value: float) → None

–

Sets the texture scale factor.

Parameters:

Matrix4x4

class ORSModel.ors.Matrix4x4

Bases: ORSModel.ors.Unmanaged

brief_description: A wrapper to a 3D matrix. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Matrix4x4.__init__(self) -> None –

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4

Matrix4x4.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:

Matrix4x4.__init__(self, rhs: ORSModel.ors.Matrix4x4) -> None –

Parameters:
asRotationMatrix(self, inputVector: ORSModel.ors.Vector3) → None

–

Parameters:
copy(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
getClassNameStatic() → str

–

:return : :rtype : str

getInverted(self) → Matrix4x4

–

Gets an inverted matrix.

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
getIsIdentity(self) → bool

–

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4

:return : :rtype : bool

getMultiply(self, IMatrix: ORSModel.ors.Matrix4x4) → Matrix4x4

–

Parameters:
getScale(self) → Vector3

–

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
getTransformedBoundedPlane(self, inputBoundedPlane: ORSModel.ors.Rectangle) → Rectangle

–

Parameters:
getTransformedBox(self, inputBox: ORSModel.ors.Box) → Box

–

Parameters:
getTransformedCoordinate(self, inputCoordinate: ORSModel.ors.Vector3) → Vector3

–

Parameters:
getTransformedLine(self, inputLine: ORSModel.ors.Line) → Line

–

Parameters:
getTransformedLineSegment(self, inputLineSegment: ORSModel.ors.LineSegment) → LineSegment

–

Parameters:
getTransformedOrientedPlane(self, inputOrientedPlane: ORSModel.ors.OrientedPlane) → OrientedPlane

–

Parameters:
getTransformedPlane(self, inputPlane: ORSModel.ors.Plane) → Plane

–

Parameters:
getTransformedVector(self, inputVector: ORSModel.ors.Vector3) → Vector3

–

Parameters:
getTranslation(self) → Vector3

–

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
getTransposed(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
getValue(self, row: int, column: int) → float

–

Gets a value from the matrix.

Parameters:
  • self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
  • row (int) – row (an int)
  • column (int) – column (an int)

:return : :rtype : float

multiply(self, IMatrix: ORSModel.ors.Matrix4x4) → None

–

Multiplies the matrix by another matrix.

Parameters:
none() → Matrix4x4

–

setAsRotation(self, axisOfRotation: ORSModel.ors.Vector3, angleInRadian: float) → None

–

Parameters:
setScale(self, scaleVector: ORSModel.ors.Vector3) → None

–

Parameters:
setTranslation(self, translation: ORSModel.ors.Vector3) → None

–

Parameters:
setValue(self, row: int, column: int, value: float) → None

–

Sets a value in the matrix.

Parameters:
  • self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
  • row (int) – row (an int)
  • column (int) – column (an int)
  • value (float) – a float value
setValues(self, values: float) → None

–

Sets the matrix values from an array of floats.

Parameters:
  • self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
  • values (float) – an array of 16 float values (a floatPtr)
setupAsIdentity(self) → None

–

Initializes the matrix.

Parameters:self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4

Mesh

class ORSModel.ors.Mesh

Bases: ORSModel.ors.UnstructuredGrid

brief_description: A visual that represents a author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 A visual that represents a VisualMesh.

Mesh.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Mesh.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
convertToVTKPolyData(currentTimeStep, includeScalar=False, vertexXScaleFactor=1.0, vertexYScaleFactor=1.0, vertexZScaleFactor=1.0)
getArea(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, IProgress: ORSModel.ors.Progress) → float

–

Gets the one sided area from closed mesh.

Parameters:

:return : :rtype : float

getAsMeshProjectedOnPlane(self, aPlane: ORSModel.ors.Plane, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, inMesh: ORSModel.ors.Mesh) → Mesh

–

Parameters:
getAsMeshWithEdgesDecimatedSmallerThan(self, value: float, IProgress: ORSModel.ors.Progress, worldTransform: ORSModel.ors.Matrix4x4, inoutMesh: ORSModel.ors.Mesh) → Mesh

–

Decimates all edges with a length smaller than a threshold value.

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

–

Parameters:
getBoundingBoxPlusEpsilon(timestep, worldMatrix, epsilon=0.01)
getClassNameStatic() → str

–

:return : :rtype : str

getColorAtIndex(self, iVertexIndex: int, iTIndex: int, IColor: ORSModel.ors.Color) → bool

–

Get the color of a vertex.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iVertexIndex (int) – the vertex index (uint32_t)
  • iTIndex (int) – the colors data(a Color)
  • IColor (ORSModel.ors.Color) –

:return : :rtype : bool

getColors(self, iTIndex: int) → ArrayDouble

–

Gets the vertices colors.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the time step (an unsigned short)
getContourAreaForPlane(self, nax: float, nby: float, ncz: float, nd: float, iTIndex: int) → float

–

Gets area of contours of mesh for plane.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • 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) –

:return : :rtype : float

getContourMeshForPlane(self, nax: float, nby: float, ncz: float, nd: float, iTIndex: int, inoutMesh: ORSModel.ors.Mesh) → Mesh

–

Returns a mesh representing the contour of the mesh intersecting the specifed plane.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • 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) –
getCurrentFaceScalarValuesSlot(self) → int

–

gets the current face scalar.

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh

:return : :rtype : int

getDefaultColor(self) → Color

–

Gets the mesh default color.

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh
getDefaultMeshAlphaColor(self) → float

–

Queries the mesh to get its default alpha color.

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh

:return : :rtype : float

getEdgeCount(self, iTIndex: int) → int

–

Returns the number of edges.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the the time step (an unsigned short)

:return : :rtype : int

getEdgeCountPerFace(self) → int

–

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh

:return : :rtype : int

getEdges(self, iTIndex: int) → ArrayUnsignedLong

–

Get the edge array.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the the time step (an unsigned short)
getExtractedSubMesh(self, IMeshROI: ORSModel.ors.MeshFacesROI, IOutputMesh: ORSModel.ors.Mesh, bExtractSubMeshROI: bool) → Mesh

–

Parameters:
getFaceCount(self, iTIndex: int) → int

–

Gets the number of faces.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : int

getFaceScalarValue(self, nScalarValueSlotIndex: int, scalarValueFaceIndex: int, iTIndex: int) → float

–

Gets the value of a face scalar.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • scalarValueFaceIndex (int) – the face index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

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

–

Gets a face scalar description.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : str

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

–

method getFaceScalarValueMax

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) –
  • iTIndex (int) –

:return : :rtype : float

getFaceScalarValueMaxs(self, iTIndex: int) → ArrayDouble

–

method getFaceScalarValueMaxs

Parameters:
getFaceScalarValueMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

–

Gets a face scalar min value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

getFaceScalarValueMins(self, iTIndex: int) → ArrayDouble

–

method getFaceScalarValueMins

Parameters:
getFaceScalarValueOffset(self, nScalarValueSlotIndex: int, iTIndex: int) → float

–

Gets a face scalar offset value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

getFaceScalarValueOffsets(self, iTIndex: int) → ArrayDouble

–

Get the face scalar offset values.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the time step (an unsigned short)
getFaceScalarValueSlope(self, scalarValueSlotIndex: int, iTIndex: int) → float

–

Gets a face scalar slope value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • scalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

getFaceScalarValueSlopes(self, iTIndex: int) → ArrayDouble

–

Get the face scalar slope values.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the time step (an unsigned short)
getFaceScalarValueUnit(self, nScalarValueSlotIndex: int, iTIndex: int) → int

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) –
  • iTIndex (int) –

:return : :rtype : int

getFaceScalarValues(self, nScalarValueSlotIndex: int, iTIndex: int) → Array

–

Gets the values of a face scalar.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the face scalar value slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)
getFaceScalarValuesAsPandaDataFrame()
getFaceScalarValuesDatatype(self, nScalarValueSlotIndex: int, iTIndex: int) → int

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) –
  • iTIndex (int) –

:return : :rtype : int

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

–

Get a face scalar range max boundary value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a face scalar range min boundary value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a face scalar range max value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a face scalar range min value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

getFaceScalarValuesSlotCount(self) → int

–

Gets the number of slots for face scalar values.

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh

:return : :rtype : int

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

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) –
  • iTIndex (int) –

:return : :rtype : float

getFaceScalarValuesWindowMaxs(self, iTIndex: int) → ArrayDouble

–

Parameters:
getFaceScalarValuesWindowMin(self, nScalarValueSlotIndex: int, iTIndex: int) → float

–

Gets a face scalar window min value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

getFaceScalarValuesWindowMins(self, iTIndex: int) → ArrayDouble

–

Parameters:
getMinMaxFaceScalarValue(self, nScalarValueSlotIndex: int, iTIndex: int, fMinValue: float, fMaxValue: float) → None

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) –
  • iTIndex (int) –
  • fMinValue (float) –
  • fMaxValue (float) –
getSignedVerticesDistance(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, iTIndex: int, pProgress: ORSModel.ors.Progress) → ArrayFloat

–

Get signed distance between vertices of two meshes.

Parameters:
getTransformed(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, pInOutMesh: ORSModel.ors.Mesh) → Mesh

–

Parameters:
getUVs(self, iTIndex: int) → ArrayFloat

–

Gets the UV values.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the time step (an unsigned short)
getUseDefaultMeshAlphaColor(self) → bool

–

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

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh

:return : :rtype : bool

getUseDefaultMeshColor(self) → bool

–

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

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh

:return : :rtype : bool

getUseFaceScalarValues(self) → bool

–

Sets the mesh to have face scalar values or not.

Parameters:self (ORSModel.ors.Mesh) – an instance of Mesh

:return : :rtype : bool

getVertexScalarValuesAsPandaDataFrame()
getVerticesClosestFacesId(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, iTIndex: int, pProgress: ORSModel.ors.Progress, oMapping: ORSModel.ors.ArrayLong, oCollisionPoints: ORSModel.ors.ArrayDouble) → None

–

Get for each vertex of a mesh the closest faces id of an other mesh.

Parameters:
getVerticesDistance(self, target: ORSModel.ors.Mesh, targetOctree: ORSModel.ors.Octree, iTIndex: int, pProgress: ORSModel.ors.Progress) → ArrayFloat

–

Get absolute distance between vertices of two meshes.

Parameters:
getVerticesNormals(self, iTIndex: int) → ArrayFloat

–

Gets the normals.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the time step (an unsigned short)
getVolume(self, aPlane: ORSModel.ors.Plane, timeStep: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, IProgress: ORSModel.ors.Progress) → float

–

Gets the volume from closed mesh.

Parameters:

:return : :rtype : float

labelizeMesh(self, nScalarValueSlotIndex: int, iTIndex: int) → int

–

Labelizes mesh vertices based on connectivity.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar index where to place labels (an unsigned short)
  • iTIndex (int) –

:return : :rtype : int

laplacianSmooth(self, nNbIterations: int, iTIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nNbIterations (int) –
  • iTIndex (int) –
mapScalarValuesFromAnOtherMesh(self, referenceMesh: ORSModel.ors.Mesh, mapping: ORSModel.ors.ArrayLong, collisionPoints: ORSModel.ors.ArrayDouble, referenceSlotIndex: int, sourceSlotIndex: int, referenceTIndex: int, sourceTIndex: int, defaultScalarValue: float) → None

–

Maps vertices scalar values of a reference mesh to a source mesh.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • 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 (unsigned int)
  • sourceSlotIndex (int) – the slot destination of the source mesh (unsigned int)
  • referenceTIndex (int) – the time step of the reference mesh (unsigned short)
  • sourceTIndex (int) – the time step of the soruce mesh (unsigned short)
  • defaultScalarValue (float) – a default value in case that no match is found between a vertexe and a face (double)
mapScalarValuesSlotToColors(self, iTIndex: int, anILUT: ORSModel.ors.LookupTable, iScalarValueSlotIndex: int) → None

–

Maps the scalar values to a lookup table.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iTIndex (int) – the time step (a unsigned short)
  • anILUT (ORSModel.ors.LookupTable) – the lookup table (an LookupTable)
  • iScalarValueSlotIndex (int) – the scalar value slot index of the value to map (a short) - Applies a coloring scheme to the mesh, according to its scalar values applied against a lookup table.
mapScalarValuesToColors(self, iTIndex: int, anILUT: ORSModel.ors.LookupTable) → None

–

Maps the scalar values to a lookup table.

Parameters:
mapVertexScalarValuesToColorsWithRange(self, pData: ORSModel.ors.Array, fMinDisplayableValue: float, fMaxDisplayableValue: float, fMinSelectionRangeValue: float, fMaxSelectionRangeValue: float, anILUT: ORSModel.ors.LookupTable) → None

–

ComputeMesh color table using vertex scalar value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • pData (ORSModel.ors.Array) – the scalar value to use (an Array)
  • fMinDisplayableValue (float) – the minimum value used for the LUT range (a double)
  • fMaxDisplayableValue (float) – the maximum value used for the LUT range (a double)
  • fMinSelectionRangeValue (float) – the minimum range value (a double)
  • fMaxSelectionRangeValue (float) – the maximum range value (a double)
  • anILUT (ORSModel.ors.LookupTable) – the LookUpTable (a LookupTable)
none() → Mesh

–

removeDuplicateVertices(self, fEpsilon: float, iTIndex: int, pInOutMesh: ORSModel.ors.Mesh) → Mesh

–

Removes duplicate vertices of the mesh.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • fEpsilon (float) – an epsilon value (a float)
  • iTIndex (int) – the the time step (an unsigned short)
  • pInOutMesh (ORSModel.ors.Mesh) – the output mesh (a Mesh)
setColorAtIndex(self, iVertexIndex: int, iTIndex: int, pColors: ORSModel.ors.Color) → None

–

Set color of a vertex.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iVertexIndex (int) – the vertex index (uint32_t)
  • iTIndex (int) – the colors data(a Color)
  • pColors (ORSModel.ors.Color) –
setCurrentFaceScalarValuesSlot(self, slotIndex: int) → None

–

Sets the current face scalar.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • slotIndex (int) – the current scalar slot index (an unsigned short)
setDefaultColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the mesh default color.

Parameters:
setDefaultMeshAlphaColor(self, value: float) → None

–

Sets the mesh its default alpha color.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • value (float) – Alpha color (double)
setEdgeCountPerFace(self, value: int) → None

–

Parameters:
setFaceScalarValue(self, nScalarValueSlotIndex: int, scalarValueFaceIndex: int, aValue: float, iTIndex: int) → None

–

Sets the value of a face scalar.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • 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 (an unsigned short)
setFaceScalarValueDescription(self, nScalarValueSlotIndex: int, value: str, iTIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) –
  • value (str) –
  • iTIndex (int) –
setFaceScalarValueMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a face scalar max value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – scalar slot index (an unsigned short)
  • value (float) – scalar max value (a double)
  • iTIndex (int) – time step (an unsigned short)
setFaceScalarValueMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

method setFaceScalarValueMaxs

Parameters:
setFaceScalarValueMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

method setFaceScalarValueMin

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setFaceScalarValueMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

method setFaceScalarValueMins

Parameters:
setFaceScalarValueOffset(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a face scalar offset value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • value (float) – the scalar offset value (a double)
  • iTIndex (int) – the time step (an unsigned short)
setFaceScalarValueOffsets(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Set the face scalar offset values.

Parameters:
setFaceScalarValueSlope(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Gets a face scalar slope value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – scalar slot index (an unsigned short)
  • value (float) – scalar slope value (a double)
  • iTIndex (int) – time step (an unsigned short)
setFaceScalarValueSlopes(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Set the face scalar slope values.

Parameters:
setFaceScalarValueUnit(self, nScalarValueSlotIndex: int, value: int, iTIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) –
  • value (int) –
  • iTIndex (int) –
setFaceScalarValues(self, pScalarValues: ORSModel.ors.Array, nScalarValueSlotIndex: int, iTIndex: int) → None

–

Sets the values of a face scalar.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • pScalarValues (ORSModel.ors.Array) – an array of values (an ArrayFloat)
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the the time step (an unsigned short)
setFaceScalarValuesDatatype(self, iSlotIndex: int, iTIndex: int, nFaceScalarValuesDatatype: int) → None

–

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • iSlotIndex (int) –
  • iTIndex (int) –
  • nFaceScalarValuesDatatype (int) –
setFaceScalarValuesFromPandaDataFrame(dataFrame, iTIndex=0)
setFaceScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a face scalar range max boundary value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setFaceScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a face scalar range min boundary value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(an unsigned short)
setFaceScalarValuesRangeMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a face scalar range max value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setFaceScalarValuesRangeMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a face scalar range min value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(an unsigned short)
setFaceScalarValuesSlotCount(self, value: int) → None

–

Sets the number of slots for face scalar values.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • value (int) – the number of slots (an unsigned short)
setFaceScalarValuesWindowMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a face scalar max value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – scalar slot index (an unsigned short)
  • value (float) – scalar max value (a double)
  • iTIndex (int) – time step (an unsigned short)
setFaceScalarValuesWindowMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Parameters:
setFaceScalarValuesWindowMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

method setFaceScalarValuesWindowMin

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setFaceScalarValuesWindowMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Parameters:
setOutOfRangeScalarValue(self, value: float) → None

–

Sets a scalar out or range value.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • value (float) – the value (a float)
setUseDefaultMeshAlphaColor(self, value: bool) → None

–

Sets the mesh to use its default alpha color.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • value (bool) – TRUE for using a default alpha color for the mesh, FALSE otherwise (bool)
setUseDefaultMeshColor(self, value: bool) → None

–

Sets the mesh to use its default color.

Parameters:
  • self (ORSModel.ors.Mesh) – an instance of Mesh
  • value (bool) – TRUE to use the mesh default color, FALSE otherwise
setUseFaceScalarValues(self, value: bool) → None

–

Gets the status of face scalar values usage.

Parameters:
setVertexScalarValuesFromPandaDataFrame(dataFrame, iTIndex=0)
updateVerticesNormal(self, iTIndex: int) → None

–

Parameters:

MeshFacesROI

class ORSModel.ors.MeshFacesROI

Bases: ORSModel.ors.Node

brief_description: Represents a region of interest for a mesh ( author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 warning: Not currently supported. see: ROI Represents a region of interest for a Mesh.

MeshFacesROI.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

MeshFacesROI.__init__(self) -> None –

Parameters:self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI

MeshFacesROI.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addFaceIndex(self, nFaceIndex: int, nTIndex: int) → None

–

Parameters:
addFacesIndexes(self, indexes: ORSModel.ors.ArrayUnsignedLong, nNbIndex: int, nTIndex: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFaceIndexAtPosition(self, pos: int, nTIndex: int) → int

–

Parameters:

:return : :rtype : int

getFaceIndexes(self, nTimeStep: int, IInputFaceIndexes: ORSModel.ors.ArrayUnsignedLong) → ArrayUnsignedLong

–

Parameters:
getFaceIndexesCount(self, nTIndex: int) → int

–

Parameters:

:return : :rtype : int

getHasFaceIndex(self, nFaceIndex: int, nTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getIntersectionWithMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI

–

Parameters:
getInverseMeshFacesROI(self, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI

–

Parameters:
getIsVisibleForAllDisplays(self) → bool

–

Gets the visibility of the receiver in all displays.

Parameters:self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI

:return : :rtype : bool

getIsVisibleForDisplay(self, IDisplay: ORSModel.ors.View) → bool

–

Gets the visibility of the receiver in a given display.

Parameters:

:return : :rtype : bool

getSubtractionFromMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI

–

Parameters:
getUnionWithMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI

–

Parameters:
none() → MeshFacesROI

–

removeAllFaceIndexes(self, nTIndex: int) → None

–

Parameters:
removeFaceIndex(self, nFaceIndex: int, nTIndex: int) → None

–

Parameters:
removeFaceIndexAtPosition(self, pos: int, nTimeStep: int) → int

–

Parameters:

:return : :rtype : int

setColor(self, aColor: ORSModel.ors.Color) → None

–

Parameters:
setIsVisibleForAllDisplays(self, bValue: bool) → None

–

Sets the visibility of the receiver in all displays.

Parameters:
  • self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI
  • bValue (bool) – TRUE to make the receiver visible in all displays, FALSE to hide it
setIsVisibleForDisplay(self, IDisplay: ORSModel.ors.View, bValue: bool) → None

–

Sets the visibility of the receiver in a given display.

Parameters:

Model

class ORSModel.ors.Model

Bases: sip.wrapper

brief_description: Main gateway into the author: Normand Mongeau. All other members of ORS participated. version: 1.2 date: September 2006 Main gateway into the ORS Core library. Used for general functionality of the ORS Core library.

addCallbackToClassEvent(aClassName: str, anEventName: str, sCallbackName: str, callbackInfo: int, permanent: bool) → bool

–

Adds a callback subscription to a class event.

Parameters:
  • aClassName (str) – the class name (a string)
  • anEventName (str) – the event name (a string)
  • sCallbackName (str) – the callback name (a string)
  • callbackInfo (bytes) – a pointer to a ORS_EVENT_CALLBACK_INFO struct
  • permanent (bool) – true to make the callback permanent (will survive a new session), false for a normal callback

:return : :rtype : bool

addCallbackToGlobalEvent(anEventName: str, sCallbackName: str, callbackInfo: int, permanent: bool) → bool

–

Adds a callback subscription to a global event.

Parameters:
  • anEventName (str) – the event name (a string)
  • sCallbackName (str) – the callback name (a string)
  • callbackInfo (bytes) – a pointer to a ORS_EVENT_CALLBACK_INFO struct
  • permanent (bool) – true to make the callback permanent (will survive a new session), false for a normal callback

:return : :rtype : bool

checkFeature(iProduct: int, iFeature: int) → bool

–

Parameters:
  • iProduct (int) –
  • iFeature (int) –

:return : :rtype : bool

deleteAllObjects(pFinalExit: bool) → None

–

Parameters:pFinalExit (bool) –
getActiveWorkerThreadsCount() → int

–

Returns the number of active worker threads.

:return : :rtype : unsigned int

getAvailableCPUCount() → int

–

Returns how many CPUs are available.

:return : :rtype : int

getBuildNumber() → str

–

Returns the Core library internal build number.

:return : :rtype : str

getDLLFilename() → str

–

Returns the Core library file name.

:return : :rtype : str

getDLLVersion() → str

–

Returns the Core library internal version.

:return : :rtype : str

getDebugMode() → bool

–

Checks if the Core library is in debug mode.

:return : :rtype : bool

getEpsilon() → float

–

:return : :rtype : float

getFontNames() → str

–

:return : :rtype : str

getIsRunningInReleaseMode() → bool

–

Checks if the Core library is running in release mode.

:return : :rtype : bool

getLicenseExpiry() → int

–

:return : :rtype : unsigned int

getLicenseInformation(iKey: int) → str

–

Parameters:iKey (int) –

:return : :rtype : str

getMajorVersion() → str

–

Returns the Core library internal major version.

:return : :rtype : str

getMaximumViewportHeight() → int

–

:return : :rtype : unsigned int

getMaximumViewportWidth() → int

–

:return : :rtype : unsigned int

getPresetFileExtension() → str

–

:return : :rtype : str

getSessionUserName() → str

–

:return : :rtype : str

getStartupResultCode() → int

–

:return : :rtype : int

getWasLicenseDowngraded() → bool

–

:return : :rtype : bool

isNotNone(self) → bool

–

Parameters:self (ORSModel.ors.Model) – an instance of Model

:return : :rtype : bool

loadSessionFromFile(aFilename: str) → bool

–

Loads a session file.

Parameters:aFilename (str) – a fully qualified file path (a string)

:return : :rtype : bool

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)

:return : :rtype : bool

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)

:return : :rtype : bool

saveSessionToFile(pSessionName: str, aFilename: str) → 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)

:return : :rtype : int

setAvailableCPUCount(pNbCPUs: int) → None

–

Tells the Core library to limit the number of CPUs it should use.

Parameters:pNbCPUs (int) – a count (an unsigned short)
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) –

:return : :rtype : bool

setDebugMode(pState: bool) → None

–

Parameters:pState (bool) –
setEpsilon(anEpsilon: float) → None

–

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

:return : :rtype : bool

setPrecision(iPrecision: int) → None

–

Parameters:iPrecision (int) –
setSessionUserName(aName: str) → None

–

Parameters:aName (str) –
setStartupCode(iVal: int) → None

–

Parameters:iVal (int) –
setStartupExpiry(iVal: int) → None

–

Parameters:iVal (int) –
startWorkersFor(pWorkData: int) → None

–

Parameters:pWorkData (bytes) –
stopWorkersWithID(id: int) → None

–

Parameters:id (int) –
triggerGlobalEvent(anEventName: str, pEventStruct: None) → bool

–

Parameters:
  • anEventName (str) –
  • pEventStruct (None) –

:return : :rtype : bool

MultiROI

class ORSModel.ors.MultiROI

Bases: ORSModel.ors.StructuredGrid

brief_description: Container for multiple ROIs. author: Normand Mongeau. All other members of ORS participated. version: 1.0 date: February 2010

MultiROI.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

MultiROI.__init__(self) -> None –

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI

MultiROI.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addToVolumeROI(self, pOutputROI: ORSModel.ors.ROI, pLabel: int) → None

–

Extract a label and adds it to a VolumeROI.

Parameters:
addToVolumeROILabelAtIndex(self, pOutputROI: ORSModel.ors.ROI, pIndex: int) → None

–

Finds the label at a given index, then extracts the label data and adds it to a VolumeROI.

Parameters:
addToVolumeROILabelAtPosition(self, pOutputROI: ORSModel.ors.ROI, tIndex: int, pVector: ORSModel.ors.Vector3) → None

–

Finds the label at a given position, then extracts the label data and adds it to a VolumeROI.

Parameters:
addVolumeROIToLabel(self, aLabel: int, pROI: ORSModel.ors.ROI) → bool

–

Parameters:

:return : :rtype : bool

appendLabeledMultiROI(self, pLabeledMultiROI: ORSModel.ors.MultiROI, pLabelArray: ORSModel.ors.ArrayUnsignedLong) → None

–

Parameters:
clear(self) → None

–

Clears the entire data.

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI
clearLabel(self, pLabel: int) → None

–

Clears a label.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • pLabel (int) – the label to clear (an unsigned int)
clearLabels(self, pLabelArray: ORSModel.ors.ArrayUnsignedLong) → None

–

Clears a set of labels.

Parameters:
copyInto(self, aMultiROI: ORSModel.ors.MultiROI) → None

–

Copies the receiver into anotherROI.

Parameters:
fromChannel(self, pChan: ORSModel.ors.Channel) → None

–

Parameters:
generateAnalyzer(self, inputChannel: ORSModel.ors.Channel, pROI: ORSModel.ors.ROI, aTimeStep: int, pStats: int, pCompute2DStats: bool, IProgress: ORSModel.ors.Progress) → MultiROIAnalyzer

–

Parameters:
getAsArray(self, tIndex: int, pOutputArray: ORSModel.ors.ArrayUnsignedLong) → ArrayUnsignedLong

–

Extracts the labels and adds them all to anArray.

Parameters:
getAsChannelWithLabelOffset(self, labelOffset: int, pOutputChannel: ORSModel.ors.Channel) → Channel

–

Extracts the labels and adds them all to a channel.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • labelOffset (int) – a label offset to add to output channel values (a unsigned int)
  • pOutputChannel (ORSModel.ors.Channel) – an optional output channel (an Channel)
getAsCubicMesh(self, bWorld: bool, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → Mesh

–

Parameters:
getAsCubicMeshSubset(self, IEnabledLabel: ORSModel.ors.ArrayChar, bWorld: bool, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → Mesh

–

Parameters:
getBoundingBoxOfLabel(self, pTIndex: int, iLabel: int) → Box

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getClipBox(timestep=0, display=None)

Gets the clip box of the ROI or of the MultiROI

Parameters:
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:
Returns:
getCurrentScalarValuesSlot(self) → int

–

gets the current scalar value slot index.

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI

:return : :rtype : int

getIntersectionWithLabeledMultiROI(self, pInputLabeledMultiROI: ORSModel.ors.MultiROI, anOutputLabeledMultiROI: ORSModel.ors.MultiROI) → MultiROI

–

Intersects theMultiROI with another MultiROI.

Parameters:
getIntersectionWithROI(self, aROI: ORSModel.ors.ROI, anOutputMultiROI: ORSModel.ors.MultiROI) → MultiROI

–

Intersects theMultiROI with a ROI.

Parameters:
getIsClipped(timestep=0, display=None)

Gets to know if the clip box of the ROI or MultiROI is active

Parameters:
Returns:

isClipped (bool) – if True, the clip box of the ROI or MultiROI is visible; False otherwise.
getIsEmpty(self) → bool

–

Verifies to see if all labels are empty or not.

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI

:return : :rtype : bool

getLabelAtIndex(self, pIndex: int) → int

–

Gets the label value at a given index.

Parameters:

:return : :rtype : unsigned int

getLabelAtPosition(self, tIndex: int, pVector: ORSModel.ors.Vector3) → int

–

Gets the label value at a given World position.

Parameters:

:return : :rtype : unsigned int

getLabelColor(self, label: int) → Color

–

Parameters:
getLabelCount(self) → int

–

Gets the number of distinct labels within.

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI

:return : :rtype : unsigned int

getLabelSize(self, pLabel: int) → int

–

Gets the size of a given label.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • pLabel (int) – the label value (an unsigned int)

:return : :rtype : int

getNonEmptyLabels(self, pOutputArray: ORSModel.ors.ArrayUnsignedLong) → ArrayUnsignedLong

–

Returns an array of all non empty labels.

Parameters:
getProjectionIn(self, aLabeledMultiROI: ORSModel.ors.MultiROI, sourceTimeOffset: int, pProgress: ORSModel.ors.Progress) → MultiROI

–

Parameters:
getScalarValueDescription(self, nScalarValueSlotIndex: int, iTIndex: int) → str

–

Gets a scalar description value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : str

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

–

Gets a scalar max value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

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

–

Gets a scalar min value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

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

–

Gets a scalar offset value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

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

–

Get a scalar slope value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

getScalarValueUnit(self, nScalarValueSlotIndex: int, iTIndex: int) → int

–

Gets a scalar value unit.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – scalar slot index (an unsigned short)
  • iTIndex (int) – time step (an unsigned short)

:return : :rtype : int

getScalarValues(self, nScalarValueSlotIndex: int, iTIndex: int) → OrderedCollection

–

Gets the values of a scalar.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the the time step (an unsigned short)
  • iTIndex (int) –
getScalarValuesAsPandaDataFrame(iTIndex=0)
getScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float

–

Get a scalar range max boundary value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a scalar range min boundary value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a scalar range max value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a scalar range min value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

getScalarValuesSlotCount(self) → int

–

Gets the number of slots for scalar values.

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI

:return : :rtype : int

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

–

Gets a scalar window max value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

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

–

Gets a scalar window min value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

getTotalVoxelCount(self) → int

–

Gets the total size of all labels.

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI

:return : :rtype : int

getUseScalarValues(self) → bool

–

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI

:return : :rtype : bool

getVoxelCount(self, iTIndex: int) → int

–

Gets the size of all labels for a given T value.

Parameters:

:return : :rtype : int

insertLabeledMultiROI(self, pLabeledMultiROI: ORSModel.ors.MultiROI, insertionLabel: int) → bool

–

Insert all the labels of aMultiROI starting at an insertion label.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • pLabeledMultiROI (ORSModel.ors.MultiROI) – the MultiROI to insert (a MultiROI)
  • insertionLabel (int) – the label at which the insertion begins (an unsigned int)

:return : :rtype : bool

mapLabelsToColors(self, anILUT: ORSModel.ors.LookupTable) → None

–

Parameters:
mapLabelsToDiscreteColors(self, anILUT: ORSModel.ors.LookupTable) → None

–

Parameters:
mapScalarValuesToColors(self, pData: ORSModel.ors.Array, pHightlightOpacityValue: ORSModel.ors.ArrayFloat, pLMROpacityValue: ORSModel.ors.ArrayFloat, fMinDisplayableValue: float, fMaxDisplayableValue: float, anILUT: ORSModel.ors.LookupTable) → None

–

Parameters:
mapScalarValuesToColorsWithRange(self, pData: ORSModel.ors.Array, fMinDisplayableValue: float, fMaxDisplayableValue: float, fMinSelectionRangeValue: float, fMaxSelectionRangeValue: float, anILUT: ORSModel.ors.LookupTable) → None

–

ComputeMultiROI color table using scalar value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • pData (ORSModel.ors.Array) – the scalar value to use (an Array)
  • fMinDisplayableValue (float) – the minimum value used for the LUT range (a double)
  • fMaxDisplayableValue (float) – the maximum value used for the LUT range (a double)
  • fMinSelectionRangeValue (float) – the minimum range value (a double)
  • fMaxSelectionRangeValue (float) – the maximum range value (a double)
  • anILUT (ORSModel.ors.LookupTable) – the LookUpTable (a LookupTable)
mapScalarValuesToDiscreteColors(self, pData: ORSModel.ors.Array, pHightlightOpacityValue: ORSModel.ors.ArrayFloat, pLMROpacityValue: ORSModel.ors.ArrayFloat, nMinDisplayableValue: int, nMaxDisplayableValue: int, anILUT: ORSModel.ors.LookupTable) → None

–

Parameters:
mergeLabels(self, targetLabel: int, sourceLabel: int) → bool

–

Merge a label into another one.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • targetLabel (int) – the receiving label (an unsigned int)
  • sourceLabel (int) – the source label (an unsigned int)

:return : :rtype : bool

none() → MultiROI

–

removeAScalarValuesSlot(self, nScalarValueSlotIndex: int, iTIndex: int) → None

–

Remove a scalar values slot from aMultiROI.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the T value (an unsigned short)
removeEmptyLabelsAndRenumber(self) → None

–

Removes all empty labels and renumber the remaining labels in the same order.

Parameters:self (ORSModel.ors.MultiROI) – an instance of MultiROI
removeFromVolumeROI(self, pOutputROI: ORSModel.ors.ROI, pLabel: int) → None

–

Extract a label and remove it from a VolumeROI.

Parameters:
removeLabelAndRenumber(self, pLabel: int) → None

–

Removes the specified label and renumber the remaining labels in the same order.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • pLabel (int) – the label to remove (an unsigned int)
removeLabeledMultiROI(self, pInputLabeledMultiROI: ORSModel.ors.MultiROI) → None

–

Removes aMultiROI.

Parameters:
removeLabelsAndRenumber(self, pLabelArray: ORSModel.ors.ArrayUnsignedLong) → None

–

Removes the specified labels and renumber the remaining labels in the same order.

Parameters:
removeVolumeROI(self, pInputROI: ORSModel.ors.ROI) → None

–

Removes a VolumeROI.

Parameters:
removeVolumeROIFromLabel(self, aLabel: int, pROI: ORSModel.ors.ROI) → bool

–

Parameters:

:return : :rtype : bool

setCurrentScalarValuesSlot(self, nScalarValueSlotIndex: int) → None

–

Sets the current scalar.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
setLabelColor(self, label: int, IColor: ORSModel.ors.Color) → None

–

Parameters:
setLabelCount(self, aCount: int) → None

–

Sets the label count.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • aCount (int) – the label count to set (an unsigned int)
setScalarValueDescription(self, nScalarValueSlotIndex: int, sDesc: str, iTIndex: int) → None

–

Sets a face scalar description value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – scalar slot index (an unsigned short)
  • sDesc (str) – scalar description value (a std::wstring)
  • iTIndex (int) – time step (an unsigned short)
setScalarValueMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a scalar max value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • value (float) – the scalar max value (a float)
  • iTIndex (int) – the time step (an unsigned short)
setScalarValueMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a scalar min value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • value (float) – the scalar min value (a float)
  • iTIndex (int) – the time step (an unsigned short)
setScalarValueOffset(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a scalar offset value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • value (float) – the scalar offset value (a float)
  • iTIndex (int) – the time step (an unsigned short)
setScalarValueSlope(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a scalar slope value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – scalar slot index (an unsigned short)
  • value (float) – scalar slope value (a float)
  • iTIndex (int) – time step (an unsigned short)
setScalarValueUnit(self, nScalarValueSlotIndex: int, iUnit: int, iTIndex: int) → None

–

Sets a scalar unit value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – scalar slot index (an unsigned short)
  • iUnit (int) – iUnit (an unsigned short)
  • iTIndex (int) – time step (an unsigned short)
setScalarValues(self, pScalarValues: ORSModel.ors.OrderedCollection, nScalarValueSlotIndex: int, iTIndex: int) → None

–

Sets the values of a scalar.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • pScalarValues (ORSModel.ors.OrderedCollection) – an array of values (an ArrayFloat)
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • iTIndex (int) – the the time step (an unsigned short)
setScalarValuesFromPandaDataFrame(dataFrame, iTIndex=0)
setScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a scalar range max boundary value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a scalar range min boundary value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(an unsigned short)
setScalarValuesRangeMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a scalar range max value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setScalarValuesRangeMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a scalar range min value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(an unsigned short)
setScalarValuesSlotCount(self, nScalarValueSlotCount: int) → None

–

Sets the number of slots for scalar values.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotCount (int) – the number of slots (an unsigned short)
setScalarValuesWindowMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a scalar window max value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • value (float) – the scalar max value (a float)
  • iTIndex (int) – the time step (an unsigned short)
setScalarValuesWindowMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a scalar window min value.

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • nScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
  • value (float) – the scalar min value (a float)
  • iTIndex (int) – the time step (an unsigned short)
sortAndRenumberLabelsOnSize(self, bAscending: bool, bRemoveEmptyLabels: bool) → None

–

Sorts and renumbers the labels based on their sizes (number of labels).

Parameters:
  • self (ORSModel.ors.MultiROI) – an instance of MultiROI
  • 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

MultiROIAnalyzer

class ORSModel.ors.MultiROIAnalyzer

Bases: ORSModel.ors.Unmanaged

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

MultiROIAnalyzer.__init__(self) -> None –

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

MultiROIAnalyzer.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

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

–

Parameters:
getCenterOfMassMinMax(self, pXMin: float, pYMin: float, pZMin: float, pXMax: float, pYMax: float, pZMax: float) → None

–

Parameters:
  • self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
  • pXMin (float) –
  • pYMin (float) –
  • pZMin (float) –
  • pXMax (float) –
  • pYMax (float) –
  • pZMax (float) –
getClassNameStatic() → str

–

:return : :rtype : str

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

–

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

–

Parameters:
getIndiciesCountInLabels(self) → ArrayLONGLONG

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelAspectRatio(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelCenterOfMass(self, pLabel: int) → Vector3

–

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

–

Parameters:

:return : :rtype : float

getLabelEquivalentRadius(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelInertiaEigenValue(self, pLabel: int, vectorIndex: int) → float

–

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

Parameters:
  • self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
  • pLabel (int) – label (an unsigned int)
  • vectorIndex (int) – eigenvalue index (0: minimum eigenvalue; 1: medium eigenvalue; 2: maximum eigenvalue) (an unsigned short)

:return : :rtype : float

getLabelInertiaEigenValueMax(self, pLabel: int) → float

–

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

Parameters:

:return : :rtype : float

getLabelInertiaEigenValueMed(self, pLabel: int) → float

–

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

Parameters:

:return : :rtype : float

getLabelInertiaEigenValueMin(self, pLabel: int) → float

–

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

Parameters:

:return : :rtype : float

getLabelInertiaEigenVector(self, pLabel: int, vectorIndex: int) → Vector3

–

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

Parameters:
  • self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
  • pLabel (int) – label (an unsigned int)
  • vectorIndex (int) – eigenvalue index (0: minimum eigenvalue; 1: medium eigenvalue; 2: maximum eigenvalue) (an unsigned short)
getLabelInertiaEigenVectorWithMaxEigenValue(self, pLabel: int) → Vector3

–

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

Parameters:
getLabelInertiaEigenVectorWithMedEigenValue(self, pLabel: int) → Vector3

–

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

Parameters:
getLabelInertiaEigenVectorWithMinEigenValue(self, pLabel: int) → Vector3

–

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

Parameters:
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.

Parameters:

:return : :rtype : float

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.

Parameters:

:return : :rtype : float

getLabelMaximumVoxel(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelMeanVoxel(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelMinimumVoxel(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelSizeMinMax(self, pMin: int, pMax: int) → None

–

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

–

Parameters:

:return : :rtype : float

getLabelStandardDeviationVoxel(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelSurfaceArea(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelSurfaceXArea(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelSurfaceYArea(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelSurfaceZArea(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelVarianceVoxel(self, pLabel: int) → float

–

Parameters:

:return : :rtype : float

getLabelWeightedCenterOfMass(self, pLabel: int) → Vector3

–

Parameters:
getLabelsAspectRatio(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsCenterOfMassX(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsCenterOfMassY(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsCenterOfMassZ(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsEntropy(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsEquivalentRadius(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsInertiaEigenValueMax(self) → ArrayDouble

–

Gets the maximum eigenvalues of the inertia tensor.

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsInertiaEigenValueMed(self) → ArrayDouble

–

Gets the medium eigenvalues of the inertia tensor.

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsInertiaEigenValueMin(self) → ArrayDouble

–

Gets the minimum eigenvalues of the inertia tensor.

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsInertiaEigenVectorWithMinEigenValuePhiAngle(self) → ArrayDouble

–

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

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsInertiaEigenVectorWithMinEigenValueThetaAngle(self) → ArrayDouble

–

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

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMaxLocationX(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMaxLocationY(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMaxLocationZ(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMaximumVoxel(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMeanVoxel(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMinLocationX(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMinLocationY(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMinLocationZ(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsMinimumVoxel(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsSphericity(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsStandardDeviationVoxel(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsSurfaceArea(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsSurfaceXArea(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsSurfaceYArea(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsSurfaceZArea(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsVarianceVoxel(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsWeightedCenterOfMassX(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsWeightedCenterOfMassY(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getLabelsWeightedCenterOfMassZ(self) → ArrayDouble

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
getMaximumVoxelMinMax(self, pMin: float, pMax: float) → None

–

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

–

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

–

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

–

Parameters:

:return : :rtype : int

getNumberOfROIIndiciesInLabelsMinMax(self, pMin: int, pMax: int) → None

–

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

–

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

–

Parameters:
getSurfaceAreaMax(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getSurfaceAreaMin(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getSurfaceAreaMinMax(self, pMin: float, pMax: float) → None

–

Parameters:
getSurfaceXAreaMax(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getSurfaceXAreaMin(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getSurfaceYAreaMax(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getSurfaceYAreaMin(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getSurfaceZAreaMax(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getSurfaceZAreaMin(self) → float

–

Parameters:self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer

:return : :rtype : float

getVarianceVoxelMinMax(self, pMin: float, pMax: float) → None

–

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

–

Parameters:
  • self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
  • pXMin (float) –
  • pYMin (float) –
  • pZMin (float) –
  • pXMax (float) –
  • pYMax (float) –
  • pZMax (float) –
initializeFor(self, IMultiROI: ORSModel.ors.MultiROI, pStats: int, pCompute2DStats: bool) → None

–

Parameters:
none() → MultiROIAnalyzer

–

class stats

Bases: enum.IntEnum

An enumeration.

basic = 1
center_of_mass = 32
entropy = 128
equivalent_radius = 4
min_max_location = 64
sphericity = 2
surface_area = 8
tensor_inertia = 16

Node

class ORSModel.ors.Node

Bases: ORSModel.ors.Managed

brief_description: An abstract class for any object that can be a node in the visualization flow. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Node.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
attachChild(self, anINode: ORSModel.ors.Node) → bool

–

Attaches a child node.

Parameters:

:return : :rtype : bool

attachChildAtPosition(self, anINode: ORSModel.ors.Node, position: int) → bool

–

Attaches a child node at a given position.

Parameters:

:return : :rtype : bool

copyGraph(self) → Node

–

Returns a copy of the node, including its graph.

Parameters:self (ORSModel.ors.Node) – an instance of Node
detachChild(self, anINode: ORSModel.ors.Node) → bool

–

Detaches a child node.

Parameters:

:return : :rtype : bool

getAllChildrenNodes(self) → List

–

Returns a flattened list of the child hierarchy of the node.

Parameters:self (ORSModel.ors.Node) – an instance of Node
getAllChildrenOfClass(self, pProgId: str) → List

–

Returns all the nodes of the specified class found in the child hierarchy.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getAllChildrenOfClassReachableByRenderer(self, pProgId: str) → List

–

Returns a flattened list of all the child nodes, of the given class, that are renderable.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getAllParentNodes(self) → List

–

Returns a flattened list of the parent hierarchy of the node.

Parameters:self (ORSModel.ors.Node) – an instance of Node
getAllParentsOfClass(self, pProgId: str) → List

–

Returns all the nodes of the specified class found in the parent hierarchy.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getChildWithGUID(self, aGUID: str) → Node

–

Gets an immediate child node with the given GUID.

Parameters:
getChildWithTitle(self, aTitle: str) → Node

–

Gets an immediate child node with the given title.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • aTitle (str) – a string (a string)
getChildrenNodes(self) → List

–

Returns the list of immediate child nodes.

Parameters:self (ORSModel.ors.Node) – an instance of Node
getChildrenOfClass(self, pProgId: str) → List

–

Returns the nodes of the specified class found in the immediate children.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getClassNameStatic() → str

–

:return : :rtype : str

getFirstChildOfClass(self, pProgId: str) → Node

–

Returns the first object of the specified class found in the child hierarchy.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getFirstChildOfClassAndPrivateTitle(self, pProgId: str, privateTitle: str) → Node

–

Searches the hierarchy for a child node with the specified class and private title.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
  • privateTitle (str) – some text (a string)
getFirstNodeWithClassNameTowardsNode(self, pProgId: str, anINode: ORSModel.ors.Node) → Node

–

Searches the hierarchy for a parent node with the specified class toward a specific parent nopde.

Parameters:
getFirstParentOfClass(self, pProgId: str) → Node

–

Returns the first object of the specified class found in the parent hierarchy.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getFirstParentOfClassAndPrivateTitle(self, pProgId: str, privateTitle: str) → Node

–

Searches the hierarchy for a parent node with the specified class and private title.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
  • privateTitle (str) – some text (a string)
getImmediateChildOfClass(self, pProgId: str) → Node

–

Searches for a child node with the specified class.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getImmediateParentOfClass(self, pProgId: str) → Node

–

Searches for a parent node with the specified class.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
getImmediateParentWithGUID(self, pGUID: str) → Node

–

Gets a parent node with the given GUID.

Parameters:
getIsNodeOneOfMyAscendants(self, anINode: ORSModel.ors.Node) → bool

–

Checks to see if a specified node is in the parent hierarchy of the node.

Parameters:

:return : :rtype : bool

getIsNodeOneOfMyDescendants(self, anINode: ORSModel.ors.Node) → bool

–

Checks to see if a specified node is in the child hierarchy of the node.

Parameters:

:return : :rtype : bool

getMaxTSize(self) → int

–

Get Maximum T Size of all children node of this node.

Parameters:self (ORSModel.ors.Node) – an instance of Node

:return : :rtype : int

getParentNodes(self) → List

–

Gets the immediate parent nodes.

Parameters:self (ORSModel.ors.Node) – an instance of Node
getParentWithGUID(self, pGUID: str) → Node

–

Gets a parent node (from the hierarchy) with the given GUID.

Parameters:
getParentsOfClass(self, pProgId: str) → List

–

Returns the nodes of the specified class found in the immediate parents.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pProgId (str) – the ProgId of the class to test against (a string)
none() → Node

–

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) → None

–

Causes a dirty message to be sent to all children nodes.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • 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
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) → None

–

Causes all 3D views in the parent hierarchy of the node to be refreshed.

Parameters:self (ORSModel.ors.Node) – an instance of Node
refreshAll3DParentViews(self) → None

–

Causes all 3D views in the parent hierarchy of the node to be refreshed.

Parameters:self (ORSModel.ors.Node) – an instance of Node
refreshAllParentViews(self) → None

–

Causes all views in the parent hierarchy of the node to be refreshed.

Parameters:self (ORSModel.ors.Node) – an instance of Node
setAllowRenderingInAllParentViews(self, bValue: bool) → None

–

Allows or prevents rendering in the views affected by a node.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • bValue (bool) – TRUE to allow rendering, FALSE to disallow it.
setAutoUpdate(self, pAutoUpdate: bool) → None

–

Sets a node to be “auto-updating”, i.e. it needs not and will not receive dirty messages.

Parameters:
  • self (ORSModel.ors.Node) – an instance of Node
  • pAutoUpdate (bool) – TRUE to set the node to be “auto-updating”, FALSE otherwise
switchOrderOfPrecedenceOfChildrenNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool

–

Rearranges the order of child nodes.

Parameters:

:return : :rtype : bool

switchOrderOfPrecedenceOfParentNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool

–

Rearranges the ordering of immediate parent nodes.

Parameters:

:return : :rtype : bool

ORSBaseClass

class ORSModel.ors.ORSBaseClass(self) → None

Bases: sip.wrapper

–

Parameters:self (ORSModel.ors.ORSBaseClass) – an instance of ORSBaseClass
isManaged(self) → bool

–

Parameters:self (ORSModel.ors.ORSBaseClass) – an instance of ORSBaseClass

:return : :rtype : bool

isNone(self) → bool

–

Parameters:self (ORSModel.ors.ORSBaseClass) – an instance of ORSBaseClass

:return : :rtype : bool

Octree

class ORSModel.ors.Octree(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:
  • self (ORSModel.ors.Octree) – an instance of Octree
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Octree.__init__(self) -> None –

Parameters:self (ORSModel.ors.Octree) – an instance of Octree

Octree.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
buildOctreeBox(self, pGrid: ORSModel.ors.UnstructuredGrid, iTIndex: int, bAppend: bool) → None

–

Parameters:
buildOctreeBoxMultiThread(self, pGrid: ORSModel.ors.UnstructuredGrid, iTIndex: int, bAppend: bool) → None

–

Parameters:
buildSpheresOctreeBox(self, pCollection: ORSModel.ors.SequenceableCollection, boxThatContainTheSpheres: ORSModel.ors.Box, iTIndex: int, bAppend: bool) → None

–

Parameters:
getAtomsForPoint(self, x: float, y: float, z: float, iTIndex: int) → ArrayLong

–

Parameters:
  • self (ORSModel.ors.Octree) – an instance of Octree
  • x (float) –
  • y (float) –
  • z (float) –
  • iTIndex (int) –
getAtomsIntersectingBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle, iTIndex: int) → List

–

Parameters:
getAtomsIntersectingBox(self, aBox: ORSModel.ors.Box, iTIndex: int) → List

–

Parameters:
getAtomsIntersectingLine(self, aLine: ORSModel.ors.Line, iTIndex: int) → List

–

Parameters:
getAtomsIntersectingPlane(self, a: float, b: float, c: float, d: float, iTIndex: int) → List

–

Parameters:
  • self (ORSModel.ors.Octree) – an instance of Octree
  • a (float) –
  • b (float) –
  • c (float) –
  • d (float) –
  • iTIndex (int) –
getClassNameStatic() → str

–

:return : :rtype : str

isEqualTo(self, anOctree: ORSModel.ors.Octree, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

none() → Octree

–

OpticalFlow

class ORSModel.ors.OpticalFlow(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

OpticalFlow.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
computeAverageSpeedAndRotation(self, bUsePonderationByIntensityIm1: bool, pAverageSpeedX: float, pAverageSpeedY: float, pAverageSpeedZ: float, pAverageRotationAroundZ: float, pBarycenterX: float, pBarycenterY: float) → None

–

Parameters:
  • self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
  • bUsePonderationByIntensityIm1 (bool) –
  • pAverageSpeedX (float) –
  • pAverageSpeedY (float) –
  • pAverageSpeedZ (float) –
  • pAverageRotationAroundZ (float) –
  • pBarycenterX (float) –
  • pBarycenterY (float) –
computeOpticalFlow(self) → None

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
createGaussianPyramid(self, pIOutChannelsGaussianPyramidIm1: ORSModel.ors.Channel, pIOutChannelsGaussianPyramidIm2: ORSModel.ors.Channel, pNumberOfLevels: int) → None

–

Parameters:
findMaximalLevelGaussianPyramid(self) → int

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : unsigned int

findMaximalLevelGaussianPyramidChannelAWithChannelB(self, pIBoundingBoxSearchArea: ORSModel.ors.Box) → int

–

Parameters:

:return : :rtype : unsigned int

findMaximalLevelGaussianPyramidForThisImageSize(self, sizeX: int, sizeY: int, sizeZ: int, bPerformZReduction: bool) → int

–

Parameters:
  • self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
  • sizeX (int) –
  • sizeY (int) –
  • sizeZ (int) –
  • bPerformZReduction (bool) –

:return : :rtype : unsigned int

findMinimalLevelGaussianPyramidForGivenPrecision(self, pIBoundingBoxReferenceIm1: ORSModel.ors.Box, pIBoundingBoxSearchArea: ORSModel.ors.Box, minimalDistanceToStopOpticalFlow: float, minimalRotationToStopOpticalFlow: float, maximalNumberOfIterationsOpticalFlow: int, acceptableRelativeError: float) → int

–

Parameters:
  • self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
  • pIBoundingBoxReferenceIm1 (ORSModel.ors.Box) –
  • pIBoundingBoxSearchArea (ORSModel.ors.Box) –
  • minimalDistanceToStopOpticalFlow (float) –
  • minimalRotationToStopOpticalFlow (float) –
  • maximalNumberOfIterationsOpticalFlow (int) –
  • acceptableRelativeError (float) –

:return : :rtype : unsigned int

getChannelIm1(self) → Channel

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
getChannelIm2(self) → Channel

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
getClassNameStatic() → str

–

:return : :rtype : str

getFactorRegularizationSpeedCorrection(self) → float

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : float

getLastDisplacementRegistration2DTransformation(self, pAverageSpeedX: float, pAverageSpeedY: float, pAverageRotationAroundZ: float, pBarycenterX: float, pBarycenterY: float) → None

–

Parameters:
  • self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
  • pAverageSpeedX (float) –
  • pAverageSpeedY (float) –
  • pAverageRotationAroundZ (float) –
  • pBarycenterX (float) –
  • pBarycenterY (float) –
getMaxLevelGaussianPyramid(self) → int

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : unsigned int

getMaximalConditionValueRegularizedAtransposeA(self) → float

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : float

getMinLevelGaussianPyramid(self) → int

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : unsigned int

getOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int) → None

–

Parameters:
getOriginPixelsIm1(self, x: int, y: int, z: int, t: int) → None

–

Parameters:
getOriginPixelsIm2(self, x: int, y: int, z: int, t: int) → None

–

Parameters:
getPatchWindowHalfsize(self, x: int, y: int, z: int) → None

–

Parameters:
getPerformZReduction(self) → bool

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : bool

getSizeImagesPixels(self, x: int, y: int, z: int) → None

–

Parameters:
getSizePixelsAverageSpeed(self, x: int, y: int, z: int) → None

–

Parameters:
getUpsampleSpeedToSameSizeAsBaseChannel(self) → bool

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : bool

getUseBrightnessCorrectionFactors(self, pValueLinearFactor: bool, pValueConstantFactor: bool) → None

–

Parameters:
  • self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
  • pValueLinearFactor (bool) –
  • pValueConstantFactor (bool) –
getUseRotationAroundZ(self) → bool

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : bool

getUseTranslationX(self) → bool

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : bool

getUseTranslationY(self) → bool

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow

:return : :rtype : bool

getXSpeed(self) → Channel

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
getYSpeed(self) → Channel

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
getZSpeed(self) → Channel

–

Parameters:self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
none() → OpticalFlow

–

registration2DTransformation(self, pIBoundingBoxReferenceIm1: ORSModel.ors.Box, pIBoundingBoxSearchArea: ORSModel.ors.Box, minimalDistanceToStopOpticalFlow: float, minimalRotationToStopOpticalFlow: float, maximalNumberOfIterationsOpticalFlow: int, bApplyTransformation: bool, IProgress: ORSModel.ors.Progress) → Matrix4x4

–

Parameters:
setChannelIm1(self, pIInputChannel: ORSModel.ors.Channel) → None

–

Parameters:
setChannelIm2(self, pIInputChannel: ORSModel.ors.Channel) → None

–

Parameters:
setFactorRegularizationSpeedCorrection(self, value: float) → None

–

Parameters:
setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int) → None

–

Parameters:
setMaximalConditionValueRegularizedAtransposeA(self, value: float) → None

–

Parameters:
setOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int) → None

–

Parameters:
setOriginPixelsIm1(self, x: int, y: int, z: int, t: int) → None

–

Parameters:
setOriginPixelsIm2(self, x: int, y: int, z: int, t: int) → None

–

Parameters:
setPatchWindowHalfsize(self, x: int, y: int, z: int) → None

–

Parameters:
setPerformZReduction(self, bValue: bool) → None

–

Parameters:
setSizeImagesPixels(self, x: int, y: int, z: int) → None

–

Parameters:
setSizePixelsAverageSpeed(self, x: int, y: int, z: int) → None

–

Parameters:
setUpsampleSpeedToSameSizeAsBaseChannel(self, bValue: bool) → None

–

Parameters:
setUseBrightnessCorrectionFactors(self, bValueLinearFactor: bool, bValueConstantFactor: bool) → None

–

Parameters:
  • self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
  • bValueLinearFactor (bool) –
  • bValueConstantFactor (bool) –
setUseRotationAroundZ(self, bValue: bool) → None

–

Parameters:
setUseTranslationX(self, bValue: bool) → None

–

Parameters:
setUseTranslationY(self, bValue: bool) → None

–

Parameters:

OrderedCollection

class ORSModel.ors.OrderedCollection

Bases: ORSModel.ors.SequenceableCollection

brief_description: Abstraction class for ordered collections. author: Normand Mongeau. version: 1.0 Abstraction class for ordered collections.

OrderedCollection.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

OrderedCollection.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addAll(self, aSequenceableCollection: ORSModel.ors.SequenceableCollection) → None

–

Parameters:
addAllFirst(self, aSequenceableCollection: ORSModel.ors.SequenceableCollection) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → OrderedCollection

–

OrderedCollectionChar

class ORSModel.ors.OrderedCollectionChar(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionChar.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar

OrderedCollectionChar.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar

:return : :rtype : int

getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionChar

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrderedCollectionDouble

class ORSModel.ors.OrderedCollectionDouble(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionDouble.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble

OrderedCollectionDouble.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: float) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: float) → None

–

Parameters:
addFirst(self, pValue: float) → None

–

Parameters:
at(self, index: int) → float

–

Parameters:

:return : :rtype : float

atPut(self, index: int, pValue: float) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → float

–

Parameters:self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble

:return : :rtype : float

getLast(self) → float

–

Parameters:self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble

:return : :rtype : float

getOccurrencesOf(self, pValue: float) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: float) → None

–

Parameters:
none() → OrderedCollectionDouble

–

removeAllOccurrencesOf(self, pValue: float) → None

–

Parameters:

OrderedCollectionFloat

class ORSModel.ors.OrderedCollectionFloat(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionFloat.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat

OrderedCollectionFloat.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: float) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: float) → None

–

Parameters:
addFirst(self, pValue: float) → None

–

Parameters:
at(self, index: int) → float

–

Parameters:

:return : :rtype : float

atPut(self, index: int, pValue: float) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → float

–

Parameters:self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat

:return : :rtype : float

getLast(self) → float

–

Parameters:self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat

:return : :rtype : float

getOccurrencesOf(self, pValue: float) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: float) → None

–

Parameters:
none() → OrderedCollectionFloat

–

removeAllOccurrencesOf(self, pValue: float) → None

–

Parameters:

OrderedCollectionLONGLONG

class ORSModel.ors.OrderedCollectionLONGLONG(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionLONGLONG.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG

OrderedCollectionLONGLONG.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG

:return : :rtype : int

getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionLONGLONG

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrderedCollectionLong

class ORSModel.ors.OrderedCollectionLong(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionLong.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong

OrderedCollectionLong.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong

:return : :rtype : int

getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionLong

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrderedCollectionShort

class ORSModel.ors.OrderedCollectionShort(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionShort.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort

OrderedCollectionShort.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort

:return : :rtype : int

getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionShort

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrderedCollectionUnsignedChar

class ORSModel.ors.OrderedCollectionUnsignedChar(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionUnsignedChar.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar

OrderedCollectionUnsignedChar.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar

:return : :rtype : int

getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionUnsignedChar

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrderedCollectionUnsignedLONGLONG

class ORSModel.ors.OrderedCollectionUnsignedLONGLONG(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionUnsignedLONGLONG.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG

OrderedCollectionUnsignedLONGLONG.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG

:return : :rtype : int

getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionUnsignedLONGLONG

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrderedCollectionUnsignedLong

class ORSModel.ors.OrderedCollectionUnsignedLong(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionUnsignedLong.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong

OrderedCollectionUnsignedLong.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong

:return : :rtype : int

getOccurrencesOf(self, pValue: int) → int

–

Parameters:

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionUnsignedLong

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrderedCollectionUnsignedShort

class ORSModel.ors.OrderedCollectionUnsignedShort(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.OrderedCollection

–

Parameters:

OrderedCollectionUnsignedShort.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort

OrderedCollectionUnsignedShort.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
add(self, pValue: int) → None

–

Parameters:
addBeforeIndex(self, index: int, pValue: int) → None

–

Parameters:
addFirst(self, pValue: int) → None

–

Parameters:
at(self, index: int) → int

–

Parameters:

:return : :rtype : int

atPut(self, index: int, pValue: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getFirst(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort

:return : :rtype : int

getLast(self) → int

–

Parameters:self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort

:return : :rtype : int

insertAt(self, index: int, pValue: int) → None

–

Parameters:
none() → OrderedCollectionUnsignedShort

–

removeAllOccurrencesOf(self, pValue: int) → None

–

Parameters:

OrientedPlane

class ORSModel.ors.OrientedPlane

Bases: ORSModel.ors.Shape2D

brief_description: Oriented plane manipulation services. author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: May 2010

OrientedPlane.__init__(self) -> None –

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane

OrientedPlane.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → OrientedPlane

–

Gets a copy of the receiver.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
from3PointsAndUp(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3, point2: ORSModel.ors.Vector3, up: ORSModel.ors.Vector3) → None

–

Initializes the plane from 3 points and an up vector.

Parameters:
fromPointAndNormalAndUp(self, point: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3, up: ORSModel.ors.Vector3) → None

–

Initializes the receiver from an origin point, a normal vector and an up vector.

Parameters:
getA(self) → float

–

Gets the A plane value.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane

:return : :rtype : float

getB(self) → float

–

Gets the B plane value.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane

:return : :rtype : float

getC(self) → float

–

Gets the C plane value.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane

:return : :rtype : float

getCenter(self) → Vector3

–

Gets the center position.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getClassNameStatic() → str

–

:return : :rtype : str

getD(self) → float

–

Gets the D plane value.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane

:return : :rtype : float

getDirection0(self) → Vector3

–

Gets the orientedPlane right direction.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getDirection1(self) → Vector3

–

Gets the orientedPlane up direction.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getDirection2(self) → Vector3

–

Gets the orientedPlane normal direction.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getDistanceFromOrientedPlane(self, orientedPlane: ORSModel.ors.OrientedPlane) → float

–

Gets the distance from the provided plane to the receiver.

Parameters:

:return : :rtype : float

getDistanceFromPlane(self, plane: ORSModel.ors.Plane) → float

–

Returns the distance from the receiver to the provided plane.

Parameters:

:return : :rtype : float

getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float

–

Returns the distance from the receiver to the provided point.

Parameters:

:return : :rtype : float

getEulerAngles(self, yaw: float, pitch: float, roll: float) → None

–

Returns the yaw, pitch, roll of the plane.

Parameters:

self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:
  • yaw (float) – yaw (a double)
  • pitch (float) – pitch (a double)
  • roll (float) – roll (a double)
getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → Vector3

–

Returns the vector representing the intersection with the provided line.

Parameters:
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → Vector3

–

Returns the vector representing the intersection with the provided line segment.

Parameters:
getIntersectionWithPlanes(self, plane1: ORSModel.ors.Plane, plane2: ORSModel.ors.Plane) → Vector3

–

Returns the point of the intersection with the provided planes.

Parameters:
getIsEqualTo(self, anOrientedPlane: ORSModel.ors.OrientedPlane) → bool

–

Parameters:

:return : :rtype : bool

getIsParallelWithOrientedPlane(self, orientedPlane: ORSModel.ors.OrientedPlane) → bool

–

Checks if the receiver is parallel with the provided oriented plane.

Parameters:

:return : :rtype : bool

getIsParallelWithPlane(self, plane: ORSModel.ors.Plane) → bool

–

Checks if the receiver is parallel with the provided plane.

Parameters:

:return : :rtype : bool

getNormal(self) → Vector3

–

Returns the normal of the plane.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getPlane(self) → Plane

–

Gets the plane represented by the receiver.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getPointOnOrientedPlaneClosestToOrigin(self) → Vector3

–

Returns the point on the receiver that is closest to the origin (0, 0, 0)

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getProjectionOnPlane(self, point: ORSModel.ors.Vector3) → Vector3

–

Returns the point provided projected on the receiver.

Parameters:
getRight(self) → Vector3

–

Gets the cross product of the normal and up vectors.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → OrientedPlane

–

Parameters:
getTransformed(self, aTransformationMatrix: ORSModel.ors.Matrix4x4) → OrientedPlane

–

Parameters:
getTranslatedToIncludePoint(self, point: ORSModel.ors.Vector3) → OrientedPlane

–

Parameters:
getUp(self) → Vector3

–

Gets the up vector.

Parameters:self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
none() → OrientedPlane

–

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None

–

Applies a rotation to the receiver.

Parameters:
setA(self, a: float) → None

–

Sets the A plane value.

Parameters:
setB(self, b: float) → None

–

Sets the B plane value.

Parameters:
setC(self, c: float) → None

–

Sets the C plane value.

Parameters:
setCenter(self, pCenterVector: ORSModel.ors.Vector3) → None

–

Sets the center position.

Parameters:
setD(self, d: float) → None

–

Sets the D plane value.

Parameters:
setOrientedPlaneValue(self, a: float, b: float, c: float, d: float, upX: float, upY: float, upZ: float, centerX: float, centerY: float, centerZ: float) → None

–

Sets all the receiver value components.

Parameters:
  • self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
  • a (float) – the A parameter (a double)
  • b (float) – the B parameter (a double)
  • c (float) – the C parameter (a double)
  • d (float) – the D parameter (a double)
  • upX (float) – the up X component (a double)
  • upY (float) – the up Y component (a double)
  • upZ (float) – the up Z component (a double)
  • centerX (float) – the center position X component (a double)
  • centerY (float) – the center position Y component (a double)
  • centerZ (float) – the center position Z component (a double)
setUp(self, upVector: ORSModel.ors.Vector3) → None

–

Sets the up vector.

Parameters:
translateToIncludePoint(self, point: ORSModel.ors.Vector3) → None

–

Parameters:

PartialSpaceDijkstra

class ORSModel.ors.PartialSpaceDijkstra(self) → None

Bases: ORSModel.ors.Dijkstra

–

Parameters:self (ORSModel.ors.PartialSpaceDijkstra) – an instance of PartialSpaceDijkstra

PartialSpaceDijkstra.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
extractBoundaryFromROI(self, aVolROI: ORSModel.ors.ROI) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → PartialSpaceDijkstra

–

setRadiusOfInterest(self, radius: int) → None

–

Parameters:

PartialSpaceFastMarching

class ORSModel.ors.PartialSpaceFastMarching(self) → None

Bases: ORSModel.ors.FastMarching

–

Parameters:self (ORSModel.ors.PartialSpaceFastMarching) – an instance of PartialSpaceFastMarching

PartialSpaceFastMarching.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
extractBoundaryFromROI(self, aVolROI: ORSModel.ors.ROI) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → PartialSpaceFastMarching

–

setRadiusOfInterest(self, radius: int) → None

–

Parameters:

Plane

class ORSModel.ors.Plane

Bases: ORSModel.ors.Shape2D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Plane.__init__(self) -> None –

Parameters:self (ORSModel.ors.Plane) – an instance of Plane

Plane.__init__(self, a: float, b: float, c: float, d: float) -> None –

Parameters:
  • self (ORSModel.ors.Plane) – an instance of Plane
  • a (float) –
  • b (float) –
  • c (float) –
  • d (float) –

Plane.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → Plane

–

Copies a plane.

Parameters:self (ORSModel.ors.Plane) – an instance of Plane
from3Points(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3, point2: ORSModel.ors.Vector3) → None

–

Initializes the plane from 3 points.

Parameters:
fromNPointsLeastMeanSquares(self, aPointCollection: ORSModel.ors.SequenceableCollection) → None

–

Gets the plane minimizing the sum of the squares distances from a set of (at least 3) points.

Parameters:
fromPointAndNormal(self, point: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3) → None

–

Initializes the plane from an origin point and a normal vector.

Parameters:
getA(self) → float

–

Gets the a coefficient of the plane.

Parameters:self (ORSModel.ors.Plane) – an instance of Plane

:return : :rtype : float

getB(self) → float

–

Gets the b coefficient of the plane.

Parameters:self (ORSModel.ors.Plane) – an instance of Plane

:return : :rtype : float

getC(self) → float

–

Gets the c coefficient of the plane.

Parameters:self (ORSModel.ors.Plane) – an instance of Plane

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getD(self) → float

–

Gets the d coefficient of the plane.

Parameters:self (ORSModel.ors.Plane) – an instance of Plane

:return : :rtype : float

getDistanceFromPlane(self, plane: ORSModel.ors.Plane) → float

–

Computes the distance from another plane.

Parameters:

:return : :rtype : float

getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float

–

Computes the distance from a point.

Parameters:

:return : :rtype : float

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → Vector3

–

Return the vector representing the intersection of the provided line and the receiver.

Parameters:
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → Vector3

–

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:
getIntersectionWithPlane(self, plane: ORSModel.ors.Plane) → Line

–

Parameters:
getIntersectionWithPlanes(self, plane1: ORSModel.ors.Plane, plane2: ORSModel.ors.Plane) → Vector3

–

Return the point of the intersection of the provided planes and the receiver.

Parameters:
getIsEqualTo(self, plane: ORSModel.ors.Plane) → bool

–

Verifies equality between the receiver and a given plane.

Parameters:

:return : :rtype : bool

getIsParallelWithPlane(self, plane: ORSModel.ors.Plane) → bool

–

Checks to see if a given plane is parallel to the received plane.

Parameters:

:return : :rtype : bool

getNormal(self) → Vector3

–

Returns the normal of the plane.

Parameters:self (ORSModel.ors.Plane) – an instance of Plane
getPointOnPlaneClosestToOrigin(self) → Vector3

–

Returns the closest point to the origin of the plane.

Parameters:self (ORSModel.ors.Plane) – an instance of Plane
getProjectionOnPlane(self, point: ORSModel.ors.Vector3) → Vector3

–

Parameters:
getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Plane

–

Parameters:
getTranslatedToIncludePoint(self, point: ORSModel.ors.Vector3) → Plane

–

Parameters:
none() → Plane

–

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None

–

Applies a rotation to the receiver.

Parameters:
setA(self, a: float) → None

–

Sets the a coefficient of the plane.

Parameters:
  • self (ORSModel.ors.Plane) – an instance of Plane
  • a (float) – The a coefficient of the plane (a double)
setB(self, b: float) → None

–

Sets the b coefficient of the plane.

Parameters:
  • self (ORSModel.ors.Plane) – an instance of Plane
  • b (float) – The b coefficient of the plane (a double)
setC(self, c: float) → None

–

Sets the c coefficient of the plane.

Parameters:
  • self (ORSModel.ors.Plane) – an instance of Plane
  • c (float) – The c coefficient of the plane (a double)
setD(self, d: float) → None

–

Sets the d coefficient of the plane.

Parameters:
  • self (ORSModel.ors.Plane) – an instance of Plane
  • d (float) – The d coefficient of the plane (a double)
translateToIncludePoint(self, point: ORSModel.ors.Vector3) → None

–

Parameters:

PlaneCollection

class ORSModel.ors.PlaneCollection

Bases: ORSModel.ors.Visual

brief_description: Represents a collection of planes in the view. author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: Mai 2015 Represents a collection of planes in the view.

PlaneCollection.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

PlaneCollection.__init__(self) -> None –

Parameters:self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection

PlaneCollection.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addPlane(self, aPlane: ORSModel.ors.Plane, tIndex: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getColor(self) → Color

–

Parameters:self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection
getHighlightedPlaneCollection(self, tIndex: int) → OrderedCollectionUnsignedChar

–

Parameters:
getHighlightedPlaneCount(self, tIndex: int) → int

–

Parameters:

:return : :rtype : int

getPlane(self, planeIndex: int, tIndex: int) → Plane

–

Parameters:
getPlaneCount(self, tIndex: int) → int

–

Parameters:

:return : :rtype : int

getSelectedColor(self) → Color

–

Parameters:self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection
getSelectedPlaneCollection(self, tIndex: int) → OrderedCollectionUnsignedChar

–

Parameters:
getSelectedPlaneCount(self, tIndex: int) → int

–

Parameters:

:return : :rtype : int

getThicknessIn2DView(self) → int

–

Parameters:self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection

:return : :rtype : unsigned int

none() → PlaneCollection

–

removePlane(self, planeIndex: int, tIndex: int) → None

–

Parameters:
setColor(self, color: ORSModel.ors.Color) → None

–

Parameters:
setPlane(self, aPlane: ORSModel.ors.Plane, planeIndex: int, tIndex: int) → None

–

Parameters:
setSelectedColor(self, color: ORSModel.ors.Color) → None

–

Parameters:
setThicknessIn2DView(self, tickness: int) → None

–

Parameters:

Progress

class ORSModel.ors.Progress

Bases: ORSModel.ors.Managed

brief_description: An entity to control progress of lengthy processes. author: Normand All other members of ORS participated. version: 1.0 date: August 2014 An entity describing a progress controller.

Progress.__init__(self) -> None –

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

Progress.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:

Progress.__init__(self, buffer: int, nBytes: int) -> None –

Parameters:
closeProgress(self) → None

–

Closes the progress bar.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress
decrementRangeBy(self, iVal: int) → None

–

Decrements the progress range.

Parameters:
deleteObject(self) → None

–

Parameters:self (ORSModel.ors.Progress) – an instance of Progress
getCaption(self) → str

–

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : str

getClassNameStatic() → str

–

:return : :rtype : str

getCurrentProgress(self) → int

–

Gets the current progress position.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : int

getExtraText(self) → str

–

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : str

getID(self) → int

–

Gets the ID.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : int

getIsCancellable(self) → bool

–

Gets if the progress is cancellable.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : bool

getIsCancelled(self) → bool

–

Checks if the progress was cancelled by the user.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : bool

getIsVisible(self) → bool

–

Gets if the progress is visible.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : bool

getIsWorkingBar(self) → bool

–

Gets if the progress is a working progress or not.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : bool

getRange(self) → int

–

Gets the progress range.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress

:return : :rtype : int

incrementRangeBy(self, iVal: int) → None

–

Increments the progress range.

Parameters:
none() → Progress

–

resetCancelledState(self) → None

–

Resets the cancelled state.

Parameters:self (ORSModel.ors.Progress) – an instance of Progress
setExtraText(self, text: str) → None

–

Sets the extra text.

Parameters:
setIsCancellable(self, pValue: bool) → None

–

Sets if the progress is cancellable.

Parameters:
  • self (ORSModel.ors.Progress) – an instance of Progress
  • pValue (bool) – true to make the progress cancellable, false otherwise
setIsCancelled(self, pValue: bool) → None

–

Sets the progress to be cancelled or not.

Parameters:
  • self (ORSModel.ors.Progress) – an instance of Progress
  • pValue (bool) – true to cancel, false otherwise
setIsVisible(self, bVisible: bool) → None

–

Sets if the progress is visible.

Parameters:
startProgressWithCaption(self, sCaption: str, iRange: int, bCancellable: bool) → None

–

Starts a normal progress bar.

Parameters:
  • self (ORSModel.ors.Progress) – an instance of Progress
  • sCaption (str) – the progress caption (a string)
  • iRange (int) – the range (an uint32_t)
  • bCancellable (bool) – true if the progress bar is to be cancellable, false otherwise
startProgressWithID(self, iID: int, iRange: int, bCancellable: bool) → None

–

Starts a normal progress bar.

Parameters:
  • self (ORSModel.ors.Progress) – an instance of Progress
  • iID (int) – the progress id (an unsigned short, see ORSProgressBars.h for supported IDs)
  • iRange (int) – the range (an uint32_t)
  • bCancellable (bool) – true if the progress bar is to be cancellable, false otherwise
startWorkingProgressWithCaption(self, sCaption: str, bCancellable: bool) → None

–

Starts a working progress bar.

Parameters:
  • self (ORSModel.ors.Progress) – an instance of Progress
  • sCaption (str) – the progress caption (a string)
  • bCancellable (bool) – true if the working bar is to be cancellable, false otherwise
startWorkingProgressWithID(self, iID: int, bCancellable: bool) → None

–

Starts a working progress bar.

Parameters:
  • self (ORSModel.ors.Progress) – an instance of Progress
  • iID (int) – the progress id (an unsigned short, see ORSProgressBars.h for supported IDs)
  • bCancellable (bool) – true if the working bar is to be cancellable, false otherwise
updateProgress(self, iPosition: int) → None

–

Updates the progress bar.

Parameters:
  • self (ORSModel.ors.Progress) – an instance of Progress
  • iPosition (int) – the new progress bar position (an uint32_t)

ROI

class ORSModel.ors.ROI

Bases: ORSModel.ors.StructuredGrid

brief_description: Represents a region of interest for a dataset. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: VisualChannel, MeshFacesROI Represents a VisualRegion of Interest (ROI) for a dataset. Can be used to highlight, subtract, extract, etc, portions of a dataset. Each ROI has its own color, opacity, visual state, etc. Only a limited amount of ROIs (255) can be visible simultaneously.

ROI.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ROI.__init__(self) -> None –

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

ROI.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
adaptToChannel(self, pChannel: ORSModel.ors.Channel, x: int, y: int, z: int, pTSourceOffset: int, pTRange: int) → None

–

Adapts aROI to a channel, according to the channel’s coordinates.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pChannel (ORSModel.ors.Channel) – a reference channel (an Channel)
  • x (int) – an X offset (an short)
  • y (int) – an Y offset (an short)
  • z (int) – a Z offset (an short)
  • pTSourceOffset (int) – the T start position of the ROI (an unsigned short)
  • pTRange (int) – the number of Ts to process (an unsigned short)
addCircleArea(self, posX: float, posY: float, posZ: float, normalX: float, normalY: float, normalZ: float, radius: float, tStep: int) → None

–

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • posX (float) –
  • posY (float) –
  • posZ (float) –
  • normalX (float) –
  • normalY (float) –
  • normalZ (float) –
  • radius (float) –
  • tStep (int) –
addCircularPath2D(self, path: ORSModel.ors.VisualPath, box: ORSModel.ors.Box, plane: ORSModel.ors.Plane, includeAllTouchingVoxel: bool, inverse: bool, bRemove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Parameters:
addCircularPath3D(self, path: ORSModel.ors.VisualPath, box: ORSModel.ors.Box, plane: ORSModel.ors.Plane, includeAllTouchingVoxel: bool, inverse: bool, bRemove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Parameters:
addEllipse2D(self, plane: ORSModel.ors.Rectangle, includeAllTouchingVoxel: bool, inverse: bool, remove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Adds a 2D ellipse to theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • plane (ORSModel.ors.Rectangle) – the bounded plane on which the ellipse lies (an Rectangle)
  • includeAllTouchingVoxel (bool) – true to include all touching voxels, false to only include voxels where center is included
  • inverse (bool) – true to add the inverse of the polygon
  • remove (bool) – true to remove the polygon, false to add it
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
  • tStep (int) – time step for which to add the ellipse (an unsigned short)
addEllipse3D(self, plane: ORSModel.ors.Rectangle, includeAllTouchingVoxel: bool, inverse: bool, remove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Adds a 2D ellipse to theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • plane (ORSModel.ors.Rectangle) – the bounded plane on which the ellipse lies (an Rectangle)
  • includeAllTouchingVoxel (bool) – true to include all touching voxels, false to only include voxels where center is included
  • inverse (bool) – true to add the inverse of the polygon
  • remove (bool) – true to remove the polygon, false to add it
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
  • tStep (int) – time step for which to add the ellipse (an unsigned short)
addLine(self, pLine: ORSModel.ors.Line, tStep: int) → None

–

Adds a line to theROI.

Parameters:
addLineIfInRange(self, pLine: ORSModel.ors.Line, tStep: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Adds a line to theROI if the corresponding voxels in the channel are within the specified range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pLine (ORSModel.ors.Line) – the line to add (an Line)
  • tStep (int) – the time step (an unsigned short)
  • lowerThreshold (float) – the lower range value (a double)
  • upperThreshold (float) – the upper range value (a double)
  • pChannel (ORSModel.ors.Channel) – a channel of the same shape as the receiver (an Channel)
addLineSegment(self, lineSegment: ORSModel.ors.LineSegment, tStep: int) → None

–

Adds a line segment to theROI.

Parameters:
addLineSegmentIfInRange(self, lineSegment: ORSModel.ors.LineSegment, tStep: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Adds a line segment to theROI if the corresponding voxels in the channel are within the specified range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • lineSegment (ORSModel.ors.LineSegment) – the line segment to add (an LineSegment)
  • tStep (int) – the time step (an unsigned short)
  • lowerThreshold (float) – the lower range value (a double)
  • upperThreshold (float) – the upper range value (a double)
  • pChannel (ORSModel.ors.Channel) – a channel of the same shape as the receiver (an Channel)
addPathContour(self, aPath: ORSModel.ors.VisualPath, aBox: ORSModel.ors.Box, tStep: int) → None

–

Parameters:
addPolygon2D(self, ptsList: float, ptsListSize: int, plane: ORSModel.ors.Plane, includeAllTouchingVoxel: bool, inverse: bool, remove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Add a 3D polygon to theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • ptsList (float) – the points list (a double array)
  • ptsListSize (int) – the size of the point list (an int)
  • plane (ORSModel.ors.Plane) – the plane on which the points lie (a Plane)
  • includeAllTouchingVoxel (bool) – true to include all touching voxels, false to only include voxels where center is included
  • inverse (bool) – true to add the inverse of the polygon
  • remove (bool) – true to remove the polygon, false to add it
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
  • tStep (int) – the T index (an unsigned short)
addPolygon3D(self, ptsList: float, ptsListSize: int, plane: ORSModel.ors.Plane, includeAllTouchingVoxel: bool, inverse: bool, remove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Add a 3D polygon to theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • ptsList (float) – the points list (a double array)
  • ptsListSize (int) – the size of the point list (an int)
  • plane (ORSModel.ors.Plane) – the plane on which the points lie (a Plane)
  • includeAllTouchingVoxel (bool) – true to include all touching voxels, false to only include voxels where center is included
  • inverse (bool) – true to add the inverse of the polygon
  • remove (bool) – true to remove the polygon, false to add it
  • IProgress (ORSModel.ors.Progress) – a progress object (a Progress)
  • tStep (int) – the T index (an unsigned short)
addROI(self, aROI: ORSModel.ors.ROI) → None

–

Adds aROI to the current ROI.

Parameters:
addROIAtTOffset(self, aROI: ORSModel.ors.ROI, pTOffset: int) → None

–

Adds aROI to the current ROI, but at a specific T offset.

Parameters:
addROIAtTimeStepAtTOffset(self, aROI: ORSModel.ors.ROI, timeIndex: int, pTOffset: int) → None

–

Adds aROI to the current ROI, but at a specific T offset.

Parameters:
addRectangle2D(self, plane: ORSModel.ors.Rectangle, includeAllTouchingVoxel: bool, inverse: bool, remove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Adds a 3D rectangle to theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • plane (ORSModel.ors.Rectangle) – the bounded plane on which the rectangle lies (an Rectangle)
  • includeAllTouchingVoxel (bool) – true to include all touching voxels, false to only include voxels where center is included
  • inverse (bool) – true to add the inverse of the polygon
  • remove (bool) – true to remove the polygon, false to add it
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
  • tStep (int) – time step for which to add the rectangle (an unsigned short)
addRectangle3D(self, plane: ORSModel.ors.Rectangle, includeAllTouchingVoxel: bool, inverse: bool, remove: bool, IProgress: ORSModel.ors.Progress, tStep: int) → None

–

Adds a 3D rectangle to theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • plane (ORSModel.ors.Rectangle) – the bounded plane on which the rectangle lies (an Rectangle)
  • includeAllTouchingVoxel (bool) – true to include all touching voxels, false to only include voxels where center is included
  • inverse (bool) – true to add the inverse of the polygon
  • remove (bool) – true to remove the polygon, false to add it
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
  • tStep (int) – time step for which to add the rectangle (an unsigned short)
addToVolumeROIAtPosition(self, xmin: int, ymin: int, zmin: int, tmin: int, inputROI: ORSModel.ors.ROI) → ROI

–

Extracts a subset from indices.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • xmin (int) – the minimal X indicies of the subset (an unsigned int)
  • ymin (int) – the maximal Y indicies of the subset (an unsigned int)
  • zmin (int) – the minimal Z indicies of the subset (an unsigned int)
  • tmin (int) – the time step start (an unsigned int)
  • inputROI (ORSModel.ors.ROI) – the subset ROI
addVoxel(self, index: int) → None

–

Adds a voxel.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • index (int) – the index of the voxel (a int64_t)
addVoxelFromWorldCoordinates(self, pVect: ORSModel.ors.Vector3, timeIndex: int) → None

–

Adds point (supplied in the form of world vector) to theROI.

Parameters:
addVoxelIndicesToROIIfInRange(self, indices: int, indicesSize: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Adds indices to theROI, checking against a range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • indices (int) – an array of indices (a int64_t*)
  • indicesSize (int) – the number of indices in the array (a int64_t)
  • lowerThreshold (float) – the lower range (a double)
  • upperThreshold (float) – the upper range (a double)
  • pChannel (ORSModel.ors.Channel) – the channel to check against (an Channel)
addVoxelIntersectingBoundedPlane(self, aPlane: ORSModel.ors.Rectangle, tStep: int) → None

–

Parameters:
addVoxelInterval(self, iStart: int, iEnd: int) → None

–

Adds a voxel interval of indicies.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • iStart (int) – the start value (inclusive) of the interval (a int64_t)
  • iEnd (int) – the end value (inclusive) of the interval (a int64_t)
addVoxelIntervals(self, pIntervalArray: int, pNumberOfIntervals: int) → None

–

Adds a list of voxel indicies intervals.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pIntervalArray (int) – an array of interval begin and end (inclusive) values (a int64_t*)
  • pNumberOfIntervals (int) – the number of interval pairs in the array (a int32_t*)
addVoxels(self, indices: int, indicesSize: int) → None

–

Adds a list of voxels.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • indices (int) – an array of indicies (a int64_t*)
  • indicesSize (int) – the number of indicies in the array (a int64_t)
addVoxelsFromWorldCoordinates(self, worldPositionArray: ORSModel.ors.ArrayDouble, timeIndex: int) → None

–

Adds indices (supplied in the form of world coordinates) to theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • worldPositionArray (ORSModel.ors.ArrayDouble) – an array of world position triplets (an ArrayDouble)
  • timeIndex (int) – the T index (an unsigned int)
addVoxelsFromWorldCoordinatesIfInRange(self, worldPositionArray: ORSModel.ors.ArrayDouble, timeIndex: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Adds indices (supplied in the form of world coordinates) to theROI, checking against a range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • worldPositionArray (ORSModel.ors.ArrayDouble) – an array of world position triplets (an ArrayDouble)
  • timeIndex (int) – the T index (an unsigned int)
  • lowerThreshold (float) – the lower range (a double)
  • upperThreshold (float) – the upper range (a double)
  • pChannel (ORSModel.ors.Channel) – the channel to check against (an Channel)
clearROI(self) → None

–

Empties all voxel data from the region of interest.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI
clearTimeStepRange(self, pTimeStepStart: int, pTimeStepEnd: int) → None

–

Empties a time step range of the region of interest.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pTimeStepStart (int) – the time step start (an unsigned short)
  • pTimeStepEnd (int) – the time step end (an unsigned short)
copyInto(self, aROI: ORSModel.ors.ROI) → None

–

Copies the receiver into anotherROI.

Parameters:
dijkstra3DGrow(self, inputChannel: ORSModel.ors.Channel, volumeToGrowIn: ORSModel.ors.Box, volumeOfTheGrow: float, timeStep: int) → None

–

Parameters:
dilate(self, pNumberOfIterations: int, pTimeStep: int, progress: ORSModel.ors.Progress) → None

–

Dilates (grows) theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pNumberOfIterations (int) – the number of dilate iterations (a unsigned short)
  • pTimeStep (int) – the time step (an unsigned short)
  • progress (ORSModel.ors.Progress) – a progress object (a Progress)
duplicateTimeStepDataAcrossAllTimeSteps(self, pSourceTimeStep: int) → None

–

Duplicates data from one time step to all time steps.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pSourceTimeStep (int) – the source time step (an unsigned short)
erode(self, pNumberOfIterations: int, pTimeStep: int, progress: ORSModel.ors.Progress) → None

–

Erodes (shrinks) theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pNumberOfIterations (int) – the number of erode iterations (a unsigned short)
  • pTimeStep (int) – the time step (an unsigned short)
  • progress (ORSModel.ors.Progress) – a progress object (a Progress)
exchangeInternalData(self, aROI: ORSModel.ors.ROI) → bool

–

Exchanges (swaps) internal data between the receiver and the argumentROI.

Parameters:

:return : :rtype : bool

extractCenterLinePaths(self, aSourceROI: ORSModel.ors.ROI, aTargetROI: ORSModel.ors.ROI) → List

–

Parameters:
extractMinimumLengthPaths(self, aSourceROI: ORSModel.ors.ROI, aTargetROI: ORSModel.ors.ROI) → List

–

Parameters:
extractSmoothPaths(self, aSourceROI: ORSModel.ors.ROI, aTargetROI: ORSModel.ors.ROI, fastMarchingGeometricBias: float, centered: bool) → List

–

Parameters:
fillAllInnerHoles2DALongDirection(self, dirX: float, dirY: float, dirZ: float, considerDiagonal: bool) → None

–

Fills all inner holes of 2D slices aint32_t any direction.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • dirX (float) – the X component of the direction (a double)
  • dirY (float) – the Y component of the direction (a double)
  • dirZ (float) – the Z component of the direction (a double)
  • considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)
fillAllInnerHoles2DAlongXAxis(self, iTIndex: int, considerDiagonal: bool) → None

–

Fills all X slices’ inner holes.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • iTIndex (int) – the T index (an unsigned short)
  • considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)
fillAllInnerHoles2DAlongYAxis(self, iTIndex: int, considerDiagonal: bool) → None

–

Fills all Y slices’ inner holes.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • iTIndex (int) – the T index (an unsigned short)
  • considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)
fillAllInnerHoles2DAlongZAxis(self, iTIndex: int, considerDiagonal: bool) → None

–

Fills all Z slices’ inner holes.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • iTIndex (int) – the T index (an unsigned short)
  • considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)
fillInnerHoles(self, iTIndex: int, considerDiagonal: bool) → None

–

Fills theROI’s interior.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • iTIndex (int) – the T index (an unsigned short)
  • considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)
fillInnerHoles2D(self, pCenter: ORSModel.ors.Vector3, pDirection: ORSModel.ors.Vector3, considerDiagonal: bool) → None

–

Fills theROI’s interior in 2D.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pCenter (ORSModel.ors.Vector3) – a vector describing the 2D plane’s center point (an Vector3)
  • pDirection (ORSModel.ors.Vector3) – a vector describing the direction of the plane (an Vector3)
  • considerDiagonal (bool) – true to use 26 neighbors, false to use 6 neighbors (see note below)
fillIntervalArrays(self, pOutputLow: ORSModel.ors.ArrayUnsignedLong, pOutputHigh: ORSModel.ors.ArrayLONGLONG) → None

–

Extracts indicies in the form of intervals.

Parameters:

self (ORSModel.ors.ROI) – an instance of ROI
Returns:
generateAnalyzer(self, aTimeStep: int, inputChannel: ORSModel.ors.Channel, longestDistance: bool, longestSegment: bool, inertiaTensorPrincipalComponent: bool, surfaceArea: bool, centerOfMass: bool, IProgress: ORSModel.ors.Progress) → ROIAnalyzer

–

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • aTimeStep (int) –
  • inputChannel (ORSModel.ors.Channel) –
  • longestDistance (bool) –
  • longestSegment (bool) –
  • inertiaTensorPrincipalComponent (bool) –
  • surfaceArea (bool) –
  • centerOfMass (bool) –
  • IProgress (ORSModel.ors.Progress) –
getAsCubicMesh(self, bWorld: bool, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → Mesh

–

Generates a cubic mesh model from theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • bWorld (bool) – true to have the resulting mesh model in world coordinates, false in local
  • IProgress (ORSModel.ors.Progress) – a progress object or NULL to show no progress (an Progress)
  • IInMesh (ORSModel.ors.Mesh) – an optional target mesh model (an Mesh)
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) → Mesh

–

Creates a marching cube from theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • isovalue (float) – an isovalue (a float)
  • bSnapToContour (bool) – true to snap vertices to contour, false to interpolate
  • flipNormal (bool) – true flips normals, false doesn’t
  • timeStep (int) – the time step to use (an unsigned short)
  • xSample (int) – the X sampling (an unsigned short, 1 means no sampling)
  • ySample (int) – the Y sampling (an unsigned short, 1 means no sampling)
  • zSample (int) – the Z sampling (an unsigned short, 1 means no sampling)
  • pNearest (bool) – true to sample to nearest value, false to sample linearly (if sampling is 1 this flag is ignored)
  • pWorld (bool) – true to have the resulting mesh model in world coordinates, false in local
  • IProgress (ORSModel.ors.Progress) – a progress object, NULL for no progress (an Progress)
Returns:

pMesh (ORSModel.ors.Mesh) – an optional output mesh model (an Mesh)
getAsROIClipped(self, minX: int, minY: int, minZ: int, minT: int, maxX: int, maxY: int, maxZ: int, maxT: int, aROI: ORSModel.ors.ROI) → ROI

–

Clips theROI to the specified region.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • minX (int) – the X min dimension of the clip region (an int)
  • minY (int) – the Y min dimension of the clip region (an int)
  • minZ (int) – the Z min dimension of the clip region (an int)
  • minT (int) – the T min dimension of the clip region (an int)
  • maxX (int) – the X max dimension of the clip region (an int)
  • maxY (int) – the Y max dimension of the clip region (an int)
  • maxZ (int) – the Z max dimension of the clip region (an int)
  • maxT (int) – the T max dimension of the clip region (an int)
  • aROI (ORSModel.ors.ROI) – an optional target ROI (an ROI)
getAsROIClosedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, pInRoi: ORSModel.ors.ROI, pTimeStep: int) → ROI

–

Closes theROI according to a supplied 3D kernel.

Parameters:
getAsROIDilatedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, pInRoi: ORSModel.ors.ROI, pTimeStep: int, progress: ORSModel.ors.Progress) → ROI

–

Dilates (grows) theROI according to a supplied 3D kernel.

Parameters:
getAsROIErodedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, pInRoi: ORSModel.ors.ROI, pTimeStep: int, progress: ORSModel.ors.Progress) → ROI

–

Erodes (shrinks) theROI according to a supplied 3D kernel.

Parameters:
getAsROIFromTimeStepsUnion(self, pTimeStep1: int, pTimeStep2: int, anOutputROI: ORSModel.ors.ROI) → ROI

–

Merges (union) 2 time steps of theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pTimeStep1 (int) – source time step (an unsigned short)
  • pTimeStep2 (int) – time step to merge with (an unsigned short)
  • anOutputROI (ORSModel.ors.ROI) – the output ROI (an ROI), see note below
getAsROIMovedInChannel(self, pInputData: ORSModel.ors.Channel, xOffset: int, yOffset: int, zOffset: int, pTargetROI: ORSModel.ors.ROI) → ROI

–

Moves theROI by a given offset in a channel.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pInputData (ORSModel.ors.Channel) – the source channel (an Channel)
  • xOffset (int) – an X voxel offset (an int)
  • yOffset (int) – a Y voxel offset (an int)
  • zOffset (int) – a Z voxel offset (an int)
  • pTargetROI (ORSModel.ors.ROI) – an optional output ROI (an ROI)
getAsROIOpenWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, pInRoi: ORSModel.ors.ROI, pTimeStep: int) → ROI

–

Opens theROI according to a supplied 3D kernel.

Parameters:
getAsROIThinned(self, aROI: ORSModel.ors.ROI) → ROI

–

Parameters:
getBoxGrownToContainVoxels(self, aBox: ORSModel.ors.Box, timeStep: int) → Box

–

Grow the given box so that it include all the voxels of the specified time step.

Parameters:
getCenterOfMass(self, pTimeStep: int) → Vector3

–

Computes theROI’s center of mass.

Parameters:
getCircumferenceAreaAndMinMaxDiameter(self, pBoundedPlane: ORSModel.ors.Rectangle, pointInside: ORSModel.ors.Vector3, nTimeStep: int, area: float, circumference: float, meanDiameter: float, maxDiameterPoint0: ORSModel.ors.Vector3, maxDiameterPoint1: ORSModel.ors.Vector3, minDiameter0: ORSModel.ors.Vector3, minDiameter1: ORSModel.ors.Vector3) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getClipBox(timestep=0, display=None)

Gets the clip box of the ROI or of the MultiROI

Parameters:
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:
Returns:
getConnectedComponent(self, iTIndex: int, considerDiagonal: bool, IProgress: ORSModel.ors.Progress, pInData: ORSModel.ors.MultiROI) → MultiROI

–

Connected connectivity analysis of theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • iTIndex (int) – the T index (an unsigned short)
  • considerDiagonal (bool) – true to consider diagonals, false otherwise
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress
  • pInData (ORSModel.ors.MultiROI) – an optional output object (an MultiROI)
getContour(self, pPlane: ORSModel.ors.Plane, nTimeStep: int, pfPoints: ORSModel.ors.Array) → None

–

Parameters:
getContour2(self, pBoudedPlane: ORSModel.ors.Rectangle, nTimeStep: int, pfPoints: ORSModel.ors.Array) → None

–

Parameters:
getContourOrdered(self, pPlane: ORSModel.ors.Plane, nTimeStep: int, pfPoints: ORSModel.ors.Array, pnIndexes: ORSModel.ors.ArrayLong) → None

–

GetROI contours Sorts the labels on their sizes, in descending order.

Parameters:
getContourOrdered2(self, pBoudedPlane: ORSModel.ors.Rectangle, nTimeStep: int, pfPoints: ORSModel.ors.Array, pnIndexes: ORSModel.ors.ArrayLong) → None

–

GetROI contours Sorts the labels on their sizes, in descending order.

Parameters:
getEndPoints(self, aROI: ORSModel.ors.ROI) → ROI

–

Parameters:
getFromTimeStepRange(self, pTimeStepStart: int, pTimeStepEnd: int, anOutputROI: ORSModel.ors.ROI) → ROI

–

Extracts a T range from the region of interest, as a new region of interest.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pTimeStepStart (int) – the time step start (an unsigned short)
  • pTimeStepEnd (int) – the time step end (an unsigned short)
  • anOutputROI (ORSModel.ors.ROI) –
getFurthestPointsAndDistance(self, pX: int, pY: int, pZ: int, pX2: int, pY2: int, pZ2: int, pDistance: float, timeStep: int) → None

–

Finds the two furthest points and computes the distance between these points.

Parameters:
Returns:
  • pX (int) – the X coordinate of the first point (an int)
  • pY (int) – the Y coordinate of the first point (an int)
  • pZ (int) – the Z coordinate of the first point (an int)
  • pX2 (int) – the X coordinate of the second point (an int)
  • pY2 (int) – the Y coordinate of the second point (an int)
  • pZ2 (int) – the Z coordinate of the second point (an int)
  • pDistance (float) – the distance between these two points (a double)
getHasDataWithinArea(self, xmin: int, ymin: int, zmin: int, tmin: int, xmax: int, ymax: int, zmax: int, tmax: int) → bool

–

Queries theROI to know if it has data within a specific range of indicies.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • xmin (int) – the minimal x coordinate (a int)
  • ymin (int) – the minimal y coordinate (a int)
  • zmin (int) – the minimal z coordinate (a int)
  • tmin (int) – the minimal t coordinate (a int)
  • xmax (int) – the maximal x coordinate (a int)
  • ymax (int) – the maximal y coordinate (a int)
  • zmax (int) – the maximal z coordinate (a int)
  • tmax (int) – the maximal t coordinate (a int)

:return : :rtype : bool

getHasDataWithinRange(self, startIndex: int, endIndex: int) → bool

–

Queries theROI to know if it has data within a specific range of indicies.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • startIndex (int) – the starting index (a int64_t)
  • endIndex (int) – the ending index (a int64_t)

:return : :rtype : bool

getHasVoxelIndex(self, index: int) → bool

–

Verifies if the receiverROI contains a specified voxel index.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • index (int) – a voxel index (a int64_t)

:return : :rtype : bool

getHistogramData(self, pNumberOfBins: int, pTimeStep: int, IChannel: ORSModel.ors.Channel) → HistogramData

–

Gets a histogram of theROI’s underlying data (from its channel).

Parameters:
getInertiaAxis(self, first: ORSModel.ors.Vector3, second: ORSModel.ors.Vector3, third: ORSModel.ors.Vector3, pTimeStep: int) → None

–

Computes theROI’s inertia tensor eigen vector.

Parameters:
getInitialColor(self) → Color

–

Gets the initialROI color.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI
getIntersectionWithROI(self, aROI: ORSModel.ors.ROI, anOutputROI: ORSModel.ors.ROI) → ROI

–

Intersects theROI with another ROI.

Parameters:
getIsClipped(timestep=0, display=None)

Gets to know if the clip box of the ROI or MultiROI is active

Parameters:
Returns:

isClipped (bool) – if True, the clip box of the ROI or MultiROI is visible; False otherwise.
getIsEmpty(self) → bool

–

Sees if theROI contains data.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : bool

getLabel(self) → int

–

Gets theROI label.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : int

getLabelization(self, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, iTIndex: int, considerDiagonal: bool, IProgress: ORSModel.ors.Progress, pInData: ORSModel.ors.MultiROI) → MultiROI

–

Connected connectivity analysis of theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • minX (int) – the minimum X range (an unsigned short)
  • minY (int) – the minimum Y range (an unsigned short)
  • minZ (int) – the minimum Z range (an unsigned short)
  • maxX (int) – the maximum X range (an unsigned short)
  • maxY (int) – the maximum Y range (an unsigned short)
  • maxZ (int) – the maximum Z range (an unsigned short)
  • iTIndex (int) – the T index (an unsigned short)
  • considerDiagonal (bool) – true to consider diagonals, false otherwise
  • IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress
  • pInData (ORSModel.ors.MultiROI) – an optional output object (an MultiROI)
getLocalBoundingBoxMax(self, timeStep: int) → Vector3

–

Gets the upper-right corner of the visual’s bounding box.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • timeStep (int) – timeStep (unsigned short)
getLocalBoundingBoxMin(self, timeStep: int) → Vector3

–

Gets the lower-left corner of the visual’s bounding box.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • timeStep (int) – timeStep (unsigned short)
getMaxIndex(self) → int

–

Gets the largest index of theROI.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : int

getMaxSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float

–

Gets the maximum source voxel value of theROI for a given channel.

Parameters:

:return : :rtype : float

getMeanSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float

–

Gets the mean source voxel value of theROI for a given channel.

Parameters:

:return : :rtype : float

getMinIndex(self) → int

–

Gets the smallest index of theROI.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : int

getMinSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float

–

Gets the minimum source voxel value of theROI for a given channel.

Parameters:

:return : :rtype : float

getProjectionIn(self, pChannel: ORSModel.ors.Channel, sourceTimeOffset: int, pProgress: ORSModel.ors.Progress) → ROI

–

Projects theROI in a channel’s spatial box.

Parameters:
getReversed(self, pTargetROI: ORSModel.ors.ROI) → ROI

–

Reverses theROI.

Parameters:
getShowContour(self) → bool

–

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : bool

getShowContourCubic(self) → bool

–

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : bool

getShowContourInterpolated(self) → bool

–

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : bool

getSimplePoints(self, aROI: ORSModel.ors.ROI) → ROI

–

Parameters:
getSimplifiedGraphMesh(self, aROI: ORSModel.ors.ROI, aResultMesh: ORSModel.ors.Mesh, aSurfaceMesh: ORSModel.ors.Mesh) → ROI

–

Parameters:
getStandardDeviationSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float

–

Gets the standard deviation of the source voxels of theROI for a given channel.

Parameters:

:return : :rtype : float

getSubsetFromCoordinates(self, xmin: int, ymin: int, zmin: int, tmin: int, xmax: int, ymax: int, zmax: int, tmax: int, subsetROI: ORSModel.ors.ROI) → ROI

–

Extracts a subset from indices.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • xmin (int) – the minimal X indicies of the subset (an unsigned short)
  • ymin (int) – the minimal Y indicies of the subset (an unsigned short)
  • zmin (int) – the minimal Z indicies of the subset (an unsigned short)
  • tmin (int) – the minimal T indicies of the subset (an unsigned short)
  • xmax (int) – the maximal X indicies of the subset (an unsigned short)
  • ymax (int) – the maximal Y indicies of the subset (an unsigned short)
  • zmax (int) – the maximal Z indicies of the subset (an unsigned short)
  • tmax (int) – the maximal T indicies of the subset (an unsigned short)
  • subsetROI (ORSModel.ors.ROI) – the subset ROI
getSubtractionFromROI(self, aROI: ORSModel.ors.ROI, pOutputROI: ORSModel.ors.ROI) → ROI

–

Subtracts anotherROI from the receiver ROI.

Parameters:
getSurface(self, timeStep: int) → float

–

Gets theROI’s surface area.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • timeStep (int) – step for wich we want the surface

:return : :rtype : float

getTotalVoxelCount(self) → int

–

Gets the total number of voxels within theROI.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : int

getUnionWithROI(self, aROI: ORSModel.ors.ROI, iTOffset: int, anOutputROI: ORSModel.ors.ROI) → ROI

–

Merges theROI with another ROI.

Parameters:
getVolume(self, timeStep: int) → float

–

Returns thecomputed volume of the region of interest.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • timeStep (int) – the time step (an unsigned short)

:return : :rtype : float

getVoxelCount(self, iTIndex: int) → int

–

Gets the number of voxels within theROI for a given T value.

Parameters:

:return : :rtype : int

getWillBeDisplayed(self) → bool

–

Gets whether or not theROI is destined to be displayed.

Parameters:self (ORSModel.ors.ROI) – an instance of ROI

:return : :rtype : bool

iterateIntervals(self, callbackFunction: int, userdata: int, bForceSingleThread: bool, bAlignMultiThreadingToZ: bool, createMultiThreadDataFunction: int) → None

–

Iterates through theROI indicies, calling a callback function with index intervals.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • callbackFunction (int) – a callback function (the address of a ORSVOLUMEROIITERATORLINEAR function)
  • userdata (bytes) – any user data to be supplied to the callback function
  • bForceSingleThread (bool) – true to force single threaded execution, false to have it multi-threaded
  • bAlignMultiThreadingToZ (bool) – true to align multi-thread execution to Z slices, false to align to nothing
  • createMultiThreadDataFunction (int) – a callback function to create multithread data (the address of a ORSVOLUMEROIITERATORCREATETHREADDATA function)
iterateXYZTIntervals(self, callbackFunction: int, userdata: int, bForceSingleThread: bool, bAlignMultiThreadingToZ: bool, createMultiThreadDataFunction: int) → None

–

Iterates through theROI indicies, calling a callback function with X/Y/Z/T intervals.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • callbackFunction (int) – a callback function (the address of a ORSVOLUMEROIITERATORXYZT function)
  • userdata (bytes) – any user data to be supplied to the callback function
  • bForceSingleThread (bool) – true to force single threaded execution, false to have it multi-threaded
  • bAlignMultiThreadingToZ (bool) – true to align multi-thread execution to Z slices, false to align to nothing
  • createMultiThreadDataFunction (int) – a callback function to create multithread data (the address of a ORSVOLUMEROIITERATORCREATETHREADDATA function)
makeROIForChannel(self, pChannel: ORSModel.ors.Channel, x: int, y: int, z: int) → ROI

–

Makes a newROI from the receiver, according to a given channel’s coordinates.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pChannel (ORSModel.ors.Channel) – a reference channel (an Channel)
  • x (int) – an X offset (an short)
  • y (int) – an Y offset (an short)
  • z (int) – a Z offset (an short)
none() → ROI

–

paintBoxIntersectingChannel(self, pBox: ORSModel.ors.Box, label: float, tStep: int, intersectingChannel: ORSModel.ors.Channel, levelingMinRange: float, levelingMaxRange: float, pLUT: ORSModel.ors.LookupTable, intersectingChannelClipBox: ORSModel.ors.Box) → None

–

Parameters:
paintBoxIntersectingMultiROI(self, pBox: ORSModel.ors.Box, label: float, tStep: int, intersectingMultiROI: ORSModel.ors.MultiROI, fHightlightOpacity: float, fHightlightOpacityOutRange: float, intersectingMultiROIClipBox: ORSModel.ors.Box) → None

–

Parameters:
paintBoxIntersectingROI(self, pBox: ORSModel.ors.Box, label: float, tStep: int, intersectingROI: ORSModel.ors.ROI, intersectingROIClipBox: ORSModel.ors.Box) → None

–

Parameters:
paintSphereIntersectingChannel(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int, intersectingChannel: ORSModel.ors.Channel, levelingMinRange: float, levelingMaxRange: float, pLUT: ORSModel.ors.LookupTable, intersectingChannelClipBox: ORSModel.ors.Box) → None

–

Parameters:
paintSphereIntersectingMultiROI(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int, intersectingMultiROI: ORSModel.ors.MultiROI, fHightlightOpacity: float, fHightlightOpacityOutRange: float, intersectingMultiROIClipBox: ORSModel.ors.Box) → None

–

Parameters:
paintSphereIntersectingROI(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int, intersectingROI: ORSModel.ors.ROI, intersectingROIClipBox: ORSModel.ors.Box) → None

–

Parameters:
removeAllVoxelsIfInRange(self, timeStep: int, minValue: float, maxValue: float, pChannel: ORSModel.ors.Channel) → None

–

Parameters:
removeAllVoxelsIfNotInRange(self, timeStep: int, minValue: float, maxValue: float, pChannel: ORSModel.ors.Channel) → None

–

Parameters:
removeCircleArea(self, posX: float, posY: float, posZ: float, normalX: float, normalY: float, normalZ: float, radius: float, tStep: int) → None

–

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • posX (float) –
  • posY (float) –
  • posZ (float) –
  • normalX (float) –
  • normalY (float) –
  • normalZ (float) –
  • radius (float) –
  • tStep (int) –
removeLine(self, pLine: ORSModel.ors.Line, tStep: int) → None

–

Removes a line from theROI.

Parameters:
removeLineIfInRange(self, pLine: ORSModel.ors.Line, tStep: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Removes a line from theROI if the corresponding voxels in the channel are within the specified range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pLine (ORSModel.ors.Line) – the line to remove (an Line)
  • tStep (int) – the time step (an unsigned short)
  • lowerThreshold (float) – the lower range value (a double)
  • upperThreshold (float) – the upper range value (a double)
  • pChannel (ORSModel.ors.Channel) – a channel of the same shape as the receiver (an Channel)
removeLineSegment(self, lineSegment: ORSModel.ors.LineSegment, tStep: int) → None

–

Removes a line segment from theROI.

Parameters:
removeLineSegmentIfInRange(self, lineSegment: ORSModel.ors.LineSegment, tStep: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Removes a line segment from theROI if the corresponding voxels in the channel are within the specified range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • lineSegment (ORSModel.ors.LineSegment) – the line segment to remove (an LineSegment)
  • tStep (int) – the time step (an unsigned short)
  • lowerThreshold (float) – the lower range value (a double)
  • upperThreshold (float) – the upper range value (a double)
  • pChannel (ORSModel.ors.Channel) – a channel of the same shape as the receiver (an Channel)
removeROI(self, aROI: ORSModel.ors.ROI) → None

–

Parameters:
removeSimplePointsWithDistanceMap(self, seedPointROI: ORSModel.ors.ROI, spaceChannel: ORSModel.ors.Channel, outputROI: ORSModel.ors.ROI) → ROI

–

Parameters:
removeVoxel(self, index: int) → None

–

Removes a voxel.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • index (int) – the index of the voxel (a int64_t)
removeVoxelIndicesFromROIIfInRange(self, indices: int, indicesSize: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Removes indices from theROI, checking against a range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • indices (int) – an array of indices (a int64_t*)
  • indicesSize (int) – the number of indices in the array (a int64_t)
  • lowerThreshold (float) – the lower range (a double)
  • upperThreshold (float) – the upper range (a double)
  • pChannel (ORSModel.ors.Channel) – the channel to check against (an Channel)
removeVoxelInterval(self, iStart: int, iEnd: int) → None

–

Removes a voxel interval of indicies.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • iStart (int) – the start value (inclusive) of the interval (a int64_t)
  • iEnd (int) – the end value (inclusive) of the interval (a int64_t)
removeVoxelIntervals(self, pIntervalArray: int, pNumberOfIntervals: int) → None

–

Removes a list of voxel indicies intervals.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pIntervalArray (int) – an array of interval begin and end (inclusive) values (a int64_t*)
  • pNumberOfIntervals (int) – the number of interval pairs in the array (a int32_t*)
removeVoxels(self, indices: int, indicesSize: int) → None

–

Removes a list of voxels.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • indices (int) – an array of indicies (a int64_t*)
  • indicesSize (int) – the number of indicies in the array (a int64_t)
removeVoxelsFromWorldCoordinates(self, worldPositionArray: ORSModel.ors.ArrayDouble, timeIndex: int) → None

–

Removes indices (supplied in the form of world coordinates) from theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • worldPositionArray (ORSModel.ors.ArrayDouble) – an array of world position triplets (an ArrayDouble)
  • timeIndex (int) – the T index (an unsigned int)
removeVoxelsFromWorldCoordinatesIfInRange(self, worldPositionArray: ORSModel.ors.ArrayDouble, timeIndex: int, lowerThreshold: float, upperThreshold: float, pChannel: ORSModel.ors.Channel) → None

–

Removes indices (supplied in the form of world coordinates) from theROI, checking against a range.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • worldPositionArray (ORSModel.ors.ArrayDouble) – an array of world position triplets (an ArrayDouble)
  • timeIndex (int) – the T index (an unsigned int)
  • lowerThreshold (float) – the lower range (a double)
  • upperThreshold (float) – the upper range (a double)
  • pChannel (ORSModel.ors.Channel) – the channel to check against (an Channel)
reverseTimeStepRange(self, pTimeStepStart: int, pTimeStepEnd: int) → None

–

Reverses a time step range of theROI.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • pTimeStepStart (int) – the time step start (an unsigned short)
  • pTimeStepEnd (int) – the time step end (an unsigned short)
setInitialColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the initialROI color.

Parameters:
setLabel(self, aLabel: int) → None

–

Sets theROI label.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • aLabel (int) – a label (an unsigned short)
setShowContour(self, pFlag: bool) → None

–

Parameters:
setShowContourCubic(self, pFlag: bool) → None

–

Parameters:
setShowContourInterpolated(self, pFlag: bool) → None

–

Parameters:
setWillBeDisplayed(self, value: bool) → None

–

Indicates whether or not theROI is destined to be displayed.

Parameters:
  • self (ORSModel.ors.ROI) – an instance of ROI
  • value (bool) – true if the ROI will be displayed, false otherwise

ROIAnalyzer

class ORSModel.ors.ROIAnalyzer

Bases: ORSModel.ors.Unmanaged

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

ROIAnalyzer.__init__(self) -> None –

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

ROIAnalyzer.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
geVolumeWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getCenterOfMass(self) → Vector3

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
getCenterOfMassWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getInertiaTensorPrincipalComponent(self) → Vector3

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
getInertiaTensorPrincipalComponentWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getLongestDistance(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getLongestDistanceWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getLongestLineSegment(self) → LineSegment

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
getLongestSegmentWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getMax(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getMaxInPhysicalUnits(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getMean(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getMeanInPhysicalUnits(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getMeanWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getMin(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getMinInPhysicalUnits(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getMinMaxWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getStandardDeviation(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getStandardDeviationInPhysicalUnits(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getStandardDeviationWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getSurfaceArea(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getSurfaceAreaInPhysicalUnits(self) → float

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : float

getSurfaceAreaWasComputed(self) → bool

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : bool

getTimeStep(self) → int

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : int

getVoxelCount(self) → int

–

Parameters:self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

:return : :rtype : int

none() → ROIAnalyzer

–

Rectangle

class ORSModel.ors.Rectangle

Bases: ORSModel.ors.Shape2D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Rectangle.__init__(self) -> None –

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

Rectangle.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
atomicLoad(self, aFilename: str) → None

–

Loads an object from a file.

Parameters:
atomicSave(self, aFilename: str) → int

–

Saves the object to a file.

Parameters:

:return : :rtype : unsigned int

copy(self) → Rectangle

–

Gets a copy of the receiver.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getArea(self) → float

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getBoundedDoublePlaneInBoxReferential(self, inRefBox: ORSModel.ors.Box) → Rectangle

–

Gets a copy of the receiver in the argument referential.

Parameters:
getBox(self, direction2Size: float) → Box

–

Returns a box, with direction2 size provided by the argument, with the same origin as the receiver.

Parameters:
getCenter(self) → Vector3

–

Gets the geometrical middle of the bounded plane.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getCenterHalfVoxel(self) → Vector3

–

Gets the middle of the voxel in the middle of the box.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getCenteredBox(self, direction2Size: float) → Box

–

Returns a box, with direction2 size provided by the argument, with origin displaced as to have the receiver centered in the direction2 vector.

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getDirection(self, index: int) → Vector3

–

Gets the bounded plane direction2.

Parameters:
getDirection0(self) → Vector3

–

Gets the bounded plane direction2.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getDirection0Size(self) → float

–

Gets the bounded plane direction1 vector length.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getDirection0SizeInVoxel(self) → float

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getDirection0Spacing(self) → float

–

Gets the receiver direction0 spacing.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getDirection1(self) → Vector3

–

Gets the bounded plane direction2.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getDirection1Size(self) → float

–

Gets the bounded plane direction1 vector length.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getDirection1SizeInVoxel(self) → float

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getDirection1Spacing(self) → float

–

Gets the receiver direction0 spacing.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getDirection2(self) → Vector3

–

Gets the bounded plane direction2.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getDirectionSize(self, index: int) → float

–

Gets the bounded plane direction1 vector length.

Parameters:

:return : :rtype : float

getDirectionSizeVector(self) → Vector3

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getDirectionSpacing(self, index: int) → float

–

Gets the receiver direction0 spacing.

Parameters:

:return : :rtype : float

getDirectionSpacingVector(self) → Vector3

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float

–

Parameters:

:return : :rtype : float

getIndex(self) → float

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : float

getIntersectionWithPlane(self, pPlane: ORSModel.ors.Plane) → LineSegment

–

Returns the line segment representing the intersection of the provided plane and the receiver.

Parameters:
getInvertedWorldTranformation(self) → Matrix4x4

–

The getWorldTransform matrix cannot be directlly inverted.Use this call to retriev the inverse transform.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getIsEqualTo(self, aBplane: ORSModel.ors.Rectangle) → bool

–

Parameters:

:return : :rtype : bool

getLinearInterpolatedBoundedPlane(self, aPlane: ORSModel.ors.Rectangle, normalizedInterpolationFactor: float) → Rectangle

–

Returns a bounded plane which is the linear interpolation of the receiver and the provided bounded plane.

Parameters:
  • self (ORSModel.ors.Rectangle) – an instance of Rectangle
  • aPlane (ORSModel.ors.Rectangle) – a bounded plane (an Rectangle)
  • normalizedInterpolationFactor (float) – an interpolation factor [0.0 , 1.0] plane (a double)
getNormal(self) → Vector3

–

Returns the normal of theRectangle.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getOrigin(self) → Vector3

–

Gets the bounded plane origin position.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getOriginOpposite(self) → Vector3

–

Gets the bounded plane origin opposite position.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getPlane(self) → Plane

–

Returns the plane on which the bounded plane resides.

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
getProjectionOnPlane(self, aPoint: ORSModel.ors.Vector3) → Vector3

–

Returns a point which is the argument projected on the plane described by the receiver.

Parameters:
getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle

:return : :rtype : str

getSpacingInDirection(self, aDirection: ORSModel.ors.Vector3) → float

–

Parameters:

:return : :rtype : float

getSummit(self, maxDirection0: bool, maxDirection1: bool) → Vector3

–

Gets the position of one of the summits of the bounded plane.

Parameters:
  • self (ORSModel.ors.Rectangle) – an instance of Rectangle
  • maxDirection0 (bool) – TRUE to get maxDirection0, FALSE to get minDirection0
  • maxDirection1 (bool) – TRUE to get maxDirection1, FALSE to get minDirection1
getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → Rectangle

–

Parameters:
getVoxelToWorldCoordinates(self, anIndex: ORSModel.ors.Vector3) → Vector3

–

Gets the position of a given voxel.

Parameters:
getWorldToVoxelCoordinates(self, pPointInWorld: ORSModel.ors.Vector3) → Vector3

–

Gets the position of a given world coordinate.

Parameters:
getWorldTranformation(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.Rectangle) – an instance of Rectangle
growToIncludePoint(self, aPoint: ORSModel.ors.Vector3) → None

–

Grows the receiver as to include the provided point.

Parameters:
none() → Rectangle

–

setDirection(self, index: int, pVect: ORSModel.ors.Vector3) → None

–

Sets the bounded plane direction0.

Parameters:
setDirection0(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the bounded plane direction0.

Parameters:
setDirection0Size(self, aSize: float) → None

–

Sets the bounded plane direction1 vector length.

Parameters:
setDirection0Spacing(self, aSpacing: float) → None

–

Sets the receiver direction0 spacing.

Parameters:
  • self (ORSModel.ors.Rectangle) – an instance of Rectangle
  • aSpacing (float) – the side 0 spacing (a double)
setDirection1(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the bounded plane direction0.

Parameters:
setDirection1Size(self, aSize: float) → None

–

Sets the bounded plane direction1 vector length.

Parameters:
setDirection1Spacing(self, aSpacing: float) → None

–

Sets the receiver direction0 spacing.

Parameters:
  • self (ORSModel.ors.Rectangle) – an instance of Rectangle
  • aSpacing (float) – the side 0 spacing (a double)
setDirectionSize(self, index: int, aSize: float) → None

–

Sets the bounded plane direction1 vector length.

Parameters:
  • self (ORSModel.ors.Rectangle) – an instance of Rectangle
  • index (int) – the side 1 length (a double)
  • aSize (float) –
setDirectionSizeVector(self, pVect: ORSModel.ors.Vector3) → None

–

Parameters:
setDirectionSpacing(self, index: int, aSpacing: float) → None

–

Sets the receiver direction0 spacing.

Parameters:
  • self (ORSModel.ors.Rectangle) – an instance of Rectangle
  • index (int) – the side 0 spacing (a double)
  • aSpacing (float) –
setDirectionSpacingVector(self, pVect: ORSModel.ors.Vector3) → None

–

Parameters:
setOrigin(self, pVect: ORSModel.ors.Vector3) → None

–

Sets the receiver origin position.

Parameters:

ReferenceFrame

class ORSModel.ors.ReferenceFrame

Bases: ORSModel.ors.Node

brief_description: Used to represent a referential. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: Visual Used to represent different referentials (transformation matricies). A frame or any visual ORS object can be attached to a frame to be in a different referential. Visuals attached to a frame can be rotated, scaled, and/or translated. A referential is in reality a 4D transformation matrix that represents a scale, a rotation and a translation in the parent referential (or the world).

ReferenceFrame.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

ReferenceFrame.__init__(self) -> None –

Parameters:self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame

ReferenceFrame.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addLocalTranslation(self, pTranslation: ORSModel.ors.Vector3, pTimeStep: int) → None

–

Moves the frame by the specified offsets.

Parameters:
addLocalTranslationForAllTimeStep(self, pTranslation: ORSModel.ors.Vector3) → None

–

Moves the frame by the specified offsets.

Parameters:
addRotation(self, pRotation: ORSModel.ors.Vector3, angle: float, pTimeStep: int) → None

–

Adds a rotation to the frame referential.

Parameters:
addRotationAroundPoint(self, fromNode: ORSModel.ors.Node, axis: ORSModel.ors.Vector3, centerOfRotation: ORSModel.ors.Vector3, angle: float, pTimeStep: int) → None

–

Parameters:
addRotationAroundPointForAllTimeStep(self, fromNode: ORSModel.ors.Node, axis: ORSModel.ors.Vector3, centerOfRotation: ORSModel.ors.Vector3, angle: float) → None

–

Parameters:
addRotationForAllTimeStep(self, pRotation: ORSModel.ors.Vector3, angle: float) → None

–

Parameters:
addScaling(self, pScale: ORSModel.ors.Vector3, pTimeStep: int) → None

–

Parameters:
addScalingAtPoint(self, pScale: ORSModel.ors.Vector3, pPoint: ORSModel.ors.Vector3, pTimeStep: int) → None

–

Parameters:
addScalingAtPointForAllTimeStep(self, pScale: ORSModel.ors.Vector3, pPoint: ORSModel.ors.Vector3) → None

–

Parameters:
addScalingForAllTimeStep(self, pScale: ORSModel.ors.Vector3) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getLocalPosition(self, pTimeStep: int) → Vector3

–

Gets the frame translation (a vector) from the local parent referential.

Parameters:
getMatrix(self, pTimeStep: int) → Matrix4x4

–

Gets the frame matrix.

Parameters:
getParentFrame(self) → ReferenceFrame

–

Gets the first parent referential.

Parameters:self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
getPosition(self, aNode: ORSModel.ors.Node, pTimeStep: int) → Vector3

–

Gets the frame translation (a vector) directly from the world referential.

Parameters:
getTSize(self) → int

–

Parameters:self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame

:return : :rtype : int

getTransformationFromNodeToThis(self, fromNode: ORSModel.ors.Node, inputOutMatrix: ORSModel.ors.Matrix4x4, pTimeStep: int) → Matrix4x4

–

Parameters:
getXScale(self, pTimeStep: int) → float

–

Gets the X scale of the frame in the parent referential.

Parameters:

:return : :rtype : float

getYScale(self, pTimeStep: int) → float

–

Gets the Y scale of the frame in the parent referential.

Parameters:

:return : :rtype : float

getZScale(self, pTimeStep: int) → float

–

Gets the Z scale of the frame in the parent referential.

Parameters:

:return : :rtype : float

none() → ReferenceFrame

–

reset(self, pTimeStep: int) → None

–

Resets the frame.

Parameters:
resetForAllTimeStep(self) → None

–

Resets the frame.

Parameters:self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
resetFromBox(self, anIBox: ORSModel.ors.Box, pTimeStep: int) → None

–

Resets the frame to a box’s referential.

Parameters:
resetFromBoxForAllTimeStep(self, anIBox: ORSModel.ors.Box) → None

–

Resets the frame to a box’s referential.

Parameters:
setLocalPosition(self, aIVector: ORSModel.ors.Vector3, pTimeStep: int) → None

–

Sets the frame translation from a vector in the local parent referential.

Parameters:
setLocalPositionForAllTimeStep(self, aIVector: ORSModel.ors.Vector3) → None

–

Sets the frame translation from a vector in the local parent referential.

Parameters:
setMatrix(self, pMatrix: ORSModel.ors.Matrix4x4, pTimeStep: int) → None

–

Sets the frame matrix.

Parameters:
setMatrixForAllTimeStep(self, pMatrix: ORSModel.ors.Matrix4x4) → None

–

Sets the frame matrix.

Parameters:
setOrientationCosine(self, fromNode: ORSModel.ors.Node, direction0Cosine: ORSModel.ors.Vector3, direction1Cosine: ORSModel.ors.Vector3, direction2Cosine: ORSModel.ors.Vector3, pTimeStep: int) → None

–

Parameters:
setOrientationCosineForAllTimeStep(self, fromNode: ORSModel.ors.Node, direction0Cosine: ORSModel.ors.Vector3, direction1Cosine: ORSModel.ors.Vector3, direction2Cosine: ORSModel.ors.Vector3) → None

–

Parameters:
setPosition(self, aNode: ORSModel.ors.Node, aIVector: ORSModel.ors.Vector3, pTimeStep: int) → None

–

Sets the frame translation from a vector directly in the world referential.

Parameters:
setPositionForAllTimeStep(self, aNode: ORSModel.ors.Node, aIVector: ORSModel.ors.Vector3) → None

–

Sets the frame translation from a vector directly in the world referential.

Parameters:
setTSize(self, pTSize: int) → None

–

Parameters:
setXScale(self, xScale: float, pTimeStep: int) → None

–

Sets the X scale of the frame in the parent referential.

Parameters:
  • self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
  • xScale (float) – a scale (a double)
  • pTimeStep (int) – the time step (an unsigned short)
setXScaleForAllTimeStep(self, xScale: float) → None

–

Sets the X scale of the frame in the parent referential.

Parameters:
setYScale(self, yScale: float, pTimeStep: int) → None

–

Sets the Y scale of the frame in the parent referential.

Parameters:
  • self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
  • yScale (float) – a scale (a double)
  • pTimeStep (int) – the time step (an unsigned short)
setYScaleForAllTimeStep(self, yScale: float) → None

–

Sets the Y scale of the frame in the parent referential.

Parameters:
setZScale(self, zScale: float, pTimeStep: int) → None

–

Sets the Z scale of the frame in the parent referential.

Parameters:
  • self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
  • zScale (float) – a scale (a double)
  • pTimeStep (int) – the time step (an unsigned short)
setZScaleForAllTimeStep(self, zScale: float) → None

–

Sets the Z scale of the frame in the parent referential.

Parameters:

RenderingEffect

class ORSModel.ors.RenderingEffect(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:

RenderingEffect.__init__(self) -> None –

Parameters:self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

RenderingEffect.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addApplicableClassName(self, sClassName: str) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getEffectIndex(self) → int

–

Parameters:self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

:return : :rtype : int

getID(self) → str

–

Parameters:self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

:return : :rtype : str

getIsApplicableToVisual(self, visual: ORSModel.ors.Visual) → bool

–

Parameters:

:return : :rtype : bool

getIsEnabledForView(self, view: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getShaderCodeForView(self, aView: ORSModel.ors.View, raycastElementId: int, outputElementId: int) → str

–

get the evaluated shader code (in glsl)

Parameters:

:return : :rtype : str

getShaderVariableCount(self) → int

–

Parameters:self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

:return : :rtype : unsigned int

getShaderVariableDoubleCount(self) → int

–

Parameters:self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

:return : :rtype : unsigned int

getShaderVariableDoubleForAll(self, variableName: str) → float

–

Parameters:

:return : :rtype : float

getShaderVariableDoubleForView(self, view: ORSModel.ors.View, variableName: str) → float

–

Parameters:

:return : :rtype : float

getShaderVariableDoubleNameAtIndex(self, iIndex: int) → str

–

Parameters:

:return : :rtype : str

getShaderVariableLUTCount(self) → int

–

Parameters:self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

:return : :rtype : unsigned int

getShaderVariableLUTForAll(self, variableName: str) → LookupTable

–

Parameters:
getShaderVariableLUTForView(self, view: ORSModel.ors.View, variableName: str) → LookupTable

–

Parameters:
getShaderVariableLUTNameAtIndex(self, iIndex: int) → str

–

Parameters:

:return : :rtype : str

none() → RenderingEffect

–

setEffectIndex(self, iValue: int) → None

–

Parameters:
setID(self, sId: str) → None

–

Parameters:
setIsEnabledForView(self, view: ORSModel.ors.View, bState: bool) → None

–

Parameters:
setShaderCode(self, code: str) → None

–

Parameters:
setShaderVariableDoubleForAll(self, variableName: str, aValue: float) → None

–

Parameters:
setShaderVariableDoubleForView(self, view: ORSModel.ors.View, variableName: str, aValue: float) → None

–

Parameters:
setShaderVariableLUTForAll(self, variableName: str, aLUT: ORSModel.ors.LookupTable) → None

–

Parameters:
setShaderVariableLUTForView(self, view: ORSModel.ors.View, variableName: str, aLUT: ORSModel.ors.LookupTable) → None

–

Parameters:

Saver

class ORSModel.ors.Saver

Bases: ORSModel.ors.Managed

brief_description: Allows to save author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: Loader Allows to save ORS objects, for later retrieval. ORS objects are saved in XML format, so this loader uses internally the msxml framework (hence the frequent mention of DOM). Can also be used to create any XML (i.e. not just saving objects).

Saver.__init__(self) -> None –

Parameters:self (ORSModel.ors.Saver) – an instance of Saver

Saver.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addAttributeToCurrentNode(self, attributName: str, attributeValue: str) → None

–

Adds a string attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • attributName (str) – the attribute name (a string)
  • attributeValue (str) – the attribute value (a string)
addBoolAttributeToCurrentNode(self, sAttributeName: str, bValue: bool) → None

–

Adds a boolean attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • bValue (bool) – the attribute value (a bool)
addDoubleAttributeToCurrentNode(self, sAttributeName: str, fValue: float) → None

–

Adds a double attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • fValue (float) – the attribute value (a double)
addFloatAttributeToCurrentNode(self, sAttributeName: str, fValue: float) → None

–

Adds a float attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • fValue (float) – the attribute value (a float)
addIntAttributeToCurrentNode(self, sAttributeName: str, lValue: int) → None

–

Adds an int attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • lValue (int) – the attribute value (an int)
addLONGLONGAttributeToCurrentNode(self, sAttributeName: str, lValue: int) → None

–

Adds a int64_t attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • lValue (int) – the attribute value (a int64_t)
addShortAttributeToCurrentNode(self, sAttributeName: str, lValue: int) → None

–

Adds a short attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • lValue (int) – the attribute value (a short)
addSimpleBoolElementToCurrentNode(self, sElementName: str, bElementValue: bool) → None

–

Adds a boolean element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • bElementValue (bool) – the element value (a bool)
addSimpleCDATAElementToCurrentNode(self, sElementName: str, sElementValue: str) → None

–

Adds a CDATA element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • sElementValue (str) – the element value (a string)
addSimpleDoubleElementToCurrentNode(self, sElementName: str, iElementValue: float) → None

–

Adds a double element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • iElementValue (float) – the element value (a double)
addSimpleElementToCurrentNode(self, elementName: str, elementValue: str) → None

–

Adds a string element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • elementName (str) – the element name (a string)
  • elementValue (str) – the element value (a string)
addSimpleFloatElementToCurrentNode(self, sElementName: str, iElementValue: float) → None

–

Adds a float element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • iElementValue (float) – the element value (a float)
addSimpleIntElementToCurrentNode(self, sElementName: str, lElementValue: int) → None

–

Adds an int element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • lElementValue (int) – the element value (an int)
addSimpleLONGLONGElementToCurrentNode(self, sElementName: str, lElementValue: int) → None

–

Adds a int64_t element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • lElementValue (int) – the element value (a int64_t)
addSimpleShortElementToCurrentNode(self, sElementName: str, lElementValue: int) → None

–

Adds a short element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • lElementValue (int) – the element value (a short)
addSimpleULONGLONGElementToCurrentNode(self, sElementName: str, iElementValue: int) → None

–

Adds an uint64_t element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • iElementValue (int) – the element value (an uint64_t)
addSimpleUnsignedIntElementToCurrentNode(self, sElementName: str, iElementValue: int) → None

–

Adds an unsigned int element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • iElementValue (int) – the element value (an unsigned int)
addSimpleUnsignedShortElementToCurrentNode(self, sElementName: str, iElementValue: int) → None

–

Adds an unsigned short element to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sElementName (str) – the element name (a string)
  • iElementValue (int) – the element value (an unsigned short)
addULONGLONGAttributeToCurrentNode(self, sAttributeName: str, iValue: int) → None

–

Adds an uint64_t attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • iValue (int) – the attribute value (an uint64_t)
addUnsignedIntAttributeToCurrentNode(self, sAttributeName: str, iValue: int) → None

–

Adds an unsigned int attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • iValue (int) – the attribute value (an unsigned int)
addUnsignedShortAttributeToCurrentNode(self, sAttributeName: str, iValue: int) → None

–

Adds an unsigned short attribute to the current node of an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • sAttributeName (str) – the attribute name (a string)
  • iValue (int) – the attribute value (an unsigned short)
getClassNameStatic() → str

–

:return : :rtype : str

getXML(self) → str

–

Parameters:self (ORSModel.ors.Saver) – an instance of Saver

:return : :rtype : str

loadFromFile(self, anXMLFilename: str) → bool

–

Initializes the saver from an XML file.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • anXMLFilename (str) – the file name, including full path (a string)

:return : :rtype : bool

loadString(self, anXMLString: str) → bool

–

Initializes the saver from an XML string.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • anXMLString (str) – a valid XML (a string)

:return : :rtype : bool

none() → Saver

–

pop(self) → None

–

Goes up one level in an XML tree being created.

Parameters:self (ORSModel.ors.Saver) – an instance of Saver
push(self, aXMLNodeName: str) → None

–

Creates a new node in an XML tree.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • aXMLNodeName (str) – the node name (a string)
saveXMLToFile(self, pFilename: str) → int

–

Saves the contents of theSaver as XML format to a file.

Parameters:
  • self (ORSModel.ors.Saver) – an instance of Saver
  • pFilename (str) – the file name, including full path (a string)

:return : :rtype : int

SequenceableCollection

class ORSModel.ors.SequenceableCollection

Bases: ORSModel.ors.Collection

brief_description: Abstraction class for sequenceable collections. author: Normand Mongeau. version: 1.0 Abstraction class for sequenceable collections. Sequenceable collections are collections that have an innate ordering.

SequenceableCollection.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

SequenceableCollection.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
asArray(self) → Array

–

Parameters:self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
asOrderedCollection(self) → OrderedCollection

–

Parameters:self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
atAsDouble(self, index: int) → float

–

Parameters:

:return : :rtype : float

atPutAsDouble(self, index: int, pValue: float) → None

–

Parameters:
dtype
getAsNDArray()
getClassNameStatic() → str

–

:return : :rtype : str

getMaxValueAsDouble(self) → float

–

Parameters:self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection

:return : :rtype : float

getMaxValueAsDoubleInRange(self, startIndex: int, endIndex: int) → float

–

Parameters:

:return : :rtype : float

getMinValueAsDouble(self) → float

–

Parameters:self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection

:return : :rtype : float

getMinValueAsDoubleInRange(self, startIndex: int, endIndex: int) → float

–

Parameters:

:return : :rtype : float

none() → SequenceableCollection

–

removeAt(self, index: int) → None

–

Parameters:
removeFirst(self) → None

–

Parameters:self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
removeLast(self) → None

–

Parameters:self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
reverse(self) → None

–

Parameters:self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
setSize(self, iNewSize: int) → None

–

Sets the size of theSequenceableCollection.

Parameters:
shape
sortAscending(self, bSlave: ORSModel.ors.SequenceableCollection, cSlave: ORSModel.ors.SequenceableCollection, dSlave: ORSModel.ors.SequenceableCollection, eSlave: ORSModel.ors.SequenceableCollection) → None

–

Parameters:
sortDescending(self, bSlave: ORSModel.ors.SequenceableCollection, cSlave: ORSModel.ors.SequenceableCollection, dSlave: ORSModel.ors.SequenceableCollection, eSlave: ORSModel.ors.SequenceableCollection) → None

–

Parameters:
sortRangeAscending(self, index1: int, index2: int) → None

–

Parameters:
sortRangeDescending(self, index1: int, index2: int) → None

–

Parameters:
swap(self, index: int, index2: int) → None

–

Parameters:

Shape

class ORSModel.ors.Shape

Bases: ORSModel.ors.Unmanaged

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2017

Shape.__init__(self) -> None –

Parameters:self (ORSModel.ors.Shape) – an instance of Shape

Shape.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
atomicLoad(self, aFilename: str) → None

–

Loads an object from a file.

Parameters:
  • self (ORSModel.ors.Shape) – an instance of Shape
  • aFilename (str) – a file path (a string)
atomicSave(self, aFilename: str) → int

–

Saves the object to a file.

Parameters:
  • self (ORSModel.ors.Shape) – an instance of Shape
  • aFilename (str) – a file path (a string)

:return : :rtype : unsigned int

copy(self) → Unmanaged

–

Gets a copy of the receiver.

Parameters:self (ORSModel.ors.Shape) – an instance of Shape
getClassNameStatic() → str

–

:return : :rtype : str

getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Shape) – an instance of Shape

:return : :rtype : str

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Shape

–

Parameters:
getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → Shape

–

Parameters:
none() → Shape

–

rotate(self, axisInWorld: ORSModel.ors.Vector3, aroundPointInWorld: ORSModel.ors.Vector3, angleInRadian: float) → None

–

Applies a rotation to the receiver.

Parameters:
transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None

–

Applies a transformation to the receiver.

Parameters:

Shape2D

class ORSModel.ors.Shape2D(self) → None

Bases: ORSModel.ors.Shape

–

Parameters:self (ORSModel.ors.Shape2D) – an instance of Shape2D

Shape2D.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → Shape2D

–

Shape3D

class ORSModel.ors.Shape3D(self) → None

Bases: ORSModel.ors.Shape

–

Parameters:self (ORSModel.ors.Shape3D) – an instance of Shape3D

Shape3D.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → Shape3D

–

Sphere

class ORSModel.ors.Sphere

Bases: ORSModel.ors.Shape3D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2017

Sphere.__init__(self) -> None –

Parameters:self (ORSModel.ors.Sphere) – an instance of Sphere

Sphere.__init__(self, center: ORSModel.ors.Vector3, radius: float) -> None –

Parameters:

Sphere.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
copy(self) → Sphere

–

Gets a copy of the receiver.

Parameters:self (ORSModel.ors.Sphere) – an instance of Sphere
getCenter(self) → Vector3

–

Parameters:self (ORSModel.ors.Sphere) – an instance of Sphere
getClassNameStatic() → str

–

:return : :rtype : str

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → LineSegment

–

Return the vector representing the intersection of the provided line and the receiver.

Parameters:
getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → LineSegment

–

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:
getIsEqualTo(self, Sphere: ORSModel.ors.Sphere) → bool

–

Verifies equality between the receiver and a givenSphere.

Parameters:

:return : :rtype : bool

getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Sphere) – an instance of Sphere

:return : :rtype : str

getRadius(self) → float

–

Parameters:self (ORSModel.ors.Sphere) – an instance of Sphere

:return : :rtype : float

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Sphere

–

Parameters:
none() → Sphere

–

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None

–

Applies a rotation to the receiver.

Parameters:
setCenter(self, center: ORSModel.ors.Vector3) → None

–

Parameters:
setRadius(self, radius: float) → None

–

Parameters:

StatisticalAnalyzer

class ORSModel.ors.StatisticalAnalyzer(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer

StatisticalAnalyzer.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
analyze(self, momentsCount: int, median: bool, aCollection: ORSModel.ors.Collection) → None

–

Parameters:
analyzeSubset(self, momentsCount: int, median: bool, startIndex: int, endIndex: int, aCollection: ORSModel.ors.SequenceableCollection) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getMaximumValue(self) → float

–

Parameters:self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer

:return : :rtype : float

getMedian(self) → float

–

Parameters:self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer

:return : :rtype : float

getMinimumValue(self) → float

–

Parameters:self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer

:return : :rtype : float

getMoment(self, niemeMoment: int) → float

–

Parameters:

:return : :rtype : float

none() → StatisticalAnalyzer

–

StructuredGrid

class ORSModel.ors.StructuredGrid(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:
  • self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

StructuredGrid.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
copyShapeFromBox(self, pBox: ORSModel.ors.Box, tSize: int) → None

–

Initializes the structured grid’s shape based on a box.

Parameters:
copyShapeFromRectangle(self, aRectangle: ORSModel.ors.Rectangle, zSpacing: float, tSize: int) → None

–

Initializes the structured grid’s shape based on a rectangle.

Parameters:
  • self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
  • aRectangle (ORSModel.ors.Rectangle) – a rectangle (a Rectangle)
  • zSpacing (float) – the thickness of the output structured grid (a double)
  • tSize (int) – a T size (an unsigned short)
copyShapeFromStructuredGrid(self, pStructuredGrid: ORSModel.ors.StructuredGrid) → None

–

Initializes the structured grid’s shape based on another structured grid.

Parameters:
getAsChannel(self, inOutStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid

–

Convert a structured grid to a channel.

Parameters:
getAsMultiROI(self, inOutStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid

–

Convert a structured grid to aMultiROI.

Parameters:
getAsROI(self, inOutStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid

–

Convert a structured grid to a VolumeROI.

Parameters:
getBoundingBox(self, pTIndex: int) → Box

–

Parameters:
getBox(self) → Box

–

Gets the boxe.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
getClassNameStatic() → str

–

:return : :rtype : str

getDirtyBox(self, bResetDirtyBox: bool) → Box

–

Gets the dirty box.

Parameters:
  • self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
  • bResetDirtyBox (bool) – insicate that the dirty box should be resetted (a bool)
getHasSameShape(self, pStructuredGrid: ORSModel.ors.StructuredGrid) → bool

–

Verifies if the structured grid has same shape as another structured grid (see note below).

Parameters:

:return : :rtype : bool

getIndexOfFirstIntersectingNonZeroElement(self, aLine: ORSModel.ors.Line, subBox: ORSModel.ors.Box, timestep: int) → Vector3

–

Parameters:
getIsIdenticalTo(self, pStructuredGrid: ORSModel.ors.StructuredGrid) → bool

–

Verifies if the structured grid is identical to another structured grid (see note below).

Parameters:

:return : :rtype : bool

getLabelAtPosition(self, tIndex: int, worldPosition: ORSModel.ors.Vector3) → int

–

Parameters:

:return : :rtype : unsigned int

getOrigin(self) → Vector3

–

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
getOriginalBox(self) → Box

–

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
getPositionOfFirstIntersectingNonZeroElement(self, aLine: ORSModel.ors.Line, subBox: ORSModel.ors.Box, timestep: int) → Vector3

–

Parameters:
getSliceAtIndex(self, zIndex: int, inStructuredGridSlice: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid

–

Parameters:
getSliceIntersectingBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle, inStructuredGridSlice: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid

–

Parameters:
getSpaceHasBeenTransformed(self) → bool

–

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : bool

getSpacingInDirection(self, pDirection: ORSModel.ors.Vector3) → float

–

Gets the spacing in the specified direction.

Parameters:

:return : :rtype : float

getSubset(self, xmin: int, ymin: int, zmin: int, tmin: int, xmax: int, ymax: int, zmax: int, tmax: int, inChannelSubset: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid

–

Gets a subset of the the structuredGrid.

Parameters:
  • self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
  • xmin (int) – the X lower range (an unsigned short)
  • ymin (int) – the Y lower range (an unsigned short)
  • zmin (int) – the Z lower range (an unsigned short)
  • tmin (int) – the T lower range (an unsigned short)
  • xmax (int) – the X upper range (an unsigned short)
  • ymax (int) – the Y upper range (an unsigned short)
  • zmax (int) – the Z upper range (an unsigned short)
  • tmax (int) – the T upper range (an unsigned short)
  • inChannelSubset (ORSModel.ors.StructuredGrid) – the output structured grid (see notes)
  • IProgress (ORSModel.ors.Progress) –
getTSize(self) → int

–

Gets the T size of the structured grid.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : int

getTSpacing(self) → float

–

Gets the structured grid’s T spacing.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : float

getTransformationFromOriginalReferential(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
getVoxelToWorldCoordinates(self, anIndex: ORSModel.ors.Vector3) → Vector3

–

Gets a given voxel’s location in DICOM Reference Coordinates System.

Parameters:
getWorldToVoxelCoordinates(self, pPointInWorld: ORSModel.ors.Vector3) → Vector3

–

Gets a given voxel’s index from DICOM Reference Coordinates System.

Parameters:
getXSize(self) → int

–

Gets the X size of the structured grid.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : int

getXSpacing(self) → float

–

Gets the structured grid’s X spacing.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : float

getYSize(self) → int

–

Gets the Y size of the structured grid.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : int

getYSpacing(self) → float

–

Gets the structured grid’s Y spacing.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : float

getZSize(self) → int

–

Gets the Z size of the structured grid.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : int

getZSliceThickness(self) → float

–

Gets the structured grid’s Z slice thickness.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : float

getZSpacing(self) → float

–

Gets the structured grid’s Z spacing.

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

:return : :rtype : float

none() → StructuredGrid

–

paintBox(self, pBox: ORSModel.ors.Box, label: float, tStep: int) → None

–

Parameters:
paintBoxIfInRange(self, pBox: ORSModel.ors.Box, label: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None

–

Parameters:
paintCircleOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintCircleOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintEllipseOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, dir0Radius: float, dir1Radius: float, axisOrientation: float, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintEllipseOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, dir0Radius: float, dir1Radius: float, axisOrientation: float, label: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintPolygonOnPlane(self, pPlane: ORSModel.ors.Rectangle, polygonWorldPos: ORSModel.ors.ArrayDouble, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintPolygonOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, polygonWorldPos: ORSModel.ors.ArrayDouble, label: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintRectangleOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, dir0Length: float, dir1Length: float, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintRectangleOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, dir0Length: float, dir1Length: float, label: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintShape3D(self, aShape: ORSModel.ors.Shape3D, label: float, tStep: int) → None

–

Parameters:
paintShape3DIfInRange(self, aShape: ORSModel.ors.Shape3D, label: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None

–

Parameters:
paintSphere(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int) → None

–

Parameters:
paintSphereIfInRange(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None

–

Parameters:
paintSquareOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintSquareOnPlaneIfInRange(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid, worldPositionArray: ORSModel.ors.ArrayDouble) → None

–

Parameters:
paintSubset(self, startX: int, startY: int, startZ: int, endX: int, endY: int, endZ: int, label: float, tStep: int) → None

–

Parameters:
  • self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
  • startX (int) –
  • startY (int) –
  • startZ (int) –
  • endX (int) –
  • endY (int) –
  • endZ (int) –
  • label (float) –
  • tStep (int) –
paintSubsetIfInRange(self, startX: int, startY: int, startZ: int, endX: int, endY: int, endZ: int, label: float, tStep: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None

–

Parameters:
  • self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
  • startX (int) –
  • startY (int) –
  • startZ (int) –
  • endX (int) –
  • endY (int) –
  • endZ (int) –
  • label (float) –
  • tStep (int) –
  • lowerThreshold (float) –
  • upperThreshold (float) –
  • pRangeChannel (ORSModel.ors.StructuredGrid) –
paintVoxelsFromWorldCoordinates(self, worldPositionArray: ORSModel.ors.ArrayDouble, label: float, timeIndex: int) → None

–

Parameters:
paintVoxelsFromWorldCoordinatesIfInRange(self, worldPositionArray: ORSModel.ors.ArrayDouble, label: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None

–

Parameters:
projectInto(self, aDestinationStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → None

–

Copies the receiver into the destination, keeping the destination shape.

Parameters:
setBox(self, IInBox: ORSModel.ors.Box) → None

–

Set the boxe.

Parameters:
setCurrentShapeAsOriginal(self) → None

–

Parameters:self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
setOrigin(self, origin: ORSModel.ors.Vector3) → None

–

Parameters:
setTSize(self, pTSize: int) → None

–

Sets the T size of the structured grid.

Parameters:
setTSpacing(self, pTSpacing: float) → None

–

Sets the structured grid’s T spacing.

Parameters:
setXSize(self, pXSize: int) → None

–

Sets the X size of the structured grid.

Parameters:
setXSpacing(self, pXSpacing: float) → None

–

Sets the structured grid’s X spacing.

Parameters:
setXYZTSize(self, pXSize: int, pYSize: int, pZSize: int, pTSize: int) → None

–

Sets the X,Y,Z,T sizes of the structured grid.

Parameters:
  • self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
  • pXSize (int) – X size (an uint32_t)
  • pYSize (int) – Y size (an uint32_t)
  • pZSize (int) – Z size (an uint32_t)
  • pTSize (int) – T size (an uint32_t)
setYSize(self, pYSize: int) → None

–

Sets the Y size of the structured grid.

Parameters:
setYSpacing(self, pYSpacing: float) → None

–

Sets the structured grid’s Y spacing.

Parameters:
setZSize(self, pZSize: int) → None

–

Sets the Z size of the structured grid.

Parameters:
setZSliceThickness(self, pZThickness: float) → None

–

Sets the structured grid’s Z slice thickness.

Parameters:
setZSpacing(self, pZSpacing: float) → None

–

Sets the structured grid’s Z spacing.

Parameters:
shape
sliceIteratorFromBox(viewBox, mask=None, usePositiveMask=True, computeMask=False)
sliceIteratorFromDirection(dir0, dir1, mask=None, positiveMask=True, computeMask=False)
sliceIteratorFromView(view, mask=None, positiveMask=True, computeMask=False)

TraceBackChannelAnalyzer

class ORSModel.ors.TraceBackChannelAnalyzer(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer

TraceBackChannelAnalyzer.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
findAllLeaves(self, aChannel: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI) → ROI

–

Parameters:
forwardSelectionFromRoi(self, linputChannelTraceForward: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI) → None

–

Parameters:
forwardSelectionFromRoiToDistance(self, linputChannelTraceForward: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI, distance: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → TraceBackChannelAnalyzer

–

selectPointFurtherOrNearerThanMinDistance(self, linputChannelTraceBack: ORSModel.ors.Channel, indices: int, indicesSize: int, minDistance: int, outputROI: ORSModel.ors.ROI, further: bool) → None

–

Parameters:
traceBackTotraceForward(self, linputChannelTraceBack: ORSModel.ors.Channel, loutputChannelTraceForward: ORSModel.ors.Channel) → None

–

Parameters:
tracebackCPU(self, linputChannelTraceBack: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI, outputVoteChannel: ORSModel.ors.Channel, gatherAlgo: bool) → ROI

–

Parameters:
tracebackPath(self, linputChannelTraceBack: ORSModel.ors.Channel, worldPosition: ORSModel.ors.Vector3, aPath: ORSModel.ors.VisualPath, pathWorldMatrix: ORSModel.ors.Matrix4x4, gatherAlgo: bool) → None

–

Parameters:

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSModel.ors.ORSBaseClass

brief_description: Abstract class for objects that are not managed by the core library. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Unmanaged.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:

Unmanaged.__init__(self) -> None –

Parameters:self (ORSModel.ors.Unmanaged) – an instance of Unmanaged
createObjectFromPythonRepresentation(aUnmanagedObjectInPythonRepresentation: str) → Unmanaged

–

Parameters:aUnmanagedObjectInPythonRepresentation (str) –
classmethod getAllSubclasses(outputCollection=None)
classmethod getClassDenomination()
static getClassFromProgId(progId)
getClassName(self) → str

–

Parameters:self (ORSModel.ors.Unmanaged) – an instance of Unmanaged

:return : :rtype : str

getClassNameStatic() → str

–

:return : :rtype : str

classmethod getIsSubclassOf(parentClass)
isNone(self) → bool

–

Parameters:self (ORSModel.ors.Unmanaged) – an instance of Unmanaged

:return : :rtype : bool

isNotNone(self) → bool

–

Parameters:self (ORSModel.ors.Unmanaged) – an instance of Unmanaged

:return : :rtype : bool

none() → Unmanaged

–

UnstructuredGrid

class ORSModel.ors.UnstructuredGrid(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Node

–

Parameters:

UnstructuredGrid.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getBoundingBox(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → Box

–

Parameters:
getCenterOfMass(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → Vector3

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getClipBox(timestep=0, display=None)

Gets the clip box of the channel

Parameters:
Returns:

aClipBox (ORSModel.ors.Box) – the clip box
getClosestVertexIndexToPoint(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4, pPoint: ORSModel.ors.Vector3) → int

–

Gets the index of the closest vertex to a given point.

Parameters:

:return : :rtype : int

getCurrentVertexScalarValuesSlot(self) → int

–

gets the current vertex scalar.

Parameters:self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid

:return : :rtype : int

getMinMaxVertexScalarValue(self, scalarValueSlotIndex: int, iTIndex: int, fMinValue: float, fMaxValue: float) → None

–

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • scalarValueSlotIndex (int) –
  • iTIndex (int) –
  • fMinValue (float) –
  • fMaxValue (float) –
getMinimumBoundingBox(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → Box

–

Parameters:
getTSize(self) → int

–

Gets the number of time steps for the mesh.

Parameters:self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid

:return : :rtype : int

getUseVertexScalarValues(self) → bool

–

Sets the mesh to have vertex scalar values or not.

Parameters:self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid

:return : :rtype : bool

getVertexAtIndex(self, iTIndex: int, vertexIndex: int, x: float, y: float, z: float) → None

–

Gets a specific vertex.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • iTIndex (int) – the time step (an unsigned short)
  • vertexIndex (int) – the vertex index (an uint64_t )
  • x (float) – the X value (a double*)
  • y (float) – the Y value (a double*)
  • z (float) – the Z value (a double*)
getVertexCount(self, iTIndex: int) → int

–

Returns the number of vertices.

Parameters:

:return : :rtype : int

getVertexDatatype(self) → int

–

Parameters:self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid

:return : :rtype : int

getVertexScalarValue(self, scalarValueSlotIndex: int, scalarValueVertexIndex: int, iTIndex: int) → float

–

Gets the value of a vertex scalar.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • scalarValueSlotIndex (int) – the scalar slot index (an uint32_t)
  • scalarValueVertexIndex (int) – the vertex index (an uint32_t)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

getVertexScalarValueDescription(self, scalarValueSlotIndex: int, iTIndex: int) → str

–

Parameters:

:return : :rtype : str

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

–

method getVertexScalarValueMax

Parameters:

:return : :rtype : float

getVertexScalarValueMaxs(self, iTIndex: int) → ArrayDouble

–

method getVertexScalarValueMaxs

Parameters:
getVertexScalarValueMin(self, scalarValueSlotIndex: int, iTIndex: int) → float

–

method getVertexScalarValueMin

Parameters:

:return : :rtype : float

getVertexScalarValueMins(self, iTIndex: int) → ArrayDouble

–

method getVertexScalarValueMins

Parameters:
getVertexScalarValueOffset(self, scalarValueSlotIndex: int, iTIndex: int) → float

–

Gets a vertex scalar offset value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • scalarValueSlotIndex (int) – the scalar slot index (an uint32_t)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

getVertexScalarValueOffsets(self, iTIndex: int) → ArrayDouble

–

Get the vertex scalar offset values.

Parameters:
getVertexScalarValueSlope(self, scalarValueSlotIndex: int, iTIndex: int) → float

–

Get a vertex scalar slope value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • scalarValueSlotIndex (int) – the scalar slot index (an uint32_t)
  • iTIndex (int) – the time step (an unsigned short)

:return : :rtype : float

getVertexScalarValueSlopes(self, iTIndex: int) → ArrayDouble

–

Get the vertex scalar slope values.

Parameters:
getVertexScalarValueUnit(self, scalarValueSlotIndex: int, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getVertexScalarValues(self, iSlotIndex: int, iTIndex: int) → Array

–

Gets the values of a vertex scalar.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • iSlotIndex (int) – the the time step (an unsigned short)
  • iTIndex (int) –
getVertexScalarValuesDatatype(self, iSlotIndex: int, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

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

–

Get a vertex scalar range max boundary value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a vertex scalar range min boundary value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a vertex scalar range max value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

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

–

Get a vertex scalar range min value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • iTIndex (int) – the time step(an unsigned short)

:return : :rtype : float

getVertexScalarValuesSlotCount(self) → int

–

Gets the number of slots for vertex scalar values.

Parameters:self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid

:return : :rtype : int

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

–

Parameters:

:return : :rtype : float

getVertexScalarValuesWindowMaxs(self, iTIndex: int) → ArrayDouble

–

Parameters:
getVertexScalarValuesWindowMin(self, scalarValueSlotIndex: int, iTIndex: int) → float

–

Parameters:

:return : :rtype : float

getVertexScalarValuesWindowMins(self, iTIndex: int) → ArrayDouble

–

Parameters:
getVertices(self, iTIndex: int) → Array

–

Gets the vertices.

Parameters:
mapScalarValuesFromAMultiROI(self, referenceMultiROI: ORSModel.ors.MultiROI, multiROIScalarValueSlotIndex: int, sourceScalarValuesSlotIndex: int, multiROITIndex: int, sourceTIndex: int, aDefaultScalarValue: float) → None

–

Map a scalar values slot from aMultiROI to a unstructured grid.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • referenceMultiROI (ORSModel.ors.MultiROI) – the multiROI modele (an MultiROI)
  • multiROIScalarValueSlotIndex (int) – the index of the MultiROI scalar values slot to map (an unsigned short)
  • sourceScalarValuesSlotIndex (int) – the index of the destination scalar values lot (an unsigned short)
  • multiROITIndex (int) – the multiROI time step (an unsigned short)
  • sourceTIndex (int) – the unstructured grid time step (an unsigned short)
  • aDefaultScalarValue (float) – a default scalar value in case that no match is possible for a vertex between the structured grid and the MultiROI (a double)
none() → UnstructuredGrid

–

offsetVertices(self, x: float, y: float, z: float) → None

–

Offsets the mesh vertices.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • x (float) – an X offset value (a double)
  • y (float) – a Y offset value (a double)
  • z (float) – a Z offset value (a double)
removeAVertexScalarValuesSlot(self, nScalarValueSlotIndex: int, iTIndex: int) → None

–

Remove a scalar slot from the vertex scalars values slot.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the index of the slot to be removed (an unsigned short)
  • iTIndex (int) – the time step (an unsigned short)
setCurrentVertexScalarValuesSlot(self, nCurrentScalarValueSlotIndex: int) → None

–

Sets the current vertex scalar.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nCurrentScalarValueSlotIndex (int) – the scalar slot index (an unsigned short)
setTSize(self, tSize: int) → None

–

Sets the number of time steps for the mesh.

Parameters:
setUseVertexScalarValues(self, value: bool) → None

–

Gets the status of vertex scalar values usage.

Parameters:
setVertexAtIndex(self, iTIndex: int, vertexIndex: int, x: float, y: float, z: float) → None

–

Sets a specific vertex.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • iTIndex (int) – the time step (an unsigned short)
  • vertexIndex (int) – the vertex index (an uint64_t)
  • x (float) – the X value (a double)
  • y (float) – the Y value (a double)
  • z (float) – the Z value (a double)
setVertexDatatype(self, nVertexDatatype: int) → None

–

Parameters:
setVertexScalarValue(self, scalarValueSlotIndex: int, scalarValueVertexIndex: int, aValue: float, iTIndex: int) → None

–

Sets the value of a vertex scalar.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • scalarValueSlotIndex (int) – the scalar slot index (an uint32_t)
  • scalarValueVertexIndex (int) – the vertex index (an uint32_t)
  • aValue (float) – the value of a vertex scalar to set (a float)
  • iTIndex (int) – the time step (an unsigned short)
setVertexScalarValueDescription(self, scalarValueSlotIndex: int, value: str, iTIndex: int) → None

–

Parameters:
setVertexScalarValueMax(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

method setVertexScalarValueMax

Parameters:
setVertexScalarValueMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

method setVertexScalarValueMaxs

Parameters:
setVertexScalarValueMin(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

method setVertexScalarValueMin

Parameters:
setVertexScalarValueMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

method setVertexScalarValueMins

Parameters:
setVertexScalarValueOffset(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Sets a vertex scalar offset value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • scalarValueSlotIndex (int) – the scalar slot index (an uint32_t)
  • value (float) – the scalar offset value (a float)
  • iTIndex (int) – the time step (an unsigned short)
setVertexScalarValueOffsets(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Set the vertex scalar offset values.

Parameters:
setVertexScalarValueSlope(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a vertex scalar slope value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • scalarValueSlotIndex (int) – scalar slot index (an uint32_t)
  • value (float) – scalar slope value (a float)
  • iTIndex (int) – time step (an unsigned short)
setVertexScalarValueSlopes(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Set the vertex scalar slope values.

Parameters:
setVertexScalarValueUnit(self, scalarValueSlotIndex: int, value: int, iTIndex: int) → None

–

Parameters:
setVertexScalarValues(self, pScalarValues: ORSModel.ors.Array, iSlotIndex: int, iTIndex: int) → None

–

Sets the values of a vertex scalar.

Parameters:
setVertexScalarValuesDatatype(self, iSlotIndex: int, iTIndex: int, nVertexScalarValuesDatatype: int) → None

–

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • iSlotIndex (int) –
  • iTIndex (int) –
  • nVertexScalarValuesDatatype (int) –
setVertexScalarValuesRangeBoundaryMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a vertex scalar range max boundary value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setVertexScalarValuesRangeBoundaryMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a vertex scalar range min boundary value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(an unsigned short)
setVertexScalarValuesRangeMax(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a vertex scalar range max value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the slot index (a unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(a unsigned short)
setVertexScalarValuesRangeMin(self, nScalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Set a vertex scalar range min value.

Parameters:
  • self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
  • nScalarValueSlotIndex (int) – the scalar slot index(an unsigned short)
  • value (float) – the value (a double)
  • iTIndex (int) – the time step(an unsigned short)
setVertexScalarValuesSlotCount(self, value: int) → None

–

Sets the number of slots for vertex scalar values.

Parameters:
setVertexScalarValuesWindowMax(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Parameters:
setVertexScalarValuesWindowMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Parameters:
setVertexScalarValuesWindowMin(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None

–

Parameters:
setVertexScalarValuesWindowMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Parameters:
setVertices(self, pVertices: ORSModel.ors.Array, iTIndex: int) → None

–

Sets the vertices.

Parameters:

Vector3

class ORSModel.ors.Vector3

Bases: ORSModel.ors.Unmanaged

brief_description: A wrapper to a 3D vector. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Vector3.__init__(self) -> None –

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

Vector3.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:

Vector3.__init__(self, x: float, y: float, z: float) -> None –

Parameters:

Vector3.__init__(self, x: float, y: float) -> None –

Parameters:
add(self, aVector: ORSModel.ors.Vector3) → None

–

Adds a vector to the receiver.

Parameters:
copy(self) → Vector3

–

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

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3
createVector3FromPythonRepresentation(self, aPythonRepresentation: str) → None

–

Parameters:
getAPerpendicular(self) → Vector3

–

Computes a perpendicular from the vector.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3
getAdditionWith(self, aVector: ORSModel.ors.Vector3) → Vector3

–

Gets the result of adding a vector to the receiver.

Parameters:
getAngleWith(self, pVect: ORSModel.ors.Vector3) → float

–

Computes the angle with another vector.

Parameters:

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getCrossProductWith(self, pVect: ORSModel.ors.Vector3) → Vector3

–

Computes the cross product with another vector.

Parameters:
getDistanceFrom(self, pVect: ORSModel.ors.Vector3) → float

–

Computes the distance to another vector.

Parameters:

:return : :rtype : float

getDotProductWith(self, pVect: ORSModel.ors.Vector3) → float

–

Computes the dot product with another vector.

Parameters:

:return : :rtype : float

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

–

Parameters:

:return : :rtype : bool

getLargestComponent(self) → float

–

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

getLength(self) → float

–

Gets the vector’s length.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

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

–

Computes the lerp with another vector.

Parameters:
getNegated(self) → Vector3

–

Gets the receiver negated in a new vector.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3
getNormalized(self) → Vector3

–

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3
getPhi(self) → float

–

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

getPythonRepresentation(self) → str

–

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : str

getRotatedAroundAxis(self, anAxis: ORSModel.ors.Vector3, centerOfRotation: ORSModel.ors.Vector3, angleInRadian: float) → Vector3

–

Return the receiver rotated around the provided axis for the provided amount of radian.

Parameters:
getScaledBy(self, scaleFactor: float) → Vector3

–

Gets the result of sacling a vector to the receiver.

Parameters:
getSmallestComponent(self) → float

–

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

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

–

Gets the result of subtracting a vector from the receiver.

Parameters:
getTheta(self) → float

–

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

getX(self) → float

–

Gets the X value from the vector.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

getY(self) → float

–

Gets the Y value from the vector.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

getZ(self) → float

–

Gets the Z value from the vector.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3

:return : :rtype : float

is_(another)
is_not(another)
negate(self) → None

–

Negates the vector.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3
none() → Vector3

–

normalize(self) → None

–

Normalizes the vector.

Parameters:self (ORSModel.ors.Vector3) – an instance of Vector3
scale(self, scaleFactor: float) → None

–

Scales the vector.

Parameters:
  • self (ORSModel.ors.Vector3) – an instance of Vector3
  • scaleFactor (float) – a scale factor (a double)
setX(self, value: float) → None

–

Sets the X value of the vector.

Parameters:
setXYZ(self, x: float, y: float, z: float) → None

–

Sets the 3 vector component.

Parameters:
  • self (ORSModel.ors.Vector3) – an instance of Vector3
  • x (float) – the X component (a double)
  • y (float) – the Y component (a double)
  • z (float) – the Z component (a double)
setY(self, value: float) → None

–

Sets the Y value of the vector.

Parameters:
setZ(self, value: float) → None

–

Sets the Z value of the vector.

Parameters:
subtract(self, aVector: ORSModel.ors.Vector3) → None

–

Subtracts a vector from the receiver.

Parameters:

VectorField

class ORSModel.ors.VectorField(self) → None

Bases: ORSModel.ors.UnstructuredGrid

–

Parameters:self (ORSModel.ors.VectorField) – an instance of VectorField

VectorField.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VectorField) – an instance of VectorField
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VectorField.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
copyInto(self, aDestinationUnstructuredGrid: ORSModel.ors.Node) → None

–

Copies the receiver unstructured grid into another unstructured grid.

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getVectorAtIndex(self, iTIndex: int, vertexIndex: int, x: float, y: float, z: float) → None

–

Gets a specific vector.

Parameters:
  • self (ORSModel.ors.VectorField) – an instance of VectorField
  • iTIndex (int) – the time step (an unsigned short)
  • vertexIndex (int) – the vertex index (an uint64_t )
  • x (float) – the X value (a double*)
  • y (float) – the Y value (a double*)
  • z (float) – the Z value (a double*)
getVectors(self, iTIndex: int) → ArrayDouble

–

Gets the vectors.

Parameters:
none() → VectorField

–

setVectorAtIndex(self, iTIndex: int, vertexIndex: int, x: float, y: float, z: float) → None

–

Sets a specific vector.

Parameters:
  • self (ORSModel.ors.VectorField) – an instance of VectorField
  • iTIndex (int) – the time step (an unsigned short)
  • vertexIndex (int) – the vertex index (an uint64_t)
  • x (float) – the X value of the vector (a double)
  • y (float) – the Y value of the vector (a double)
  • z (float) – the Z value of the vector(a double)
setVectors(self, pVectors: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Sets the vectors.

Parameters:

View

class ORSModel.ors.View

Bases: ORSModel.ors.Node

brief_description: Represents a host window where the renderer is displayed. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 Represents a host window where the renderer is displayed.

View.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

View.__init__(self) -> None –

Parameters:self (ORSModel.ors.View) – an instance of View

View.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
compile(self) → None

–

Parameters:self (ORSModel.ors.View) – an instance of View
decrementTimeStep(self) → None

–

Decrements the view’s time step counter.

Parameters:self (ORSModel.ors.View) – an instance of View
draw(self) → None

–

Forces an immediate draw of the view.

Parameters:self (ORSModel.ors.View) – an instance of View
drawOnCurrentGLContext(self) → None

–

Parameters:self (ORSModel.ors.View) – an instance of View
exportSnapshotCustomSized(self, iWidth: int, iHeight: int, pOutputImage: ORSModel.ors.Image) → Image

–

Exports a snapshot of the view to an image, sized to specification.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • iWidth (int) – the width of the image to be saved (an unsigned short)
  • iHeight (int) – the height of the image to be saved (an unsigned short)
  • pOutputImage (ORSModel.ors.Image) – (optional) an output image (an Image)
fitBoundedPlaneInView(self, IBoundedPlane: ORSModel.ors.Rectangle) → None

–

Parameters:
fitBoundedPlaneInViewLogged(rectangle, logging=True)
fitBoxInView(self, aBox: ORSModel.ors.Box) → None

–

Parameters:
fitBoxInViewLogged(box, logging=True)
gatherTimeStepMaxFromAll(self) → None

–

Parameters:self (ORSModel.ors.View) – an instance of View
get2DBackgroundColor(self) → Color

–

Gets the view’s 3D first background color.

Parameters:self (ORSModel.ors.View) – an instance of View
get3DBackgroundColor1(self) → Color

–

Gets the view’s 3D first background color.

Parameters:self (ORSModel.ors.View) – an instance of View
get3DBackgroundColor2(self) → Color

–

Gets the view’s 3D first background color.

Parameters:self (ORSModel.ors.View) – an instance of View
get3DBackgroundColorMode(self) → int

–

Gets the view’s 3D background color mode.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getAllVisibleChildrenOfClass(self, pProgId: str) → List

–

Returns a flattened list of all the child nodes, of the given class, that are visible.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • pProgId (str) – the ProgId of the class to test against (a string)
getAmbientLightColor(self) → Color

–

Parameters:self (ORSModel.ors.View) – an instance of View
getAngleDimensionUnit(self) → DimensionUnit

–

Parameters:self (ORSModel.ors.View) – an instance of View
getAutoFocus(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getBorderColor(self) → Color

–

Parameters:self (ORSModel.ors.View) – an instance of View
getBorderWidth(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getBoundedPlaneOfFirstSliceOfBox(self, aBox: ORSModel.ors.Box) → Rectangle

–

Parameters:
getBoundedPlaneOfLastSliceOfBox(self, aBox: ORSModel.ors.Box) → Rectangle

–

Parameters:
getBoundedPlaneOfSliceOfBox(self, aBox: ORSModel.ors.Box, sliceIndex: int) → Rectangle

–

Parameters:
getBoxAbleToContainAllEnabledVisualReachableByRender(self, inbox: ORSModel.ors.Box) → Box

–

Parameters:
getCamera(self) → Camera

–

Gets the picked Overlay in a view.

Parameters:self (ORSModel.ors.View) – an instance of View
getCameraSpaceLightPos(self) → Vector3

–

Parameters:self (ORSModel.ors.View) – an instance of View
getCineMode(self) → int

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getClassNameStatic() → str

–

:return : :rtype : str

getContext()
getCurrentTimeStep(self) → int

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : unsigned int

getDiffuseFactor(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getDiffuseLightColor(self) → Color

–

Parameters:self (ORSModel.ors.View) – an instance of View
getDimensionUnit(self, dimensionType: int) → DimensionUnit

–

Gets the view’s dimension unit.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • dimensionType (int) – the unit type (a CxvUniverse_Dimension_type)
getDimensionUnitID(self, dimensionType: int) → int

–

Gets the view’s dimension unit.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • dimensionType (int) – the unit type (a CxvUniverse_Dimension_type)

:return : :rtype : int

getDisplayedAxis(self, aBox: ORSModel.ors.Box) → int

–

Gets the axis direction of the view.

Parameters:

:return : :rtype : int

getDrawFocusRect(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getEnableFocus(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getFitToViewBorder(self) → int

–

Gets the number of pixels allocated to the border around the view.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getFocalDistance(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getFocusSigma(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getHWND(self) → int

–

Gets the view handle.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getImageNumberingAscending(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIntersliceDistance(self, box: ORSModel.ors.Box) → float

–

Parameters:

:return : :rtype : float

getIsBorderEnabled(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsChildReachableByRenderer(self, INode: ORSModel.ors.Node) → bool

–

Verifies if a child node is renderable.

Parameters:

:return : :rtype : bool

getIsEnabled(self) → bool

–

Queries the view to know if it is enabled.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsFrozen(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsIn2DViewMode(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsIn3DViewMode(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsInAcquisitionPlaneOf(self, aChannel: ORSModel.ors.Channel) → bool

–

Parameters:

:return : :rtype : bool

getIsInNoViewMode(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsInThinMIPViewMode(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsOrientationAndPositionLocked(self) → bool

–

Gets the view’s position and orientation lock status.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsOrientationLocked(self) → bool

–

Gets the view’s orientation lock status.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsOrthoProjection(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsPositionLocked(self) → bool

–

Gets the view’s position lock status.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsRenderingTiled(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsShadowEnabled(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getIsTrackingLight(self) → bool

–

Queries if the view is in tracking light mode or not.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getLODEnabled(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getLODMode(self) → int

–

Gets the view LOD mode.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getLayoutGenealogicalName()

Gets the genealogical name of the view

Returns:aName (str) – the genealogical name of the view
getLengthAsPixelCount(self, aLength: float) → float

–

Gets the number of pixels on the screen that represent a world length.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • aLength (float) – the world length (a double)

:return : :rtype : float

getLengthDimensionUnit(self) → DimensionUnit

–

Parameters:self (ORSModel.ors.View) – an instance of View
getLightFollowCamera(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getLightMaxDistance(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getLightPosition(self) → Vector3

–

Parameters:self (ORSModel.ors.View) – an instance of View
getLocalPositionArrayTransformedToXY(self, pVisual: ORSModel.ors.Visual, pLocalPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pTimeStep: int, pOutputXYPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection

–

Parameters:
getLocalPositionFromVisualLocalPosition(self, pVisual: ORSModel.ors.Visual, anotherVisual: ORSModel.ors.Visual, pAlocalPositionInAnotherVisual: ORSModel.ors.Vector3, pTimeStep: int) → Vector3

–

Parameters:
getLocalPositionFromWorldPosition(self, pVisual: ORSModel.ors.Visual, pWorldPosition: ORSModel.ors.Vector3, pTimeStep: int) → Vector3

–

Parameters:
getLocalPositionTransformedToXY(self, IVisual: ORSModel.ors.Visual, pCoord: ORSModel.ors.Vector3, pTimeStep: int, oX: float, oY: float) → bool

–

Transforms a local coordinate in 2D coordinates.

Parameters:

:return : :rtype : bool :return pTimeStep: the X 2D coordinate (a double*) :rtype pTimeStep: int :return oX: the Y 2D coordinate (a double*) :rtype oX: float

getMaxTimeStep(self) → int

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getMillisecondsElapsedSinceLastDraw(self) → int

–

Returns the time elapsed since the last draw, in milliseconds.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : unsigned int

getNeedRefresh(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getNextSliceDirectionOfBox(self, aBox: ORSModel.ors.Box) → Vector3

–

Parameters:
getOrthoZoomFactor(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getPickData(self, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → Intersection

–

Gets the object being picked in the view.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • pixelXPositionInDisplay (int) –
  • pixelYPositionInDisplay (int) –
getPickVisualData(self, aIVisual: ORSModel.ors.Visual, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → Intersection

–

Gets the pick region from a visual in the view.

Parameters:
getProjectionMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.View) – an instance of View
getProjectionMode2D(self) → int

–

Gets the 2D projection mode of the view.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getRectangle()

Get the rectangle in the space defined by the View

Returns:rectangle (ORSModel.ors.Rectangle) – a Rectangle
getRenderMode(self) → int

–

Gets the view render mode.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getRestTime(self) → int

–

Gets the rendering idle time.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getScreenLengthTransformedToWorldLength(self, inLength: float) → float

–

Parameters:

:return : :rtype : float

getShadowMapSize(self) → int

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getShadowOpacity(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getShadowPrecision(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getShadowStrength(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getShininess(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getShowOrientationIndicators(self) → bool

–

Gets the visibility of the orientation indicators.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getShowViewFPS(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getSlabThickness(self) → float

–

Gets the view’s slab thickness.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getSliceCountOfBox(self, aBox: ORSModel.ors.Box) → int

–

Gets the number of slices of a given box.

Parameters:

:return : :rtype : unsigned int

getSliceIndexOfBox(self, aBox: ORSModel.ors.Box) → float

–

Gets the current slice position of a given box.

Parameters:

:return : :rtype : float

getSpecularFactor(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getSpecularLightColor(self) → Color

–

Parameters:self (ORSModel.ors.View) – an instance of View
getSpotlightFactor(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getSurfaceDimensionUnit(self) → DimensionUnit

–

Parameters:self (ORSModel.ors.View) – an instance of View
getUseSuperSampling(self) → bool

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getValueInCurrentUnitConvertedToMeter(self, pValue: float) → float

–

Converts a value expressed in the view’s current dimension unit to meters.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • pValue (float) – the value to be converted (a double)

:return : :rtype : float

getValueInMeterConvertedToCurrentUnit(self, pValue: float) → float

–

Converts a value against the view’s current dimension unit.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • pValue (float) – the value (in meters) to be converted (a double)

:return : :rtype : float

getViewActualWidth(self) → float

–

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

getViewAlignedBoxThatContainsAllEnabledVisualsReachableByRenderer(self) → Box

–

Parameters:self (ORSModel.ors.View) – an instance of View
getViewBoundedPlaneInWorldCoordinates(self) → Rectangle

–

Returns a plane bounded to the view, in world coordinates.

Parameters:self (ORSModel.ors.View) – an instance of View
getViewCenter(self) → Vector3

–

Parameters:self (ORSModel.ors.View) – an instance of View
getViewMatrix(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.View) – an instance of View
getViewMode(self) → int

–

Gets the view’s volume mode.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getViewNormal(self) → Vector3

–

Parameters:self (ORSModel.ors.View) – an instance of View
getViewOrientedBoxThatContainsBox(self, aBox: ORSModel.ors.Box) → Box

–

Parameters:
getViewOrientedPlane(self) → OrientedPlane

–

Parameters:self (ORSModel.ors.View) – an instance of View
getViewPlane(self) → Plane

–

Parameters:self (ORSModel.ors.View) – an instance of View
getViewRepresentationColor(self) → Color

–

Gets the view’s representation color.

Parameters:self (ORSModel.ors.View) – an instance of View
getVolumeDimensionUnit(self) → DimensionUnit

–

Parameters:self (ORSModel.ors.View) – an instance of View
getWorldLengthTransformedToScreenLength(self, inLength: float) → float

–

Parameters:

:return : :rtype : float

getWorldPositionArrayTransformedToXY(self, pWorldPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pOutputXYPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection

–

Parameters:
getWorldPositionFromLocalPosition(self, pVisual: ORSModel.ors.Visual, pLocalPosition: ORSModel.ors.Vector3, pTimeStep: int) → Vector3

–

Parameters:
getWorldPositionTransformedToXY(self, pPosition: ORSModel.ors.Vector3, oX: float, oY: float) → bool

–

Transforms a world coordinate in 2D coordinates.

Parameters:

:return : :rtype : bool :return oX: the X 2D coordinate (a double*) :rtype oX: float :return oY: the Y 2D coordinate (a double*) :rtype oY: float

getXSize(self) → int

–

Gets the view X size.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getXYArrayTransformedToLocalPosition(self, pVisual: ORSModel.ors.Visual, pXYPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pTimeStep: int, pOutputLocalPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection

–

Parameters:
getXYArrayTransformedToWorldPosition(self, pXYPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pOutputWorldPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection

–

Parameters:
getXYTransformedToWorldPosition(self, x: float, y: float) → Vector3

–

Transforms a 2D coordinates to world coordinate.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • x (float) – the X 2D coordinate (a double)
  • y (float) – the Y 2D coordinate (a double)
getYSize(self) → int

–

Gets the view Y size.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : int

getZoomAtCursorPosition(self) → bool

–

Gets the zoom reaction value.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : bool

getZoomFactor(self) → float

–

Gets the current zoom factor.

Parameters:self (ORSModel.ors.View) – an instance of View

:return : :rtype : float

imshow(structuredGrid, lut=None)
incrementTimeStep(self) → None

–

Increments the view’s time step counter.

Parameters:self (ORSModel.ors.View) – an instance of View
none() → View

–

refresh(self) → None

–

Parameters:self (ORSModel.ors.View) – an instance of View
resetNeedRefresh(self) → None

–

Parameters:self (ORSModel.ors.View) – an instance of View
set2DBackgroundColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the view’s 2D background color.

Parameters:
set3DBackgroundColor(self, iMode: int, IColor1: ORSModel.ors.Color, IColor2: ORSModel.ors.Color) → None

–

Sets the view’s 2D background color.

Parameters:
setAmbientLightColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
setAutoFocus(self, aValue: bool) → None

–

Parameters:
setBorderColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
setBorderWidth(self, aValue: float) → None

–

Parameters:
setCamera(self, aCamera: ORSModel.ors.Camera) → None

–

Parameters:
setCameraLogged(camera, logging=True)
setCameraSpaceLightPos(self, pPosition: ORSModel.ors.Vector3) → None

–

Parameters:
setCineMode(self, mode: int) → None

–

Parameters:
setCurrentTimeStep(self, value: int) → None

–

Parameters:
setDiffuseFactor(self, aValue: float) → None

–

Parameters:
setDiffuseLightColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
setDimensionUnitID(self, dimensionType: int, pUnit: int) → None

–

Sets the view’s dimension unit.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • dimensionType (int) – the unit type (a CxvUniverse_Dimension_type)
  • pUnit (int) – a CxvUniverse_Dimension unit (a int32_t*)
setDrawFocusRect(self, value: bool) → None

–

Parameters:
setEnableFocus(self, aValue: bool) → None

–

Parameters:
setFitToViewBorder(self, value: int) → None

–

Sets the number of pixels allocated to the border around the view.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • value (int) – the number of pixels (a int32_t*)
setFocalDistance(self, aValue: float) → None

–

Parameters:
setFocusSigma(self, aValue: float) → None

–

Parameters:
setImageNumberingAscending(self, value: bool) → None

–

Parameters:
setIsBorderEnabled(self, aValue: bool) → None

–

Parameters:
setIsEnabled(self, pEnabled: bool) → None

–

Enables or disables the view.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • pEnabled (bool) – true to enable the view, false to disable it
setIsFrozen(self, value: bool) → None

–

Parameters:
setIsOrientationAndPositionLocked(self, value: bool) → None

–

Sets the view’s position lock status.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • value (bool) – true to lock the view position, false otherwise
setIsOrientationLocked(self, value: bool) → None

–

Sets the view’s orientation lock status.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • value (bool) – true to lock the view orientation, false otherwise
setIsOrthoProjection(self, value: bool) → None

–

Parameters:
setIsPositionLocked(self, value: bool) → None

–

Sets the view’s position lock status.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • value (bool) – true to lock the view position, false otherwise
setIsShadowEnabled(self, aValue: bool) → None

–

Parameters:
setIsTrackingLight(self, value: bool) → None

–

Sets the view to be in tracking light mode or not.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • value (bool) – true to be in tracking light mode, false otherwise
setLODEnabled(self, aValue: bool) → None

–

Parameters:
setLODMode(self, dwMode: int) → None

–

Sets the view LOD mode.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • dwMode (int) – an LOD mode (a int32_t*)
setLightFollowCamera(self, aValue: bool) → None

–

Parameters:
setLightMaxDistance(self, aValue: float) → None

–

Parameters:
setLightPosition(self, aLightPosition: ORSModel.ors.Vector3) → None

–

Parameters:
setOrientationIndicators(self, left: str, right: str, up: str, down: str, top: str, bottom: str) → None

–

Sets the orientation indicators.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • left (str) – 6 string, one for each orientation indicator
  • right (str) –
  • up (str) –
  • down (str) –
  • top (str) –
  • bottom (str) –
setOrientedPlaneWithBox(self, anOrientedPlane: ORSModel.ors.OrientedPlane, aBox: ORSModel.ors.Box) → None

–

Parameters:
setOrientedPlaneWithBoxLogged(orientedPlane, box, logging=True)
setOrthoZoomFactor(self, value: float) → None

–

Parameters:
setOrthoZoomFactorLogged(zoomFactor, logging=True)
setProjectionMode2D(self, iMode: int) → None

–

Sets the 2D projection mode of the view.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • iMode (int) – a 2D projection mode (an int)
setProjectionMode2DLogged(projectionMode, logging=True)
setRenderMode(self, mode: int) → None

–

Sets the view render mode.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • mode (int) – an unsigned char (an OrsRenderMode, see ors_def.h)
setRestTime(self, value: int) → None

–

Parameters:
setShadowMapSize(self, value: int) → None

–

Parameters:
setShadowOpacity(self, aValue: float) → None

–

Parameters:
setShadowPrecision(self, aValue: float) → None

–

Parameters:
setShadowStrength(self, aValue: float) → None

–

Parameters:
setShininess(self, aValue: float) → None

–

Parameters:
setShowOrientationIndicators(self, pFlag: bool) → None

–

Sets the visibility of the orientation indicators.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • pFlag (bool) – true to show the orientation indicators, false to hide them
setShowViewFPS(self, bShow: bool) → None

–

Parameters:
setSize(self, xSize: int, ySize: int) → None

–

Sets the view size.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • xSize (int) – the X size, in pixels (an unsigned short)
  • ySize (int) – the Y size, in pixels (an unsigned short)
setSlabThickness(self, value: float) → None

–

Sets the view’s slab thickness.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • value (float) – the slab thickness, in microns (a double)
setSlabThicknessLogged(thickness, logging=True)
setSliceIndexOfBox(self, aBox: ORSModel.ors.Box, sliceIndex: float) → None

–

Sets the current slice position for a given box.

Parameters:
setSliceIndexOfBoxLogged(box, sliceIndex, logging=True)
setSpecularFactor(self, aValue: float) → None

–

Parameters:
setSpecularLightColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
setSpotlightFactor(self, aValue: float) → None

–

Parameters:
setUseSuperSampling(self, aValue: bool) → None

–

Parameters:
setViewActualWidth(self, value: float) → None

–

Parameters:
setViewMode(self, viewMode: int) → None

–

Sets the view’s volume mode.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • viewMode (int) – a CxvView_Mode (a int32_t*)
setViewModeLogged(viewMode, logging=True)
setViewOrientedPlane(self, anOrientedPlane: ORSModel.ors.OrientedPlane, aSlabThickness: float) → None

–

Parameters:
setViewOrientedPlaneLogged(orientedPlane, thickness, logging=True)
setViewPlanePosition(self, worldPosition: ORSModel.ors.Vector3, centerView: bool) → None

–

Parameters:
setViewPlanePositionLogged(point, center, logging=True)
setViewRepresentationColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the view’s representation color.

Parameters:
setXSize(self, xSize: int) → None

–

Sets the view X size.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • xSize (int) – the X size, in pixels (an unsigned short)
setYSize(self, ySize: int) → None

–

Sets the view Y size.

Parameters:
  • self (ORSModel.ors.View) – an instance of View
  • ySize (int) – the Y size, in pixels (an unsigned short)
setZoomAtCursorPosition(self, value: bool) → None

–

Sets the zoom to react centered from the cursor position.

Parameters:
setZoomFactor(self, value: float) → None

–

Parameters:

Visual

class ORSModel.ors.Visual

Bases: ORSModel.ors.Node

brief_description: An abstract class that handles all services pertaining to visualizing objects. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Visual.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

Visual.__init__(self) -> None –

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

Visual.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getAction(self) → str

–

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : str

getAllParentViewsWhereVisualIsVisible(self) → List

–

Gets a list of views where the visual appears.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual
getAssociatedState(self) → str

–

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : str

getBoundingBox(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Box

–

Parameters:
getBoundingBoxInView(self, aView: ORSModel.ors.View) → Box

–

Gets the bounding box of the visual in the orientation of the view.

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getClipBox(timestep=0, display=None)

Gets the clip box of the visual

Parameters:
Returns:

aClipBox (ORSModel.ors.Box) – the clip box
getFirstFrameTowardsNode(self, anINode: ORSModel.ors.Node) → ReferenceFrame

–

Gets the first frame found going up the hierarchy towards a given object.

Parameters:
getFrameTransformationFromNode(self, towardNode: ORSModel.ors.Node, pTimeStep: int) → Matrix4x4

–

Parameters:
getHighlightColor(self) → Color

–

Parameters:self (ORSModel.ors.Visual) – an instance of Visual
getIsHighlightable(self) → bool

–

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

getIsHighlightedInView(self, aView: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getIsPickable(self) → bool

–

Gets the visual’s pickable state.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

getIsSelected(self) → bool

–

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

getIsShadowEnabled(self) → bool

–

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

getIsVisibleForAllViews(self) → bool

–

Gets the visibility of the receiver in all views.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

getIsVisibleForView(self, IView: ORSModel.ors.View) → bool

–

Gets the visibility of the receiver in a given view.

Parameters:

:return : :rtype : bool

getMaterial(self) → Material

–

Gets the visual’s material.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual
getPickTolerance(self) → float

–

Gets the pick tolerance.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : float

getShowIn2D(self) → bool

–

Gets the visual visibility mode in 2D views.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

getShowIn3D(self) → bool

–

Gets the visual visibility mode in 2D views.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

getTSize(self) → int

–

Gets the T size.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : int

getZEnabled(self) → bool

–

Gets the visual’s Z buffer state.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

initializeVisual(self) → bool

–

Initializes the visual.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

:return : :rtype : bool

none() → Visual

–

resetVisibility(self) → None

–

Parameters:self (ORSModel.ors.Visual) – an instance of Visual
setAction(self, anAction: str) → None

–

Parameters:
setAssociatedState(self, aGlobalState: str) → None

–

Parameters:
setHighlightColor(self, color: ORSModel.ors.Color) → None

–

Parameters:
setIsHighlightable(self, value: bool) → None

–

Parameters:
setIsHighlightedInView(self, aView: ORSModel.ors.View, aFlag: bool) → None

–

Parameters:
setIsPickable(self, value: bool) → None

–

Sets the visual to be pickable or not.

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • value (bool) – TRUE to make the visual pickable, false otherwise
setIsSelected(self, aBool: bool) → None

–

Parameters:
setIsShadowEnabled(self, value: bool) → None

–

Parameters:
setIsVisibleForAllViews(self, bValue: bool) → None

–

Sets the visibility of the receiver in all views.

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • bValue (bool) – true to make the receiver visible in all views, false to hide it
setIsVisibleForView(self, IView: ORSModel.ors.View, bValue: bool) → None

–

Sets the visibility of the receiver in a given view.

Parameters:
setIsVisibleForViewLogged(view, flag, logging=True)
setMaterial(self, aIMaterial: ORSModel.ors.Material) → None

–

Sets the visual’s material.

Parameters:
setPickTolerance(self, pValue: float) → None

–

Sets the pick tolerance.

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • pValue (float) – a number of pixels (a double between 0 and 1)
setShowIn2D(self, show: bool) → None

–

Sets the visual to be visible or not in 3D views.

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • show (bool) – true to have the visual be visible in 3D views, false otherwise
setShowIn3D(self, show: bool) → None

–

Sets the visual to be visible or not in 3D views.

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • show (bool) – true to have the visual be visible in 3D views, false otherwise
setTSize(self, pTSize: int) → None

–

Sets the T size.

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • pTSize (int) – T size (an unsigned short)
setZEnabled(self, value: bool) → None

–

Sets the visual’s Z buffer state.

Parameters:
  • self (ORSModel.ors.Visual) – an instance of Visual
  • value (bool) – true to enable the Z buffer, false to disable it
stackVisualState(self) → None

–

Saves the receiver’s visual state on a stack.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual
unstackVisualState(self) → None

–

Restores a visual state from a stack.

Parameters:self (ORSModel.ors.Visual) – an instance of Visual

VisualAngle

class ORSModel.ors.VisualAngle

Bases: ORSModel.ors.Annotation

brief_description: Represents an angle and its measurement. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Aug 2006

VisualAngle.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualAngle) – an instance of VisualAngle
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualAngle.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualAngle) – an instance of VisualAngle

VisualAngle.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
fitFromPoints(self, count: int, points: float, iTIndex: int) → None

–

Gets the primitive to fit itself to a list of points.

Parameters:
  • self (ORSModel.ors.VisualAngle) – an instance of VisualAngle
  • count (int) – the number of triplets supplied (an uint32_t) (see note below)
  • points (float) – an array of points to fit to (a double*)
  • iTIndex (int) –
getAngleValue(self, iTIndex: int) → float

–

Gets the value of the angle.

Parameters:

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getIsSplitted(self, iTIndex: int) → bool

–

Queries the angle to see if it is splitted or not.

Parameters:

:return : :rtype : bool

none() → VisualAngle

–

setIsSplitted(self, value: bool, iTIndex: int) → None

–

Sets the angle to be splitted or not.

Parameters:
  • self (ORSModel.ors.VisualAngle) – an instance of VisualAngle
  • value (bool) – TRUE to split the angle, FALSE otherwise (see note)
  • iTIndex (int) –

VisualArrow

class ORSModel.ors.VisualArrow(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Annotation

–

Parameters:
  • self (ORSModel.ors.VisualArrow) – an instance of VisualArrow
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualArrow.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualArrow) – an instance of VisualArrow

VisualArrow.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getPositionOnVisual(self, iTIndex: int) → Vector3

–

Parameters:
none() → VisualArrow

–

setIsPickingVisual(self, value: bool, iTIndex: int) → None

–

Parameters:
setPositionOnVisual(self, x: float, y: float, z: float, iTIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.VisualArrow) – an instance of VisualArrow
  • x (float) –
  • y (float) –
  • z (float) –
  • iTIndex (int) –
setPositionOnVisualForAllTimeStep(self, x: float, y: float, z: float) → None

–

Parameters:

VisualBox

class ORSModel.ors.VisualBox(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.VisualShape3D

–

Parameters:
  • self (ORSModel.ors.VisualBox) – an instance of VisualBox
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualBox.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualBox) – an instance of VisualBox

VisualBox.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getBox(self, iTIndex: int) → Box

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getGridRectangleSize(self) → float

–

Parameters:self (ORSModel.ors.VisualBox) – an instance of VisualBox

:return : :rtype : float

getHighlightedBoxFace(self, faceIndex: int, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getHighlightedBoxFaceCount(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : unsigned int

getIsMiddleAnchorHighlited(self, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getPickedFace(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getRangeMode(self, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getSelectedBoxFace(self, faceIndex: int, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getSelectedBoxFaceCount(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : unsigned int

getShowFaceAnchors(self) → bool

–

Parameters:self (ORSModel.ors.VisualBox) – an instance of VisualBox

:return : :rtype : bool

getShowGrid(self) → bool

–

Parameters:self (ORSModel.ors.VisualBox) – an instance of VisualBox

:return : :rtype : bool

none() → VisualBox

–

pickBoxFace(self, pDisplay: ORSModel.ors.View, xPixelPositionInDisplay: int, yPixelPositionInDisplay: int) → int

–

Parameters:

:return : :rtype : int

pickBoxMiddleAnchor(self, pDisplay: ORSModel.ors.View, xPixelPositionInDisplay: int, yPixelPositionInDisplay: int) → bool

–

Parameters:

:return : :rtype : bool

pickSpecificBoxFace(self, pDisplay: ORSModel.ors.View, faceIndex: int, xPixelPositionInDisplay: int, yPixelPositionInDisplay: int) → bool

–

Parameters:

:return : :rtype : bool

setBox(self, aBox: ORSModel.ors.Box, iTIndex: int) → None

–

Parameters:
setGridRectangleSize(self, aSize: float) → None

–

Parameters:
setHighlightedBoxFace(self, faceIndex: int, iTIndex: int) → None

–

Parameters:
setIsMiddleAnchorHighlited(self, aValue: bool, iTIndex: int) → None

–

Parameters:
setPickedFace(self, faceIndex: int, iTIndex: int) → None

–

Parameters:
setRangeMode(self, aFlag: bool, iTIndex: int) → None

–

Parameters:
setSelectedBoxFace(self, faceIndex: int, iTIndex: int) → None

–

Parameters:
setShowFaceAnchors(self, showFaceAnchors: bool) → None

–

Parameters:
setShowGrid(self, flag: bool) → None

–

Parameters:
unHighlightAllBoxFace(self, iTIndex: int) → None

–

Parameters:
unSelectAllBoxFace(self, iTIndex: int) → None

–

Parameters:

VisualCapsule

class ORSModel.ors.VisualCapsule(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.VisualShape3D

–

Parameters:
  • self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualCapsule.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule

VisualCapsule.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getCapsule(self, iTIndex: int) → Capsule

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → VisualCapsule

–

setCapsule(self, aCapsule: ORSModel.ors.Capsule, iTIndex: int) → None

–

Parameters:

VisualChannel

class ORSModel.ors.VisualChannel

Bases: ORSModel.ors.DatasetPresenter

brief_description: Represents a high quality visual volume in the view. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: Channel, VisualChannel, CxvChannel_Data_Type A visual object that represents a high quality volume. A high quality volume uses a volumetric texture instead of three stacks of 2D textures. Volume objects accept only channels of same size, spacing and type. The first channel connected to a volume will determine the size, spacing, and type of the volume. The volume supports up to 4 channels (rgba) ordered from the first parent (red) to the last (alpha). Missing channels are considered empty. Before it can be displayed, a volume must build its texture from the channels. This texture must be rebuilt every time the channels become dirty.

VisualChannel.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualChannel.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

VisualChannel.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
attachChannels(self, aChannel1: ORSModel.ors.Channel, aChannel2: ORSModel.ors.Channel, aChannel3: ORSModel.ors.Channel, aChannel4: ORSModel.ors.Channel) → bool

–

Attaches between 1 and 4 channels to the volume.

Parameters:

:return : :rtype : bool

copyShapeFromChannel(self, pISourceChannel: ORSModel.ors.Channel) → None

–

Parameters:
detachChannel(self, anIChannel: ORSModel.ors.Channel) → bool

–

Detaches a child channel from the volume.

Parameters:

:return : :rtype : bool

eraseWindowLevelDataForView(self, aView: ORSModel.ors.View) → None

–

Erases the window level data specific to a given view.

Parameters:
get2DLODEnabled(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

get2DLODSlabEnabled(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

get2DOpacityFactorForAllViews(self) → float

–

Gets the opacity of the volume for all views.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : float

get2DOpacityFactorForView(self, aView: ORSModel.ors.View) → float

–

Gets the opacity of the volume for a given view.

Parameters:

:return : :rtype : float

get2DWindowLevel2ValuesNormalized(self, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current second 2D window level values (width and center) normalized between 0 and 1.

Parameters:
get2DWindowLevelValuesNormalizedForAllViews(self, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 3D window level values (width and center) normalized between 0 and 1, for all views.

Parameters:
get2DWindowLevelValuesNormalizedForView(self, aView: ORSModel.ors.View, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 2D window level values (width and center) normalized between 0 and 1, for a given view.

Parameters:
get3DClassificationMode(self) → int

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : unsigned int

get3DOpacityFactorForAllViews(self) → float

–

Gets the opacity of the volume for all views.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : float

get3DOpacityFactorForView(self, aView: ORSModel.ors.View) → float

–

Gets the opacity of the volume for a given view.

Parameters:

:return : :rtype : float

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

–

Parameters:

:return : :rtype : unsigned int

get3DWindowLevelValuesNormalizedForAllViews(self, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 3D window level values (width and center) normalized between 0 and 1, for all views.

Parameters:
get3DWindowLevelValuesNormalizedForView(self, aView: ORSModel.ors.View, pWindowWidth: float, pWindowCenter: float) → None

–

Gets the current 2D window level values (width and center) normalized between 0 and 1, for a given view.

Parameters:
getBox(self) → Box

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
getCanCreateVisualChannel(self, anIChannel: ORSModel.ors.Channel, nNbChannels: int) → bool

–

Returns true if a volume 3D can be created with the given values.

Parameters:

:return : :rtype : bool

getCanCreateVolume(self, anIChannel: ORSModel.ors.Channel, nNbChannels: int) → bool

–

Returns true if a volume can be created with the given values.

Parameters:

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getEdgeContrastForAllViews(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

getEdgeContrastForView(self, aView: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getFilteringMode(self) → int

–

Gets the current filtering mode.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : int

getGradientModeForAllViews(self) → int

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : int

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

–

Parameters:

:return : :rtype : int

getHasSourceDataSameShapeAsChannel(self, pChannel: ORSModel.ors.Channel) → bool

–

Verifies if the visual’s source data has the same shape as another channel (see note below).

Parameters:

:return : :rtype : bool

getInverseSegmentationLighting(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

getIs2DRangeSelectionEnabled(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

getIsoValueForAllViews(self) → float

–

Gets the IsoValue of the volume for all views.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : float

getIsoValueForView(self, aView: ORSModel.ors.View) → float

–

Gets the IsoValue of the volume for a given view.

Parameters:

:return : :rtype : float

getPixelIntensity(self, aView: ORSModel.ors.View, pXPos: int, pYPos: int, pIntensity: float) → bool

–

Gets the pixel intensity at any given screen coordinate, for a given view.

Parameters:
  • self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
  • aView (ORSModel.ors.View) – a view (an View)
  • pXPos (int) – the X coordinate (an unsigned short)
  • pYPos (int) – the Y coordinate (an unsigned short)
  • pIntensity (float) –

:return : :rtype : bool

getProjectionMode(self) → int

–

Gets the projection mode.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : int

getSourceDataPosition(self) → Vector3

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
getSourceDataXSize(self) → int

–

Gets the visual’s total X size.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : int

getSourceDataXSpacing(self) → float

–

Gets the visual’s X spacing.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : float

getSourceDataYSize(self) → int

–

Gets the visual’s total Y size.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : int

getSourceDataYSpacing(self) → float

–

Gets the visual’s Y spacing.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : float

getSourceDataZSize(self) → int

–

Gets the visual’s total Z size.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : int

getSourceDataZSpacing(self) → float

–

Gets the visual’s Z spacing.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : float

getSurfacenessThresholdForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : float

getSurfacenessThresholdForView(self, aView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getUseHighQualityIn3D(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

getUseTriCubicFilteringIn2D(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

getUseTriCubicFilteringIn3D(self) → bool

–

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

:return : :rtype : bool

none() → VisualChannel

–

reset2DWindowLevelForAllViews(self) → None

–

Resets the 3D window level for all views.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
reset2DWindowLevelForView(self, aView: ORSModel.ors.View) → None

–

Resets the 2D window level for a given view.

Parameters:
reset3DWindowLevelForAllViews(self) → None

–

Resets the 3D window level for all views.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
reset3DWindowLevelForView(self, aView: ORSModel.ors.View) → None

–

Resets the 2D window level for a given view.

Parameters:
set2DLODEnabled(self, value: bool) → None

–

Parameters:
set2DLODSlabEnabled(self, value: bool) → None

–

Parameters:
set2DOpacityFactorForAllViews(self, value: float) → None

–

Sets the opacity of the volume for all views.

Parameters:
  • self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
  • value (float) – the opacity value (a double, between 0 and 1)
set2DOpacityFactorForView(self, aView: ORSModel.ors.View, value: float) → None

–

Sets the opacity of the volume for a given view.

Parameters:
set2DOpacityFactorForViewLogged(view, opacity, logging=True)
set2DWindowLevel2ToShowFullRange(self) → None

–

Sets the second 2D window level to show the full range of data.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
set2DWindowLevelToShowFullRangeForAllViews(self) → None

–

Sets the 3D window level to show the full range of data, for all views.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
set2DWindowLevelToShowFullRangeForView(self, aView: ORSModel.ors.View) → None

–

Sets the 3D window level to show the full range of data, for a given view.

Parameters:
set3DClassificationMode(self, aMode: int) → None

–

Parameters:
set3DOpacityFactorForAllViews(self, value: float) → None

–

Sets the opacity of the volume for all views.

Parameters:
  • self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
  • value (float) – the opacity value (a double, between 0 and 1)
set3DOpacityFactorForView(self, aView: ORSModel.ors.View, value: float) → None

–

Sets the opacity of the volume for a given view.

Parameters:
set3DOpacityFactorForViewLogged(view, opacity, logging=True)
set3DShadingModeForView(self, aView: ORSModel.ors.View, aMode: int) → None

–

Parameters:
set3DWindowLevelToShowFullRangeForAllViews(self) → None

–

Sets the 3D window level to show the full range of data, for all views.

Parameters:self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
set3DWindowLevelToShowFullRangeForView(self, aView: ORSModel.ors.View) → None

–

Sets the 3D window level to show the full range of data, for a given view.

Parameters:
setEdgeContrastForAllViews(self, value: bool) → None

–

Parameters:
setEdgeContrastForView(self, aView: ORSModel.ors.View, value: bool) → None

–

Parameters:
setFilteringMode(self, iMode: int) → None

–

Sets the current filtering mode.

Parameters:
setGradientModeForAllViews(self, aValue: int) → None

–

Parameters:
setGradientModeForView(self, aView: ORSModel.ors.View, aValue: int) → None

–

Parameters:
setInverseSegmentationLighting(self, bInverse: bool) → None

–

Parameters:
setIs2DRangeSelectionEnabled(self, pFlag: bool) → None

–

Parameters:
setIsoValueForAllViews(self, value: float) → None

–

Sets the IsoValue of the volume for all views.

Parameters:
setIsoValueForView(self, aView: ORSModel.ors.View, value: float) → None

–

Sets the IsoValue of the volume for a given view.

Parameters:
setPlaneChannelForView(self, pView: ORSModel.ors.View, pChannel: ORSModel.ors.Channel) → None

–

Parameters:
setProjectionMode(self, iMode: int) → None

–

Sets the projection mode.

Parameters:
setSurfacenessThresholdForAllViews(self, value: float) → None

–

Parameters:
setSurfacenessThresholdForView(self, aView: ORSModel.ors.View, value: float) → None

–

Parameters:
setUseHighQualityIn3D(self, value: bool) → None

–

Parameters:
setUseTriCubicFilteringIn2D(self, value: bool) → None

–

Parameters:
setUseTriCubicFilteringIn3D(self, value: bool) → None

–

Parameters:
shape

VisualColorBar

class ORSModel.ors.VisualColorBar

Bases: ORSModel.ors.Visual

brief_description: Used to present a ColorBar on the renderer. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2006 see: LookupTable Used to present a color bar on the renderer.

VisualColorBar.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualColorBar.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

VisualColorBar.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getAllViewsUsingLookupTable(self, aLUT: ORSModel.ors.LookupTable) → List

–

Parameters:
getBold(self) → bool

–

Gets the bold status of the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : bool

getBorder(self) → bool

–

Gets the border status of the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : bool

getCanBeVisibleForAllViews(self) → bool

–

Gets whether or not the color bar can be visible.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : bool

getCanBeVisibleForView(self, pView: ORSModel.ors.View) → bool

–

Gets whether or not the color bar can be visible.

Parameters:

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getDecimalPrecision(self) → int

–

Gets the decimal precision of the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : int

getDrawTextShadow(self) → bool

–

Gets if the scale bar is showing text shadow.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : bool

getHeightAsViewFractionForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getHeightAsViewFractionForView(self, pView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getIsEnabledForAllViews(self) → bool

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : bool

getIsEnabledForView(self, pView: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getItalic(self) → bool

–

Gets the italic status of the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : bool

getLineThickness(self) → float

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getLookupTableForAllViews(self) → LookupTable

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
getLookupTableForView(self, pView: ORSModel.ors.View) → LookupTable

–

Parameters:
getOffset(self) → float

–

Gets the color bar offset.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getPositionForAllViews(self) → Vector3

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
getPositionForView(self, pView: ORSModel.ors.View) → Vector3

–

Parameters:
getRangeDimensionUnitForAllViews(self) → int

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : int

getRangeDimensionUnitForView(self, pView: ORSModel.ors.View) → int

–

Parameters:

:return : :rtype : int

getRangeMaxForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getRangeMaxForView(self, pView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getRangeMinForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getRangeMinForView(self, pView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getSlope(self) → float

–

Gets the color bar slope.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getTextColor(self) → Color

–

Gets the text color of the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
getTextFontName(self) → str

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : str

getTextFontSize(self) → float

–

Gets the text font size, in screen one thousandths.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getTextMinimumFontSize(self) → int

–

Gets the minimum text font size, in font points.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : int

getTextShadowColor(self) → Color

–

Gets the text shadow color of the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
getTickCount(self) → int

–

Gets the number of visible ticks on the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : int

getTransparent(self) → bool

–

Gets the transparency status of the color bar.

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : bool

getWidthAsViewFractionForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

:return : :rtype : float

getWidthAsViewFractionForView(self, pView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

none() → VisualColorBar

–

setBold(self, value: bool) → None

–

Sets the color bar to be bold or not.

Parameters:
setBorder(self, value: bool) → None

–

Sets the color bar to have a border or not.

Parameters:
setCanBeVisibleForAllViews(self, aValue: bool) → None

–

Sets whether or not the color bar can be visible.

Parameters:
  • self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
  • aValue (bool) – true if color bar can be make visible, false otherwise
setCanBeVisibleForView(self, pView: ORSModel.ors.View, aValue: bool) → None

–

Sets whether or not the color bar can be visible.

Parameters:
setCanBeVisibleForViewLogged(view, flag, logging=True)
setDecimalPrecision(self, value: int) → None

–

Sets the decimal precision of the color bar.

Parameters:
  • self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
  • value (int) – the number of decimal places (an unsigned short)
setDefaultPosition(self, x: float, y: float) → None

–

Sets the default position of the color bar.

Parameters:
  • self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
  • x (float) – the X coordinate (a double)
  • y (float) – the Y coordinate (a double)
setDrawTextShadow(self, bFlag: bool) → None

–

Toggles displaying shadows for the text.

Parameters:
setHeightAsViewFractionForAllViews(self, aValue: float) → None

–

Parameters:
setHeightAsViewFractionForView(self, pView: ORSModel.ors.View, aValue: float) → None

–

Parameters:
setIsEnabledForAllViews(self, aValue: bool) → None

–

Parameters:
setIsEnabledForView(self, pView: ORSModel.ors.View, aValue: bool) → None

–

Parameters:
setItalic(self, value: bool) → None

–

Sets the color bar to be italic or not.

Parameters:
setLineThickness(self, value: float) → None

–

Parameters:
setLookupTableForAllViews(self, aLUT: ORSModel.ors.LookupTable) → None

–

Parameters:
setLookupTableForView(self, pView: ORSModel.ors.View, aLUT: ORSModel.ors.LookupTable) → None

–

Parameters:
setLookupTableForViewLogged(view, lut, logging=True)
setOffset(self, anOffset: float) → None

–

Sets the color bar offset.

Parameters:
setOrientationToHorizontalForAllViews(self) → None

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
setOrientationToHorizontalForView(self, pView: ORSModel.ors.View) → None

–

Parameters:
setOrientationToVerticalForAllViews(self) → None

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
setOrientationToVerticalForView(self, pView: ORSModel.ors.View) → None

–

Parameters:
setPositionForAllViews(self, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setPositionForView(self, pView: ORSModel.ors.View, aPoint: ORSModel.ors.Vector3) → None

–

Set the color bar position in view.

Parameters:
setRangeDimensionUnitForAllViews(self, value: int) → None

–

Parameters:
setRangeDimensionUnitForView(self, pView: ORSModel.ors.View, value: int) → None

–

Parameters:
setRangeForAllViews(self, min: float, max: float, unit: int) → None

–

Parameters:
setRangeForView(self, pView: ORSModel.ors.View, min: float, max: float, unit: int) → None

–

Parameters:
setSlope(self, aSlope: float) → None

–

Sets the color bar slope.

Parameters:
setTextColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the text color of the color bar.

Parameters:
setTextFontName(self, sFontName: str) → None

–

Sets the text font name.

Parameters:
setTextFontSize(self, fontSize: float) → None

–

Sets the text font size, in screen one thousandths.

Parameters:
setTextMinimumFontSize(self, fontSize: int) → None

–

Sets the minimum font size, in font points.

Parameters:
setTextShadowColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the text shadow color of the color bar.

Parameters:
setTickCount(self, value: int) → None

–

Sets the number of visible ticks on the color bar.

Parameters:
setTransparent(self, value: bool) → None

–

Sets the color bar to be transparent or not.

Parameters:
setWidthAsViewFractionForAllViews(self, aValue: float) → None

–

Parameters:
setWidthAsViewFractionForView(self, pView: ORSModel.ors.View, aValue: float) → None

–

Parameters:
updateRampForAllViews(self) → None

–

Parameters:self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
updateRampForView(self, pView: ORSModel.ors.View) → None

–

Parameters:

VisualCylinder

class ORSModel.ors.VisualCylinder(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.VisualShape3D

–

Parameters:
  • self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualCylinder.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder

VisualCylinder.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getCylinder(self, iTIndex: int) → Cylinder

–

Parameters:
none() → VisualCylinder

–

setCylinder(self, aCylinder: ORSModel.ors.Cylinder, iTIndex: int) → None

–

Parameters:

VisualGrid

class ORSModel.ors.VisualGrid

Bases: ORSModel.ors.Visual

brief_description: Represents a grid in a display. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: View Represents a grid in the display.

VisualGrid.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualGrid) – an instance of VisualGrid
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualGrid.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualGrid) – an instance of VisualGrid

VisualGrid.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → VisualGrid

–

VisualLabel

class ORSModel.ors.VisualLabel

Bases: ORSModel.ors.Annotation

brief_description: Represents a label, which is used to associate text to other objects. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Aug 2006

VisualLabel.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualLabel.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel

VisualLabel.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getBindedNode(self) → Node

–

Gets the node associated to the label.

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
getClassNameStatic() → str

–

:return : :rtype : str

getIsCollapsed(self, iTIndex: int) → bool

–

Gets the label’s collapsed status.

Parameters:

:return : :rtype : bool

getLabelSortMode(self) → int

–

Gets the label sort mode (see note).

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel

:return : :rtype : int

getLabelTextFontName(self) → str

–

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel

:return : :rtype : str

getLabelTextFontSize(self) → int

–

Gets the font size.

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel

:return : :rtype : int

getPickPlusMinus(self, iTIndex: int) → bool

–

Queries the label to know if the plus/minus sign is picked.

Parameters:
  • self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
  • iTIndex (int) – TRUE if mouse is over the plus/minus sign, FALSE otherwise

:return : :rtype : bool

getShowLines(self) → bool

–

Gets the label lines visibility.

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel

:return : :rtype : bool

moveLabelToCursorPositionInDisplay(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → None

–

Moves the label to the current cursor position in a given display.

Parameters:
none() → VisualLabel

–

setForBWRendering(self) → None

–

Sets the Label to be rendered in Black & White.

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
setForNormalRendering(self) → None

–

Sets the Label to be rendered normally.

Parameters:self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
setHasBindedNode(self, bValue: bool) → None

–

Sets the label as being associated to its parent node.

Parameters:
  • self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
  • bValue (bool) – TRUE to be associated, FALSE otherwise
setIsCollapsed(self, bValue: bool, iTIndex: int) → None

–

Sets the label to be collapsed or expanded.

Parameters:
  • self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
  • bValue (bool) – TRUE to collapse the label, FALSE to expand it
  • iTIndex (int) –
setLabelSortMode(self, iMode: int) → None

–

Sets the label sort mode (see note).

Parameters:
setLabelTextFontName(self, sName: str) → None

–

Sets the text font name of the label.

Parameters:
setLabelTextFontSize(self, pValue: int) → None

–

Sets the font size.

Parameters:
setPositionInDisplay(self, IDisplay: ORSModel.ors.View, xPos: float, yPos: float) → None

–

Sets the position of the receiver in a given display.

Parameters:
setShowLines(self, value: bool) → None

–

Sets the label lines visibility.

Parameters:
  • self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
  • value (bool) – TRUE to show the line, FALSE to hide them

VisualLegend

class ORSModel.ors.VisualLegend

Bases: ORSModel.ors.VisualColorBar

brief_description: Used to present a legend on the renderer. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2006 see: LookupTable Used to present a legend on the renderer.

VisualLegend.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualLegend) – an instance of VisualLegend
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualLegend.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualLegend) – an instance of VisualLegend

VisualLegend.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getLabelAtIndex(self, index: int) → str

–

Parameters:

:return : :rtype : str

getLabelCount(self) → int

–

Parameters:self (ORSModel.ors.VisualLegend) – an instance of VisualLegend

:return : :rtype : int

getViewOrderAtIndex(self, index: int) → int

–

Parameters:

:return : :rtype : int

getViewOrderSize(self) → int

–

Parameters:self (ORSModel.ors.VisualLegend) – an instance of VisualLegend

:return : :rtype : int

none() → VisualLegend

–

setLabelAtIndex(self, index: int, label: str) → None

–

Parameters:
setLabelCount(self, labelCount: int) → None

–

Parameters:
setViewOrderAtIndex(self, index: int, viewOrder: int) → None

–

Parameters:
setViewOrderSize(self, iNewSize: int) → None

–

Parameters:

VisualMesh

class ORSModel.ors.VisualMesh(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Visual

–

Parameters:
  • self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualMesh.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

VisualMesh.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getBoundingBoxPlusEpsilon(timestep, worldMatrix, epsilon=0.01)
getBuildOctree(self) → bool

–

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getColorAtIndex(self, iTIndex: int, vertexIndex: int) → Color

–

Gets the color of a specific vertex.

Parameters:
  • self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
  • iTIndex (int) – the T index (an unsigned short)
  • vertexIndex (int) – the vertex index (an uint32_t)
getCullMode(self) → int

–

Gets the culling mode of the mesh.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : int

getCurrentAlphaFuncValue(self) → int

–

Sets the transparency of the mesh.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : int

getFillModeForAllViews(self) → int

–

Gets the mesh fill mode.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : int

getFillModeForView(self, pView: ORSModel.ors.View) → int

–

Gets the mesh fill mode.

Parameters:

:return : :rtype : int

getIsFillModePoint(self, pView: ORSModel.ors.View) → bool

–

Queries the mesh to know if it is in point mode.

Parameters:

:return : :rtype : bool

getIsFillModeSolid(self, pView: ORSModel.ors.View) → bool

–

Queries the mesh to know if it is in solid mode.

Parameters:

:return : :rtype : bool

getIsFillModeWireFrame(self, pView: ORSModel.ors.View) → bool

–

Queries the mesh to know if it is in wire frame mode.

Parameters:

:return : :rtype : bool

getIsPerVertexTransparent(self) → bool

–

Gets the status of transparency.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : bool

getIsTransparent(self) → bool

–

Gets the transparency state of the mesh.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : bool

getOpacity(self) → float

–

Gets the opacity of the mesh.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : float

getOpacityOutRange(self) → float

–

Gets the opacity for unselected area of the mesh.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : float

getShowColorIn2D(self) → bool

–

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : bool

getShowIn2DDuringMotion(self) → bool

–

Gets the visibility of the mesh in 2D views during mouse motion.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : bool

getThickness(self) → float

–

Gets the thickness of lines in 2D mode.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : float

getUseLighting(self) → bool

–

Gets the mesh lighting mode.

Parameters:self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

:return : :rtype : bool

none() → VisualMesh

–

setBuildOctree(self, value: bool) → None

–

Parameters:
setCullMode(self, iMode: int) → None

–

Sets the culling mode for the mesh.

Parameters:
setCurrentAlphaFuncValue(self, value: int) → None

–

Parameters:
setFillModeForAllViews(self, pFillMode: int) → None

–

Sets the mesh fill mode.

Parameters:
setFillModeForView(self, pView: ORSModel.ors.View, pFillMode: int) → None

–

Sets the mesh fill mode.

Parameters:
setIsPerVertexTransparent(self, value: bool) → None

–

Sets the transparency to be read from the RGBA vertex color.

Parameters:
  • self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
  • value (bool) – true to use the transparency from the RGBA color, false to use the global transparency
setIsTransparent(self, value: bool) → None

–

Sets the transparency of the mesh.

Parameters:
  • self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
  • value (bool) – true to make it transparent, false otherwise
setOpacity(self, value: float) → None

–

Sets the opacity for unselected range of the mesh.

Parameters:
setOpacityOutRange(self, value: float) → None

–

Sets the opacity of the mesh.

Parameters:
setShowColorIn2D(self, value: bool) → None

–

Parameters:
setShowIn2DDuringMotion(self, pValue: bool) → None

–

Sets the mesh to be visible or not in 2D views, during mouse motion.

Parameters:
  • self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
  • pValue (bool) – true to have the mesh be visible in 2D views during mouse movement, false otherwise
setThickness(self, value: float) → None

–

Sets the thickness of lines in 2D mode.

Parameters:
  • self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
  • value (float) – the thickness, in pixel units (an double)
setUseLighting(self, useLighting: bool) → None

–

Sets the mesh lighting mode.

Parameters:
  • self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
  • useLighting (bool) – true to use lighting, false otherwise
updateMeshColor(self, timeStep: int) → None

–

Parameters:

VisualOverlay

class ORSModel.ors.VisualOverlay

Bases: ORSModel.ors.Visual

brief_description: Represents a 2D image as a visual in the 3D space. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005 see: VisualText Represents a 2D image as a visual in the 3D space. Textures can come from resources or files. Supported file formats are: bmp, dds, dib, hdr, jpg, pfm, png, ppm and tga.

VisualOverlay.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualOverlay.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

VisualOverlay.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getExtent(self) → Vector3

–

Gets the extent of the overlay.

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
getExtentInBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle) → Vector3

–

Parameters:
getHighlightedAnchor(self, anchorIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getHighlightedAnchorCount(self) → int

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : unsigned int

getHighlightedBorder(self, borderIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getHighlightedBorderCount(self) → int

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : unsigned int

getIsSelectedAndShapeAndPositionEditionEnabled(self) → bool

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : bool

getIsShapeAndPositionEditable(self) → bool

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : bool

getIsShapeAndPositionEditionEnabled(self) → bool

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : bool

getKeepAspectRatio(self) → bool

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : bool

getMaximumPixelSize(self) → Vector3

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
getMinimumPixelSize(self) → Vector3

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
getOpacity(self) → float

–

Gets the opacity of the overlay.

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : float

getOverlayMode(self) → int

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : int

getPosition(self) → Vector3

–

Gets the position of the overlay.

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
getPositionInBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle) → Vector3

–

Parameters:
getPreserveGeometry(self) → bool

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : bool

getRenderingRectangle(self, aView: ORSModel.ors.View) → Rectangle

–

Parameters:
getSelectedColor(self) → Color

–

Gets the selected color of the overlay.

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
getShapeAndPositionEditionAssociatedState(self) → str

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

:return : :rtype : str

none() → VisualOverlay

–

pickAnchor(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int

–

Parameters:

:return : :rtype : int

pickBorder(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int

–

Parameters:

:return : :rtype : int

setExtent(self, aVect: ORSModel.ors.Vector3) → None

–

Sets the extent of the overlay.

Parameters:
setHighlightedAnchor(self, anchorIndex: int) → None

–

Parameters:
setHighlightedBorder(self, borderIndex: int) → None

–

Parameters:
setIsShapeAndPositionEditable(self, value: bool) → None

–

Parameters:
setIsShapeAndPositionEditionEnabled(self, value: bool) → None

–

Parameters:
setKeepAspectRatio(self, aValue: bool) → None

–

Parameters:
setMaximumPixelSize(self, aVect: ORSModel.ors.Vector3) → None

–

Parameters:
setMinimumPixelSize(self, aVect: ORSModel.ors.Vector3) → None

–

Parameters:
setOpacity(self, value: float) → None

–

Sets the opacity of the overlay.

Parameters:
setOverlayMode(self, aMode: int) → None

–

Parameters:
setPosition(self, pPosition: ORSModel.ors.Vector3) → None

–

Sets the position of the overlay.

Parameters:
setPreserveGeometry(self, aValue: bool) → None

–

Parameters:
setSelectedColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the selected color of the overlay.

Parameters:
setShapeAndPositionEditionAssociatedState(self, aState: str) → None

–

Parameters:
unHighlightAllAnchor(self) → None

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
unHighlightAllBorder(self) → None

–

Parameters:self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

VisualPath

class ORSModel.ors.VisualPath

Bases: ORSModel.ors.Annotation

brief_description: Represents a path. A path is composed of a series of points. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Aug 2006

VisualPath.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualPath.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

VisualPath.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addPathMarker(self, parameter: float, iTIndex: int) → None

–

Parameters:
addPoint(self, pPoint: ORSModel.ors.Vector3, iTIndex: int) → None

–

Adds a point.

Parameters:
addPointForAllTimeStep(self, pPoint: ORSModel.ors.Vector3) → None

–

Parameters:
addPointForControlPoint(self, controlPointIndex: int, iTIndex: int, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
applyConvolution(self, aKernel: ORSModel.ors.ConvolutionKernel, timeStep: int) → None

–

Apply the kernel to the path position.

Parameters:
clearAll(self, iTIndex: int) → None

–

Clears all points and control points.

Parameters:
clearAllForAllTimeStep(self) → None

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath
closestPointOnPathInCurvedOnScreen(self, pView: ORSModel.ors.View, pixelXPositionInView: int, pixelYPositionInView: int) → int

–

Parameters:

:return : :rtype : int

getAllCurvedViewsOfPath(self) → List

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath
getAllShortAxialViewsOfPath(self) → List

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath
getArea(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → float

–

Returns the area of the path.

Parameters:

:return : :rtype : float

getBezierSamplingLength(self) → float

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : float

getBuildOctree(self) → bool

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getControlPointIndexFromPointIndex(self, id: int, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getControlPointPositionsList(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pIndicesArray: ORSModel.ors.ArrayLong) → ArrayDouble

–

Batch gets of given control point’s coordinates by indices.

Parameters:
getControlPointRadiusAtIndex(self, index: int, iTIndex: int) → float

–

Parameters:

:return : :rtype : float

getCurrentPointIndex(self) → int

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : int

getDistanceAlongPathBetweenPosition(self, s0: float, s1: float, iTIndex: int) → float

–

Parameters:

:return : :rtype : float

getDistanceBetweenPosition(self, s0: float, s1: float, iTIndex: int, pMatrix: ORSModel.ors.Matrix4x4) → float

–

Parameters:

:return : :rtype : float

getHideLine(self) → bool

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getHightlightedPathMarkerIndex(self) → int

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : int

getIndexOfClosestPoint(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, pointToCompareTo: ORSModel.ors.Vector3, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getIndexOfFarthestPoint(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, pointToCompareTo: ORSModel.ors.Vector3, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getIndexOfPathMarkerWithCaption(self, aCaption: str, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getIntersectionPointsOfContourForBoundedPlane(self, aBP: ORSModel.ors.Rectangle, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pfOutputPoints: ORSModel.ors.OrderedCollectionDouble) → OrderedCollectionDouble

–

Parameters:
getIsBezier(self) → bool

–

Gets the path’s Bezier curve status.

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getIsClosed(self) → bool

–

Gets if the path is closed.

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getIsToBeShownInCurvedView(self) → bool

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getLength(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → float

–

Returns the total length of the path.

Parameters:

:return : :rtype : float

getParameterAtControlPointIndex(self, index: int, iTIndex: int) → float

–

Gets the position of a given control point on the path.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) – the index of the control point (an uint32_t)
  • iTIndex (int) –

:return : :rtype : float

getParameterAtPointIndex(self, index: int, iTIndex: int) → float

–

Gets the position of a given point on the path.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) – the index of the point (an uint32_t)
  • iTIndex (int) –

:return : :rtype : float

getPathMarkerCaption(self, index: int, iTIndex: int) → str

–

Parameters:

:return : :rtype : str

getPathMarkerColor(self, index: int, iTIndex: int) → Color

–

Parameters:
getPathMarkerCount(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getPathMarkerPosition(self, index: int, iTIndex: int) → float

–

Parameters:

:return : :rtype : float

getPathMarkerReferenceLineIsHightlighted(self) → bool

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getPathMarkerReferenceLineOffsetForView(self, pView: ORSModel.ors.View) → int

–

Parameters:

:return : :rtype : int

getPathMarkerRegionID(self, index: int, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getPathMarkerRegionMode(self, index: int, iTIndex: int) → int

–

Parameters:

:return : :rtype : int

getPathMarkerScalar(self, index: int, scalarIndex: int, iTIndex: int) → float

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) –
  • scalarIndex (int) –
  • iTIndex (int) –

:return : :rtype : float

getPathMarkerScalarCount(self) → int

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : int

getPathMarkerVisible(self, index: int, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getPathPointCenterOfMass(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3

–

Parameters:
getPathPointGlobalOrientation(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3

–

Parameters:
getPathPoints(self, iTIndex: int) → OrderedCollectionDouble

–

Parameters:
getPickPathMarker(self, pDisp: ORSModel.ors.View, pixelXPositionInView: int, pixelYPositionInView: int) → int

–

Parameters:

:return : :rtype : int

getPointAtIndex(self, index: int, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3

–

Gets a given point’s coordinates.

Parameters:
getPointCount(self, iTIndex: int) → int

–

Gets the number of points.

Parameters:

:return : :rtype : int

getPointPositionsList(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pnIndexes: ORSModel.ors.ArrayLong) → ArrayDouble

–

Parameters:
getPositionOnPath(self, parameter: float, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3

–

Parameters:
getPositionOnPathNearestTo(self, aLocation: ORSModel.ors.Vector3, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → float

–

Parameters:

:return : :rtype : float

getPositionOnViewForCurvedChannel(self, pNormalizedPositionOnPath: float, aView: ORSModel.ors.View, aCurvedChannel: ORSModel.ors.Channel) → Vector3

–

Parameters:
getPositionOnViewOfControlPointForCurvedChannel(self, controlPointIndex: int, aView: ORSModel.ors.View, aCurvedChannel: ORSModel.ors.Channel) → Vector3

–

Parameters:
getPositionTangentAndNormalOnPath(self, parameter: float, position: ORSModel.ors.Vector3, up: ORSModel.ors.Vector3, right: ORSModel.ors.Vector3, tangent: ORSModel.ors.Vector3, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → None

–

Gets the positional, tangent and normal vectors at a given position on the path.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • parameter (float) – a relative position on the path (a float)
  • iTIndex (int) – TRUE to get results in world values, FALSE otherwise
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:
getPositionsOnPath(self, pPositions: ORSModel.ors.ArrayDouble, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pfOutputPoints: ORSModel.ors.ArrayDouble) → ArrayDouble

–

Parameters:
getShowAllIn2D(self) → bool

–

Gets the Show All status of the path.

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getShowPathMarkerReferenceLine(self) → bool

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath

:return : :rtype : bool

getTubularMeshFromControlPoints(self, nbPtsCircle: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, offset: float, iTIndex: int, inoutMesh: ORSModel.ors.Mesh) → Mesh

–

Returns a tubular mesh with variable radius, built from the control points.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • nbPtsCircle (int) – the number of point on the circumference of the tube
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) – create a mesh in local or world coordinate
  • offset (float) – an offset to add at the end and beginning of the tube
  • iTIndex (int) – Pointer to the mesh
  • inoutMesh (ORSModel.ors.Mesh) –
getTubularMeshFromPoints(self, nbPtsCircle: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pointSpacing: float, offset: float, iTIndex: int, inoutMesh: ORSModel.ors.Mesh) → Mesh

–

Returns a tubular mesh built from path points.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • nbPtsCircle (int) – the number of point on the circumference of the tube
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) – create a mesh in local or world coordinate
  • pointSpacing (float) – the physical spacing between two points
  • offset (float) – an offset to add at the end and beginning of the tube
  • iTIndex (int) – Pointer to the mesh
  • inoutMesh (ORSModel.ors.Mesh) –
getTubularMeshWithFixedRadiusFromControlPoints(self, radius: float, nbPtsCircle: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, offset: float, iTIndex: int, inoutMesh: ORSModel.ors.Mesh) → Mesh

–

Returns a tubular mesh built from the control points.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • radius (float) – the radius of the mesh double radius (a double)
  • nbPtsCircle (int) – the number of points on the circumference of the tube (an unsigned short)
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix
  • offset (float) – an offset to add at the end and beginning of the tube (a double)
  • iTIndex (int) – T index
  • inoutMesh (ORSModel.ors.Mesh) – Pointer to the mesh
getTubularMeshWithFixedRadiusFromPoints(self, radius: float, nbPtsCircle: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pointSpacing: float, offset: float, iTIndex: int, inoutMesh: ORSModel.ors.Mesh) → Mesh

–

Returns a tubular mesh built from path points.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • radius (float) – the radius of the mesh double radius
  • nbPtsCircle (int) – the number of point on the circumference of the tube
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) – create a mesh in local or world coordinate
  • pointSpacing (float) – the physical spacing between two points
  • offset (float) – an offset to add at the end and beginning of the tube
  • iTIndex (int) – Pointer to the mesh
  • inoutMesh (ORSModel.ors.Mesh) –
insertControlPointForAllTimeStep(self, index: int, pPoint: ORSModel.ors.Vector3) → None

–

Parameters:
insertPathMarker(self, index: int, iTIndex: int, parameter: float, canPassOver: bool) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) –
  • iTIndex (int) –
  • parameter (float) –
  • canPassOver (bool) –
movePathMarker(self, pDisp: ORSModel.ors.View, index: int, pixelXPositionInView: int, pixelYPositionInView: int, canPassOver: bool) → None

–

Parameters:
none() → VisualPath

–

rebuildBezier(self, iTIndex: int) → None

–

Rebuilds the Bezier curve.

Parameters:
rebuildBezierForAllTimeStep(self) → None

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath
rebuildNonBezier(self, iTIndex: int) → None

–

Parameters:
rebuildNonBezierForAllTimeStep(self) → None

–

Parameters:self (ORSModel.ors.VisualPath) – an instance of VisualPath
removeAllPathMarkers(self, iTIndex: int) → None

–

Parameters:
removeAllPointsBetweenControlPoint(self, controlPointIndex1: int, controlPointIndex2: int, iTIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • controlPointIndex1 (int) –
  • controlPointIndex2 (int) –
  • iTIndex (int) –
removePathMarker(self, index: int, iTIndex: int) → None

–

Parameters:
reorderPathPointsForWinding(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, bCounterClockWise: bool) → None

–

Reorder the points of the path accordingly to the desired winding, for the given orientation.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • iTIndex (int) – the T index (an unsigned short)
  • aTransformationMatrix (ORSModel.ors.Matrix4x4) – the transformation matrix to apply to the points before performing the analysis in the xy plane
  • bCounterClockWise (bool) – if true, the points will be reordered to have a counter-clockwise winding; if false, the windinw will be clockwise.
resamplePath(self, numberOfTime: int, newPointsCount: int, iTIndex: int) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • numberOfTime (int) –
  • newPointsCount (int) –
  • iTIndex (int) –
setBezierSamplingLength(self, value: float) → None

–

Parameters:
setBuildOctree(self, value: bool) → None

–

Parameters:
setControlPointCount(self, aSize: int, iTIndex: int) → None

–

Sets the number of control points.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • aSize (int) – the control points count (an uint32_t)
  • iTIndex (int) – the T index (an unsigned short)
setControlPointCountForAllTimeStep(self, aSize: int) → None

–

Parameters:
setControlPointPositionsList(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pIndicesArray: ORSModel.ors.ArrayLong, pfPoints: ORSModel.ors.ArrayDouble) → None

–

Batch sets of given control point’s coordinates by indices.

Parameters:
setControlPointRadiusAtIndex(self, index: int, iTIndex: int, radius: float) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) –
  • iTIndex (int) –
  • radius (float) –
setControlPointRadiusAtIndexForAllTimeStep(self, index: int, radius: float) → None

–

Parameters:
setFirstUpVector(self, anIVector: ORSModel.ors.Vector3, iTIndex: int) → None

–

Parameters:
setHideLine(self, value: bool) → None

–

Parameters:
setIsBezier(self, value: bool) → None

–

Sets the path to follow a Bezier curve.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • value (bool) – TRUE to make it follow a Bezier curve, FALSE otherwise
setIsClosed(self, value: bool) → None

–

Sets the path to be closed or not.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • value (bool) – TRUE to close the path, FALSE otherwise
setIsToBeShownInCurvedView(self, flag: bool) → None

–

Parameters:
setPathMarkerCaption(self, index: int, iTIndex: int, caption: str) → None

–

Parameters:
setPathMarkerColor(self, index: int, iTIndex: int, IColor: ORSModel.ors.Color) → None

–

Parameters:
setPathMarkerPosition(self, index: int, iTIndex: int, parameter: float, canPassOver: bool) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) –
  • iTIndex (int) –
  • parameter (float) –
  • canPassOver (bool) –
setPathMarkerReferenceLineIsHightlighted(self, value: bool) → None

–

Parameters:
setPathMarkerReferenceLineOffsetForView(self, pView: ORSModel.ors.View, value: int) → None

–

Parameters:
setPathMarkerRegionID(self, index: int, iTIndex: int, regionID: int) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) –
  • iTIndex (int) –
  • regionID (int) –
setPathMarkerRegionMode(self, index: int, iTIndex: int, regionMode: int) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) –
  • iTIndex (int) –
  • regionMode (int) –
setPathMarkerScalar(self, index: int, scalarIndex: int, iTIndex: int, s: float) → None

–

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • index (int) –
  • scalarIndex (int) –
  • iTIndex (int) –
  • s (float) –
setPathMarkerScalarCount(self, s: int) → None

–

Parameters:
setPathMarkerVisible(self, index: int, iTIndex: int, s: bool) → None

–

Parameters:
setPointAtIndex(self, index: int, iTIndex: int, pPoint: ORSModel.ors.Vector3) → None

–

Sets a given point’s coordinates.

Parameters:
setPointAtIndexForAllTimeStep(self, index: int, pPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setPointPositionsList(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pnIndexes: ORSModel.ors.ArrayLong, pfPoints: ORSModel.ors.ArrayDouble) → None

–

Parameters:
setShowAllIn2D(self, value: bool) → None

–

Sets the Show All status of the path.

Parameters:
  • self (ORSModel.ors.VisualPath) – an instance of VisualPath
  • value (bool) – TRUE to set the path to be shown fully, FALSE otherwise
setShowPathMarkerReferenceLine(self, value: bool) → None

–

Parameters:

VisualPlane

class ORSModel.ors.VisualPlane(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.VisualShape2D

–

Parameters:
  • self (ORSModel.ors.VisualPlane) – an instance of VisualPlane
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualPlane.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualPlane) – an instance of VisualPlane

VisualPlane.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getEnabled(self) → bool

–

Parameters:self (ORSModel.ors.VisualPlane) – an instance of VisualPlane

:return : :rtype : bool

getIsClipping(self) → bool

–

Parameters:self (ORSModel.ors.VisualPlane) – an instance of VisualPlane

:return : :rtype : bool

getIsEditable(self) → bool

–

Parameters:self (ORSModel.ors.VisualPlane) – an instance of VisualPlane

:return : :rtype : bool

getOrientedPlane(self, iTIndex: int) → OrientedPlane

–

Parameters:
getShowBorder(self) → bool

–

Parameters:self (ORSModel.ors.VisualPlane) – an instance of VisualPlane

:return : :rtype : bool

none() → VisualPlane

–

setEnabled(self, pFlag: bool) → None

–

Parameters:
setIsClipping(self, pFlag: bool) → None

–

Parameters:
setIsEditable(self, pFlag: bool) → None

–

Parameters:
setOrientedPlane(self, aPlane: ORSModel.ors.OrientedPlane, iTIndex: int) → None

–

Parameters:
setShowBorder(self, pFlag: bool) → None

–

Parameters:

VisualPoints

class ORSModel.ors.VisualPoints(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Annotation

–

Parameters:
  • self (ORSModel.ors.VisualPoints) – an instance of VisualPoints
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualPoints.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualPoints) – an instance of VisualPoints

VisualPoints.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → VisualPoints

–

VisualROI

class ORSModel.ors.VisualROI(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Visual

–

Parameters:
  • self (ORSModel.ors.VisualROI) – an instance of VisualROI
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualROI.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

VisualROI.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
fillLookupTableWithLabelColors(self, IStructuredGrid: ORSModel.ors.MultiROI, IView: ORSModel.ors.View, pLUT: ORSModel.ors.LookupTable, labelOffset: int) → None

–

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getColorForAllViews(self) → Color

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI
getColorForView(self, IView: ORSModel.ors.View) → Color

–

Parameters:
getHighlightOpacityForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : float

getHighlightOpacityForView(self, IView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getHighlightOpacityOutRangeForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : float

getHighlightOpacityOutRangeForView(self, IView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getIsVisibleIn2DForAllViews(self) → bool

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : bool

getIsVisibleIn2DForView(self, IView: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getIsVisibleIn3DForAllViews(self) → bool

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : bool

getIsVisibleIn3DForView(self, IView: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getLabelColor(self, IStructuredGrid: ORSModel.ors.MultiROI, IView: ORSModel.ors.View, label: int) → Color

–

Parameters:
getPlaneChannelForGUID(self, aGUID: str, createIfAbsent: bool) → Channel

–

Parameters:
getROIOpacityForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : float

getROIOpacityForView(self, IView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getROIOpacityOutRangeForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : float

getROIOpacityOutRangeForView(self, IView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

getShowContourForAllViews(self) → bool

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : bool

getShowContourForView(self, IView: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

getVolumeOpacityForAllViews(self) → float

–

Parameters:self (ORSModel.ors.VisualROI) – an instance of VisualROI

:return : :rtype : float

getVolumeOpacityForView(self, IView: ORSModel.ors.View) → float

–

Parameters:

:return : :rtype : float

none() → VisualROI

–

presentInChannel(self, aChannel: ORSModel.ors.Channel, aView: ORSModel.ors.View) → None

–

Parameters:
presentInImage(self, anImage: ORSModel.ors.Image, aView: ORSModel.ors.View) → bool

–

Parameters:

:return : :rtype : bool

setColorForAllViews(self, color: ORSModel.ors.Color) → None

–

Parameters:
setColorForView(self, IView: ORSModel.ors.View, color: ORSModel.ors.Color) → None

–

Parameters:
setHighlightOpacityForAllViews(self, opacity: float) → None

–

Parameters:
setHighlightOpacityForView(self, IView: ORSModel.ors.View, opacity: float) → None

–

Parameters:
setHighlightOpacityOutRangeForAllViews(self, opacity: float) → None

–

Parameters:
setHighlightOpacityOutRangeForView(self, IView: ORSModel.ors.View, opacity: float) → None

–

Parameters:
setIsVisibleIn2DForAllViews(self, bValue: bool) → None

–

Parameters:
setIsVisibleIn2DForView(self, IView: ORSModel.ors.View, bValue: bool) → None

–

Parameters:
setIsVisibleIn3DForAllViews(self, bValue: bool) → None

–

Parameters:
setIsVisibleIn3DForView(self, IView: ORSModel.ors.View, bValue: bool) → None

–

Parameters:
setROIOpacityForAllViews(self, opacity: float) → None

–

Parameters:
setROIOpacityForView(self, IView: ORSModel.ors.View, opacity: float) → None

–

Parameters:
setROIOpacityOutRangeForAllViews(self, opacity: float) → None

–

Parameters:
setROIOpacityOutRangeForView(self, IView: ORSModel.ors.View, opacity: float) → None

–

Parameters:
setShowContourForAllViews(self, bValue: bool) → None

–

Parameters:
setShowContourForView(self, IView: ORSModel.ors.View, bValue: bool) → None

–

Parameters:
setVolumeOpacityForAllViews(self, opacity: float) → None

–

Parameters:
setVolumeOpacityForView(self, IView: ORSModel.ors.View, opacity: float) → None

–

Parameters:
updateChannel(self, aChannel: ORSModel.ors.Channel, aContourLabelChannel: ORSModel.ors.Channel, aContourChannel: ORSModel.ors.Channel, IView: ORSModel.ors.View, haveToDoAll: bool) → bool

–

Parameters:

:return : :rtype : bool

updateChannel2DForGUIDFromPlane(self, aGUID: str, aBplane: ORSModel.ors.Rectangle, currentTimeStep: int, haveToDoAll: bool) → bool

–

Parameters:

:return : :rtype : bool

VisualRegion

class ORSModel.ors.VisualRegion

Bases: ORSModel.ors.Annotation

brief_description: Represents a user-selected 2D region of a view. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2006 see: View Represents a user-selected 2D region of a view.

VisualRegion.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualRegion.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualRegion) – an instance of VisualRegion

VisualRegion.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addRegionIn3DInOrthoToROI(self, outputROI: ORSModel.ors.ROI, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, inside: bool, currentTimeStep: int, IProgress: ORSModel.ors.Progress) → None

–

Parameters:
addRegionIn3DPerspectiveProjectionToROIIntersectingChannel(self, pCamera: ORSModel.ors.Camera, inside: bool, outputROI: ORSModel.ors.ROI, currentTimeStep: int, intersectingChannel: ORSModel.ors.Channel, levelingMinRange: float, levelingMaxRange: float, ILUT: ORSModel.ors.LookupTable, clipBox: ORSModel.ors.Box) → None

–

Parameters:
addRegionIn3DPerspectiveProjectionToROIIntersectingLabeldMultiROI(self, pCamera: ORSModel.ors.Camera, inside: bool, outputROI: ORSModel.ors.ROI, currentTimeStep: int, intersectingMultiROI: ORSModel.ors.MultiROI, fHightlightOpacity: float, fHightlightOpacityOutRange: float, clipBox: ORSModel.ors.Box) → None

–

Parameters:
addRegionIn3DPerspectiveProjectionToROIIntersectingROI(self, pCamera: ORSModel.ors.Camera, inside: bool, outputROI: ORSModel.ors.ROI, currentTimeStep: int, intersectingROI: ORSModel.ors.ROI, clipBox: ORSModel.ors.Box) → None

–

Parameters:
fitFromPoints(self, count: int, points: float, iTIndex: int) → None

–

Gets the primitive to fit itself to a list of points.

Parameters:
  • self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
  • count (int) – the number of triplets supplied (an uint32_t) (see note below)
  • points (float) – an array of points to fit to (a float*)
  • iTIndex (int) –
getArea(self, timeStep: int, worldTransform: ORSModel.ors.Matrix4x4) → float

–

Parameters:

:return : :rtype : float

getClassNameStatic() → str

–

:return : :rtype : str

getHistogramData(self, aChannel: ORSModel.ors.Channel, currentTimeStep: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, inside: bool, numberOfBins: int) → HistogramData

–

Gets a histogram of the region’s data.

Parameters:
  • self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
  • aChannel (ORSModel.ors.Channel) – the channel to use for the data (a Channel)
  • currentTimeStep (int) – the time step (an unsigned int)
  • aWorldTransformMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (a Matrix4x4)
  • inside (bool) – true to use the inside of the region, false to use the outside
  • numberOfBins (int) – the number of desired bins (an unsigned short)
getIsOn3DView(self) → bool

–

Parameters:self (ORSModel.ors.VisualRegion) – an instance of VisualRegion

:return : :rtype : bool

getPerimeter(self, timeStep: int, worldTransform: ORSModel.ors.Matrix4x4) → float

–

Parameters:

:return : :rtype : float

getShape(self) → int

–

Gets the shape of the region.

Parameters:self (ORSModel.ors.VisualRegion) – an instance of VisualRegion

:return : :rtype : int

insertControlPointForAllTimeStep(self, pPoint: ORSModel.ors.Vector3) → None

–

Parameters:
none() → VisualRegion

–

setControlPoints(self, pfPoints: ORSModel.ors.ArrayDouble, iTIndex: int) → None

–

Sets the points of the region.

Parameters:
setIsOn3DView(self, value: bool) → None

–

Insert a point to the region between the two nearest existing points.

Parameters:
setPlane(self, a: float, b: float, c: float, d: float, iTIndex: int) → None

–

Sets the plane coefficient.

Parameters:
  • self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
  • a (float) – the a member (a float)
  • b (float) – the b member (a float)
  • c (float) – the c member (a float)
  • d (float) – the d member (a float)
  • iTIndex (int) –
setShape(self, shape: int) → None

–

Sets the shape of the region.

Parameters:

VisualRuler

class ORSModel.ors.VisualRuler

Bases: ORSModel.ors.Annotation

brief_description: Represents a ruler, used to take measures. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Aug 2006

VisualRuler.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualRuler) – an instance of VisualRuler
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualRuler.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualRuler) – an instance of VisualRuler

VisualRuler.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getLength(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → float

–

Gets the length value of the ruler.

Parameters:

:return : :rtype : float

getShowTicks(self) → bool

–

Gets the display status of the ruler’s ticks.

Parameters:self (ORSModel.ors.VisualRuler) – an instance of VisualRuler

:return : :rtype : bool

getTickCount(self) → int

–

Gets the number of visible ticks on the ruler.

Parameters:self (ORSModel.ors.VisualRuler) – an instance of VisualRuler

:return : :rtype : int

none() → VisualRuler

–

setShowTicks(self, value: bool) → None

–

Sets the display of the ruler’s ticks.

Parameters:
  • self (ORSModel.ors.VisualRuler) – an instance of VisualRuler
  • value (bool) – true to show the ruler’s ticks, false to hide them
setTickCount(self, value: int) → None

–

Sets the number of visible ticks on the ruler.

Parameters:

VisualScaleBar

class ORSModel.ors.VisualScaleBar(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Visual

–

Parameters:
  • self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualScaleBar.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

VisualScaleBar.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getAutoAdjustFloatingLength(self) → bool

–

Gets if the scalebar auto-adjusts or not.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getColor(self) → Color

–

Gets the scale bar color.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
getDrawTextShadow(self) → bool

–

Gets if the scale bar is showing text shadow.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : bool

getFloatingLength(self) → float

–

Gets the scalebar’s length when floating.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : float

getIsFloating(self) → bool

–

Gets if the scalebar is floating.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : bool

getPrecision(self) → int

–

Gets the length precision.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : int

getScaleBarPositionInView(self, pView: ORSModel.ors.View) → Vector3

–

Parameters:
getTextColor(self) → Color

–

Gets the text color of the scale bar.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
getTextFontName(self) → str

–

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : str

getTextFontSize(self) → float

–

Gets the font size, in screen one thousandths.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : float

getTextMinimumFontSize(self) → int

–

Gets the minimum text font size, in font points.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

:return : :rtype : int

getTextShadowColor(self) → Color

–

Gets the text shadow color of the scale bar.

Parameters:self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
none() → VisualScaleBar

–

setAutoAdjustFloatingLength(self, value: bool) → None

–

Sets if the scalebar auto-adjusts or not.

Parameters:
  • self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
  • value (bool) – TRUE to have the scale bar auto-adjust, FALSE otherwise
setColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the scale bar color.

Parameters:
setDrawTextShadow(self, bFlag: bool) → None

–

Toggles displaying shadows for the text.

Parameters:
setFloatingLength(self, floatLength: float) → None

–

Sets the scalebar’s length when floating.

Parameters:
setIsFloating(self, value: bool) → None

–

Sets the scalebar to be floating or not.

Parameters:
  • self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
  • value (bool) – TRUE so set the scale bar to be floating, FALSE to be normal
setPrecision(self, iPrecision: int) → None

–

Sets the length precision.

Parameters:
setScaleBarPositionInView(self, pView: ORSModel.ors.View, aPoint: ORSModel.ors.Vector3) → None

–

Parameters:
setTextColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the text color of the scale bar.

Parameters:
setTextFontName(self, sFontName: str) → None

–

Sets the font name.

Parameters:
setTextFontSize(self, fontSize: float) → None

–

Sets the font size, in screen one thousandths.

Parameters:
setTextMinimumFontSize(self, fontSize: int) → None

–

Sets the minimum font size, in font points.

Parameters:
setTextShadowColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the text shadow color of the scale bar.

Parameters:

VisualShape

class ORSModel.ors.VisualShape(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.Visual

–

Parameters:
  • self (ORSModel.ors.VisualShape) – an instance of VisualShape
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualShape.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualShape) – an instance of VisualShape

VisualShape.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
addAffectedVisual(self, pObject: ORSModel.ors.Managed) → None

–

Parameters:
getAffectedVisualsGUID(self) → str

–

Parameters:self (ORSModel.ors.VisualShape) – an instance of VisualShape

:return : :rtype : str

getClassNameStatic() → str

–

:return : :rtype : str

getColor(self) → Color

–

Parameters:self (ORSModel.ors.VisualShape) – an instance of VisualShape
getHighlightedAnchor(self, anchorIndex: int, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getHighlightedAnchorCount(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : unsigned int

getHighlightedBorder(self, borderIndex: int, iTIndex: int) → bool

–

Parameters:

:return : :rtype : bool

getHighlightedBorderCount(self, iTIndex: int) → int

–

Parameters:

:return : :rtype : unsigned int

getIsInverted(self) → bool

–

Parameters:self (ORSModel.ors.VisualShape) – an instance of VisualShape

:return : :rtype : bool

getSelectedColor(self) → Color

–

Gets the selected color of the shape.

Parameters:self (ORSModel.ors.VisualShape) – an instance of VisualShape
getShaderCode(self, aView: ORSModel.ors.View, raycastElementId: int, outputElementId: int) → str

–

get the evaluated shader code (in glsl)

Parameters:

:return : :rtype : str

getShape(self, timestep: int) → Shape

–

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

–

Parameters:

:return : :rtype : bool

getShapeIndex(self) → int

–

Parameters:self (ORSModel.ors.VisualShape) – an instance of VisualShape

:return : :rtype : int

none() → VisualShape

–

pickAnchor(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int

–

Parameters:

:return : :rtype : int

pickBorder(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int

–

Parameters:

:return : :rtype : int

pickSpecificBorder(self, pView: ORSModel.ors.View, borderIndex: int, xPixelPositionInView: int, yPixelPositionInView: int) → bool

–

Parameters:

:return : :rtype : bool

removeAffectedVisual(self, pObject: ORSModel.ors.Managed) → None

–

Parameters:
setAffectedVisualsGUID(self, guids: str) → None

–

Parameters:
setColor(self, color: ORSModel.ors.Color) → None

–

Parameters:
setHighlightedAnchor(self, anchorIndex: int, iTIndex: int) → None

–

Parameters:
setHighlightedBorder(self, borderIndex: int, iTIndex: int) → None

–

Parameters:
setIsInverted(self, bIsInverted: bool) → None

–

Parameters:
setSelectedColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the selected color of the shape.

Parameters:
setShape(self, aShape: ORSModel.ors.Shape, timestep: int) → None

–

Parameters:
setShapeIndex(self, iIndex: int) → None

–

Parameters:
unHighlightAllAnchor(self, iTIndex: int) → None

–

Parameters:
unHighlightAllBorder(self, iTIndex: int) → None

–

Parameters:

VisualShape2D

class ORSModel.ors.VisualShape2D

Bases: ORSModel.ors.VisualShape

brief_description: None author: Mathieu Gendron. All other members of ORS participated. version: 1.0 date: November 2017

VisualShape2D.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualShape2D) – an instance of VisualShape2D
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualShape2D.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualShape2D) – an instance of VisualShape2D

VisualShape2D.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → VisualShape2D

–

VisualShape3D

class ORSModel.ors.VisualShape3D

Bases: ORSModel.ors.VisualShape

brief_description: None author: Mathieu Gendron. All other members of ORS participated. version: 1.0 date: November 2017

VisualShape3D.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualShape3D) – an instance of VisualShape3D
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualShape3D.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualShape3D) – an instance of VisualShape3D

VisualShape3D.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → VisualShape3D

–

VisualSphere

class ORSModel.ors.VisualSphere(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → None

Bases: ORSModel.ors.VisualShape3D

–

Parameters:
  • self (ORSModel.ors.VisualSphere) – an instance of VisualSphere
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualSphere.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualSphere) – an instance of VisualSphere

VisualSphere.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getSphere(self, iTIndex: int) → Sphere

–

Parameters:
none() → VisualSphere

–

setSphere(self, aSphere: ORSModel.ors.Sphere, iTIndex: int) → None

–

Parameters:

VisualText

class ORSModel.ors.VisualText

Bases: ORSModel.ors.Visual

brief_description: To display text on the renderer. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

VisualText.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:
  • self (ORSModel.ors.VisualText) – an instance of VisualText
  • buffer (bytes) –
  • nBytes (int) –
  • bPreserveIdentity (bool) –

VisualText.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

VisualText.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getDrawShadow(self) → bool

–

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : bool

getHorizontalAlignment(self) → int

–

Gets the horizontal alignment of the item.

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : int

getIsOriginAtTop(self) → bool

–

Gets whether or not the text is top-aligned.

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : bool

getText(self) → str

–

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : str

getTextColor(self) → Color

–

Gets the text color of the item.

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText
getTextFontName(self) → str

–

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : str

getTextFontSize(self) → float

–

Gets the text font size, in screen one thousandths.

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : float

getTextMinimumFontSize(self) → int

–

Gets the minimum text font size, in font points.

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : int

getTextShadowColor(self) → Color

–

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText
getType(self) → str

–

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : str

getU(self) → float

–

Gets the U coordinate of the item.

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : float

getV(self) → float

–

Gets the V coordinate of the item.

Parameters:self (ORSModel.ors.VisualText) – an instance of VisualText

:return : :rtype : float

none() → VisualText

–

setDrawShadow(self, bFlag: bool) → None

–

Parameters:
setHorizontalAlignment(self, pValue: int) → None

–

Sets the horizontal item alignment.

Parameters:
  • self (ORSModel.ors.VisualText) – an instance of VisualText
  • pValue (int) – 0 if the text is to be left-aligned, 1 for center-aligned or 2 for right-aligned
setIsOriginAtTop(self, pValue: bool) → None

–

Sets whether or not the text is top-aligned.

Parameters:
  • self (ORSModel.ors.VisualText) – an instance of VisualText
  • pValue (bool) – TRUE if the text is to be top-aligned, FALSE otherwise
setText(self, sText: str) → None

–

Sets the text of the item.

Parameters:
setTextColor(self, IColor: ORSModel.ors.Color) → None

–

Sets the text color of the item.

Parameters:
setTextFontName(self, sName: str) → None

–

Sets the text font name of the item.

Parameters:
setTextFontSize(self, iValue: float) → None

–

Sets the text font size, in screen one thousandths.

Parameters:
  • self (ORSModel.ors.VisualText) – an instance of VisualText
  • iValue (float) – the size (a double between 0 and 1)
setTextMinimumFontSize(self, fontSize: int) → None

–

Sets the minimum font size, in font points.

Parameters:
setTextShadowColor(self, IColor: ORSModel.ors.Color) → None

–

Parameters:
setType(self, aType: str) → None

–

Parameters:
setU(self, fValue: float) → None

–

Sets the U coordinate of the item.

Parameters:
setV(self, fValue: float) → None

–

Sets the V coordinate of the item.

Parameters:

VisualVectorField

class ORSModel.ors.VisualVectorField

Bases: ORSModel.ors.Visual

brief_description: A visual that represents a author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: Dec 2017 A visual that represents a VisualVectorField.

VisualVectorField.__init__(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> None –

Parameters:

VisualVectorField.__init__(self) -> None –

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

VisualVectorField.__init__(self, rhs: ORSModel.ors.Managed) -> None –

Parameters:
getBuildOctree(self) → bool

–

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

:return : :rtype : bool

getClassNameStatic() → str

–

:return : :rtype : str

getCurrentAlphaFuncValue(self) → int

–

Sets the transparency of the mesh.

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

:return : :rtype : int

getOpacity(self) → float

–

Gets the opacity of the mesh.

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

:return : :rtype : float

getOpacityOutRange(self) → float

–

Gets the opacity for unselected area of the mesh.

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

:return : :rtype : float

getRenderingColor(self) → Color

–

Gets the rendering color of the vector field.

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
getShowIn2DDuringMotion(self) → bool

–

Gets the visibility of the mesh in 2D views during mouse motion.

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

:return : :rtype : bool

getThickness(self) → float

–

Gets the thickness of lines in 2D mode.

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

:return : :rtype : float

getUseLighting(self) → bool

–

Gets the mesh lighting mode.

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

:return : :rtype : bool

getVectorTransform(self) → Matrix4x4

–

Parameters:self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
none() → VisualVectorField

–

setBuildOctree(self, value: bool) → None

–

Parameters:
setOpacity(self, value: float) → None

–

Sets the opacity for unselected range of the mesh.

Parameters:
setOpacityOutRange(self, value: float) → None

–

Sets the opacity of the mesh.

Parameters:
setRenderingColor(self, aColor: ORSModel.ors.Color) → None

–

set rendering color

Parameters:
setShowColorIn2D(self, value: bool) → None

–

Parameters:
setThickness(self, value: float) → None

–

Sets the thickness of lines in 2D mode.

Parameters:
setUseLighting(self, useLighting: bool) → None

–

Sets the mesh lighting mode.

Parameters:
setVectorTransform(self, aMatrix: ORSModel.ors.Matrix4x4) → None

–

Parameters:

Watershed

class ORSModel.ors.Watershed(self) → None

Bases: ORSModel.ors.Unmanaged

–

Parameters:self (ORSModel.ors.Watershed) – an instance of Watershed

Watershed.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
compute(self, watershedDistance: ORSModel.ors.Channel, lOutputChannelLabel: ORSModel.ors.Channel) → None

–

Creates a distance map starting from all the providedROI sources.

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

getNeighborCount(self) → int

–

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

Parameters:self (ORSModel.ors.Watershed) – an instance of Watershed

:return : :rtype : int

getROICount(self) → int

–

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

Parameters:self (ORSModel.ors.Watershed) – an instance of Watershed

:return : :rtype : int

getVolumeROI(self, index: int) → ROI

–

Retrieves a particularROI from the index specified slot.

Parameters:
  • self (ORSModel.ors.Watershed) – an instance of Watershed
  • index (int) – the slot index (an unsigned char)
none() → Watershed

–

resetVolumeROIs(self) → None

–

Empties all the sourceROI slots.

Parameters:self (ORSModel.ors.Watershed) – an instance of Watershed
setInputChannelAndWorkingArea(self, inputChannel: ORSModel.ors.Channel, minX: int, minY: int, minZ: int, maxX: int, maxY: int, maxZ: int, currentT: int) → None

–

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

Parameters:
  • self (ORSModel.ors.Watershed) – an instance of Watershed
  • inputChannel (ORSModel.ors.Channel) – the input channel (an Channel)
  • minX (int) – the minimum X index in the input channel (an unsigned short)
  • minY (int) – the minimum Y index in the input channel (an unsigned short)
  • minZ (int) – the minimum Z index in the input channel (an unsigned short)
  • maxX (int) – the maximum X index in the input channel (an unsigned short)
  • maxY (int) – the maximum Y index in the input channel (an unsigned short)
  • maxZ (int) – the maximum Z index in the input channel (an unsigned short)
  • currentT (int) –
setInputLabelsChannel(self, aInputLabelsChannel: ORSModel.ors.Channel) → None

–

Parameters:
setInputMultiROI(self, anInputMultiROI: ORSModel.ors.MultiROI) → None

–

Parameters:
setMaskROI(self, IMaskROI: ORSModel.ors.ROI) → None

–

Parameters:
setNeighborCountTo18(self) → None

–

Sets the number of neighbors used by theDijkstra algorithm to 18 ( Neighbor distance <= sqrt(2)).

Parameters:self (ORSModel.ors.Watershed) – an instance of Watershed
setNeighborCountTo26(self) → None

–

Sets the number of neighbors used by theDijkstra algorithm to 18 ( Neighbor distance <= sqrt(2)).

Parameters:self (ORSModel.ors.Watershed) – an instance of Watershed
setNeighborCountTo6(self) → None

–

Sets the number of neighbors used by theDijkstra algorithm to 18 ( Neighbor distance <= sqrt(2)).

Parameters:self (ORSModel.ors.Watershed) – an instance of Watershed
setProgressObject(self, IProgress: ORSModel.ors.Progress) → None

–

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

–

Fills a particularROI slot to be used as a source for the Dijkstra algorithm.

Parameters:
  • self (ORSModel.ors.Watershed) – an instance of Watershed
  • index (int) – the slot index (an unsigned short)
  • aVolROI (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI)

WatershedOnGrid

class ORSModel.ors.WatershedOnGrid(self) → None

Bases: ORSModel.ors.Watershed

–

Parameters:self (ORSModel.ors.WatershedOnGrid) – an instance of WatershedOnGrid

WatershedOnGrid.__init__(self, rhs: ORSModel.ors.Unmanaged) -> None –

Parameters:
getClassNameStatic() → str

–

:return : :rtype : str

none() → WatershedOnGrid

–

setGridSize(self, xSize: int, ySize: int, zSize: int) → None

–

Parameters:

Alternative constructors

Subclasses of Unmanaged

ORSModel.__init__.orsColor(r=0, g=0, b=0, a=0)
ORSModel.__init__.orsVect(x=0, y=0, z=0)
ORSModel.__init__.orsRect(origin, dir0, dir0Length, dir0Spacing, dir1, dir1Length, dir1Spacing)
ORSModel.__init__.orsKernel(sizeX, sizeY, sizeZ, *arg)
ORSModel.__init__.orsBox(origin, dir0, dir0Length, dir0Spacing, dir1, dir1Length, dir1Spacing, dir2, dir2Length, dir2Spacing)
ORSModel.__init__.orsPlane(a, b, c, d)
ORSModel.__init__.orsMatrix(v00, v01, v02, v03, v10, v11, v12, v13, v20, v21, v22, v23, v30, v31, v32, v33)
ORSModel.__init__.orsCamera(dir, pos, up, pivot, vHeight, vWidth, vTopLefX, vTopLeftY, vNear, vFar, useOrtho, orthoZoom, focalLength, depthOfField, angleOfView, normalizationTranslationMatix, normalizationRotationMatix, normalizationScaleMatix)
ORSModel.__init__.orsOrientedPlane(a, b, c, d, center, up)
ORSModel.__init__.orsLine(origin, orientation)
ORSModel.__init__.orsLineSegment(start, end)

orsObj

ORSModel.__init__.orsObj(guid)