ORSModel ¶

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

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

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

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

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

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

Adds a control point.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation pPoint (ORSModel.ors.Vector3) – a point (an Vector3) iTIndex (int) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –

Note

Any change to a annotation should be followed by update() to reflect the changes visually.

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation pPoint (ORSModel.ors.Vector3) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –

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

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

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

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

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation aTransformationMatrix (ORSModel.ors.Matrix4x4) – iTIndex (int) –

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

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

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation aControlPointCollection (ORSModel.ors.OrderedCollectionDouble) – iTIndex (int) –

duplicateTimeStepDataAcrossAllTimeSteps(self, iTIndex: int) → None¶

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

get3DThickness(self) → float¶

Gets the thickness of lines in 3D mode.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (float) – the thickness, in screen proportion (a double between 0 and 1)

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) – worldTransform (ORSModel.ors.Matrix4x4) – pOutputROI (ORSModel.ors.ROI) –

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation worldTransform (ORSModel.ors.Matrix4x4) – pOutputROI (ORSModel.ors.ROI) –

getAutoCaption(self) → bool¶

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

getCaption(self) → str¶

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

getCaptionTextFontName(self) → str¶

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

getCaptionTextFontSize(self) → float¶

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (float) – the font size (a double between 0 and 1)

getCaptionTextMinimumFontSize(self) → int¶

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (int) – the font size

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

Gets the World centroid of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) – worldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Vector3) – The centroid vector

getClassNameStatic() → str¶

Returns:	output (str) –

getControlPointAppearance(self) → int¶

Gets the control point appearance.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (int) – The appearance (an int) 0:Circle 1:Square 2:Triangle 3:+ 4:x

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation index (int) – iTIndex (int) –
Returns:	output (str) –

getControlPointCount(self, iTIndex: int) → int¶

Gets the number of control points for a given T.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) – the T index (a uint16_t)
Returns:	output (int) – the number of control points (an uint32_t)

Note

Control point indicies are zero based.

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation index (int) – iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Vector3) –

getControlPoints(self, iTIndex: int) → OrderedCollectionDouble¶

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) –
Returns:	output (ORSModel.ors.OrderedCollectionDouble) –

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
Returns:	output (ORSModel.ors.OrientedPlane) – an Oriented Plane (an OrientedPlane)

getCreationOrientedPlaneInView(self, aView: ORSModel.ors.View) → OrientedPlane¶

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation aView (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.OrientedPlane) –

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:	self (ORSModel.ors.Annotation) – an instance of Annotation aStartPoint (ORSModel.ors.Vector3) – the start and end point (Vector3) aEndPoint (ORSModel.ors.Vector3) – the t index (a uint16_t) iTIndex (int) – a transformation matrix (a Matrix4x4) aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (float) – the distance (a double)

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

Gets the distance between this priannotationmitive and a givenPlane.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation aPlane (ORSModel.ors.Plane) – the a b c and d plane parameter (doubles) iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (float) – the distance (a double)

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

Gets the distance between this annotation and a given Point.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation aPoint (ORSModel.ors.Vector3) – a point (a Vector3) iTIndex (int) – the T index (a uint16_t) aTransformationMatrix (ORSModel.ors.Matrix4x4) – an optional transformation matrix (a Matrix4x4)
Returns:	output (float) – the distance (a double)

getDrawTextShadow(self) → bool¶

Gets the view text shadows status.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (bool) – true if text shadows are visible, false otherwise

getHighlightControlPointColor(self) → Color¶

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

getHighlightedControlPointsArray(self, iTIndex: int) → OrderedCollectionUnsignedLong¶

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) –
Returns:	output (ORSModel.ors.OrderedCollectionUnsignedLong) –

getHighlightedControlPointsCount(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) –
Returns:	output (int) –

getIsEditable(self) → bool¶

Sees if the annotation is editable or not.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (bool) – true if the annotation is editable, false otherwise

Note

Non editable annotations appear to be “locked”, i.e. they do not react to user modifications.

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

Indicates if the primitive intersects with a box.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation box (ORSModel.ors.Box) – iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (bool) –

getNormalColor(self) → Color¶

Gets the normal color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (ORSModel.ors.Color) – the color (a Color)

Note

Because annotations can switch from normal to selected colors, you can store them within the annotation, and switch from one to the other with setToNormalColor() and setToSelectedColor().

getProjectionIn(self, worldTransform: ORSModel.ors.Matrix4x4) → Annotation¶

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation worldTransform (ORSModel.ors.Matrix4x4) – the channel in which to project (a Channel)
Returns:	output (ORSModel.ors.Annotation) – a new annotation (an Annotation)

getSelectedColor(self) → Color¶

Gets the selected color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (ORSModel.ors.Color) – the color (a Color)

Note

Because annotations can switch from normal to selected colors, you can store them within the annotation, and switch from one to the other with setToNormalColor() and setToSelectedColor().

getSelectedControlPointArray(self, iTIndex: int) → OrderedCollectionUnsignedLong¶

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) –
Returns:	output (ORSModel.ors.OrderedCollectionUnsignedLong) –

getSelectedControlPointColor(self) → Color¶

Gets the control point selected color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (ORSModel.ors.Color) – the color (a Color)

getSelectedControlPointCount(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation iTIndex (int) –
Returns:	output (int) –

getShow3DIn2D(self) → bool¶

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

getShowCaption(self) → bool¶

get the view status of the annotation caption.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (bool) – true if caption are displayed, false otherwise

getShowControlPoints(self) → bool¶

Sees if control points are visible.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (bool) – true if control points are visible, false otherwise

getTextColor(self) → Color¶

Gets the text color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (ORSModel.ors.Color) – the color (a Color)

Note

The text color is used for the caption.

getTextShadowColor(self) → Color¶

Gets the text shadow color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (ORSModel.ors.Color) – the color (a Color)

getThickness(self) → float¶

Gets the thickness of lines in 2D mode.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation
Returns:	output (float) – the thickness, in screen proportion (a double between 0 and 1)

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

Insert a control point.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation index (int) – a point (an Vector3) pPoint (ORSModel.ors.Vector3) – iTIndex (int) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –

Note

Any change to a annotation should be followed by update() to reflect the changes visually.

none()¶

Annotation.Annotation() -> Annotation

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

removeAllControlPoints(self, iTIndex: int) → None¶

Removes all control points.

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

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

Note

Control point indicies are zero based.

removeControlPointForAllTimeStep(self, index: int) → None¶

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

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

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

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

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

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:	self (ORSModel.ors.Annotation) – an instance of Annotation aValue (bool) –

setCaption(self, text: str) → None¶

Sets the caption of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation text (str) – a caption (a string)

Note

Any modification to annotation properties must be followed by an update() to be shown on the view.

setCaptionTextFontName(self, sFontName: str) → None¶

Sets the font name of text captions.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation sFontName (str) – the font name (a string)

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:	self (ORSModel.ors.Annotation) – an instance of Annotation fontSize (int) – the font size

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:	self (ORSModel.ors.Annotation) – an instance of Annotation index (int) – iTIndex (int) – anIVector (ORSModel.ors.Vector3) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –

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

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation index (int) – anIVector (ORSModel.ors.Vector3) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –

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

Set the oriented plane on which the annotation is created.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation anOrientedPlane (ORSModel.ors.OrientedPlane) – an Oriented Plane (an anOrientedPlanePtr)

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

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

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:	self (ORSModel.ors.Annotation) – an instance of Annotation IColor (ORSModel.ors.Color) –

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

Note

Non editable annotations appear to be “locked”, i.e. they do not react to user modifications.

setNormalColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the normal color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation IColor (ORSModel.ors.Color) – the color (an Color)

Note

Because annotations can switch from normal to selected colors, you can store them within the annotation, and switch from one to the other with setToNormalColor() and setToSelectedColor().

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

Sets the selected color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation IColor (ORSModel.ors.Color) – the color (a Color)

Note

Because annotations can switch from normal to selected colors, you can store them within the annotation, and switch from one to the other with setToNormalColor() and setToSelectedColor().

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

Sets the control point selected color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation IColor (ORSModel.ors.Color) – the color (a Color)

setShow3DIn2D(self, nValue: bool) → None¶

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

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

Note

Any modification to annotation properties must be followed by an update() to be shown on the view.

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

Note

Any modification to annotation properties must be followed by an update() to be shown on the view.

setTextColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the text color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation IColor (ORSModel.ors.Color) – the color (a Color)

Note

The text color is used for the caption.

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

Sets the text shadow color of the annotation.

Parameters:	self (ORSModel.ors.Annotation) – an instance of Annotation IColor (ORSModel.ors.Color) – the color (a Color)

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.Array(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> Array

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

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

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

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

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)

Note

The array will grow to accommodate the copied data, if required.

copyFromNumpyArray()¶

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)

Note

The memory buffer needs to be big enough to accommodate the input.

getClassNameStatic() → str¶

Returns:	output (str) –

getNDArray()¶

getNumpyArrayCopy()¶

getOffsetBitAnd(self) → int¶

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

getOffsetBitShift(self) → int¶

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

getPacketCount(self) → int¶

Gets the number of packets currently in the array.

Parameters:	self (ORSModel.ors.Array) – an instance of Array
Returns:	output (int) – the packet count (an uint32_t)

Note

Arrays are composed of packets, this method return the number of packets.

getPacketSize(self) → int¶

Gets the packet size used by the array.

Parameters:	self (ORSModel.ors.Array) – an instance of Array
Returns:	output (int) – the packet size (an uint32_t)

Note

Arrays are composed of packets, this method return the packet size used. The packet size represents the number of items in the packet, not the byte size.

none()¶

Array.Array() -> Array

Parameters:	self (ORSModel.ors.Array) – an instance of 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)

Note

This should be the first method invoked after instantiating the array. If the array has been used (items added/deleted) then this method can be costly if the array has many elements, as changing the internal storage implies that the data can co-exist momentarily.

Note

Arrays are composed of packets, this method controls the packet size used. Default values are 64 and 64.

ArrayChar¶

class ORSModel.ors.ArrayChar¶

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

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

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

ArrayChar.ArrayChar(self) -> ArrayChar

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

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

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

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

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

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)
Returns:	output (int) – the value (a signed char)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

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)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (a signed short)

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)
Returns:	output (int) – the smallest value found (a signed short)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayChar) – an instance of ArrayChar pValue (int) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayChar.ArrayChar() -> ArrayChar

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

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¶

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

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

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

ArrayDouble.ArrayDouble(self) -> ArrayDouble

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

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

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

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

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

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)
Returns:	output (float) – the value (a double)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

findFirst(self, pValue: float) → int¶

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

Parameters:	self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble pValue (float) – the value to search for (a double)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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.ArrayDouble) – an instance of ArrayDouble pValue (float) – the value to search for (a double)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (float) – the largest value found (a double)

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)
Returns:	output (float) – the smallest value found (a double)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: float) → int¶

Parameters:	self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble pValue (float) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayDouble.ArrayDouble() -> ArrayDouble

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: float) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayDouble) – an instance of ArrayDouble iValue (float) – the value to set (a double)

ArrayFloat¶

class ORSModel.ors.ArrayFloat¶

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

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

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

ArrayFloat.ArrayFloat(self) -> ArrayFloat

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

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

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

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

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

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)
Returns:	output (float) – the value (a 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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

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)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (float) – the largest value found (a 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)
Returns:	output (float) – the smallest value found (a 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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: float) → int¶

Parameters:	self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat pValue (float) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayFloat.ArrayFloat() -> ArrayFloat

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: float) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayFloat) – an instance of ArrayFloat iValue (float) – the value to set (a float)

ArrayLONGLONG¶

class ORSModel.ors.ArrayLONGLONG¶

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

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

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

ArrayLONGLONG.ArrayLONGLONG(self) -> ArrayLONGLONG

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

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

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

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

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

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)
Returns:	output (int) – the value (a int64_t)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

findFirst(self, pValue: int) → int¶

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

Parameters:	self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG pValue (int) – the value to search for (a int64_t)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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.ArrayLONGLONG) – an instance of ArrayLONGLONG pValue (int) – the value to search for (a int64_t)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (a int64_t)

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)
Returns:	output (int) – the smallest value found (a int64_t)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG pValue (int) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayLONGLONG.ArrayLONGLONG() -> ArrayLONGLONG

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: int) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayLONGLONG) – an instance of ArrayLONGLONG iValue (int) – the value to set (a int64_t)

ArrayLong¶

class ORSModel.ors.ArrayLong¶

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

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

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

ArrayLong.ArrayLong(self) -> ArrayLong

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

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

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

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

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

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)
Returns:	output (int) – the value (a int32_t)

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*)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

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*)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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*)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (a int32_t)

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)
Returns:	output (int) – the smallest value found (a int32_t)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayLong) – an instance of ArrayLong pValue (int) –
Returns:	output (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*)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayLong.ArrayLong() -> ArrayLong

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: int) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayLong) – an instance of ArrayLong iValue (int) – the value to set (a int32_t*)

ArrayShort¶

class ORSModel.ors.ArrayShort¶

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

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

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

ArrayShort.ArrayShort(self) -> ArrayShort

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

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

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

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

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

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)
Returns:	output (int) – the value (a short)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

findFirst(self, pValue: int) → int¶

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

Parameters:	self (ORSModel.ors.ArrayShort) – an instance of ArrayShort pValue (int) – the value to search for (a short)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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.ArrayShort) – an instance of ArrayShort pValue (int) – the value to search for (a short)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (a signed short)

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)
Returns:	output (int) – the smallest value found (a signed short)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayShort) – an instance of ArrayShort pValue (int) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayShort.ArrayShort() -> ArrayShort

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: int) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayShort) – an instance of ArrayShort iValue (int) – the value to set (a short)

ArrayUnsignedChar¶

class ORSModel.ors.ArrayUnsignedChar¶

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

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

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

ArrayUnsignedChar.ArrayUnsignedChar(self) -> ArrayUnsignedChar

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

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

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

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

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

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)
Returns:	output (int) – the value (an char)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

findFirst(self, pValue: int) → int¶

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

Parameters:	self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar pValue (int) – the value to search for (an unsigned char)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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.ArrayUnsignedChar) – an instance of ArrayUnsignedChar pValue (int) – the value to search for (an unsigned char)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (an short)

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)
Returns:	output (int) – the smallest value found (an short)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar pValue (int) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayUnsignedChar.ArrayUnsignedChar() -> ArrayUnsignedChar

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: int) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayUnsignedChar) – an instance of ArrayUnsignedChar iValue (int) – the value to set (an unsigned char)

ArrayUnsignedLONGLONG¶

class ORSModel.ors.ArrayUnsignedLONGLONG¶

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

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

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

ArrayUnsignedLONGLONG.ArrayUnsignedLONGLONG(self) -> ArrayUnsignedLONGLONG

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

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

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

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

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

at(self, index: int) → int¶

Retrieves a single value from the array.

Parameters:	self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG index (int) – the index of the item to retrieve (an uint64_t, zero based)
Returns:	output (int) – the value (a uint64_t)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

findFirst(self, pValue: int) → int¶

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

Parameters:	self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG pValue (int) – the value to search for (a uint64_t)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG pValue (int) – the value to search for (a uint64_t)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (an uint64_t)

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)
Returns:	output (int) – the smallest value found (an uint64_t)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG pValue (int) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayUnsignedLONGLONG.ArrayUnsignedLONGLONG() -> ArrayUnsignedLONGLONG

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: int) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayUnsignedLONGLONG) – an instance of ArrayUnsignedLONGLONG iValue (int) – the value to set (an uint64_t)

ArrayUnsignedLong¶

class ORSModel.ors.ArrayUnsignedLong¶

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

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

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

ArrayUnsignedLong.ArrayUnsignedLong(self) -> ArrayUnsignedLong

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

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

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

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

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

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)
Returns:	output (int) – the value (an uint32_t)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

findFirst(self, pValue: int) → int¶

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

Parameters:	self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong pValue (int) – the value to search for (an uint32_t)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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.ArrayUnsignedLong) – an instance of ArrayUnsignedLong pValue (int) – the value to search for (an uint32_t)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (an uint32_t)

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)
Returns:	output (int) – the smallest value found (an uint32_t)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong pValue (int) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayUnsignedLong.ArrayUnsignedLong() -> ArrayUnsignedLong

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: int) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayUnsignedLong) – an instance of ArrayUnsignedLong iValue (int) – the value to set (an uint32_t)

ArrayUnsignedShort¶

class ORSModel.ors.ArrayUnsignedShort¶

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

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

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

ArrayUnsignedShort.ArrayUnsignedShort(self) -> ArrayUnsignedShort

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

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

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

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

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

at(self, index: int) → int¶

Retrieves a single value from the array.

Parameters:	self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort index (int) – the index of the item to retrieve (an uint64_t, zero based)
Returns:	output (int) – the value (an short)

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)

Note

Any previous value at the given position is lost.

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)

Note

The destination array will grow to accommodate the copied data, if required.

findFirst(self, pValue: int) → int¶

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

Parameters:	self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort pValue (int) – the value to search for (an unsigned short)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

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.ArrayUnsignedShort) – an instance of ArrayUnsignedShort pValue (int) – the value to search for (an unsigned short)
Returns:	output (int) – the index of the value (an uint64_t, zero based), or ULLONG_MAX if not found

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (int) – the largest value found (an short)

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)
Returns:	output (int) – the smallest value found (an short)

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*)

Note

Return values are written to the supplied arguments.

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort pValue (int) –
Returns:	output (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)

Note

All items after the insertion index are shifted down. The last element of the array is thus lost.

none()¶

ArrayUnsignedShort.ArrayUnsignedShort() -> ArrayUnsignedShort

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

privateGetDataPacketAtIndex(self, iIndex: int) → None¶

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

setAll(self, iValue: int) → None¶

Sets all elements of the array to the same value.

Parameters:	self (ORSModel.ors.ArrayUnsignedShort) – an instance of ArrayUnsignedShort iValue (int) – the value to set (an unsigned short)

Box¶

class ORSModel.ors.Box¶

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

Box.Box(self) -> Box

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

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

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

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

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

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

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

getBoundedPlaneOfSlice(self, sliceIndex: int) → Rectangle¶

Parameters:	self (ORSModel.ors.Box) – an instance of Box sliceIndex (int) –
Returns:	output (ORSModel.ors.Rectangle) –

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

Gets a copy of the receiver in the argument referential.

Parameters:	self (ORSModel.ors.Box) – an instance of Box inRefBox (ORSModel.ors.Box) – a box, the destination referential (an Box)
Returns:	output (ORSModel.ors.Box) – a box, a copy of the receiver in the argument referential (an Box)

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

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box intVect (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

Note

Here the spacing is not considered.

getCenter(self) → Vector3¶

Gets the geometrical middle of the box.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a box center position (an Vector3)

getCenterHalfVoxel(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a box center position (an Vector3)

getClassNameStatic() → str¶

Returns:	output (str) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aBox (ORSModel.ors.Box) –
Returns:	output (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)
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction vector is normalized.

getDirection0(self) → Vector3¶

Gets the box direction0.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction0 vector is normalized.

getDirection0Size(self) → float¶

Gets the box direction0 side length.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (float) – the side 0 length (a double)

Note

This is the size in meters of the box side 0.

getDirection0SizeInVoxel(self) → int¶

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

getDirection0Spacing(self) → float¶

Gets the box direction0 spacing.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (float) – the side 0 spacing (a double)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

getDirection1(self) → Vector3¶

Gets the box direction1.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction1 vector is normalized.

getDirection1Size(self) → float¶

Gets the box direction1 side length.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (float) – the side 1 length (a double)

Note

This is the size in meters of the box side 1.

getDirection1SizeInVoxel(self) → int¶

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

getDirection1Spacing(self) → float¶

Gets the box direction1 spacing.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (float) – the side 1 spacing (a double)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

getDirection2(self) → Vector3¶

Gets the box direction2.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction2 vector is normalized.

getDirection2Size(self) → float¶

Gets the box direction2 side length.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (float) – the side 2 length (a double)

Note

This is the size in meters of the box side 2.

getDirection2SizeInVoxel(self) → int¶

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

getDirection2Spacing(self) → float¶

Gets the box direction2 spacing.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (float) – the side 2 spacing (a double)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

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)
Returns:	output (float) – the side length (a double)

Note

This is the size in meters of the box side.

getDirectionSizeVector(self) → Vector3¶

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

getDirectionSpacing(self, index: int) → float¶

Gets the box direction0 spacing.

Parameters:	self (ORSModel.ors.Box) – an instance of Box index (int) –
Returns:	output (float) – the side 0 spacing (a double)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

getDirectionSpacingVector(self) → Vector3¶

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

getEnclosingBox(self, dir0: ORSModel.ors.Vector3, dir1: ORSModel.ors.Vector3) → Box¶

Parameters:	self (ORSModel.ors.Box) – an instance of Box dir0 (ORSModel.ors.Vector3) – dir1 (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.Box) –

getFace(self, faceIndex: int) → Rectangle¶

Parameters:	self (ORSModel.ors.Box) – an instance of Box faceIndex (int) –
Returns:	output (ORSModel.ors.Rectangle) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aLine (ORSModel.ors.Line) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box pBox (ORSModel.ors.Box) –
Returns:	output (bool) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box pBox (ORSModel.ors.Box) –
Returns:	output (bool) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.LineSegment) –

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

Checks for equality to another box.

Parameters:	self (ORSModel.ors.Box) – an instance of Box aBox (ORSModel.ors.Box) – a box (an Box)
Returns:	output (bool) – TRUE if the boxes are equal, FALSE otherwise

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aBox (ORSModel.ors.Box) –
Returns:	output (bool) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box inputLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (bool) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aPlane (ORSModel.ors.Plane) –
Returns:	output (bool) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aBplane (ORSModel.ors.Rectangle) –
Returns:	output (bool) –

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

Verifies if a point is inside the box.

Parameters:	self (ORSModel.ors.Box) – an instance of Box aPosition (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:	output (bool) – TRUE if the point is inside the box, FALSE otherwise

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box pVect (ORSModel.ors.Vector3) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aPlane (ORSModel.ors.Plane) – aLine (ORSModel.ors.Line) – insideDeep (float) –
Returns:	output (ORSModel.ors.Vector3) –

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aPlane (ORSModel.ors.Plane) – aPoint (ORSModel.ors.Vector3) – insideDeep (float) –
Returns:	output (ORSModel.ors.Vector3) –

getOrigin(self) → Vector3¶

Gets the box origin position.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – the origin (an Vector3)

Note

The origin is in world coordinates.

getOriginOpposite(self) → Vector3¶

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

getOutwardFacePlane(self, faceIndex: int) → Plane¶

Parameters:	self (ORSModel.ors.Box) – an instance of Box faceIndex (int) –
Returns:	output (ORSModel.ors.Plane) –

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

Transforms the plane provided in the receiver referential.

Parameters:	self (ORSModel.ors.Box) – an instance of Box pPlane (ORSModel.ors.Plane) – a plane (an Plane)
Returns:	output (ORSModel.ors.Plane) – a plane in the box referential (an Plane)

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box aPlane (ORSModel.ors.Plane) –
Returns:	output (ORSModel.ors.Plane) –

getPythonRepresentation(self) → str¶

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (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:	self (ORSModel.ors.Box) – an instance of Box cutPlane (ORSModel.ors.Plane) – a plane (an Plane) upVector (ORSModel.ors.Vector3) – an up vector (an Vector3)
Returns:	output (ORSModel.ors.Rectangle) – a Rectangle (a Rectangle)

Note

The bounded plane will have an area of zero if the plane does not intersect the box.

getRotationMatrix(self) → Matrix4x4¶

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

getSpacingInDirection(self, aDirection: ORSModel.ors.Vector3) → float¶

Parameters:	self (ORSModel.ors.Box) – an instance of Box aDirection (ORSModel.ors.Vector3) –
Returns:	output (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) –
Returns:	output (ORSModel.ors.Box) –

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
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getSummitmmm(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getSummitmmp(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getSummitmpm(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getSummitmpp(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (a Vector3)

getSummitpmm(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getSummitpmp(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getSummitppm(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getSummitppp(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getTransformationToGoTo(self, pIBox: ORSModel.ors.Box) → Matrix4x4¶

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box pIBox (ORSModel.ors.Box) – a box (an Box)
Returns:	output (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4)

Note

The transformation can include: translation, rotation and scaling.

getVolume(self) → float¶

Gets the volume of the receiver.

Parameters:	self (ORSModel.ors.Box) – an instance of Box
Returns:	output (float) – a volume (a double)

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

Gets the position of a given voxel.

Parameters:	self (ORSModel.ors.Box) – an instance of Box anIndex (ORSModel.ors.Vector3) – a voxel position (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the position in world coordinates (an Vector3)

Note

Only useful if the spacing of the direction vectors have been defined.

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

Transforms the given point in the box referential.

Parameters:	self (ORSModel.ors.Box) – an instance of Box inVect (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

Note

Here the spacing is not considered.

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

Gets the position of a given world coordinate.

Parameters:	self (ORSModel.ors.Box) – an instance of Box pPointInWorld (ORSModel.ors.Vector3) – a world coordinate position vector (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the position in local coordinates (an Vector3)

Note

Only useful if the spacing of the direction vectors have been defined.

getWorldTranformation(self) → Matrix4x4¶

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

grow(self, growSize: ORSModel.ors.Vector3) → None¶

Grows or shrinks the receiver, arount its center.

Parameters:	self (ORSModel.ors.Box) – an instance of Box growSize (ORSModel.ors.Vector3) – a vector with the amount of growth of each direction vector length (an Vector3)

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

Grows to include a given box.

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

Note

The receiver will grow to contain the provided box, but it will never shrink.

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

Grows the receiver as to include the provided point.

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

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

Makes the box able to contain a given box.

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

Note

The receiver will grow or shrink to fit on the provided box.

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

Parameters:	self (ORSModel.ors.Box) – an instance of Box faceIndex (int) – pVect (ORSModel.ors.Vector3) –

none()¶

Box.Box() -> Box

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

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

Sets a box direction.

Parameters:	self (ORSModel.ors.Box) – an instance of Box index (int) – the side index (an unsigned short) pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction vector will be normalized.

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

Sets the box direction0.

Parameters:	self (ORSModel.ors.Box) – an instance of Box pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction0 vector will be normalized.

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)

Note

This is the size in meters of the box side 0.

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)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

setDirection1(self, pVect: ORSModel.ors.Vector3) → None¶

Sets the box direction1.

Parameters:	self (ORSModel.ors.Box) – an instance of Box pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction1 vector will be normalized.

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)

Note

This is the size in meters of the box side 1.

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)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

setDirection2(self, pVect: ORSModel.ors.Vector3) → None¶

Sets the box direction2.

Parameters:	self (ORSModel.ors.Box) – an instance of Box pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction2 vector will be normalized.

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)

Note

This is the size in meters of the box side 2.

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)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

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)

Note

This is the size in meters of the box side.

setDirectionSizeVector(self, pVect: ORSModel.ors.Vector3) → None¶

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

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)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

setDirectionSpacingVector(self, pVect: ORSModel.ors.Vector3) → None¶

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

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

Sets the box origin position.

Parameters:	self (ORSModel.ors.Box) – an instance of Box pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The origin should be in world coordinates.

shape¶

Camera¶

class ORSModel.ors.Camera¶

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.Camera(self) -> Camera

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

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

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

copy(self) → Camera¶

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

copyFrom(self, aCamera: ORSModel.ors.Camera) → None¶

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

getAngleOfView(self) → float¶

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

getCameraDirection(self) → Vector3¶

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

getCameraLeft(self) → Vector3¶

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

getCameraPivot(self) → Vector3¶

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

getCameraPosition(self) → Vector3¶

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

getCameraRight(self) → Vector3¶

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

getCameraUp(self) → Vector3¶

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

getClassNameStatic() → str¶

Returns:	output (str) –

getDepthOfField(self) → float¶

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

getFarRectangle(self) → Rectangle¶

Get camera far plane.

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera
Returns:	output (ORSModel.ors.Rectangle) – the far plane (a Rectangle)

getFocalLength(self) → float¶

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

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

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera aCamera (ORSModel.ors.Camera) –
Returns:	output (bool) –

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

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

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera positionOnView (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.Line) – the line of sigth (an Line)

Note

Origin of the line of sight is the camera position.

getLineOfSightOrtho(self) → Line¶

Get the line of sight of the camera.

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera
Returns:	output (ORSModel.ors.Line) – the line of sigth (an Line)

Note

Origin of the line of sight is the camera position.

getNearRectangle(self) → Rectangle¶

Get camera near plane.

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera
Returns:	output (ORSModel.ors.Rectangle) – the near plane (a Rectangle)

getOrthoZoomFactor(self) → float¶

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

getRectangle(self, fDistance: float) → Rectangle¶

Get camera plane at a given distance in the frustum.

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera fDistance (float) –
Returns:	output (ORSModel.ors.Rectangle) – the plane (a Rectangle)

Note

The distance is clipped by [getViewPortNear(), getViewPortFar()]

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

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera rotationAxis (ORSModel.ors.Vector3) – rotationPivot (ORSModel.ors.Vector3) – angle (float) –
Returns:	output (ORSModel.ors.Camera) –

getSceneNormalizationMatrix(self) → Matrix4x4¶

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

getSceneNormalizationRotationMatrix(self) → Matrix4x4¶

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

getSceneNormalizationScaleMatrix(self) → Matrix4x4¶

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

getSceneNormalizationTranslationMatrix(self) → Matrix4x4¶

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

getScreenToWorldCoordinate(self, xCoordinate: float, yCoordinate: float) → Vector3¶

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera xCoordinate (float) – yCoordinate (float) –
Returns:	output (ORSModel.ors.Vector3) –

getScreenToWorldDirection(self, xCoordinate: float, yCoordinate: float) → Vector3¶

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera xCoordinate (float) – yCoordinate (float) –
Returns:	output (ORSModel.ors.Vector3) –

getUseOrthoProjection(self) → bool¶

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

getViewMatrix(self) → Matrix4x4¶

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

getViewPortFar(self) → float¶

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

getViewPortHeight(self) → int¶

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

getViewPortNear(self) → float¶

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

getViewPortTopLeftX(self) → int¶

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

getViewPortTopLeftY(self) → int¶

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

getViewPortWidth(self) → int¶

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

none()¶

Camera.Camera() -> Camera

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

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

Parameters:	self (ORSModel.ors.Camera) – an instance of Camera rotationAxis (ORSModel.ors.Vector3) – rotationPivot (ORSModel.ors.Vector3) – angle (float) –

setAngleOfView(self, aValue: float) → None¶

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

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

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

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

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

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

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

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

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

setDepthOfField(self, aValue: float) → None¶

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

setFocalLength(self, aValue: float) → None¶

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

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

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

setOrthoZoomFactor(self, zoomFactor: float) → None¶

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

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

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

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

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

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

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

setUseOrthoProjection(self, aValue: bool) → None¶

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

setViewPortFar(self, aValue: float) → None¶

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

setViewPortHeight(self, aValue: int) → None¶

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

setViewPortNear(self, aValue: float) → None¶

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

setViewPortTopLeftX(self, aValue: int) → None¶

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

setViewPortTopLeftY(self, aValue: int) → None¶

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

setViewPortWidth(self, aValue: int) → None¶

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

Capsule¶

class ORSModel.ors.Capsule¶

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

Capsule.Capsule(self) -> Capsule

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

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

Parameters:	self (ORSModel.ors.Capsule) – an instance of Capsule centerPoint1 (ORSModel.ors.Vector3) – centerPoint2 (ORSModel.ors.Vector3) – radius (float) –

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

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

getAxis(self) → Vector3¶

Returns the normal of theCapsule.

Parameters:	self (ORSModel.ors.Capsule) – an instance of Capsule
Returns:	output (ORSModel.ors.Vector3) – A vector (an Vector3)

getCap1Center(self) → Vector3¶

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

getCap2Center(self) → Vector3¶

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

getCenter(self) → Vector3¶

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

getClassNameStatic() → str¶

Returns:	output (str) –

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

Parameters:	self (ORSModel.ors.Capsule) – an instance of Capsule aLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.LineSegment) –

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

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

Parameters:	self (ORSModel.ors.Capsule) – an instance of Capsule aLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection

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

Verifies equality between the receiver and a givenCapsule.

Parameters:	self (ORSModel.ors.Capsule) – an instance of Capsule Capsule (ORSModel.ors.Capsule) –
Returns:	output (bool) – TRUE if the argument Capsule is equal to the receiver, FALSE otherwise

getRadius(self) → float¶

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

none()¶

Capsule.Capsule() -> Capsule

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

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

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

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

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

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

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

setRadius(self, aRadius: float) → None¶

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

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.Channel(self, buffer: int, nBytes: int, preserveIdentity: bool) -> Channel

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

Channel.Channel(self) -> Channel

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

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

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

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

Adds a slice of data to the channel.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pSliceData (ORSModel.ors.Array) – the slice data (an Array), see note below

Note

The array should be of similar channel type (ArrayUnsignedChar, ArrayUnsignedShort, ArrayUnsignedInt or ArrayFloat).

Note

It is assumed that the slice added is of same shape as the existing slices within the channel.

Note

The slice data is copied to the channel. You are responsible for releasing the array.

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)

Note

The window width should be >= 1.

Note

The suggested leveling values are only used to present suitable values to end users.

applyLevelingTransformationToData(self, minValue: float, maxValue: float) → None¶

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

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

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

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)

Returns:

output (ORSModel.ors.Channel) – a new converted channel (a Channel)

Note

The first argument should be one of CxvChannel_Data_Type (see ors_def.h for valid values).

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)

Note

If any index is invalid no copy occurs.

copyDataFromCommonRegionInto(self, pAChannel: ORSModel.ors.Channel, tOffset: int, filterMode: int, 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)
filterMode (int) – a CxvFiltering_Mode (an unsigned short)
IProgress (ORSModel.ors.Progress) – a progress object (an Progress)
clearValue (bool) – true to clear the companion channel before copying the channel (a boolean)

Note

This method copies the data from the receiver into a supplied channel, for the area that is common to both channels. This area is computed based on the world coordinates of both channels.

copyInto(self, aDestinationChannel: ORSModel.ors.Channel) → None¶

Copies the receiver channel into another channel.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel aDestinationChannel (ORSModel.ors.Channel) – a destination channel (an Channel)

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)

Note

Shape includes size, spacing, type, description, position and location.

Note

This method does not handle the channel data array.

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) –
Returns:	output (float) –

getAllSlicesHaveSameOrientation(self, pTIndex: int) → bool¶

Verifies if the channel is consistent in its slice orientations.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pTIndex (int) –
Returns:	output (bool) – true if all slices have identical orientations, false otherwise

Note

Normally a channel has consistent slice orientations, but in some poorly formed DICOM datasets it can happen that slices do not have the same orientation. Those channels become of limited use.

getAllSlicesHaveSameSize(self) → bool¶

Verifies if the channel has uniform slice sizes.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if all slices have the same width and height, false otherwise

Note

Normally all slices have the same sizes, but the channel can support having slices of different sizes.

getAreAllZSlicesDataAvailable(self) → bool¶

Gets the availability of all the Z slices’ data.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if all the Z slices’ data is available, false otherwise

Note

The channel can be set to work in “lazy” mode, where slices are made available as they are read.

Note

Use this method to know if the entire data has arrived, instead of querying each slice with getIsZSliceDataAvailable().

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:	self (ORSModel.ors.Channel) – an instance of Channel pCompareChannel (ORSModel.ors.Channel) – the channel to compare with (an Channel) pOutputChannel (ORSModel.ors.Channel) – the output channel (an Channel) IProgress (ORSModel.ors.Progress) – a progress object (an Progress)

Note

The provided channel serves as the reference grid and the receiver is linearly interpolated.

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:	self (ORSModel.ors.Channel) – an instance of Channel pKernel (ORSModel.ors.ConvolutionKernel) – the closing kernel made of 0 or 1 (an ConvolutionKernel) IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress pOutChannel (ORSModel.ors.Channel) – channel to put the result in (can be the receiver) (an Channel)
Returns:	output (ORSModel.ors.Channel) – a result channel (an Channel)

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

Returns:

output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

This method finds all the voxel data found aint32_t a path, and fills another channel with that data.

Note

The X and Y sizes define a box that will contain the data aint32_t the path.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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

Returns:

output (ORSModel.ors.Channel) –

getAsChannelCutAlongZWithNormal(self, normal: ORSModel.ors.Vector3, timeStep: int, outXSizeInworld: float, nearest: bool, inputChannel: ORSModel.ors.Channel) → Channel¶

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel normal (ORSModel.ors.Vector3) – timeStep (int) – outXSizeInworld (float) – nearest (bool) – inputChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Channel) –

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:	self (ORSModel.ors.Channel) – an instance of Channel InputPath (ORSModel.ors.VisualPath) – aTransformationMatrix (ORSModel.ors.Matrix4x4) – normal (ORSModel.ors.Vector3) – timeStep (int) – outXSizeInworld (float) – nearest (bool) – inputChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Channel) –

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:	self (ORSModel.ors.Channel) – an instance of Channel pKernel (ORSModel.ors.ConvolutionKernel) – the dilatation kernel made of 0 or 1 (an ConvolutionKernel) IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress pOutChannel (ORSModel.ors.Channel) – channel to put the result in (can be the receiver) (an Channel)
Returns:	output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

the simple tone of grey dilatation is a convolution operation selecting the maximum value in the kernel

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)

Returns:

output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

If no channel is provided to put the result in, a new channel is created with the number of slices corresponding to the number of slices computed.

Note

When the output channel have the same characteristics as the input channel, the output channel is not re-initialized before writing in the result of the dilation of the desired slices.

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

Returns:

output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

This method finds all the voxel data found aint32_t a path, and fills another channel with that data.

Note

The X and Y sizes define a box that will contain the data aint32_t the path.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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:	self (ORSModel.ors.Channel) – an instance of Channel pKernel (ORSModel.ors.ConvolutionKernel) – the erosion kernel made of 0 or 1 (an ConvolutionKernel) IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress pOutChannel (ORSModel.ors.Channel) – channel to put the result in (can be the receiver) (an Channel)
Returns:	output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

the simple tone of grey erosion is a convolution operation selecting the minimum value in the kernel

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)

Returns:

output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

If no channel is provided to put the result in, a new channel is created with the number of slices corresponding to the number of slices computed.

Note

When the output channel have the same characteristics as the input channel, the output channel is not re-initialized before writing in the result of the erosion of the desired slices.

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:	self (ORSModel.ors.Channel) – an instance of Channel pBoxSize (int) – the box size (an unsigned short) pOutChannel (ORSModel.ors.Channel) – an optional output channel (an ORSChannelPtr)
Returns:	output (ORSModel.ors.Channel) – the result channel (an ORSChannelPtr)

Note

The box size needs to be an odd number.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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

Creates a new channel from a given Region of Interest.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pInputROI (ORSModel.ors.ROI) – a region of interest (an ROI)
Returns:	output (ORSModel.ors.Channel) – a result channel (an Channel) pOutChannel (ORSModel.ors.Channel) – an optional output channel (an Channel)

Note

This method extracts the channel data matching the given Region of Interest into the resulting channel.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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)
Returns:	output (ORSModel.ors.Channel) – the resulting channel (an ORSChannelPtr)

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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:	self (ORSModel.ors.Channel) – an instance of Channel pKernel (ORSModel.ors.ConvolutionKernel) – the opening kernel made of 0 or 1 (an ConvolutionKernel) IProgress (ORSModel.ors.Progress) – a progress object (an Progress), or NULL for no progress pOutChannel (ORSModel.ors.Channel) – channel to put the result in (can be the receiver) (an Channel)
Returns:	output (ORSModel.ors.Channel) – a result channel (an Channel)

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)

Returns:

output (ORSModel.ors.Channel) – the resulting channel (an ORSChannelPtr)

Note

The 3 padding values are applied to the beginning and end of each dimension.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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)

Returns:

output (ORSModel.ors.Channel) – the resulting channel (an Channel)

Note

This method samples the source channel and produces an output channel according to the sampling method specified.

Note

If a target channel is supplied, data is written to it and the channel is returned as a result, otherwise a new channel is created.

Note

See the ORS_def.h file for enum CxvSamplingMethod values.

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)

Returns:

output (ORSModel.ors.Channel) – the resulting channel (an Channel)

Note

This method samples the source channel and produces an output channel according to the sampling method specified.

Note

If a target channel is supplied, data is written to it and the channel is returned as a result, otherwise a new channel is created.

Note

See the ORS_def.h file for enum CxvSamplingMethod values.

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

Returns:

output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

The general plane equation is ax + by + cz + dw = 0.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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) –
Returns:	output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

The general plane equation is ax + by + cz + dw = 0.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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

Returns:

output (ORSModel.ors.Channel) – a result channel (an Channel)

Note

algorithm to be descibed later

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:	output (ORSModel.ors.Channel) – a result channel (an Channel) pIInputChannel (ORSModel.ors.Channel) – an optional output channel (an Channel)

Note

This method creates a new channel having the same shape (characteristics) as the receiver. It extracts the channel data that falls within the given range of data into the resulting channel. The lower and upper replacement values define what value gets written to the resulting channel for the data falling outside the given range.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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:

output (ORSModel.ors.Mesh) – the resulting mesh model (an ORSMeshPtr)
pMesh (ORSModel.ors.Mesh) – an optional output mesh model (an ORSMeshPtr)

Note

The isovalue is used as a threshold, any value below it (inclusive) is not considered.

Note

The channel needs to have a minimum size of 3 in its X, Y and Z axis.

Note

If a mesh model is supplied as the last argument, the results are written to it, otherwise a new mesh model is created.

Note

If a progress object is supplied, a cancellable progress bar will be displayed, otherwise no progression is shown.

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)

Returns:

output (ORSModel.ors.MultiROI) – the resulting ROI (an ROI)

Note

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

Note

The area is expressed in X, Y and Z min/max pairs.

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)
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The range must be supplied in a normalized fashion, no matter the data type of the channel.

Note

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

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)

Returns:

output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The range must be supplied in a normalized fashion, no matter the data type of the channel.

Note

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

Note

The area is expressed in X, Y and Z min/max pairs.

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

Returns:

output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The ranges must be supplied in a normalized fashion, no matter the data type of the channel.

Note

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

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)

Returns:

output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The ranges must be supplied in a normalized fashion, no matter the data type of the channel.

Note

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

Note

The area is expressed in X, Y and Z min/max pairs.

getBitCount(self) → int¶

Gets the number of bits used to represent one pixel.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (int) – the bit count (an char)

Note

It can be 8, 16 or 32.

getByteCountPerSample(self) → int¶

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (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) –
Returns:	output (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) –
Returns:	output (ORSModel.ors.ROI) –

classmethod getClassDenomination()¶

getClassNameStatic() → str¶

Returns:	output (str) –

getClassicalStandardDeviation(self) → float¶

Computes the standard deviation.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (float) – the standard deviation (a float)

getClipBox(timestep=0, display=None)¶

Gets the clip box of the channel

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	aClipBox (ORSModel.ors.Box) – the clip box

getClipping(timestep=0, display=None)¶

Gets the origin and the opposite summit of the clip box of the channel

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	clipOriginSummit (ORSModel.ors.Vector3) – the origin summit of the clip box clipOppositeSummit (ORSModel.ors.Vector3) – the origin opposite summit of the clip box

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) –
Returns:	output (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

Returns:

output (float) – the value (a double)

Note

Applicable to the following VRs: DS, FD.

Note

To distinguish between a return value of 0 because the attribute is absent, check for the presence of the attribute with hasDICOMAttribute().

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

Returns:

output (float) – the value (a float)

Note

Applicable to the following VRs: FL, OF.

Note

To distinguish between a return value of 0 because the attribute is absent, check for the presence of the attribute with hasDICOMAttribute().

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

Returns:

output (int) – the value (an int)

Note

Applicable to the following VRs: IS, SL, SS, UL, US.

Note

To distinguish between a return value of 0 because the attribute is absent, check for the presence of the attribute with hasDICOMAttribute().

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

Returns:

output (int) – the value (a short)

Note

Applicable to the following VRs: SS.

Note

To distinguish between a return value of 0 because the attribute is absent, check for the presence of the attribute with hasDICOMAttribute().

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

Returns:

output (int) – the value (an char)

Note

Applicable to the following VRs: OB.

Note

To distinguish between a return value of 0 because the attribute is absent, check for the presence of the attribute with hasDICOMAttribute().

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

Returns:

output (int) – the value (an int)

Note

Applicable to the following VRs: UL.

Note

The success is indicated in the seventh argument. If you’re not interested in the success, you can use NULL.

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

Returns:

output (int) – the value (an short)

Note

Applicable to the following VRs: OW, US.

Note

To distinguish between a return value of 0 because the attribute is absent, check for the presence of the attribute with hasDICOMAttribute().

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) –
Returns:	output (str) –

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel iTIndex (int) – iZIndex (int) –
Returns:	output (str) –

getDataDescription(self) → int¶

Gets the channel description.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (int) – a description index (a int32_t)

Note

enum CxvChannel_Description (in ORS_def.h) is used to categorize channels.

getDataRange(self) → float¶

Gets the size of the spread of data.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (float) – a value (a double)

Note

Unless a value was supplied via setDataRange(), the value returned by this method is assumed to cover the spread of the data type (i.e. for unsigned short it will return 2^16). Float channels are an exception, where the true data range will be computed from the smallest and largest value found in the channel (because the computed spread is too large).

getDataType(self) → int¶

Gets the channel data type.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (int) – a type (a int32_t)

Note

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

getDataUnit(self) → str¶

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

getHasDICOMAttributes(self) → bool¶

Checks to see if the channel has DICOM attributes.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if DICOM attributes exist, false otherwise

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)
Returns:	output (bool) – true if overlay data exists, false otherwise

Note

An overlay is a bitmask that results in an image superimposed over the original channel data. Overlay data is expressed in bits, where 1s indicate that the pixel is to be “lit” up.

getHasSliceOrientationAndPosition(self) → bool¶

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if it does, false otherwise

Note

All channels have a zero origin orientation and position, but some channels have a greater level of detail, where each slice has orientation and position data.

getInitialWindowLevelCenter(self) → float¶

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

getInitialWindowLevelWidth(self) → float¶

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

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pLineSegment (ORSModel.ors.LineSegment) – nTIndex (int) – fSpacing (float) – nInterpolationMethod (int) – values (ORSModel.ors.Array) –
Returns:	output (ORSModel.ors.Array) –

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)
Returns:	output (ORSModel.ors.Vector3) – a vector (a Vector3)

Note

The X and Y positions can be outside the channel.

getInterpolatedValuesAtPositions(self, aWorldCoordinate: ORSModel.ors.ArrayDouble, tIndex: int, nInterpolationMethod: int, bConvertToPhysicalUnits: bool, values: ORSModel.ors.ArrayDouble) → ArrayDouble¶

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel aWorldCoordinate (ORSModel.ors.ArrayDouble) – tIndex (int) – nInterpolationMethod (int) – bConvertToPhysicalUnits (bool) – values (ORSModel.ors.ArrayDouble) –
Returns:	output (ORSModel.ors.ArrayDouble) –

getIsClipped(timestep=0, display=None)¶

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

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
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
Returns:	output (bool) – true if data is 3D, false otherwise

Note

Normally channels hold 3D data, but there are cases where it is known that the data is not 3D (for example, stacks of screenshots). In those cases channels need to be told that they do not hold 3D data.

getIsDataInitialized(self) → bool¶

Checks if the internal data is initialized.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if initialized correctly, false otherwise

Note

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

getIsLossy(self) → bool¶

Verifies if the channel is lossy or not.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if data is lossy, false otherwise

Note

A channel can be lossy for two different reasons:

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)
Returns:	output (bool) – true if the slice’s marker is on, false otherwise

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)
Returns:	output (bool) – true if the Z slice’s data is available, false otherwise

Note

The channel can be set to work in “lazy” mode, where slices are made available as they are read.

Note

If you want to know if the entire data has arrived, use getAreAllZSlicesDataAvailable().

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)

Returns:

output (ORSModel.ors.MultiROI) – the resulting object (an MultiROI)

Note

This method labels areas of the channel by finding adjacent voxels and labelling them with sequential numbering.

Note

If a multi ROI object is supplied as the last argument, the results are written to it, otherwise a new one is created.

getLineBoundedDoublePlane(self, pT: int, iZSlice: int, iYLine: int) → Rectangle¶

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pT (int) – iZSlice (int) – iYLine (int) –
Returns:	output (ORSModel.ors.Rectangle) –

getMarkedSlicesCount(self) → int¶

Gets the count of marked slices.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (int) – the count of marked slices (an int)

Note

Gets the total marked slices count, across all T dimensions.

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
Returns:	output (float) – the maximum value (a double)

Note

Min, max and mean are kept statically and are recomputed when the channel data changes.

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
Returns:	output (float) – the mean value (a double)

Note

Min, Max and Mean are kept statically and are recomputed when the channel data changes.

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) –
Returns:	output (ORSModel.ors.Vector3) –

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
Returns:	output (float) – the minimum value (a double)

Note

Min, max and mean are kept statically and are recomputed when the channel data changes.

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
Returns:	output (float) – max value (a double)

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
Returns:	output (float) – min value (a double)

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)
Returns:	output (float) – value (a double)

Note

For an 8 bit channel, return value is normalized on 256.

Note

For a 16 bit channel, return value is normalized on 65536.

Note

For a 32 bit channel, return value is normalized on the spread found in the channel.

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
Returns:	output (int) – the number of pairs (an char)

getOffset(self) → float¶

Gets the channel offset.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (float) – the offset (a double)

getOrientationComparisonPrecision(self) → float¶

Gets the channel’s orientation comparison precision.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (float) – a double (see note)

Note

To deem if a channel is well behaved or not in terms of its orientations, one can compare all the channel slices’ orientations. This method returns the precision to use to determine if orientations are close enough.

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:

output (ORSModel.ors.ArrayUnsignedChar) – the overlay data (an ArrayUnsignedChar)
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)

Note

An overlay is a bitmask that results in an image superimposed over the original channel data. Overlay data is expressed in bits, where 1s indicate that the pixel is to be “lit” up.

Note

The starting row and column indicate where the overlay data begins in relation to the channel data. 0/0 mean that the overlay data begins at the starting row and column of the channel data. Both positive and negative values are supported. If negative values are given, portions of the overlay data that fall “out” of the channel’s range will be disregarded.

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
Returns:	output (float) – the maximum value (a float)

Note

Min and max are kept statically and are recomputed when the channel data changes.

Note

The return value is not normalized, but it is always typecast to a 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
Returns:	output (float) – the minimum value (a float)

Note

Min and max are kept statically and are recomputed when the channel data changes.

Note

The return value is not normalized, but it is always typecast to a 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) –
Returns:	output (ORSModel.ors.Vector3) –

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)
Returns:	output (ORSModel.ors.Vector3) – a position (an Vector3)

Note

The X and Y positions can be outside the channel.

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)

Note

The received array is not a copy, do not release it. It will be released by the interface.

Note

Use with caution, as this method gives you direct access to the channel data. ORS encourages use of the CxvChannelData class wrapper instead of direct access.

getSampledLine(self, pPoint1: ORSModel.ors.Vector3, pPoint2: ORSModel.ors.Vector3, timeStep: 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 T index (an unsigned short)
Returns:	output (ORSModel.ors.ArrayDouble) – an array of double values (an ArrayDouble)

Note

This method finds all the voxel data placed on an imaginary line drawn between the two given points, and returns the data in a normalized fashion.

getSampledLineOfNPoints(self, pPoint1: ORSModel.ors.Vector3, pPoint2: ORSModel.ors.Vector3, timeStep: int, nbOutputPoint: int, bNormalize: bool, bConvertToPhysicalUnits: bool) → 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)
bNormalize (bool) – true normalizes the results, false doesn’t
bConvertToPhysicalUnits (bool) – true returns the values in physical units, false doesn’t

Returns:

output (ORSModel.ors.ArrayDouble) – an array containing the results (an ArrayDouble)

Note

This method finds all the voxel data placed on an imaginary line drawn between the two given points.

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
Returns:	output (int) – the current save mode (a short between 0 and 2, see below)

Note

The save mode has these meanings:

getSerieHasBeenModified(self) → bool¶

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

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel timeStep (int) – sliceIndex (int) –
Returns:	output (float) –

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel timeStep (int) – sliceIndex (int) –
Returns:	output (float) –

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel timeStep (int) – sliceIndex (int) –
Returns:	output (float) –

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel timeStep (int) – sliceIndex (int) –
Returns:	output (float) –

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel timeStep (int) – sliceIndex (int) –
Returns:	output (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)
Returns:	output (float) – the orientation value (a double)

Note

First three indicies indicate X orientation, next three indicate Y orientation and last three are for Z.

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)
Returns:	output (ORSModel.ors.Vector3) – the position (an Vector3)

getSliceRectangle(self, timeStep: int, sliceIndex: int) → Rectangle¶

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel timeStep (int) – sliceIndex (int) –
Returns:	output (ORSModel.ors.Rectangle) –

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)

Note

Normally all slices have the same sizes, but the channel can support having slices of different sizes. In that case, size the channel to the largest slice, and size each slice individually.

getSlope(self) → float¶

Gets the channel slope.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (float) – the slope (a double)

getSpacingXValidity(self) → bool¶

Checks if X spacing is valid.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if X spacing is valid, false otherwise

getSpacingYValidity(self) → bool¶

Checks if Y spacing is valid.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if Y spacing is valid, false otherwise

getSpacingZValidity(self) → bool¶

Checks if Z spacing is valid.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if Z spacing is valid, false otherwise

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)
Returns:	output (float) – the window center (a double)

Note

The suggested leveling values are only used to present suitable values to end users.

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)
Returns:	output (float) – the window width (a double)

Note

The suggested leveling values are only used to present suitable values to end users.

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)
Returns:	output (int) – an array of array of bytes (char)

Note

The received array is not a copy, do not release it. It will be released by the interface.

Note

Use with caution, as this method gives you direct access to the channel data. ORS encourages use of the CxvChannelData class wrapper instead of direct access.

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*)

Note

Time frames represent the exact time at each T increment.

Note

-1 is returned if no time frames are defined or if the T index argument is invalid.

getTotalByteCount(self) → int¶

Gets the total number of bytes in the internal data.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (int) – number of bytes (a int64_t)

Note

The size in bytes is represented by the formula: X size * Y size * Z size * T size * bit depth.

getTotalSliceIntersectionLength(self, timeStep: int) → float¶

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

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pInChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getTypeDescription(self) → str¶

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (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) –
Returns:	output (float) –

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel aWorldCoordinate (ORSModel.ors.Vector3) – tIndex (int) –
Returns:	output (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)
Returns:	output (float) – the result (a double)

Note

Slope and offset are applied to convert to physical units.

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)
Returns:	output (float) – the result (a double)

Note

Slope and offset are applied to convert from physical units.

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
Returns:	output (bool) – true if item was found, false otherwise

initializeData(self) → bool¶

Initializes the channel’s internal data.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if initialization was successful, false otherwise

Note

The memory required by the internal data is represented by the formula: X size * Y size * Z size * T size * bitSize.

Note

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

Note

The XYZT sizes, and the data type must be set prior to initializing the channel.

Note

A false result means that a memory allocation error occurred.

initializeDataForFLOAT(self) → bool¶

Initializes the channel data array for 32 bit float data.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if initialization was successful, false otherwise

Note

The size in bytes of the data array is represented by the formula: X * Y * Z * T * 4.

Note

The channel must be initialized before you set the channel data array.

Note

The XYZT sizes must be set prior to initializing the channel.

Note

A false result means that a memory allocation error occurred.

initializeDataForUCHAR(self) → bool¶

Initializes the channel data array for 8 bit unsigned data.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if initialization was successful, false otherwise

Note

The size in bytes of the data array is represented by the formula: X * Y * Z * T.

Note

The channel must be initialized before you set the channel data array.

Note

The XYZT sizes must be set prior to initializing the channel.

Note

A false result means that a memory allocation error occurred.

initializeDataForUINT(self) → bool¶

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if initialization was successful, false otherwise

Note

The size in bytes of the data array is represented by the formula: X * Y * Z * T * 4.

Note

The channel must be initialized before you set the channel data array.

Note

The XYZT sizes must be set prior to initializing the channel.

Note

A false result means that a memory allocation error occurred.

initializeDataForUSHORT(self) → bool¶

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel
Returns:	output (bool) – true if initialization was successful, false otherwise

Note

The size in bytes of the data array is represented by the formula: X * Y * Z * T * 2.

Note

The channel must be initialized before you set the channel data array.

Note

The XYZT sizes must be set prior to initializing the channel.

Note

A false result means that a memory allocation error occurred.

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)

Returns:

output (ORSModel.ors.Channel) – the inverted channel (an Channel)

Note

The axis transformation code allows to transpose the axis according to this grid: 0 -> XYZ (no transformation) 1 -> XZY 2 -> YXZ 3 -> YZX 4 -> ZXY 5 -> ZYX

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created.

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

Note

The callback function is called with the group and element numbers, the attribute as a string, and any user data supplied to this method. Note that PixelData and OverlayData attributes are excluded from the enumeration. The callback function should return true to continue iterating, but can return false to interrupt the iterating.

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:	self (ORSModel.ors.Channel) – an instance of Channel channelB (ORSModel.ors.Channel) – a source channel (an Channel) channelC (ORSModel.ors.Channel) – a target channel (an Channel) IProgress (ORSModel.ors.Progress) – a progress object (an Progress)

Note

Merging respects both channels’ orientation, size, spacing, etc.

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

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel otherChannel (ORSModel.ors.Channel) – the other channel to move data into
Returns:	output (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.Channel() -> Channel

Parameters:	self (ORSModel.ors.Channel) – an instance of 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)

Note

All three arguments are supplied in double for convenience only, and are converted into the native type of the channel. For each pixel of the channel, if its value is > minimum range and < maximum range, then its pixel is replaced with the replacement value.

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)

Note

The replacement value must be supplied in double format, no matter the data type of the channel.

Note

The sender is responsible for releasing the array of indices.

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)

Note

The replacement value must be supplied in normalized format, no matter the data type of the channel.

overwriteValueWithMultiROI(self, aMultiROI: ORSModel.ors.MultiROI, labelOffset: int) → 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)

Note

The channel and multiROI doesn’t need to have the same shape

Note

This method overwrites the channel data according to a MultiROI.

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

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

Note

The channel and multiROI doesn’t need to have the same shape

Note

This method overwrites the channel data according to a MultiROI.

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

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:	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) iTIndex (int) – the time step index (unsigned short)

Note

The channel and multiROI doesn’t need to have the same shape

Note

The box must have orthonormal base with the channel box.

Note

This method overwrites the channel data according to a MultiROI.

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

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

Note

The channel and multiROI doesn’t need to have the same shape

Note

The box must have orthonormal base with the channel box.

Note

This method overwrites the channel data according to a MultiROI.

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

overwriteValueWithROI(self, aVolumeROI: ORSModel.ors.ROI, pReplacementValue: float) → None¶

Overwrites the channel data at a given Region of Interest.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel aVolumeROI (ORSModel.ors.ROI) – a ROI (an ROI) pReplacementValue (float) – the new value (a double)

Note

The channel and ROI doesn’t need to have the same shape

Note

This method overwrites the channel data according to a Region of Interest.

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

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:	self (ORSModel.ors.Channel) – an instance of Channel aROI (ORSModel.ors.ROI) – a ROI (an ROI) pReplacementValue (float) – the new value (a double) subBox (ORSModel.ors.Box) – the box (a Box) iTIndex (int) – the time step index (unsigned short)

Note

The channel and ROI doesn’t need to have the same shape

Note

The box must have orthonormal base with the channel box.

Note

This method overwrites the channel data according to a Region of Interest.

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

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:

self (ORSModel.ors.Channel) – an instance of Channel
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) –

Returns:

output (ORSModel.ors.Channel) –

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)

Note

Note that the same slice index will be removed in all T dimensions of the channel.

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)

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

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)

Note

The box must have orthonormal base with the channel box.

Note

The new value needs to be a normalized value, and will be converted to the native channel type.

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

Note

Each slice has a BOOLEAN marker associated to it.

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

Note

The channel can be set to work in “lazy” mode, where slices are made available as they are read.

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

Returns:

output (bool) – true if successful, false otherwise

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

Note

Applicable to the following VRs: AE, AS, AT, CS, DA, DS, DT, FL, FD, IS, LO, LT, OB, OF, OW, PN, SH, SL, SS, ST, TM, UI, UL, US, UT.

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

Returns:

output (bool) – true if successful, false otherwise

Note

Applicable to the following VRs: DS, FD.

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

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

Returns:

output (bool) – true if successful, false otherwise

Note

Applicable to the following VRs: FL, OF.

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

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

Returns:

output (bool) – true if successful, false otherwise

Note

Applicable to the following VRs: IS, SL, SS, UL, US.

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

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

Returns:

output (bool) – true if successful, false otherwise

Note

Applicable to the following VRs: SS.

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

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

Returns:

output (bool) – true if successful, false otherwise

Note

Applicable to the following VRs: OB.

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

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

Returns:

output (bool) – true if successful, false otherwise

Note

Applicable to the following VRs: UL.

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

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

Returns:

output (bool) – true if successful, false otherwise

Note

Applicable to the following VRs: OW, US.

Note

To apply to all slices, set the T and Z index to -1. The T and Z values’ true type is unsigned short.

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*)

Note

Channel description is used to categorize channels.

Note

See the constants defined in ORS_def.h, enum CxvChannel_Description, for valid values.

setDataRange(self, pValue: float) → None¶

Sets the size of the spread of data.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pValue (float) – a value (a double)

Note

Normally the channel knows its data spread, for example the spread of an 8 bit channel is 256 (from 0 to 255). This method becomes useful when it is known that the pixel data is smaller that the data type. For example, it is common for DICOM data to have its pixel data represented in 12 bits, but the data is stored in 16 bits.

setDataType(self, pDataType: int) → None¶

Sets the channel data type.

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

Note

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

setDataUnit(self, bDimensionalUnit: str) → None¶

Sets the channel data unit description.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel bDimensionalUnit (str) – a string

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)

Note

This leveling will only be applied when the channel is first shown in a volume.

Note

Two special values are accepted: -1 means to normalize from the channel data spread, and 0 means to use no leveling at all.

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

Note

Normally channels hold 3D data, but there are cases where it is known that the data is not 3D (for example, stacks of screenshots). In those cases channels need to be told that they do not hold 3D data.

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

Note

A channel can be lossy for two different reasons:

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

Note

Each slice has a BOOLEAN marker associated to it.

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

Note

The channel can be set to work in “lazy” mode, where slices are made available as they are read.

setOffset(self, pOffset: float) → None¶

Sets the channel offset.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pOffset (float) – the offset (a double)

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)

Note

An overlay is a bitmask that results in an image superimposed over the original channel data. Overlay data is expressed in bits, where 1s indicate that the pixel is to be “lit” up.

Note

The starting row and column indicate where the overlay data begins in relation to the channel data. 0/0 mean that the overlay data begins at the starting row and column of the channel data. Both positive and negative values are supported. If negative values are given, portions of the overlay data that fall “out” of the channel’s range will be disregarded.

Note

The overlay data array is copied internally, so it can be safely released.

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)

Note

The save mode has these meanings:

setSerieHasBeenModified(self, seriesHasBeenChangedFlag: bool) → None¶

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

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)

Note

First three indicies indicate X orientation, next three indicate Y orientation and last three are for Z.

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:	self (ORSModel.ors.Channel) – an instance of Channel timeStep (int) – sliceIndex (int) – pBoundedPlane (ORSModel.ors.Rectangle) –

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)

Note

Normally all slices have the same sizes, but the channel can support having slices of different sizes. In that case, size the channel to the largest slice, and size each slice individually.

setSlope(self, pSlope: float) → None¶

Sets the channel slope.

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel pSlope (float) – the slope (a double)

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)

Note

Time frames represent the exact time at each T increment.

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)

Note

If any index is invalid no swap occurs.

transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None¶

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

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

Parameters:	self (ORSModel.ors.Channel) – an instance of Channel path (ORSModel.ors.VisualPath) – aTransformationMatrix (ORSModel.ors.Matrix4x4) – timeStep (int) – pInChannel (ORSModel.ors.Channel) –

updateSliceMatricesWithGlobalMatrixValue(self) → None¶

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

zeros(shape, dtype=<class 'numpy.uint8'>)¶

Channel2DOverlapMergerHelper¶

class ORSModel.ors.Channel2DOverlapMergerHelper(self) → Channel2DOverlapMergerHelper¶

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

Channel2DOverlapMergerHelper.Channel2DOverlapMergerHelper(self, rhs: ORSModel.ors.Unmanaged) -> Channel2DOverlapMergerHelper

Parameters:	self (ORSModel.ors.Channel2DOverlapMergerHelper) – an instance of Channel2DOverlapMergerHelper rhs (Unmanaged) –

getClassNameStatic() → str¶

Returns:	output (str) –

getOverLap(self, outputChannel: ORSModel.ors.Channel, listOfChannelsToMerge: ORSModel.ors.List, z: int, t: int, method: int, onlyOverlap: bool) → Channel¶

Parameters:	self (ORSModel.ors.Channel2DOverlapMergerHelper) – an instance of Channel2DOverlapMergerHelper outputChannel (ORSModel.ors.Channel) – listOfChannelsToMerge (ORSModel.ors.List) – z (int) – t (int) – method (int) – onlyOverlap (bool) –
Returns:	output (ORSModel.ors.Channel) –

none()¶

Channel2DOverlapMergerHelper.Channel2DOverlapMergerHelper() -> Channel2DOverlapMergerHelper

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

updateOverlapAtPos(self, outputChannel: ORSModel.ors.Channel, listOfChannelsToMerge: ORSModel.ors.List, oldXMin: int, oldXMax: int, oldYMin: int, oldYMax: int, newXmin: int, newXMax: int, newYMin: int, newYMax: int) → None¶

Parameters:

self (ORSModel.ors.Channel2DOverlapMergerHelper) – an instance of Channel2DOverlapMergerHelper
outputChannel (ORSModel.ors.Channel) –
listOfChannelsToMerge (ORSModel.ors.List) –
oldXMin (int) –
oldXMax (int) –
oldYMin (int) –
oldYMax (int) –
newXmin (int) –
newXMax (int) –
newYMin (int) –
newYMax (int) –

ChannelRegistrationHelper¶

class ORSModel.ors.ChannelRegistrationHelper(self) → ChannelRegistrationHelper¶

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

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

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

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

Parameters:	self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper kindOfDegreeOfFreedom (int) – numeroDirection (int) – backward (bool) –

getChannelA(self) → Channel¶

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

getChannelB(self) → Channel¶

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

getClassNameStatic() → str¶

Returns:	output (str) –

getCurrentSimilarity(self) → float¶

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

getEpsilonRotation(self) → Vector3¶

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

getEpsilonScaleFactor(self) → Vector3¶

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

getEpsilonTranslation(self) → Vector3¶

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

getFactorOfCompressionHistogramA(self) → int¶

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

getFactorOfCompressionHistogramB(self) → int¶

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

getHistogramASize(self) → int¶

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

getHistogramBSize(self) → int¶

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

getMaxSimilarityMetric(self) → float¶

Parameters:	self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper
Returns:	output (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) –
Returns:	output (float) –

getNearestInterpolation(self) → bool¶

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

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

Parameters:	self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper bApplyTransformation (bool) – IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getRotationScaleCenter(self) → Vector3¶

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

getRotationScaleCenterAlwaysAtCenter(self) → bool¶

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

getSearchDeltaRotation(self) → Vector3¶

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

getSearchDeltaScaleFactor(self) → Vector3¶

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

getSearchDeltaTranslation(self) → Vector3¶

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

getSuggestedHistogramSizesSturgesRule(self, pIChannelA: ORSModel.ors.Channel, pIChannelB: ORSModel.ors.Channel, pSuggestedSizeOfHistogram: int) → None¶

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

getTimeA(self) → int¶

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

getTimeB(self) → int¶

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

getUseMutualInfo(self) → bool¶

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

getXSampling(self) → int¶

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

getYSampling(self) → int¶

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

getZSampling(self) → int¶

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

none()¶

ChannelRegistrationHelper.ChannelRegistrationHelper() -> ChannelRegistrationHelper

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

resetRotationScaleCenter(self) → None¶

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

setChannelA(self, pIChannel: ORSModel.ors.Channel) → None¶

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

setChannelAB(self, pIChannelA: ORSModel.ors.Channel, pIChannelB: ORSModel.ors.Channel) → None¶

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

setChannelB(self, pIChannel: ORSModel.ors.Channel) → None¶

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

setEpsilonRotation(self, pVector: ORSModel.ors.Vector3) → None¶

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

setEpsilonScaleFactor(self, pVector: ORSModel.ors.Vector3) → None¶

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

setEpsilonTranslation(self, pVector: ORSModel.ors.Vector3) → None¶

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

setFactorOfCompressionHistogramA(self, factor: int) → None¶

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

setFactorOfCompressionHistogramB(self, factor: int) → None¶

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

setHistogramASize(self, value: int) → None¶

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

setHistogramBSize(self, value: int) → None¶

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

setNearestInterpolation(self, aFlag: bool) → None¶

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

setRotationScaleCenter(self, pVect: ORSModel.ors.Vector3) → None¶

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

setRotationScaleCenterAlwaysAtCenter(self, aFlag: bool) → None¶

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

setSearchDeltaEpsilonRotation(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float) → None¶

Parameters:	self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper pIInputChannel (ORSModel.ors.Channel) – searchDelta (float) – epsilon (float) –

setSearchDeltaEpsilonScaleFactor(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float) → None¶

Parameters:	self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper pIInputChannel (ORSModel.ors.Channel) – searchDelta (float) – epsilon (float) –

setSearchDeltaEpsilonTranslation(self, pIInputChannel: ORSModel.ors.Channel, searchDelta: float, epsilon: float) → None¶

Parameters:	self (ORSModel.ors.ChannelRegistrationHelper) – an instance of ChannelRegistrationHelper pIInputChannel (ORSModel.ors.Channel) – searchDelta (float) – epsilon (float) –

setSearchDeltaRotation(self, pVector: ORSModel.ors.Vector3) → None¶

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

setSearchDeltaScaleFactor(self, pVector: ORSModel.ors.Vector3) → None¶

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

setSearchDeltaTranslation(self, pVector: ORSModel.ors.Vector3) → None¶

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

setSearchDirectionBox(self, pIChannelBox: ORSModel.ors.Box) → None¶

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

setSearchDirectionChannel(self, pIChannel: ORSModel.ors.Channel) → None¶

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

setTimeA(self, time: int) → None¶

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

setTimeB(self, time: int) → None¶

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

setUseMutualInfo(self, aFlag: bool) → None¶

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

setXSampling(self, aSampling: int) → None¶

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

setYSampling(self, aSampling: int) → None¶

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

setZSampling(self, aSampling: int) → None¶

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

ChannelSliceRegistrationHelper¶

class ORSModel.ors.ChannelSliceRegistrationHelper(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → ChannelSliceRegistrationHelper¶

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

ChannelSliceRegistrationHelper.ChannelSliceRegistrationHelper(self) -> ChannelSliceRegistrationHelper

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

ChannelSliceRegistrationHelper.ChannelSliceRegistrationHelper(self, rhs: ORSModel.ors.Managed) -> ChannelSliceRegistrationHelper

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper rhs (Managed) –

addTranslation(self, zIndex: int, tIndex: int, aVect: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) – aVect (ORSModel.ors.Vector3) –

applySliceRegistrationToChannel(self, pInputChannel: ORSModel.ors.Channel, iTIndex: int, IProgress: ORSModel.ors.Progress, pOutputChannel: ORSModel.ors.Channel) → Channel¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper pInputChannel (ORSModel.ors.Channel) – iTIndex (int) – IProgress (ORSModel.ors.Progress) – pOutputChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Channel) –

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:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) – aMatrix (ORSModel.ors.Matrix4x4) –

copyInto(self, aDestinationRegistration: ORSModel.ors.ChannelSliceRegistrationHelper) → None¶

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

copyShapeFromChannel(self, aChannel: ORSModel.ors.Channel) → None¶

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

extractSliceChannel(self, pInputChannel: ORSModel.ors.Channel, aCutPlane: ORSModel.ors.Plane, IOutputSliceChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress) → Channel¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper pInputChannel (ORSModel.ors.Channel) – aCutPlane (ORSModel.ors.Plane) – IOutputSliceChannel (ORSModel.ors.Channel) – timeStep (int) – IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.Channel) –

extractZSliceChannel(self, pInputChannel: ORSModel.ors.Channel, aCutPlane: ORSModel.ors.Plane, IOutputSliceChannel: ORSModel.ors.Channel, timeStep: int, IProgress: ORSModel.ors.Progress) → Channel¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper pInputChannel (ORSModel.ors.Channel) – aCutPlane (ORSModel.ors.Plane) – IOutputSliceChannel (ORSModel.ors.Channel) – timeStep (int) – IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.Channel) –

getApplicableChannelList(self) → List¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
Returns:	output (ORSModel.ors.List) –

getClassNameStatic() → str¶

Returns:	output (str) –

getComposeMatrixFromSliceIToJ(self, zIndexI: int, zIndexJ: int, tIndex: int) → Matrix4x4¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndexI (int) – zIndexJ (int) – tIndex (int) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getGlobalMatrix(self, zIndex: int, tIndex: int) → Matrix4x4¶

Returns the transformation matrix from channel original position to slice zIndex registered position.

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getIsSliceUnmovable(self, zIndex: int, tIndex: int) → bool¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) –
Returns:	output (bool) –

getMatrix(self, zIndex: int, tIndex: int) → Matrix4x4¶

Returns the transformation matrix from slice (zIndex-1) registered position to slice zIndex registered position.

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getMaxTranslation(self, tIndex: int) → Vector3¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper tIndex (int) –
Returns:	output (ORSModel.ors.Vector3) –

getMaximumXOffsetBetweenSlice(self) → int¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
Returns:	output (int) –

getMaximumYOffsetBetweenSlice(self) → int¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
Returns:	output (int) –

getMinTranslation(self, tIndex: int) → Vector3¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper tIndex (int) –
Returns:	output (ORSModel.ors.Vector3) –

getOpticalFluxMaximalLevelGaussianPyramid(self, aChannel: ORSModel.ors.Channel, nZIndex: int, nTIndex: int, pIBoundingBoxSearchArea: ORSModel.ors.Box) → int¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper aChannel (ORSModel.ors.Channel) – nZIndex (int) – nTIndex (int) – pIBoundingBoxSearchArea (ORSModel.ors.Box) –
Returns:	output (int) –

getRegisteredChannelBox(self, aChannel: ORSModel.ors.Channel) → Box¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper aChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Box) –

getSimilarityXSampling(self) → int¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
Returns:	output (int) –

getSimilarityYSampling(self) → int¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
Returns:	output (int) –

getTSize(self) → int¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
Returns:	output (int) –

getTranslation(self, zIndex: int, tIndex: int) → Vector3¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) –
Returns:	output (ORSModel.ors.Vector3) –

getZSize(self) → int¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper
Returns:	output (int) –

mergeSliceRegistrationHelper(self, pInputRegistrationHelper: ORSModel.ors.ChannelSliceRegistrationHelper, startZ: int, endZ: int, startT: int, endT: int, pOutputRegistrationHelper: ORSModel.ors.ChannelSliceRegistrationHelper) → ChannelSliceRegistrationHelper¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper pInputRegistrationHelper (ORSModel.ors.ChannelSliceRegistrationHelper) – startZ (int) – endZ (int) – startT (int) – endT (int) – pOutputRegistrationHelper (ORSModel.ors.ChannelSliceRegistrationHelper) –
Returns:	output (ORSModel.ors.ChannelSliceRegistrationHelper) –

none()¶

ChannelSliceRegistrationHelper.ChannelSliceRegistrationHelper() -> ChannelSliceRegistrationHelper

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of 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) –

Note

Set the parameter with setSimilarityXSampling(), setSimilarityYSampling(), setMaximumXOffsetBetweenSlice(), setMaximumYOffsetBetweenSlice()

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

Note

Set the parameter with setSimilarityXSampling(), setSimilarityYSampling(), setMaximumXOffsetBetweenSlice(), setMaximumYOffsetBetweenSlice()

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:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper xEnd (int) – yEnd (int) –

setIsSliceUnmovable(self, zIndex: int, tIndex: int, bUnmovable: bool) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) – bUnmovable (bool) –

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:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) – aMatrix (ORSModel.ors.Matrix4x4) –

setMaximumXOffsetBetweenSlice(self, maxOffset: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper maxOffset (int) –

setMaximumYOffsetBetweenSlice(self, maxOffset: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper maxOffset (int) –

setSimilarityXSampling(self, sampling: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper sampling (int) –

setSimilarityYSampling(self, sampling: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper sampling (int) –

setStartOfInterestZone(self, xStart: int, yStart: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper xStart (int) – yStart (int) –

setTSize(self, tSize: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper tSize (int) –

setTranslation(self, zIndex: int, tIndex: int, aVect: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zIndex (int) – tIndex (int) – aVect (ORSModel.ors.Vector3) –

setZSize(self, zSize: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceRegistrationHelper) – an instance of ChannelSliceRegistrationHelper zSize (int) –

ChannelSliceReplacementHelper¶

class ORSModel.ors.ChannelSliceReplacementHelper(self) → ChannelSliceReplacementHelper¶

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

ChannelSliceReplacementHelper.ChannelSliceReplacementHelper(self, rhs: ORSModel.ors.Unmanaged) -> ChannelSliceReplacementHelper

Parameters:	self (ORSModel.ors.ChannelSliceReplacementHelper) – an instance of ChannelSliceReplacementHelper rhs (Unmanaged) –

analyzeAndReplaceMarkedSlices(self) → None¶

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

canSliceReplacementBePerformed(self) → bool¶

Parameters:	self (ORSModel.ors.ChannelSliceReplacementHelper) – an instance of ChannelSliceReplacementHelper
Returns:	output (bool) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

ChannelSliceReplacementHelper.ChannelSliceReplacementHelper() -> ChannelSliceReplacementHelper

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

setChannel(self, pIInputChannel: ORSModel.ors.Channel) → None¶

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

setTime(self, value: int) → None¶

Parameters:	self (ORSModel.ors.ChannelSliceReplacementHelper) – an instance of ChannelSliceReplacementHelper value (int) –

Circle¶

class ORSModel.ors.Circle¶

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

Circle.Circle(self) -> Circle

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

Circle.Circle(self, center: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3, radius: float) -> Circle

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle center (ORSModel.ors.Vector3) – normal (ORSModel.ors.Vector3) – radius (float) –

Circle.Circle(self, rhs: ORSModel.ors.Unmanaged) -> Circle

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle rhs (Unmanaged) –

copy(self) → Circle¶

Copies aCircle.

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle
Returns:	output (ORSModel.ors.Circle) – A new Circle (an Circle)

Note

The copied Circle has the same equation as the source Circle.

from3Points(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3, point2: ORSModel.ors.Vector3) → None¶

Initializes theCircle from 3 points.

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle point0 (ORSModel.ors.Vector3) – The first point (an Vector3) point1 (ORSModel.ors.Vector3) – The second point (an Vector3) point2 (ORSModel.ors.Vector3) – The third point (an Vector3)

getArea(self) → float¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle
Returns:	output (float) –

getCenter(self) → Vector3¶

Returns the normal of theCircle.

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle
Returns:	output (ORSModel.ors.Vector3) – A vector (an Vector3)

getClassNameStatic() → str¶

Returns:	output (str) –

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

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

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle aLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if not intersection

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

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

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle aLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if not intersection

getIntersectionWithPlane(self, aPlane: ORSModel.ors.Plane) → LineSegment¶

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

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle aPlane (ORSModel.ors.Plane) –
Returns:	output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection

getIsEqualTo(self, Circle: ORSModel.ors.Circle) → bool¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle Circle (ORSModel.ors.Circle) –
Returns:	output (bool) –

getNormal(self) → Vector3¶

Returns the normal of theCircle.

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle
Returns:	output (ORSModel.ors.Vector3) – A vector (an Vector3)

getPlane(self) → Plane¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle
Returns:	output (ORSModel.ors.Plane) –

getPythonRepresentation(self) → str¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle
Returns:	output (str) –

getRadius(self) → float¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle
Returns:	output (float) –

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Circle¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle axisOfRotation (ORSModel.ors.Vector3) – rotationCenter (ORSModel.ors.Vector3) – angle (float) –
Returns:	output (ORSModel.ors.Circle) –

none()¶

Circle.Circle() -> Circle

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

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None¶

Applies a rotation to the receiver.

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3) aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3) angleInRadian (float) – an angle in radian (a double)

Note

The box is a right handed bounded referential.

setCenter(self, aCenter: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle aCenter (ORSModel.ors.Vector3) –

setNormal(self, aNormal: ORSModel.ors.Vector3) → None¶

Returns the normal of theCircle.

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle aNormal (ORSModel.ors.Vector3) –

setRadius(self, aRadius: float) → None¶

Parameters:	self (ORSModel.ors.Circle) – an instance of Circle aRadius (float) –

Collection¶

class ORSModel.ors.Collection¶

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.Collection(self, rhs: ORSModel.ors.Managed) -> Collection

Parameters:	self (ORSModel.ors.Collection) – an instance of Collection rhs (Managed) –

applyLinearTransformation(self, slope: float, offset: float) → None¶

Parameters:	self (ORSModel.ors.Collection) – an instance of Collection slope (float) – offset (float) –

getClassNameStatic() → str¶

Returns:	output (str) –

getSize(self) → int¶

Parameters:	self (ORSModel.ors.Collection) – an instance of Collection
Returns:	output (int) –

none()¶

Collection.Collection() -> Collection

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

Color¶

class ORSModel.ors.Color¶

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.Color(self) -> Color

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

Color.Color(self, red: float, green: float, blue: float, alpha: float) -> Color

Parameters:	self (ORSModel.ors.Color) – an instance of Color red (float) – green (float) – blue (float) – alpha (float) –

Color.Color(self, red: float, green: float, blue: float) -> Color

Parameters:	self (ORSModel.ors.Color) – an instance of Color red (float) – green (float) – blue (float) –

Color.Color(self, RGBColor: int) -> Color

Parameters:	self (ORSModel.ors.Color) – an instance of Color RGBColor (int) –

Color.Color(self, rhs: ORSModel.ors.Unmanaged) -> Color

Parameters:	self (ORSModel.ors.Color) – an instance of Color rhs (Unmanaged) –

fromQColor(qColor)¶

getAlpha(self) → float¶

Gets the alpha component of the color.

Parameters:	self (ORSModel.ors.Color) – an instance of Color
Returns:	output (float) – the alpha value (a double)

Note

Color components are expressed as values between 0 and 1.

getAsQColor()¶

getBlue(self) → float¶

Gets the blue component of the color.

Parameters:	self (ORSModel.ors.Color) – an instance of Color
Returns:	output (float) – the blue value (a double)

Note

Color components are expressed as values between 0 and 1.

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (float) – a double value

Note

Color components are expressed as values between 0 and 1.

Note

Color components indexes are zero-based.

getComponentCount(self) → int¶

Gets the number of component of the color.

Parameters:	self (ORSModel.ors.Color) – an instance of Color
Returns:	output (int) – the component count(an short)

getComponents(self) → ArrayDouble¶

Gets all the components of the color.

Parameters:	self (ORSModel.ors.Color) – an instance of Color
Returns:	output (ORSModel.ors.ArrayDouble) – a double array (an ArrayDouble)

Note

Color components are expressed as values between 0 and 1.

getGreen(self) → float¶

Gets the green component of the color.

Parameters:	self (ORSModel.ors.Color) – an instance of Color
Returns:	output (float) – the green value (a double)

Note

Color components are expressed as values between 0 and 1.

getRed(self) → float¶

Gets the red component of the color.

Parameters:	self (ORSModel.ors.Color) – an instance of Color
Returns:	output (float) – the red value (a double)

Note

Color components are expressed as values between 0 and 1.

none()¶

Color.Color() -> Color

Parameters:	self (ORSModel.ors.Color) – an instance of 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)

Note

Color components are expressed as values between 0 and 1.

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)

Note

Color components are expressed as values between 0 and 1.

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

Note

Color components are expressed as values between 0 and 1.

Note

Color components indexes are zero-based.

setComponents(self, components: ORSModel.ors.ArrayDouble) → None¶

Sets all the components of the color.

Parameters:	self (ORSModel.ors.Color) – an instance of Color components (ORSModel.ors.ArrayDouble) – a double array (an ArrayDouble)

Note

Color components are expressed as values between 0 and 1.

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)

Note

Color components are expressed as values between 0 and 1.

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)

Note

Color components are expressed as values between 0 and 1.

ConvolutionHelper¶

class ORSModel.ors.ConvolutionHelper(self) → ConvolutionHelper¶

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

ConvolutionHelper.ConvolutionHelper(self, rhs: ORSModel.ors.Unmanaged) -> ConvolutionHelper

Parameters:	self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper rhs (Unmanaged) –

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:

self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
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) –

Returns:

output (ORSModel.ors.Channel) –

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)

Returns:

output (ORSModel.ors.Array) – the resulting output array (an Array)

Note

The convolution’s size needs to be an odd number.

Note

The kernel is a one dimension array where the dimension is of equal size to the convolution.

Note

If a Float array is supplied as the last argument, the results are written to it, otherwise a new array is created.

get1DMedian(self, inputValues: ORSModel.ors.Array, kernelSize: int, nBorderHandling: int, values: ORSModel.ors.Array) → Array¶

Parameters:	self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper inputValues (ORSModel.ors.Array) – kernelSize (int) – nBorderHandling (int) – values (ORSModel.ors.Array) –
Returns:	output (ORSModel.ors.Array) –

getClassNameStatic() → str¶

Returns:	output (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) –

Returns:

output (ORSModel.ors.Channel) – the resulting channel (an Channel)

Note

The convolution’s size needs to be an odd number.

Note

The kernel is a two dimensional array where each dimension is of equal size to the convolution. Thus a convolution size of 5 needs a kernel of 5 x 5. It should be arranged in [y][x] order.

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created of the size of the input 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)

Returns:

output (ORSModel.ors.Channel) – the resulting channel (an Channel)

Note

If a channel is supplied as the last argument, the results are written to it, otherwise a new channel is created of the minimal size needed to agree with the indexes of output specified.

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:

self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
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) –

Returns:

output (ORSModel.ors.Channel) –

getPaddingValue(self) → float¶

Parameters:	self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
Returns:	output (float) –

getZOffsetInputToOutputWithOutsideZRangeUnaffected(self) → int¶

Parameters:	self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper
Returns:	output (int) –

none()¶

ConvolutionHelper.ConvolutionHelper() -> ConvolutionHelper

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

setPaddingValue(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper aValue (float) –

setZOffsetInputToOutputWithOutsideZRangeUnaffected(self, aValue: int) → None¶

Parameters:	self (ORSModel.ors.ConvolutionHelper) – an instance of ConvolutionHelper aValue (int) –

ConvolutionKernel¶

class ORSModel.ors.ConvolutionKernel(self) → ConvolutionKernel¶

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

ConvolutionKernel.ConvolutionKernel(self, rhs: ORSModel.ors.Unmanaged) -> ConvolutionKernel

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel rhs (Unmanaged) –

getClassNameStatic() → str¶

Returns:	output (str) –

getElementSummation(self) → float¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel
Returns:	output (float) –

getIs1DKernel(self) → bool¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel
Returns:	output (bool) –

getIs2DKernel(self) → bool¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel
Returns:	output (bool) –

getIs3DKernel(self) → bool¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel
Returns:	output (bool) –

getKernelStarPoint(self, pIndexX: int, pIndexY: int, pIndexZ: int) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel pIndexX (int) – pIndexY (int) – pIndexZ (int) –

getKernelXSize(self) → int¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel
Returns:	output (int) –

getKernelYSize(self) → int¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel
Returns:	output (int) –

getKernelZSize(self) → int¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel
Returns:	output (int) –

getValueAt(self, indexX: int, indexY: int, indexZ: int) → float¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel indexX (int) – indexY (int) – indexZ (int) –
Returns:	output (float) –

initializeAs1DKernel(self, indexX: int) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel indexX (int) –

initializeAs2DKernel(self, indexX: int, indexY: int) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel indexX (int) – indexY (int) –

initializeAs3DKernel(self, indexX: int, indexY: int, indexZ: int) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel indexX (int) – indexY (int) – indexZ (int) –

multiplyAllElementBy(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel aValue (float) –

none()¶

ConvolutionKernel.ConvolutionKernel() -> ConvolutionKernel

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

setAsGaussianWithMinimumUnnormalizedSmallestValue(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel aValue (float) –

setAsGaussianWithStandarDeviation(self, sigma: float) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel sigma (float) –

setKernelStarPoint(self, indexX: int, indexY: int, indexZ: int) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel indexX (int) – indexY (int) – indexZ (int) –

setValueAt(self, indexX: int, indexY: int, indexZ: int, aValue: float) → None¶

Parameters:	self (ORSModel.ors.ConvolutionKernel) – an instance of ConvolutionKernel indexX (int) – indexY (int) – indexZ (int) – aValue (float) –

Cursor3D¶

class ORSModel.ors.Cursor3D¶

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.Cursor3D(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> Cursor3D

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

Cursor3D.Cursor3D(self) -> Cursor3D

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

Cursor3D.Cursor3D(self, rhs: ORSModel.ors.Managed) -> Cursor3D

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D rhs (Managed) –

getActivePlaneColor(self) → Color¶

Gets the active plane color of the 3D cursor.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (ORSModel.ors.Color) – a color (an Color)

Note

The color is expressed in RGB fashion.

getAllHighlightedViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View) → List¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.List) –

getAllHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View) → List¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.List) –

getAllHighlightedViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View) → List¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.List) –

getAllParentViewsExcludingCurrent(self, pCurrentDisplay: ORSModel.ors.View) → List¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.List) –

getAllParentViewsExcludingCurrentCount(self, pCurrentDisplay: ORSModel.ors.View) → int¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (int) –

getAllShownViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View) → List¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.List) –

getAllShownViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View) → List¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.List) –

getAnyHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getClassNameStatic() → str¶

Returns:	output (str) –

getColor(self) → Color¶

Gets the color of the 3D cursor.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (ORSModel.ors.Color) – a color (an Color)

Note

The color is expressed in RGB fashion.

getCrossHairMode(self) → int¶

Gets the crosshair mode of the 3D cursor.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (int) – a crosshair mode (a int32_t)

Note

See the Cxv3DCursor_Crosshair enum in the ORS_def.h header file for valid crosshair modes.

getCrossHairWidth(self) → float¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (float) –

getHideReferenceLinesInCurrentView(self) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (bool) –

getHighlightedCircleInView(self, pCurrentDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getHighlightedObliqueSliderInView(self, pCurrentDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getIsHighlightedViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getIsHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getIsHighlightedViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getIsShowViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getIsShowViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getLineThickness(self) → float¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (float) –

getMiddleHoleSize(self) → float¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (float) –

getPickAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → View¶

Picks for an anchor in the given display.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pDisplay (ORSModel.ors.View) – a display (an View) pixelXPositionInDisplay (int) – pixelYPositionInDisplay (int) –
Returns:	output (ORSModel.ors.View) – aView

getPickMIPAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → View¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pDisplay (ORSModel.ors.View) – pixelXPositionInDisplay (int) – pixelYPositionInDisplay (int) –
Returns:	output (ORSModel.ors.View) –

getPickMPRAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → View¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pDisplay (ORSModel.ors.View) – pixelXPositionInDisplay (int) – pixelYPositionInDisplay (int) –
Returns:	output (ORSModel.ors.View) –

getPickObliqueCircleAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pDisplay (ORSModel.ors.View) – pixelXPositionInDisplay (int) – pixelYPositionInDisplay (int) –
Returns:	output (bool) –

getPickObliqueSliderAnchor(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → int¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pDisplay (ORSModel.ors.View) – pixelXPositionInDisplay (int) – pixelYPositionInDisplay (int) –
Returns:	output (int) –

getPosition(self) → Vector3¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (ORSModel.ors.Vector3) –

getShowAllSynchStudyReferenceLines(self) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (bool) –

getShowCircleForView(self, pCurrentDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getShowFirstLastSynchStudyReferenceLines(self) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (bool) –

getShowObliqueSliderForView(self, pCurrentDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

getShowSynchStudyReferenceLine(self) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (bool) –

getSynchronizedMode(self) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D
Returns:	output (bool) –

getViewsDefineAValidCursorPosition(self, pCurrentDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) –
Returns:	output (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.Cursor3D() -> Cursor3D

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

setActivePlaneColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the active plane color of the 3D cursor.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D IColor (ORSModel.ors.Color) – a color (an Color)

Note

The color is expressed in RGB fashion.

setColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the color of the 3D cursor.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D IColor (ORSModel.ors.Color) – a color (an Color)

Note

The color is expressed in RGB fashion.

setCrossHairMode(self, iMode: int) → None¶

Sets the crosshair mode of the 3D cursor.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D iMode (int) – a crosshair mode (a int32_t*)

Note

See the Cxv3DCursor_Crosshair enum in the ORS_def.h header file for valid crosshair modes.

setCrossHairWidth(self, value: float) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D value (float) –

setCursorPositionFromParentView(self, pDisplay: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pDisplay (ORSModel.ors.View) –
Returns:	output (bool) –

setHideReferenceLinesInCurrentView(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D value (bool) –

setHighlightedCircleInView(self, pCurrentDisplay: ORSModel.ors.View, highlight: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – highlight (bool) –

setHighlightedObliqueSliderInView(self, pCurrentDisplay: ORSModel.ors.View, highlight: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – highlight (bool) –

setHighlightedViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, highlight: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) – highlight (bool) –

setHighlightedViewLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, highlight: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) – highlight (bool) –

setHighlightedViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, highlight: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) – highlight (bool) –

setLineThickness(self, value: float) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D value (float) –

setMiddleHoleSize(self, value: float) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D value (float) –

setPosition(self, pPosition: ORSModel.ors.Vector3) → None¶

Sets the position of the 3D cursor.

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pPosition (ORSModel.ors.Vector3) – a screen position (an Vector3)

setShowAllSynchStudyReferenceLines(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D value (bool) –

setShowCircleInView(self, pCurrentDisplay: ORSModel.ors.View, showC: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – showC (bool) –

setShowFirstLastSynchStudyReferenceLines(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D value (bool) –

setShowObliqueSliderInView(self, pCurrentDisplay: ORSModel.ors.View, showO: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – showO (bool) –

setShowSynchStudyReferenceLine(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D value (bool) –

setShowViewAnchorsInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, showA: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) – showA (bool) –

setShowViewMIPLineInView(self, pCurrentDisplay: ORSModel.ors.View, anotherDisplay: ORSModel.ors.View, showA: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D pCurrentDisplay (ORSModel.ors.View) – anotherDisplay (ORSModel.ors.View) – showA (bool) –

setSynchronizedMode(self, aBool: bool) → None¶

Parameters:	self (ORSModel.ors.Cursor3D) – an instance of Cursor3D aBool (bool) –

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¶

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

Cylinder.Cylinder(self) -> Cylinder

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

Cylinder.Cylinder(self, firstCenter: ORSModel.ors.Vector3, secondCenter: ORSModel.ors.Vector3, radius: float) -> Cylinder

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder firstCenter (ORSModel.ors.Vector3) – secondCenter (ORSModel.ors.Vector3) – radius (float) –

Cylinder.Cylinder(self, rhs: ORSModel.ors.Unmanaged) -> Cylinder

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder rhs (Unmanaged) –

copy(self) → Cylinder¶

Copies aCylinder.

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder
Returns:	output (ORSModel.ors.Cylinder) – A new Cylinder (an Cylinder)

Note

The copied Cylinder has the same equation as the source Cylinder.

getAxis(self) → Vector3¶

Returns the normal of theCylinder.

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder
Returns:	output (ORSModel.ors.Vector3) – A vector (an Vector3)

getCap1Center(self) → Vector3¶

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder
Returns:	output (ORSModel.ors.Vector3) –

getCap2Center(self) → Vector3¶

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder
Returns:	output (ORSModel.ors.Vector3) –

getCenter(self) → Vector3¶

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder
Returns:	output (ORSModel.ors.Vector3) –

getClassNameStatic() → str¶

Returns:	output (str) –

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

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

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder aLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection

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

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

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder aLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection

getIsEqualTo(self, Cylinder: ORSModel.ors.Cylinder) → bool¶

Verifies equality between the receiver and a givenCylinder.

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder Cylinder (ORSModel.ors.Cylinder) –
Returns:	output (bool) – TRUE if the argument Cylinder is equal to the receiver, FALSE otherwise

getPythonRepresentation(self) → str¶

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder
Returns:	output (str) –

getRadius(self) → float¶

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder
Returns:	output (float) –

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Cylinder¶

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder axisOfRotation (ORSModel.ors.Vector3) – rotationCenter (ORSModel.ors.Vector3) – angle (float) –
Returns:	output (ORSModel.ors.Cylinder) –

none()¶

Cylinder.Cylinder() -> Cylinder

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

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None¶

Applies a rotation to the receiver.

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3) aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3) angleInRadian (float) – an angle in radian (a double)

Note

The box is a right handed bounded referential.

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

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder aPoint (ORSModel.ors.Vector3) –

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

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder aPoint (ORSModel.ors.Vector3) –

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

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder aPoint (ORSModel.ors.Vector3) –

setRadius(self, aRadius: float) → None¶

Parameters:	self (ORSModel.ors.Cylinder) – an instance of Cylinder aRadius (float) –

DatasetPresenter¶

class ORSModel.ors.DatasetPresenter(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → DatasetPresenter¶

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

DatasetPresenter.DatasetPresenter(self, rhs: ORSModel.ors.Managed) -> DatasetPresenter

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter rhs (Managed) –

get2DWindowLevel2Center(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get2DWindowLevel2Max(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get2DWindowLevel2Min(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

Note

Return values are written to the supplied arguments.

get2DWindowLevel2Values(self, pWindowWidth: float, pWindowCenter: float) → None¶

Gets the second 2D window level values for the double leveling mode.

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pWindowWidth (float) – pWindowCenter (float) –

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

Return values are written to the supplied arguments.

get2DWindowLevel2Width(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get2DWindowLevelCenterForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get2DWindowLevelCenterForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (float) –

get2DWindowLevelMaxForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get2DWindowLevelMaxForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (float) –

get2DWindowLevelMinForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get2DWindowLevelMinForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

Note

Return values are written to the supplied arguments.

get2DWindowLevelRangeForView(self, pDisplay: ORSModel.ors.View, pMin: float, pMax: float) → None¶

Gets the current 2D window level range values.

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pMax (float) –
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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

Note

Return values are written to the supplied arguments.

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*)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

Return values are written to the supplied arguments.

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:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) – the display (an View)
Returns:	pWindowWidth (float) – the window level width (a double) pWindowCenter* (float) – the window level center (a double*)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

Return values are written to the supplied arguments.

get2DWindowLevelWidthForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get2DWindowLevelWidthForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (float) –

get3DWindowLevelCenterForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get3DWindowLevelCenterForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (float) –

get3DWindowLevelMaxForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get3DWindowLevelMaxForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (float) –

get3DWindowLevelMinForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get3DWindowLevelMinForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

Note

Return values are written to the supplied arguments.

get3DWindowLevelRangeForView(self, IDisplay: ORSModel.ors.View, pMin: float, pMax: float) → None¶

Gets the current 2D window level range values.

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pMax (float) –
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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

Note

Return values are written to the supplied arguments.

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*)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D views.

Note

The values are expressed in physical units.

Note

Return values are written to the supplied arguments.

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:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) – the display (an View)
Returns:	pWindowWidth (float) – the window level width (a double) pWindowCenter* (float) – the window level center (a double*)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

Return values are written to the supplied arguments.

get3DWindowLevelWidthForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (float) –

get3DWindowLevelWidthForView(self, pDisplay: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) –
Returns:	output (float) –

getClassNameStatic() → str¶

Returns:	output (str) –

getRangeSelectionColor(self) → Color¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (ORSModel.ors.Color) –

getUseLUTAlphaIn2DForAllViews(self) → bool¶

Ask the dataset presenter to use the applied lut alpha component.

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter
Returns:	output (bool) – bool

getUseLUTAlphaIn2DForView(self, pDisplay: ORSModel.ors.View) → bool¶

Ask the dataset presenter to use the applied lut alpha component.

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) – the view (an View)
Returns:	output (bool) – bool

none()¶

DatasetPresenter.DatasetPresenter() -> DatasetPresenter

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of 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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values should be expressed in physical units.

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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

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:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) – The lower range value (a double) iMin (float) – The upper range value (a double) iMax (float) –

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values should be expressed in physical units.

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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values should be expressed in physical units.

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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

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:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter IDisplay (ORSModel.ors.View) – The lower range value (a double) iMin (float) – The upper range value (a double) iMax (float) –

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values are expressed in physical units.

Note

The level width and center can be derived from the min/max.

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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values should be expressed in physical units.

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)

Note

Volumes support two leveling modes, one for 3D displays and the other for 2D displays.

Note

The values should be expressed in physical units.

set3DWindowLevelValuesForViewLogged(view, width, center, logging=True)¶

setRangeSelectionColor(self, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter IColor (ORSModel.ors.Color) –

setUseLUTAlphaIn2DForAllViews(self, aFlag: bool) → None¶

Tell the dataset presenter to use the applied lut alpha componenet.

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter aFlag (bool) – bool

setUseLUTAlphaIn2DForView(self, pDisplay: ORSModel.ors.View, aFlag: bool) → None¶

Tell the dataset presenter to use the applied lut alpha componenet.

Parameters:	self (ORSModel.ors.DatasetPresenter) – an instance of DatasetPresenter pDisplay (ORSModel.ors.View) – the view (an View) aFlag (bool) – bool

setUseLUTAlphaIn2DForViewLogged(view, value, logging=True)¶

Dijkstra¶

class ORSModel.ors.Dijkstra(self) → Dijkstra¶

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

Dijkstra.Dijkstra(self, rhs: ORSModel.ors.Unmanaged) -> Dijkstra

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra rhs (Unmanaged) –

cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel) → None¶

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

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra outputChannel (ORSModel.ors.Channel) – a distance map channel (an Channel)

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:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra lOutputChannelDistanceMap (ORSModel.ors.Channel) – the distance map generated by the Dijkstra algorithm (an Channel) lOutputChannelTraceBack (ORSModel.ors.Channel) – a traceback channel, can be NULL (an Channel) lOutputChannelLabel (ORSModel.ors.Channel) – a label channel, can be NULL (an Channel)

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
Returns:	output (float) – the alpha parameter (an double)

Note

Only useful when metric is set to 1.

getClassNameStatic() → str¶

Returns:	output (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
Returns:	output (float) – the minimum distance between voxels (an double)

Note

Neighbors of distance 1 will have a bias of spacialTerm

Note

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

Note

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

getGaussianPeakCenterValue(self) → float¶

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

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
Returns:	output (float) – peak center of the gaussian (a double)

Note

Only useful when metric is set to 1.

getIndexOfStopPointReach(self) → int¶

Retrieve the index reached by theDijkstra algorithm.

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
Returns:	output (int) – index in the input channel (a int64_t)

Note

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

getKappa(self) → float¶

Gets the kappa parameter for the metric == 1.

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
Returns:	output (float) – the kappa parameter (an double)

Note

Only useful when metric is set to 1.

getMetric(self) → int¶

Gets the metric used by theDijkstra algorithm.

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
Returns:	output (int) – 0 or 1

Note

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

Note

If the metric chosen is 1, the metric function will be: DijkstraDistanceBetween(a,b) = (Ia-Ib)^2 + EuclideanBias*EuclideanDistance(a,b) + alpha(1.0 - exp(-(b-gaussianPeakCenterValue)^2/kappa*sigmaPow2)); where a and b are Neighbor, Ia and Ib are intensity at a and b

getNeighborCount(self) → int¶

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

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
Returns:	output (int) – the number of neighbors (an char)

Note

Can be 6, 18 or 26

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)
Returns:	output (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI), or NULL if no ROI is at that slot

Note

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

getROICount(self) → int¶

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

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
Returns:	output (int) – the number of ROIs that have been provided (an char)

Note

A maximum of 10 ROI can be provided.

getSigmaPow2(self) → float¶

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

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra
Returns:	output (float) – variance of the gaussian (an double)

Note

Only useful when metric is set to 1.

none()¶

Dijkstra.Dijkstra() -> Dijkstra

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of 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)

Note

Only useful when metric is set to 1.

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)

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

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

Note

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

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)

Note

Only useful when metric is set to 1.

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

Note

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

setInputLabelsChannel(self, aInputLabelsChannel: ORSModel.ors.Channel) → None¶

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

setInputMultiROI(self, aInputMultiROI: ORSModel.ors.MultiROI) → None¶

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra aInputMultiROI (ORSModel.ors.MultiROI) –

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)

Note

Only useful when metric is set to 1.

setMaskROI(self, IMaskROI: ORSModel.ors.ROI) → None¶

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra IMaskROI (ORSModel.ors.ROI) –

setMetric(self, metricType: int) → None¶

Selects the metric to be used by theDijkstra algorithm.

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra metricType (int) – 0 or 1

Note

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

Note

If the metric chosen is 1, the metric function will be: DijkstraDistanceBetween(a,b) = (Ia-Ib)^2 + EuclideanBias*EuclideanDistance(a,b) + alpha(1.0 - exp(-(b-gaussianPeakCenterValue)^2/kappa*sigmaPow2)); where a and b are Neighbors, Ia and Ib are intensity at a and b

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:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra IProgress (ORSModel.ors.Progress) –

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)

Note

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

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)

Note

Only useful when metric is set to 1.

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:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra aROI (ORSModel.ors.ROI) – a trace back start (an ROI) linputChannelTraceBack (ORSModel.ors.Channel) – a trace back channel (an ROI) aPath (ORSModel.ors.VisualPath) –

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

Parameters:	self (ORSModel.ors.Dijkstra) – an instance of Dijkstra lOutputChannelDistanceMap (ORSModel.ors.Channel) – maxDistance (float) – lOutputChannelTraceBack (ORSModel.ors.Channel) – lOutputChannelLabel (ORSModel.ors.Channel) –

Dijkstra2D¶

class ORSModel.ors.Dijkstra2D(self) → Dijkstra2D¶

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

Dijkstra2D.Dijkstra2D(self, rhs: ORSModel.ors.Unmanaged) -> Dijkstra2D

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D rhs (Unmanaged) –

cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel) → None¶

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

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D outputChannel (ORSModel.ors.Channel) – a distance map channel (an Channel)

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

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

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

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D lOutputChannelDistanceMap (ORSModel.ors.Channel) – lOutputChannelLabel (ORSModel.ors.Channel) – traceBackChannel (ORSModel.ors.Channel) –

getClassNameStatic() → str¶

Returns:	output (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
Returns:	output (float) – the minimum distance between voxel (an double)

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

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

Note

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

getNeighborCount(self) → int¶

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D
Returns:	output (int) –

getROICount(self) → int¶

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

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D
Returns:	output (int) – the number of ROIs that have been provided (an char)

Note

A maximum of 10 ROI can be provided.

getVolumeROI(self, index: int) → ROI¶

Retrieves a particularROI from the index specified slot.

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D index (int) – the slot index (an unsigned char)
Returns:	output (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI), or NULL if no ROI is at that slot

Note

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

none()¶

Dijkstra2D.Dijkstra2D() -> Dijkstra2D

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of 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)

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

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

Note

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

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

Note

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

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:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D index (int) – the slot index (an unsigned char) aVolROI (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI)

Note

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

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

Parameters:	self (ORSModel.ors.Dijkstra2D) – an instance of Dijkstra2D traceBackChannel (ORSModel.ors.Channel) – worldPosition (ORSModel.ors.Vector3) – outArray (ORSModel.ors.Array) –
Returns:	output (ORSModel.ors.Array) –

DijkstraOnGraph¶

class ORSModel.ors.DijkstraOnGraph¶

generateDistanceMap(aGraph: ORSModel.ors.Graph, metric: int, startIndices: ORSModel.ors.ArrayUnsignedLong, maxDistance: float) → None¶

Parameters:	aGraph (ORSModel.ors.Graph) – metric (int) – startIndices (ORSModel.ors.ArrayUnsignedLong) – maxDistance (float) –

getClassNameStatic() → str¶

Returns:	output (str) –

DimensionUnit¶

class ORSModel.ors.DimensionUnit¶

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.DimensionUnit(self) -> DimensionUnit

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

DimensionUnit.DimensionUnit(self, rhs: ORSModel.ors.Managed) -> DimensionUnit

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit rhs (Managed) –

convertToUnit(self, aVolume: float, anIDimensionUnit: ORSModel.ors.DimensionUnit) → float¶

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit aVolume (float) – anIDimensionUnit (ORSModel.ors.DimensionUnit) –
Returns:	output (float) –

getClassNameStatic() → str¶

Returns:	output (str) –

getDefault(self, dimensionType: int) → DimensionUnit¶

Gets the default system unit.

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit dimensionType (int) –
Returns:	output (ORSModel.ors.DimensionUnit) – a DimensionUnit

getDimensionID(self) → int¶

Gets the unit dimension ID.

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit
Returns:	output (int) – a CxvUniverse_Dimension

Note

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

getDimensionType(self) → int¶

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit
Returns:	output (int) –

getReferenceUnitConvertedToUnit(self, aVolume: float) → float¶

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit aVolume (float) –
Returns:	output (float) –

getReferenceUnitToUnitFactor(self) → float¶

Gets the unit factor.

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit
Returns:	output (float) – a multiplying factor (a double)

Note

All factors are expressed in relation to 1 meter (the base unit).

getTypeForID(self, pDimension: int) → int¶

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit pDimension (int) –
Returns:	output (int) –

getUnitAbbreviation(self) → str¶

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit
Returns:	output (str) –

getUnitConvertedToReferenceUnit(self, aVolume: float) → float¶

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit aVolume (float) –
Returns:	output (float) –

getUnitForID(self, pDimension: int) → DimensionUnit¶

Gets the unit for the specified index.

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit pDimension (int) – a dimension index (an int)
Returns:	output (ORSModel.ors.DimensionUnit) – a DimensionUnit

Note

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

getUnitName(self) → str¶

Parameters:	self (ORSModel.ors.DimensionUnit) – an instance of DimensionUnit
Returns:	output (str) –

getUnitWithAbbreviation(self, sAbbreviation: str) → DimensionUnit¶

Gets the unit that has the specified abbreviation.

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

none()¶

DimensionUnit.DimensionUnit() -> DimensionUnit

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

DistanceChannelAnalyzer¶

class ORSModel.ors.DistanceChannelAnalyzer(self) → DistanceChannelAnalyzer¶

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

DistanceChannelAnalyzer.DistanceChannelAnalyzer(self, rhs: ORSModel.ors.Unmanaged) -> DistanceChannelAnalyzer

Parameters:	self (ORSModel.ors.DistanceChannelAnalyzer) – an instance of DistanceChannelAnalyzer rhs (Unmanaged) –

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

Parameters:	self (ORSModel.ors.DistanceChannelAnalyzer) – an instance of DistanceChannelAnalyzer lDistanceChannel (ORSModel.ors.Channel) – inputROI (ORSModel.ors.ROI) – outputROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) –

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

Parameters:	self (ORSModel.ors.DistanceChannelAnalyzer) – an instance of DistanceChannelAnalyzer lDistanceChannel (ORSModel.ors.Channel) – inputROI (ORSModel.ors.ROI) – InputPath (ORSModel.ors.VisualPath) –
Returns:	output (ORSModel.ors.VisualPath) –

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

Parameters:	self (ORSModel.ors.DistanceChannelAnalyzer) – an instance of DistanceChannelAnalyzer lDistanceChannel (ORSModel.ors.Channel) – inputROI (ORSModel.ors.ROI) – outputROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

DistanceChannelAnalyzer.DistanceChannelAnalyzer() -> DistanceChannelAnalyzer

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

EuclideanDistanceMapGenerator¶

class ORSModel.ors.EuclideanDistanceMapGenerator¶

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.EuclideanDistanceMapGenerator(self) -> EuclideanDistanceMapGenerator

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

EuclideanDistanceMapGenerator.EuclideanDistanceMapGenerator(self, rhs: ORSModel.ors.Unmanaged) -> EuclideanDistanceMapGenerator

Parameters:	self (ORSModel.ors.EuclideanDistanceMapGenerator) – an instance of EuclideanDistanceMapGenerator rhs (Unmanaged) –

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

Parameters:	self (ORSModel.ors.EuclideanDistanceMapGenerator) – an instance of EuclideanDistanceMapGenerator seedChannel (ORSModel.ors.Channel) – outputChannel (ORSModel.ors.Channel) – timeStep (int) – IProgress (ORSModel.ors.Progress) – bShowProgress (bool) –
Returns:	output (ORSModel.ors.Channel) –

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

Parameters:	self (ORSModel.ors.EuclideanDistanceMapGenerator) – an instance of EuclideanDistanceMapGenerator seedVolumeROI (ORSModel.ors.ROI) – outputChannel (ORSModel.ors.Channel) – timeStep (int) – IProgress (ORSModel.ors.Progress) – bShowProgress (bool) –
Returns:	output (ORSModel.ors.Channel) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

EuclideanDistanceMapGenerator.EuclideanDistanceMapGenerator() -> EuclideanDistanceMapGenerator

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

FaceVertexMesh¶

class ORSModel.ors.FaceVertexMesh(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → FaceVertexMesh¶

Bases: ORSModel.ors.Mesh

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

FaceVertexMesh.FaceVertexMesh(self) -> FaceVertexMesh

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

FaceVertexMesh.FaceVertexMesh(self, rhs: ORSModel.ors.Managed) -> FaceVertexMesh

Parameters:	self (ORSModel.ors.FaceVertexMesh) – an instance of FaceVertexMesh rhs (Managed) –

copyInto(self, aDestinationUnstructuredGrid: ORSModel.ors.Node) → None¶

Copies the receiver unstructured grid into another unstructured grid.

Parameters:	self (ORSModel.ors.FaceVertexMesh) – an instance of FaceVertexMesh aDestinationUnstructuredGrid (ORSModel.ors.Node) – a destination unstructured grid

getAsHalfEdgeModelCopy(self, pInOutMeshModel: ORSModel.ors.HalfEdgeMesh) → HalfEdgeMesh¶

Parameters:	self (ORSModel.ors.FaceVertexMesh) – an instance of FaceVertexMesh pInOutMeshModel (ORSModel.ors.HalfEdgeMesh) –
Returns:	output (ORSModel.ors.HalfEdgeMesh) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

FaceVertexMesh.FaceVertexMesh() -> FaceVertexMesh

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

FastMarching¶

class ORSModel.ors.FastMarching(self) → FastMarching¶

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

FastMarching.FastMarching(self, rhs: ORSModel.ors.Unmanaged) -> FastMarching

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching rhs (Unmanaged) –

cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel) → None¶

Remove boundary or non reached value from a speed mapChannel.

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching outputChannel (ORSModel.ors.Channel) – a distance map Channel (an Channel)

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

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching lOutputChannelSpeedMap (ORSModel.ors.Channel) – forNbIteration (int) – autoUpdateROI (bool) –

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

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching inChannelDistanceMap (ORSModel.ors.Channel) – positionTripleInSourceRef (int) – nbPosition (int) – lMaskChannel (ORSModel.ors.Channel) – traceBackChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Channel) –

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

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching lOutputChannelSpeedMap (ORSModel.ors.Channel) – forNbIteration (int) – autoUpdateROI (bool) – lMaskChannel (ORSModel.ors.Channel) –

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

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching inChannelDistanceMap (ORSModel.ors.Channel) – lMaskChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Channel) –

getClassNameStatic() → str¶

Returns:	output (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
Returns:	output (float) – the minimum distance between voxel (an double)

Note

Neighbor of distance 1 will have a bias of spacialTerm

Note

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

Note

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

getForcedMeanValue(self) → float¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (float) –

getIndexOfStopPointReach(self) → int¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (int) –

getMaxValueToConsider(self) → float¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (float) –

getMinValueToConsider(self) → float¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (float) –

getROI(self, index: int) → ROI¶

Retrieves a particularROI from the index specified slot.

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching index (int) – the slot index (an unsigned char)
Returns:	output (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI), or NULL if no ROI is at that slot

Note

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

getROICount(self) → int¶

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

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (int) – the number of ROIs that have been provided (an char)

Note

A maximum of 10 ROI can be provided.

getStopValue(self) → float¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (float) –

getStopWhenValueIsEncountered(self) → bool¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (bool) –

getUsedForcedMean(self) → bool¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching
Returns:	output (bool) –

none()¶

FastMarching.FastMarching() -> FastMarching

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

recomputeValueWindow(self, aVolumeROI: ORSModel.ors.ROI) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching aVolumeROI (ORSModel.ors.ROI) –

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)

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

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

Note

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

setForcedMeanValue(self, aVal: float) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching aVal (float) –

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)

Note

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

setMaxValueToConsider(self, maxValue: float) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching maxValue (float) –

setMinValueToConsider(self, minValue: float) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching minValue (float) –

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.FastMarching) – an instance of FastMarching index (int) – the slot index (an unsigned char) aVolROI (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI)

Note

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

setStopPosition(self, xP: int, yP: int, zP: int) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching xP (int) – yP (int) – zP (int) –

setStopValue(self, stopValue: float) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching stopValue (float) –

setStopWhenValueIsEncountered(self, aF: bool) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching aF (bool) –

setUseValueWindow(self, aF: bool) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching aF (bool) –

setUsedForcedMean(self, aF: bool) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching aF (bool) –

useDijkstraMetric(self, aF: bool) → None¶

Parameters:	self (ORSModel.ors.FastMarching) – an instance of FastMarching aF (bool) –

FastMarching2D¶

class ORSModel.ors.FastMarching2D¶

author: Benjamin Provencher. All other members of ORS participated. version: 1.0 date: June 2010

FastMarching2D.FastMarching2D(self) -> FastMarching2D

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

FastMarching2D.FastMarching2D(self, rhs: ORSModel.ors.Unmanaged) -> FastMarching2D

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D rhs (Unmanaged) –

cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel) → None¶

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

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D outputChannel (ORSModel.ors.Channel) – a distance map channel (an Channel)

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

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

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

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D lOutputChannelSpeedMap (ORSModel.ors.Channel) – forNbIteration (int) – autoUpdateROI (bool) – lMaskChannel (ORSModel.ors.Channel) –

getClassNameStatic() → str¶

Returns:	output (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
Returns:	output (float) –

getROICount(self) → int¶

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

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D
Returns:	output (int) – the number of ROIs that have been provided (an char)

Note

A maximum of 10 ROI can be provided.

getVolumeROI(self, index: int) → ROI¶

Retrieves a particularROI from the index specified slot.

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D index (int) – the slot index (an unsigned char)
Returns:	output (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI), or NULL if no ROI is at that slot

Note

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

none()¶

FastMarching2D.FastMarching2D() -> FastMarching2D

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of 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)

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

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

Note

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

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)

Note

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

setMeanValue(self, mean: float) → None¶

Set the mean value used in the setian metric.

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D mean (float) – float a normalized value

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.FastMarching2D) – an instance of FastMarching2D index (int) – the slot index (an unsigned char) aVolROI (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI)

Note

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

useDijkstraMetric(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.FastMarching2D) – an instance of FastMarching2D pFlag (bool) –

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.FastMarchingWatershed2D(self) -> FastMarchingWatershed2D

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

FastMarchingWatershed2D.FastMarchingWatershed2D(self, rhs: ORSModel.ors.Unmanaged) -> FastMarchingWatershed2D

Parameters:	self (ORSModel.ors.FastMarchingWatershed2D) – an instance of FastMarchingWatershed2D rhs (Unmanaged) –

getClassNameStatic() → str¶

Returns:	output (str) –

getGradMinimumSearchRange(self) → int¶

Parameters:	self (ORSModel.ors.FastMarchingWatershed2D) – an instance of FastMarchingWatershed2D
Returns:	output (int) –

none()¶

FastMarchingWatershed2D.FastMarchingWatershed2D() -> FastMarchingWatershed2D

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

setGradChannel(self, gradChannel: ORSModel.ors.Channel) → None¶

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

setGradMinimumSearchRange(self, range: int) → None¶

Parameters:	self (ORSModel.ors.FastMarchingWatershed2D) – an instance of FastMarchingWatershed2D range (int) –

setLabelChannel(self, labelChannel: ORSModel.ors.Channel) → None¶

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

FordBellmanAutomata¶

class ORSModel.ors.FordBellmanAutomata(self) → FordBellmanAutomata¶

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

FordBellmanAutomata.FordBellmanAutomata(self, rhs: ORSModel.ors.Unmanaged) -> FordBellmanAutomata

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata rhs (Unmanaged) –

cleanDistanceMapChannel(self, outputChannel: ORSModel.ors.Channel) → None¶

Remove boundary or non reached value from a distance mapChannel.

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata outputChannel (ORSModel.ors.Channel) – a distance map Channel (an Channel)

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

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata lOutputChannelDistanceMap (ORSModel.ors.Channel) – lOutputChannelTraceBack (ORSModel.ors.Channel) – lOutputChannelLabel (ORSModel.ors.Channel) – nbIteration (int) –

getClassNameStatic() → str¶

Returns:	output (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
Returns:	output (float) – the minimum distance between voxel (an float)

Note

Neighbor of distance 1 will have a bias of spacialTerm

Note

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

Note

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

getMetric(self) → int¶

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
Returns:	output (int) –

getNeighborCount(self) → int¶

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
Returns:	output (int) –

getROI(self, index: int) → ROI¶

Retrieves a particularROI from the index specified slot.

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata index (int) – the slot index (an unsigned char)
Returns:	output (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI), or NULL if no ROI is at that slot

Note

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

getROICount(self) → int¶

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

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata
Returns:	output (int) – the number of ROIs that have been provided (an char)

Note

A maximum of 10 ROI can be provided.

none()¶

FordBellmanAutomata.FordBellmanAutomata() -> FordBellmanAutomata

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of 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:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata EuclideanBias (float) – the minimum distance between voxels (a float)

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

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

Note

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

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

Note

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

setMetric(self, metricType: int) → None¶

Parameters:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata metricType (int) –

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:	self (ORSModel.ors.FordBellmanAutomata) – an instance of FordBellmanAutomata index (int) – the slot index (an int) aVolROI (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI)

Note

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

GaussianPyramid¶

class ORSModel.ors.GaussianPyramid(self) → GaussianPyramid¶

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

GaussianPyramid.GaussianPyramid(self, rhs: ORSModel.ors.Unmanaged) -> GaussianPyramid

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid rhs (Unmanaged) –

createGaussianPyramid(self, pIOutChannelsGaussianPyramid: ORSModel.ors.Channel, pNumberOfLevels: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid pIOutChannelsGaussianPyramid (ORSModel.ors.Channel) – pNumberOfLevels (int) –

getChannelBase(self) → Channel¶

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

getClassNameStatic() → str¶

Returns:	output (str) –

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

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid firstLevelChannel (ORSModel.ors.Channel) – secondLevelChannel (ORSModel.ors.Channel) – thirdLevelChannel (ORSModel.ors.Channel) – fourthLevelChannel (ORSModel.ors.Channel) –

getHalfsizeKernel(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid x (int) – y (int) – z (int) –

getMaxLevelGaussianPyramid(self) → int¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid
Returns:	output (int) –

getMinLevelGaussianPyramid(self) → int¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid
Returns:	output (int) –

getOriginSubsetPixels(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid x (int) – y (int) – z (int) – t (int) –

getPerformZReduction(self) → bool¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid
Returns:	output (bool) –

getSigma(self) → float¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid
Returns:	output (float) –

getSizeSubsetPixels(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid x (int) – y (int) – z (int) – t (int) –

none()¶

GaussianPyramid.GaussianPyramid() -> GaussianPyramid

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

setChannelBase(self, pIInputChannel: ORSModel.ors.Channel) → None¶

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

setHalfsizeKernel(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid x (int) – y (int) – z (int) –

setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid minLevel (int) – maxLevel (int) –

setOriginSubsetPixels(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid x (int) – y (int) – z (int) – t (int) –

setPerformZReduction(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid bValue (bool) –

setSigma(self, value: float) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid value (float) –

setSizeSubsetPixels(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.GaussianPyramid) – an instance of GaussianPyramid x (int) – y (int) – z (int) – t (int) –

Graph¶

class ORSModel.ors.Graph(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → Graph¶

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

Graph.Graph(self) -> Graph

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

Graph.Graph(self, rhs: ORSModel.ors.Managed) -> Graph

Parameters:	self (ORSModel.ors.Graph) – an instance of Graph rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getOutgoingEdgeCountForVertex(self, vertexIndex: int) → int¶

Parameters:	self (ORSModel.ors.Graph) – an instance of Graph vertexIndex (int) –
Returns:	output (int) –

getOutgoingEdgeForVertex(self, vertexIndex: int, index: int) → int¶

Parameters:	self (ORSModel.ors.Graph) – an instance of Graph vertexIndex (int) – index (int) –
Returns:	output (int) –

getScalarSlot(self, slotIndex: int) → ArrayDouble¶

Parameters:	self (ORSModel.ors.Graph) – an instance of Graph slotIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

getScalarSlotCount(self) → int¶

Parameters:	self (ORSModel.ors.Graph) – an instance of Graph
Returns:	output (int) –

getVertexCount(self) → int¶

Parameters:	self (ORSModel.ors.Graph) – an instance of Graph
Returns:	output (int) –

getVertexDistance(self) → ArrayDouble¶

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

none()¶

Graph.Graph() -> Graph

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

prepareScalarSlot(self) → None¶

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

setScalarSlotCount(self, scalarSlotCount: int) → None¶

Parameters:	self (ORSModel.ors.Graph) – an instance of Graph scalarSlotCount (int) –

GraphBuilder¶

class ORSModel.ors.GraphBuilder(self) → GraphBuilder¶

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

GraphBuilder.GraphBuilder(self, rhs: ORSModel.ors.Unmanaged) -> GraphBuilder

Parameters:	self (ORSModel.ors.GraphBuilder) – an instance of GraphBuilder rhs (Unmanaged) –

addEdge(self, vertexA: int, vertexB: int) → None¶

Parameters:	self (ORSModel.ors.GraphBuilder) – an instance of GraphBuilder vertexA (int) – vertexB (int) –

addEdgesCollection(self, aCollection: int, collectionSize: int) → None¶

Parameters:	self (ORSModel.ors.GraphBuilder) – an instance of GraphBuilder aCollection (int) – collectionSize (int) –

generateGraph(self) → Graph¶

Parameters:	self (ORSModel.ors.GraphBuilder) – an instance of GraphBuilder
Returns:	output (ORSModel.ors.Graph) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

GraphBuilder.GraphBuilder() -> GraphBuilder

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

Group¶

class ORSModel.ors.Group(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → Group¶

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

Group.Group(self) -> Group

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

Group.Group(self, rhs: ORSModel.ors.Managed) -> Group

Parameters:	self (ORSModel.ors.Group) – an instance of Group rhs (Managed) –

add(self, pObject: ORSModel.ors.Managed) → None¶

Adds an object to the group.

Parameters:	self (ORSModel.ors.Group) – an instance of Group pObject (ORSModel.ors.Managed) – object to add (an Object)

Note

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

addAll(self, IInputGroup: ORSModel.ors.Group) → None¶

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

Parameters:	self (ORSModel.ors.Group) – an instance of Group IInputGroup (ORSModel.ors.Group) – another group (an Group)

Note

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

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)
Returns:	output (ORSModel.ors.List) – a list of objects (an List)

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)
Returns:	output (ORSModel.ors.List) – a list of objects (an List)

getClassNameStatic() → str¶

Returns:	output (str) –

getCount(self) → int¶

Returns the count of objects in the group.

Parameters:	self (ORSModel.ors.Group) – an instance of Group
Returns:	output (int) – object count (an int)

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

Checks to see if an object is in the group.

Parameters:	self (ORSModel.ors.Group) – an instance of Group pObject (ORSModel.ors.Managed) – object to check (an Object)
Returns:	output (bool) – TRUE if object is in the group, FALSE otherwise

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

Returns the index of the supplied object in the group.

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

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

Intersects the group with another group.

Parameters:	self (ORSModel.ors.Group) – an instance of Group IInputGroup (ORSModel.ors.Group) – the group to intersect with (an Group) IInOutGroup (ORSModel.ors.Group) – the output group (an Group), see note below
Returns:	output (ORSModel.ors.Group) – the intersected group

Note

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

Note

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

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)
Returns:	output (ORSModel.ors.Managed) – an object (an Object)

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

Subtracts another group from the group.

Parameters:	self (ORSModel.ors.Group) – an instance of Group IInputGroup (ORSModel.ors.Group) – the group to subtract (an Group) IInOutGroup (ORSModel.ors.Group) – the output group (an Group), see note below
Returns:	output (ORSModel.ors.Group) – the subtracted group

Note

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

Note

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

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

Merges the group with another group.

Parameters:	self (ORSModel.ors.Group) – an instance of Group IInputGroup (ORSModel.ors.Group) – the group to merge with (an Group) IInOutGroup (ORSModel.ors.Group) – the output group (an Group), see note below
Returns:	output (ORSModel.ors.Group) – the merged group

Note

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

Note

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

Note

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

none()¶

Group.Group() -> Group

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

remove(self, pObject: ORSModel.ors.Managed) → None¶

Removes an object from the group.

Parameters:	self (ORSModel.ors.Group) – an instance of Group pObject (ORSModel.ors.Managed) – object to remove (an Object)

removeAll(self, IInputGroup: ORSModel.ors.Group) → None¶

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

Parameters:	self (ORSModel.ors.Group) – an instance of Group IInputGroup (ORSModel.ors.Group) – another group (an Group)

Note

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

HalfEdgeMesh¶

class ORSModel.ors.HalfEdgeMesh(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → HalfEdgeMesh¶

Bases: ORSModel.ors.Mesh

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

HalfEdgeMesh.HalfEdgeMesh(self) -> HalfEdgeMesh

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

HalfEdgeMesh.HalfEdgeMesh(self, rhs: ORSModel.ors.Managed) -> HalfEdgeMesh

Parameters:	self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh rhs (Managed) –

copyInto(self, aDestinationUnstructuredGrid: ORSModel.ors.Node) → None¶

Copies the receiver unstructured grid into another unstructured grid.

Parameters:	self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh aDestinationUnstructuredGrid (ORSModel.ors.Node) – a destination unstructured grid

getAsFaceVertexModelCopy(self, pInOutMeshModel: ORSModel.ors.FaceVertexMesh) → FaceVertexMesh¶

Parameters:	self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh pInOutMeshModel (ORSModel.ors.FaceVertexMesh) –
Returns:	output (ORSModel.ors.FaceVertexMesh) –

getClassNameStatic() → str¶

Returns:	output (str) –

getEdgesInFaceVertexTopology(self, iTIndex: int) → ArrayUnsignedLong¶

Parameters:	self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayUnsignedLong) –

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:	self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh iTIndex (int) – the the time step (an unsigned short)
Returns:	output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

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:	self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh iTIndex (int) – the the time step (an unsigned short)
Returns:	output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

none()¶

HalfEdgeMesh.HalfEdgeMesh() -> HalfEdgeMesh

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

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

Parameters:	self (ORSModel.ors.HalfEdgeMesh) – an instance of HalfEdgeMesh pEdges (ORSModel.ors.ArrayUnsignedLong) – iTIndex (int) –

HistogramAnalyzer¶

class ORSModel.ors.HistogramAnalyzer(self) → HistogramAnalyzer¶

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

HistogramAnalyzer.HistogramAnalyzer(self, rhs: ORSModel.ors.Unmanaged) -> HistogramAnalyzer

Parameters:	self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer rhs (Unmanaged) –

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:

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

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

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

Parameters:

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

fillHistogram2DFromChannels(self, IHistogramData: ORSModel.ors.HistogramData, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel1: int, tChannel2: int, IROI: ORSModel.ors.ROI, tROI: int, IProgress: ORSModel.ors.Progress) → 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:

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

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

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

Parameters:

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

getClassNameStatic() → str¶

Returns:	output (str) –

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

Computes the Otsu threshold value aint32_t a dimension.

Parameters:	self (ORSModel.ors.HistogramAnalyzer) – an instance of HistogramAnalyzer IHistogramData (ORSModel.ors.HistogramData) – the ND histogram (an HistogramData) dimension (int) – the dimension aint32_t which the threshold is computed (an unsigned int)
Returns:	output (float) –

mapHistogram2DLabels(self, IHistogramData: ORSModel.ors.HistogramData, ILMRHistogramLabels: ORSModel.ors.MultiROI, IChannel1: ORSModel.ors.Channel, IChannel2: ORSModel.ors.Channel, tChannel1: int, tChannel2: int, IROI: ORSModel.ors.ROI, tROI: int, ILMROutput: ORSModel.ors.MultiROI, tLMR: int) → 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.HistogramAnalyzer() -> HistogramAnalyzer

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

HistogramData¶

class ORSModel.ors.HistogramData¶

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.HistogramData(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> HistogramData

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

HistogramData.HistogramData(self) -> HistogramData

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

HistogramData.HistogramData(self, rhs: ORSModel.ors.Managed) -> HistogramData

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData rhs (Managed) –

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:	self (ORSModel.ors.HistogramData) – an instance of HistogramData iIndex (ORSModel.ors.ArrayUnsignedLong) – array of the bin indexes (1 index for each dimension) countToAdd (int) – number of counts to add

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:	self (ORSModel.ors.HistogramData) – an instance of HistogramData destination (HistogramData) – destination Histogram

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
Returns:	output (ORSModel.ors.HistogramData) – HistogramData

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
Returns:	output (ORSModel.ors.HistogramData) – HistogramData

getBinCount(self, dimension: int) → int¶

Get the number of bins in a given dimension.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dimension (int) – index of the dimension (starting at 0)
Returns:	output (int) – The number of bins

getBinCounts(self) → ArrayUnsignedLong¶

Get the number of bins in each dimension.

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

getBinEdges(self, dimension: int) → ArrayDouble¶

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

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

getBinEdgesEnd(self, dimension: int) → float¶

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

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dimension (int) – index of the dimension (starting at 0)
Returns:	output (float) – The ending value of the range

getBinEdgesStart(self, dimension: int) → float¶

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

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dimension (int) – index of the dimension (starting at 0)
Returns:	output (float) – The starting value of the range

getClassNameStatic() → str¶

Returns:	output (str) –

getCountAtIndex1D(self, iIndex: int) → int¶

Get the number of counts at the given index.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData iIndex (int) – bin index
Returns:	output (int) – Number of counts

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

Get the number of counts at the given index.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData iIndex0 (int) – bin index iIndex1 (int) –
Returns:	output (int) – Number of counts

getCountAtIndexND(self, iIndex: ORSModel.ors.ArrayUnsignedLong) → int¶

Get the number of counts at the given indexes.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData iIndex (ORSModel.ors.ArrayUnsignedLong) – array of bin indexes (1 value for each dimension)
Returns:	output (int) – Number of counts

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
Returns:	output (ORSModel.ors.HistogramData) – New histogramData

getData(self) → ArrayUnsignedLONGLONG¶

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

getDimensionCount(self) → int¶

Get the number of dimensions.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData
Returns:	output (int) – The number of dimensions (an int)

getIndexAtValue1D(self, dValue: float) → int¶

Determines the bin index for a given value.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dValue (float) – value
Returns:	output (int) – bin index

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
Returns:	output (int) – bin index

getIndexAtValueND(self, dValues: ORSModel.ors.ArrayDouble) → ArrayUnsignedLong¶

Determines the bin indexes for a set of values.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dValues (ORSModel.ors.ArrayDouble) – array of values (1 value for each dimension)
Returns:	output (ORSModel.ors.ArrayUnsignedLong) – array of bin indexes (1 index for each dimension)

getIsDataInitialized(self) → bool¶

Get the status of the data.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData
Returns:	output (bool) – TRUE if the data is initialized, FALSE otherwise

getIsHistogramDegenerated(self) → bool¶

Get the degenerated state of the histogram.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData
Returns:	output (bool) – TRUE if the histogram is degenerated, FALSE otherwise

getIsSparse(self) → bool¶

Get the sparse representation state.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData
Returns:	output (bool) – TRUE if using a sparse represenation, FALSE if using a dense representation

getTotalCount(self) → int¶

Get the total number of counts.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData
Returns:	output (int) – Total number of counts

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
Returns:	output (bool) – TRUE if successful, FALSE otherwise

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

Determines if the given value is in the range.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dimension (int) – index of the dimension (starting at 0) dValue (float) – value to test
Returns:	output (bool) – TRUE if the value is inside the range, FALSE otherwise

none()¶

HistogramData.HistogramData() -> HistogramData

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

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

Set the range for a given dimension, with bin edges specified individually.

Parameters:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dimension (int) – array of bin edges (the number of bins is 1 less than the number of edges specified) dValues (ORSModel.ors.ArrayDouble) –

setBinEdgesFromRange(self, dimension: int, dStart: float, dEnd: float, nbBins: int) → 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:	self (ORSModel.ors.HistogramData) – an instance of HistogramData iIndex (ORSModel.ors.ArrayUnsignedLong) – array of bin indexes (1 value for each dimension) countToSet (int) – number of counts to set

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:	self (ORSModel.ors.HistogramData) – an instance of HistogramData dimension (int) – dimension along which the sum is made
Returns:	output (ORSModel.ors.HistogramData) – New histogramData

Image¶

class ORSModel.ors.Image(self) → Image¶

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

Image.Image(self, rhs: ORSModel.ors.Managed) -> Image

Parameters:	self (ORSModel.ors.Image) – an instance of Image rhs (Managed) –

copy(self) → Image¶

Copies the current image object.

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (ORSModel.ors.Image) – a new image copied (an Image)

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

Parameters:	self (ORSModel.ors.Image) – an instance of Image aChannel (ORSModel.ors.Channel) – timeStep (int) –

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

Parameters:	self (ORSModel.ors.Image) – an instance of Image aChannel (ORSModel.ors.Channel) – timeStep (int) – levelingMinValue (float) – levelingMaxValue (float) – slabThickness (float) – aLUT (ORSModel.ors.LookupTable) – alpha (float) –

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
Returns:	output (int) –

getBoundedPlane(self) → Rectangle¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (ORSModel.ors.Rectangle) –

getClassNameStatic() → str¶

Returns:	output (str) –

getComponent(index)¶

getComponentCountPerPixel(self) → int¶

Gets the number of components per pixel.

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (int) – a count (an short)

getComponents()¶

getDataOffsetForPixelComponent(self, componentIndex: int) → float¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image componentIndex (int) –
Returns:	output (float) –

getDataSlopeForPixelComponent(self, componentIndex: int) → float¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image componentIndex (int) –
Returns:	output (float) –

getDataType(self) → int¶

Gets the image data type.

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (int) – a type (a int32_t)

Note

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

getIsDataInitialized(self) → bool¶

Checks if the internal data is initialized.

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (bool) – true if initialized correctly, false otherwise

Note

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

getMaxU(self) → float¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (float) –

getMaxV(self) → float¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (float) –

getMinU(self) → float¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (float) –

getMinV(self) → float¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (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
Returns:	output (int) – the X size (an short)

getYSize(self) → int¶

Gets the Y size of the image.

Parameters:	self (ORSModel.ors.Image) – an instance of Image
Returns:	output (int) – the Y size (an short)

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)
Returns:	output (bool) – TRUE if successful, FALSE otherwise

Note

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

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.Image() -> Image

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

setBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle) → None¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image aBoundedPlane (ORSModel.ors.Rectangle) –

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:	self (ORSModel.ors.Image) – an instance of Image direction0 (ORSModel.ors.Vector3) – direction1 (ORSModel.ors.Vector3) –

setMaxU(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image aValue (float) –

setMaxV(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image aValue (float) –

setMinU(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image aValue (float) –

setMinV(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image aValue (float) –

setOrigin(self, origin: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Image) – an instance of Image origin (ORSModel.ors.Vector3) –

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:	self (ORSModel.ors.Image) – an instance of Image aTransformationMatrix (ORSModel.ors.Matrix4x4) –

ImageCollection¶

class ORSModel.ors.ImageCollection(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → ImageCollection¶

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

ImageCollection.ImageCollection(self) -> ImageCollection

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

ImageCollection.ImageCollection(self, rhs: ORSModel.ors.Managed) -> ImageCollection

Parameters:	self (ORSModel.ors.ImageCollection) – an instance of ImageCollection rhs (Managed) –

deleteAllImages(self) → None¶

Deletes all images.

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

getClassNameStatic() → str¶

Returns:	output (str) –

getImageAtIndex(self, imageIndex: int) → Image¶

Gets the image at an index position.

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

getImageCount(self) → int¶

Gets the image count.

Parameters:	self (ORSModel.ors.ImageCollection) – an instance of ImageCollection
Returns:	output (int) – the count of images (an uint32_t)

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

Gets the index position of an image.

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

Note

Returns -1 if image is not present.

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

Inserts an image at a given index.

Parameters:	self (ORSModel.ors.ImageCollection) – an instance of ImageCollection imageIndex (int) – the image index (an uint32_t) anImage (ORSModel.ors.Image) – an image (an Image)

insertImageFirst(self, anImage: ORSModel.ors.Image) → None¶

Inserts an image at start of list.

Parameters:	self (ORSModel.ors.ImageCollection) – an instance of ImageCollection anImage (ORSModel.ors.Image) – an image (an Image)

insertImageLast(self, anImage: ORSModel.ors.Image) → None¶

Inserts an image at end of list.

Parameters:	self (ORSModel.ors.ImageCollection) – an instance of ImageCollection anImage (ORSModel.ors.Image) – an image (an Image)

none()¶

ImageCollection.ImageCollection() -> ImageCollection

Parameters:	self (ORSModel.ors.ImageCollection) – an instance of 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:	self (ORSModel.ors.ImageCollection) – an instance of ImageCollection anImage (ORSModel.ors.Image) – an image (an Image)

removeImageAtIndex(self, imageIndex: int) → None¶

Removes the image at given index.

Parameters:	self (ORSModel.ors.ImageCollection) – an instance of ImageCollection imageIndex (int) – the image index (an uint32_t)

ImageCollectionPresenter¶

class ORSModel.ors.ImageCollectionPresenter(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → ImageCollectionPresenter¶

Bases: ORSModel.ors.DatasetPresenter

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

ImageCollectionPresenter.ImageCollectionPresenter(self) -> ImageCollectionPresenter

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

ImageCollectionPresenter.ImageCollectionPresenter(self, rhs: ORSModel.ors.Managed) -> ImageCollectionPresenter

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

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

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aView (ORSModel.ors.View) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aNode (ORSModel.ors.Node) –
Returns:	output (bool) –

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

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aNode (ORSModel.ors.Node) – anImage (ORSModel.ors.Image) –
Returns:	output (bool) –

getPresentationBoundedPlane(self) → Rectangle¶

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter
Returns:	output (ORSModel.ors.Rectangle) –

none()¶

ImageCollectionPresenter.ImageCollectionPresenter() -> ImageCollectionPresenter

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

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

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aView (ORSModel.ors.View) – imageIndex (int) –

setNodeNotVisibleForAllImage(self, aNode: ORSModel.ors.Node) → None¶

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aNode (ORSModel.ors.Node) –

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

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aNode (ORSModel.ors.Node) – anImage (ORSModel.ors.Image) –

setNodeVisibleForAllImage(self, aNode: ORSModel.ors.Node) → None¶

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aNode (ORSModel.ors.Node) –

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

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aNode (ORSModel.ors.Node) – anImage (ORSModel.ors.Image) –

setPresentationBoundedPlane(self, aBoudedPlane: ORSModel.ors.Rectangle) → None¶

Parameters:	self (ORSModel.ors.ImageCollectionPresenter) – an instance of ImageCollectionPresenter aBoudedPlane (ORSModel.ors.Rectangle) –

Intersection¶

class ORSModel.ors.Intersection¶

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.Intersection(self) -> Intersection

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

Intersection.Intersection(self, rhs: ORSModel.ors.Unmanaged) -> Intersection

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection rhs (Unmanaged) –

getClassNameStatic() → str¶

Returns:	output (str) –

getClosestVisual(self) → Visual¶

Returns the picked visual object closest to the pick point.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Visual) – a visual (an Visual), or NULL if no visual was picked

Note

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

getClosestVisualOfClass(self, pProgId: str) → Visual¶

Returns the visual object of a given class closest to the pick point.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection pProgId (str) –
Returns:	output (ORSModel.ors.Visual) – a visual (a Visual), or NULL if no visual was picked

Note

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

getColor(self) → Color¶

Returns the color value of the intersection.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Color) – a color (a Color)

getColorInPhysicalUnits(self) → Color¶

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

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Color) – the color (a Color)

getControlPointIndexHit(self) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (int) –

getDataUnit(self) → str¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (str) –

getDistance(self) → float¶

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

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (float) – a double

Note

Distances are calculated in pixels.

getFarthestVisual(self) → Visual¶

Returns the picked visual object farthest from the pick point.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Visual) – a visual (a Visual), or NULL if no visual was picked

Note

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

getFarthestVisualOfClass(self, pProgId: str) → Visual¶

Returns the visual object of a given class farthest from the pick point.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection pProgId (str) –
Returns:	output (ORSModel.ors.Visual) – a visual (a Visual), or NULL if no visual was picked

Note

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

getHit(self) → bool¶

Checks if the ray pick intersects something.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (bool) – true if the intersection is valid, false otherwise

getHitCount(self) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (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
Returns:	output (int) – a face index in the mesh (a int32_t)

getMeshFaceBary1(self) → float¶

Returns the barycentric coordinate 1.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (float) – a double between 0 and 1

getMeshFaceBary2(self) → float¶

Returns the barycentric coordinate 1.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (float) – a double between 0 and 1

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
Returns:	output (int) – a vertex index 1 (a int32_t)

getMeshVertexIndex1(self) → int¶

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

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (int) – a vertex index 1 (a int32_t)

getMeshVertexIndex2(self) → int¶

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

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (int) – a vertex index 1 (a int32_t)

getNearestMeshVertexIndex(self) → int¶

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

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (int) – a vertex index in the mesh (a int32_t)

getNthDistance(self, nth: int) → float¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (float) –

getNthLabel(self, nth: int) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (int) –

getNthMeshFace(self, nth: int) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (int) –

getNthMeshFaceBary1(self, nth: int) → float¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (float) –

getNthMeshFaceBary2(self, nth: int) → float¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (float) –

getNthMeshVertexIndex0(self, nth: int) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (int) –

getNthMeshVertexIndex1(self, nth: int) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (int) –

getNthMeshVertexIndex2(self, nth: int) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (int) –

getNthNearestMeshVertexIndex(self, nth: int) → int¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (int) –

getNthPositionInLocalCoordinates(self, nth: int) → Vector3¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (ORSModel.ors.Vector3) –

getNthPositionInWorldCoordinates(self, nth: int) → Vector3¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (ORSModel.ors.Vector3) –

getNthScalarValue(self, nth: int) → float¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection nth (int) –
Returns:	output (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
Returns:	output (float) – the offset (a double)

getPickDirection(self) → Vector3¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Vector3) –

getPickOrigin(self) → Vector3¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Vector3) –

getPixelPositionInView(self) → Vector3¶

Returns the position of the intersection in screen coordinates.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

getPositionInLocalCoordinates(self) → Vector3¶

Returns the position of the intersection in local coordinates.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Vector3) – a point (a Vector3)

getPositionInVoxelIndex(self) → Vector3¶

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

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

Note

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

getPositionInWorldCoordinates(self) → Vector3¶

Returns the position of the intersection in world coordinates.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

getScalarValue(self) → float¶

Returns the scalar value of the picked triangle.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (float) – the scalar value (a double)

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
Returns:	output (float) – the slope (a double)

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)
Returns:	output (ORSModel.ors.StructuredGrid) – a structured grid (a StructuredGrid), or NULL if the index given is invalid

Note

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

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
Returns:	output (int) – a structured grid object count (an short)

Note

Since more than one structured grid can be found at any given point, this method returns how many visual objects were touched by the ray pick.

getTimeStep(self) → int¶

Returns the T value of the intersection.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (int) – an short

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)
Returns:	output (ORSModel.ors.Visual) – a visual (a Visual), or NULL if the index given is invalid

Note

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

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
Returns:	output (int) – a visual object count (an short)

Note

Since more than one visual can be found at any given point, this method returns how many visual objects were touched by the ray pick.

getVoxelIndex(self) → int¶

Returns the index of the voxel being picked.

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (int) – an index (a int64_t)

Note

The index is computed as follows: (T value * zSize * ySize * xSize) + (Z value * xSize * ySize) + (Y value * xSize) + (X value)

getWindowLeveledNormalizedValue(self) → float¶

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

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (float) – a double between 0 and 1

getXIndexInCurvedChannel(self) → float¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (float) –

getYIndexInCurvedChannel(self) → float¶

Parameters:	self (ORSModel.ors.Intersection) – an instance of Intersection
Returns:	output (float) –

none()¶

Intersection.Intersection() -> Intersection

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

Layout¶

class ORSModel.ors.Layout¶

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.Layout(self) -> Layout

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

Layout.Layout(self, rhs: ORSModel.ors.Managed) -> Layout

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout rhs (Managed) –

addFirst(self, aLayout: ORSModel.ors.Layout) → None¶

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

addLast(self, aLayout: ORSModel.ors.Layout) → None¶

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

copy(self) → Layout¶

Returns a copy of the node.

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.Layout) – a new node (a Managed)

Note

Only the immediate attributes of the node are copied. The graph surrounding the new node is the same one as the source node.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

getAllChildLayout(self) → List¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.List) –

getAllChildViews(self) → List¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.List) –

getAllLeaves(self) → List¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.List) –

getBottomRight(self) → Vector3¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.Vector3) –

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

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aLayout (ORSModel.ors.Layout) –
Returns:	output (ORSModel.ors.Vector3) –

getChildWithPrivateTitle(self, privateTitle: str) → Layout¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout privateTitle (str) –
Returns:	output (ORSModel.ors.Layout) –

getChildren(self) → List¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.List) –

getChildrenAtIndex(self, index: int) → Layout¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout index (int) –
Returns:	output (ORSModel.ors.Layout) –

getChildrenCount(self) → int¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getContext()¶

getEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (bool) –

getEnabledChildrenCount(self) → int¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (int) –

getGenealogicalName(self) → str¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (str) –

getHasChildren(self) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (bool) –

getIsLayoutMyDescendent(self, aLayout: ORSModel.ors.Layout) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aLayout (ORSModel.ors.Layout) –
Returns:	output (bool) –

getIsLinear(self) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (bool) –

getIsMyChildren(self, aLayout: ORSModel.ors.Layout) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aLayout (ORSModel.ors.Layout) –
Returns:	output (bool) –

getIsVertical(self) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (bool) –

getLayoutClass(self) → str¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (str) –

getLeaveEmpty(self) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (bool) –

getParent(self) → Layout¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.Layout) –

getTopLeft(self) → Vector3¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (ORSModel.ors.Vector3) –

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

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aLayout (ORSModel.ors.Layout) –
Returns:	output (ORSModel.ors.Vector3) –

getViewGUID(self) → str¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (str) –

getWeight(self) → float¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout
Returns:	output (float) –

none()¶

Layout.Layout() -> Layout

Parameters:	self (ORSModel.ors.Layout) – an instance of 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
Returns:	output (bool) –

removeAllChildren(self) → None¶

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

removeChildren(self, aLayout: ORSModel.ors.Layout) → None¶

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

replaceChildren(self, aLayoutToBeReplace: ORSModel.ors.Layout, aLayoutReplacement: ORSModel.ors.Layout) → bool¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aLayoutToBeReplace (ORSModel.ors.Layout) – aLayoutReplacement (ORSModel.ors.Layout) –
Returns:	output (bool) –

setBottomRight(self, aVector: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aVector (ORSModel.ors.Vector3) –

setEnabled(self, bEnabled: bool) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout bEnabled (bool) –

setIsLinear(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aValue (bool) –

setIsVertical(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aValue (bool) –

setLayoutClass(self, aClass: str) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aClass (str) –

setLeaveEmpty(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aValue (bool) –

setTopLeft(self, aVector: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aVector (ORSModel.ors.Vector3) –

setViewGUID(self, aGUID: str) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aGUID (str) –

setWeight(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.Layout) – an instance of Layout aValue (float) –

Line¶

class ORSModel.ors.Line¶

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

Line.Line(self) -> Line

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

Line.Line(self, rhs: ORSModel.ors.Unmanaged) -> Line

Parameters:	self (ORSModel.ors.Line) – an instance of Line rhs (Unmanaged) –

copy(self) → Line¶

Gets a copy of the receiver.

Parameters:	self (ORSModel.ors.Line) – an instance of Line
Returns:	output (ORSModel.ors.Line) – a line (an Line)

fromOriginAndOrientation(self, origin: ORSModel.ors.Vector3, orientation: ORSModel.ors.Vector3) → None¶

Sets the the origin and orientation of the line.

Parameters:	self (ORSModel.ors.Line) – an instance of Line origin (ORSModel.ors.Vector3) – a point (an Vector3) orientation (ORSModel.ors.Vector3) – an orientation (an Vector3)

Note

The orientation vector will be normalized.

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:	self (ORSModel.ors.Line) – an instance of Line point0 (ORSModel.ors.Vector3) – a point (an Vector3) point1 (ORSModel.ors.Vector3) – a point (an Vector3)

getClassNameStatic() → str¶

Returns:	output (str) –

getClosestPointOnLineFromPoint(self, aPoint: ORSModel.ors.Vector3) → Vector3¶

Parameters:	self (ORSModel.ors.Line) – an instance of Line aPoint (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.Vector3) –

getDistanceFromLine(self, aLine: ORSModel.ors.Line) → float¶

Parameters:	self (ORSModel.ors.Line) – an instance of Line aLine (ORSModel.ors.Line) –
Returns:	output (float) –

getDistanceFromPoint(self, pVect: ORSModel.ors.Vector3) → float¶

Gets the distance from the receiver to the provided point.

Parameters:	self (ORSModel.ors.Line) – an instance of Line pVect (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:	output (float) – the distance (a double)

getIsEqualTo(self, aLine: ORSModel.ors.Line) → bool¶

Parameters:	self (ORSModel.ors.Line) – an instance of Line aLine (ORSModel.ors.Line) –
Returns:	output (bool) –

getOrientation(self) → Vector3¶

Gets the receiver orientation.

Parameters:	self (ORSModel.ors.Line) – an instance of Line
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The orientation vector is normalized.

getOrigin(self) → Vector3¶

Gets the receiver origin position.

Parameters:	self (ORSModel.ors.Line) – an instance of Line
Returns:	output (ORSModel.ors.Vector3) – the origin (an Vector3)

Note

The origin is in world coordinates.

none()¶

Line.Line() -> Line

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

setOrientation(self, pVect: ORSModel.ors.Vector3) → None¶

Sets the receiver orientation.

Parameters:	self (ORSModel.ors.Line) – an instance of Line pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The orientation vector will be normalized.

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

Sets the receiver origin position.

Parameters:	self (ORSModel.ors.Line) – an instance of Line pVect (ORSModel.ors.Vector3) – a poing (an Vector3)

Note

The origin should be in world coordinates.

LineSegment¶

class ORSModel.ors.LineSegment¶

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

LineSegment.LineSegment(self) -> LineSegment

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

LineSegment.LineSegment(self, rhs: ORSModel.ors.Unmanaged) -> LineSegment

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment rhs (Unmanaged) –

copy(self) → LineSegment¶

Gets a copy of the receiver.

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment
Returns:	output (ORSModel.ors.LineSegment) – a box (an LineSegment)

fromOriginAndDirectionAndLength(self, origin: ORSModel.ors.Vector3, direction: ORSModel.ors.Vector3, length: float) → None¶

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment origin (ORSModel.ors.Vector3) – direction (ORSModel.ors.Vector3) – length (float) –

getClassNameStatic() → str¶

Returns:	output (str) –

getDistanceFromPoint(self, pVect: ORSModel.ors.Vector3) → float¶

Gets the distance from the receiver to the provided point,.

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment pVect (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:	output (float) – the distance (a double)

getEnd(self) → Vector3¶

Gets the receiver end point.

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

getIsEqualTo(self, aLineSegment: ORSModel.ors.LineSegment) → bool¶

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment aLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (bool) –

getLength(self) → float¶

Gets the receiver length.

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment
Returns:	output (float) – a length (a double)

getStart(self) → Vector3¶

Gets the receiver start point.

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

none()¶

LineSegment.LineSegment() -> LineSegment

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

setEnd(self, pVect: ORSModel.ors.Vector3) → None¶

Sets the receiver end point.

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment pVect (ORSModel.ors.Vector3) – a point (an Vector3)

setStart(self, pVect: ORSModel.ors.Vector3) → None¶

Set the receiver start point.

Parameters:	self (ORSModel.ors.LineSegment) – an instance of LineSegment pVect (ORSModel.ors.Vector3) – a point (an Vector3)

List¶

class ORSModel.ors.List¶

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.List(self) -> List

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

List.List(self, rhs: ORSModel.ors.List) -> List

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

List.List(self, pythonListOfGUID: str) -> List

Parameters:	self (ORSModel.ors.List) – an instance of List pythonListOfGUID (str) –

add(self, pObject: ORSModel.ors.Managed) → None¶

Adds an object to the list.

Parameters:	self (ORSModel.ors.List) – an instance of List pObject (ORSModel.ors.Managed) – an object (an Object)

appendAllObjects(self, pList: ORSModel.ors.List) → None¶

Appends a list to the list.

Parameters:	self (ORSModel.ors.List) – an instance of List pList (ORSModel.ors.List) – a list (a List)

Note

All objects are taken from the appended list, whether or not they are already in the receiver list.

appendNonPresentObjects(self, pList: ORSModel.ors.List) → None¶

Appends a list to the list, taking only the objects not present in the receiver.

Parameters:	self (ORSModel.ors.List) – an instance of List pList (ORSModel.ors.List) – a list (a List)

Note

Only the objects not already in the receiver are taken from the appended list.

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)
Returns:	output (ORSModel.ors.List) – a list (a List)

getClassNameStatic() → str¶

Returns:	output (str) –

getCount(self) → int¶

Returns the count of objects in the list.

Parameters:	self (ORSModel.ors.List) – an instance of List
Returns:	output (int) – object count (an uint32_t)

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

Verifies if an object is present in the list.

Parameters:	self (ORSModel.ors.List) – an instance of List pObject (ORSModel.ors.Managed) – an object (an Object)
Returns:	output (bool) – true if object is in the list, false otherwise

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

Parameters:	self (ORSModel.ors.List) – an instance of List pObject (ORSModel.ors.Managed) –
Returns:	output (int) –

getIntersectionWith(self, pList: ORSModel.ors.List) → List¶

Returns the intersection of the list with another list.

Parameters:	self (ORSModel.ors.List) – an instance of List pList (ORSModel.ors.List) – a list (a List)
Returns:	output (ORSModel.ors.List) – a new list (a List)

Note

Objects duplicated in both lists only appear once in the intersected list.

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 uint32_t)
Returns:	output (ORSModel.ors.Managed) – an object (a Managed)

Note

Index starts at zero (zero-based).

Note

When the type of the object is known, you can pre-type it as it will automatically typecast to the correct type, for example: Channel IChan = someList->getObjectAt(0). If the object at index 0 is not a channel, IChan will be none.

getPythonRepresentation(self) → str¶

Returns the python representation of the list.

Parameters:	self (ORSModel.ors.List) – an instance of List
Returns:	output (str) – str

getSubtractionFrom(self, pList: ORSModel.ors.List) → List¶

Returns the subtraction of another list from the list.

Parameters:	self (ORSModel.ors.List) – an instance of List pList (ORSModel.ors.List) – a list (a List)
Returns:	output (ORSModel.ors.List) – a new list (a List)

Note

The subtraction results in a list of objects only in the receiver (union of both lists is removed from the list, or A - (A U B)).

getUnionWith(self, pList: ORSModel.ors.List) → List¶

Returns the union of the list with another list.

Parameters:	self (ORSModel.ors.List) – an instance of List pList (ORSModel.ors.List) – a list (a List)
Returns:	output (ORSModel.ors.List) – a new list (a List)

Note

Objects duplicated in both lists only appear once in the unionized list.

index(item)¶

isNone(self) → bool¶

Parameters:	self (ORSModel.ors.List) – an instance of List
Returns:	output (bool) –

isNotNone(self) → bool¶

Parameters:	self (ORSModel.ors.List) – an instance of List
Returns:	output (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

Note

This illustrates the meaning of the “preserve identity” argument, if you load a file that has the same object twice in a row, if you preserve identity you’ll obtain 1 object, if you don’t preserve identity you’ll obtain 2 objects (both having the same internal state).

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 (typing.List[str]) – list of class names (see note) progress (ORSModel.ors.Progress) – a progress object

Note

This illustrates the meaning of the “preserve identity” argument, if you load a file that has the same object twice in a row, if you preserve identity you’ll obtain 1 object, if you don’t preserve identity you’ll obtain 2 objects (both having the same internal state).

Note

The filter list should be a list of class names to filter on, for example, to load only ROI and MultiROI objects, one would specify ROI.getClassNameStatic() and MultiROI.getClassNameStatic().

none()¶

List.List() -> List

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

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

Removes an object from the list.

Parameters:	self (ORSModel.ors.List) – an instance of List pObject (ORSModel.ors.Managed) – an object (an Object)
Returns:	output (bool) – true if object was removed, false otherwise (it wasn’t in the list)

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)
Returns:	output (int) – a result (an int, 0 for no error, otherwise an error code)

Loader¶

class ORSModel.ors.Loader¶

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.Loader(self) -> Loader

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

Loader.Loader(self, rhs: ORSModel.ors.Managed) -> Loader

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getCurrentNodeAttributeValue(self, attributeName: str) → str¶

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader attributeName (str) –
Returns:	output (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)
Returns:	output (bool) – the value (a bool)

Note

Return is false if attribute name is not found.

getCurrentNodeBoolValue(self) → bool¶

Gets the current node boolean value in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader
Returns:	output (bool) – the node value (a 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)
Returns:	output (float) – the value (a double)

Note

Return is 0.0 if attribute name is not found.

getCurrentNodeDoubleValue(self) → float¶

Gets the current node double value in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader
Returns:	output (float) – the node value (a double)

getCurrentNodeFloatAttributeValue(self, sAttributeName: str) → float¶

Gets a float attribute from the current node in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader sAttributeName (str) – the attribute name (a string)
Returns:	output (float) – the value (a float)

Note

Return is 0.0f if attribute name is not found.

getCurrentNodeFloatValue(self) → float¶

Gets the current node float value in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader
Returns:	output (float) – the node value (a float)

getCurrentNodeIntAttributeValue(self, sAttributeName: str) → int¶

Gets an int attribute from the current node in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader sAttributeName (str) – the attribute name (a string)
Returns:	output (int) – the value (an int)

Note

Return is 0 if attribute name is not found.

getCurrentNodeIntValue(self) → int¶

Gets the current node int value in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader
Returns:	output (int) – the node value (an 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
Returns:	output (int) – the node value (a int64_t)

getCurrentNodeName(self) → str¶

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader
Returns:	output (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)
Returns:	output (int) – the value (a short)

Note

Return is 0 if attribute name is not found.

getCurrentNodeShortValue(self) → int¶

Gets the current node short value in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader
Returns:	output (int) – the node value (a short)

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
Returns:	output (int) – the node value (an uint64_t)

getCurrentNodeUnsignedIntAttributeValue(self, sAttributeName: str) → int¶

Gets an unsigned int attribute from the current node in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader sAttributeName (str) – the attribute name (a string)
Returns:	output (int) – the value (an int)

Note

Return is 0 if attribute name is not found.

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
Returns:	output (int) – the node value (an 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)
Returns:	output (int) – the value (an short)

Note

Return is 0 if attribute name is not found.

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
Returns:	output (int) – the node value (an short)

getCurrentNodeValue(self) → str¶

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader
Returns:	output (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)
Returns:	output (bool) – the value (a bool)

Note

Return is false if element name is not valid nor found.

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)
Returns:	output (int) – the number of nodes found (an int)

getNodeDoubleValueFromCurrentNode(self, sElementName: str) → float¶

Gets a double element from the current node in an XML tree being parsed.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader sElementName (str) – the element name (a string)
Returns:	output (float) – the value (a double)

Note

Return is 0.0f if element name is not valid nor found.

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)
Returns:	output (float) – the value (a float)

Note

Return is 0.0f if element name is not valid nor found.

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)
Returns:	output (int) – the value (an int)

Note

Return is 0 if element name is not valid nor found.

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)
Returns:	output (int) – the value (a int64_t)

Note

Return is 0 if element name is not valid nor found.

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)
Returns:	output (int) – the value (a short)

Note

Return is 0 if element name is not valid nor found.

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)
Returns:	output (int) – the value (an uint64_t)

Note

Return is 0 if element name is not valid nor found.

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)
Returns:	output (int) – the value (an int)

Note

Return is 0 if element name is not valid nor found.

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)
Returns:	output (int) – the value (an short)

Note

Return is 0 if element name is not valid nor found.

getNodeValueFromCurrentNode(self, pXpath: str) → str¶

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader pXpath (str) –
Returns:	output (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)
Returns:	output (str) – the version number (a string)

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)

Note

All ORS objects can save themselves to file, in an XML format.

loadObjectsFromXML(self, anXML: str) → None¶

Loads objects from an XML string.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader anXML (str) – the XML (a string)

Note

All ORS objects can save themselves in an XML format.

none()¶

Loader.Loader() -> Loader

Parameters:	self (ORSModel.ors.Loader) – an instance of 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:	self (ORSModel.ors.Loader) – an instance of Loader pXpath (str) – an XPath (a string)
Returns:	output (bool) – true if successful, false otherwise

setCurrentNodeFromCurrentNode(self, pXpath: str) → bool¶

Selects a node in an XML tree, under the current node.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader pXpath (str) – the node name (a string)
Returns:	output (bool) – true if successful, false otherwise

Note

The node is only searched under the current node of the tree.

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
Returns:	output (bool) – true if successful, false otherwise

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)
Returns:	output (bool) – true if the XML is valid, false otherwise

setXMLStringFromFilename(self, filename: str) → bool¶

Gives an XML string from a file to the loader and DOMifies it.

Parameters:	self (ORSModel.ors.Loader) – an instance of Loader filename (str) – a filename containing the XML string (a string)
Returns:	output (bool) – true if the XML is valid, false otherwise

LookupTable¶

class ORSModel.ors.LookupTable¶

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.LookupTable(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> LookupTable

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

LookupTable.LookupTable(self) -> LookupTable

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

LookupTable.LookupTable(self, rhs: ORSModel.ors.Managed) -> LookupTable

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable rhs (Managed) –

appendColor(self, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable IColor (ORSModel.ors.Color) –

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:	self (ORSModel.ors.LookupTable) – an instance of LookupTable ILookupTable (ORSModel.ors.LookupTable) –

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 4getTableSize() 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)
Returns:	output (int) – the index control point (an int)

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (ORSModel.ors.Color) –

getColorAtPosition(self, position: float) → Color¶

Gets the color at a given position.

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable position (float) – the position (a double, see note)
Returns:	output (ORSModel.ors.Color) –

Note

This method returns a color at a position normalized between 0 and 1. If the position does not exactly match an existing control point, the returned color will be an interpolation of the two closest colors.

getColorFromPosition(self, position: float, aColor: ORSModel.ors.Color) → None¶

Gets the color at a given position.

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable position (float) – the position (a double, see note) aColor (ORSModel.ors.Color) – a Color object

Note

This method fill the providedat a position normalized between 0 and 1. If the position does not exactly match an existing control point, the returned color will be an interpolation of the two closest colors.

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)
Returns:	output (ORSModel.ors.Color) – the color (an Color)

getControlPointCount(self) → int¶

Retrieves the total number of control points in the LUT.

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable
Returns:	output (int) – the number of control points (an 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)
Returns:	output (float) – the X coordinate of the control point (a 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)
Returns:	output (float) – the Y coordinate of the control point (a float)

getGamma(self) → float¶

Gets the gamma value.

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable
Returns:	output (float) – the gamma value (a double)

getIsDiscrete(self) → bool¶

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable
Returns:	output (bool) –

getTableSize(self) → int¶

Get the table size.

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable
Returns:	output (int) – the table size (an 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)

Note

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

none()¶

LookupTable.LookupTable() -> LookupTable

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

removeAllControlPoints(self) → None¶

Removes all LUT control points.

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

removeColorAtIndex(self, nIndex: int) → bool¶

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable nIndex (int) –
Returns:	output (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:	self (ORSModel.ors.LookupTable) – an instance of LookupTable nIndex (int) – IColor (ORSModel.ors.Color) –

setColorAtPosition(self, position: float, IColor: ORSModel.ors.Color) → None¶

Sets the color at a given position.

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable position (float) – the position (a double, see note) IColor (ORSModel.ors.Color) –

Note

The position is normalized between 0 and 1. The color that will be changed will be the closest control point color.

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:	self (ORSModel.ors.LookupTable) – an instance of LookupTable index (int) – the control point index (an unsigned int) IColor (ORSModel.ors.Color) – the color (an Color)

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:	self (ORSModel.ors.LookupTable) – an instance of LookupTable value (float) – the gamma value (a double)

setIsDiscrete(self, bDiscrete: bool) → None¶

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable bDiscrete (bool) –

setRampBMPFile(self, filepath: str) → None¶

Sets the LUT to BMP file.

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable filepath (str) –

setRampGrayScale(self) → None¶

Sets the LUT to be gray scale.

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

Note

Gray scale LUTs divide the color range in 255 gray tones.

setRampRainbow(self) → None¶

Sets the LUT to be rainbow.

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

Note

Rainbow LUTs divide the color range in 4 sections.

setRampUserDefined(self) → None¶

Sets the LUT to be user-defined.

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

Note

User-defined LUTs use control points.

setTableSize(self, size: int) → None¶

Parameters:	self (ORSModel.ors.LookupTable) – an instance of LookupTable size (int) –

Managed¶

class ORSModel.ors.Managed¶

brief_description: The “mother” of all author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Managed.Managed(self, anXML: str) -> Managed

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed anXML (str) –

Managed.Managed(self, rhs: ORSModel.ors.Managed) -> Managed

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed rhs (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) –
Returns:	output (bool) –

addToDeleteSet(self, anIObject: ORSModel.ors.Managed) → None¶

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

atomicLoad(sFilename: str, bPreserveIdentity: bool) → Managed¶

Parameters:	sFilename (str) – bPreserveIdentity (bool) –
Returns:	output (Managed) –

atomicLoadFrom(self, anXML: str) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed anXML (str) –

Managed.atomicLoadFrom(self, buffer: int, nBytes: int) -> None

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed buffer (bytes) – nBytes (int) –

atomicLoadSpecificNode(self, aFilename: str, aXPathOfTheNodeToLoad: str) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed aFilename (str) – aXPathOfTheNodeToLoad (str) –
Returns:	output (bool) –

atomicSave(self, aFilename: str, isTemporary: bool) → int¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed aFilename (str) – isTemporary (bool) –
Returns:	output (int) –

copy(self) → Managed¶

Returns a copy of the node.

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (ORSModel.ors.Managed) – a new node (a Managed)

Note

Only the immediate attributes of the node are copied. The graph surrounding the new node is the same one as the source node.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

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:	self (ORSModel.ors.Managed) – an instance of Managed anIObject (ORSModel.ors.Managed) –
Returns:	output (ORSModel.ors.List) –

classmethod getAllInstances()¶

getAllInstancesOf(pProgId: str) → List¶

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

classmethod getAllObjectsOfClass(cls_name)¶

getAllObjectsOfClassAndPrivateTitle(pProgId: str, pPrivateTitle: str) → List¶

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

getAllObjectsOfClassAndUserData(pProgId: str, userDataKey: str, userDataValue: str) → List¶

Parameters:	pProgId (str) – userDataKey (str) – userDataValue (str) –
Returns:	output (ORSModel.ors.List) –

classmethod getAllSubclasses(outputCollection=None)¶

getAtomicTextRepresentation(self, bSelfContained: bool) → str¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed bSelfContained (bool) –
Returns:	output (str) –

getBinaryUserInfo(self, pTag: str) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pTag (str) –

getBinaryUserInfoAsBytes(name)¶

getBinaryUserInfoSize(self, pTag: str) → int¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pTag (str) –
Returns:	output (int) –

getCallbacksEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

getCanBeDeleted(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

classmethod getClassDenomination()¶

static getClassFromProgId(progId)¶

getClassName(self) → str¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (str) –

getClassNameStatic() → str¶

Returns:	output (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
Returns:	output (int) – an int

getDataDirtySignature()¶

Gets the current dirty signature for the flag OrsDataDirty

Returns:	dataDirtySignature (int) – the dirty signature

getDirtySignature(self, dirtyFlag: str) → int¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed dirtyFlag (str) –
Returns:	output (int) –

getGUID(self) → str¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (str) –

getGeometryDirtySignature()¶

Gets the current dirty signature for the flag OrsGeometryDirty

Returns:	geometryDirtySignature (int) – the dirty signature

getHasCallbacksForEvent(self, anEventName: str) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed anEventName (str) –
Returns:	output (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
Returns:	output (bool) – Returns True if the GUID is preserved when pickling and unpickling an object

getIsInstanceOf(self, pProgId: str) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pProgId (str) –
Returns:	output (bool) –

getIsInstanceOfAtLeastOneClasses(progIdList)¶

getIsModified(self, dirtyFlag: str) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed dirtyFlag (str) –
Returns:	output (bool) –

getIsModifiedAnyDirtyFlag(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

getIsRepresentable(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

getIsSameObjectAs(self, anObject: ORSModel.ors.Managed) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed anObject (ORSModel.ors.Managed) –
Returns:	output (bool) –

classmethod getIsSubclassOf(parentClass)¶

getIsToBeKeptAliveUntilExit(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

getIsToBeSaved(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

getObjectWithGUID(guid: str) → Managed¶

Parameters:	guid (str) –
Returns:	output (ORSModel.ors.Managed) –

getPrivateTitle(self) → str¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (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
Returns:	output (str) –

getReferenceCount(self) → int¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (int) –

getTitle(self) → str¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (str) –

getUserInfo(self, pTag: str) → str¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pTag (str) –
Returns:	output (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
Returns:	output (bool) –

isNone(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

isNotNone(self) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed
Returns:	output (bool) –

none()¶

Managed.Managed() -> Managed

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

publish()¶

removeBinaryUserInfo(self, pTag: str) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pTag (str) –

removeCallbackFromEvent(self, sEventName: str, sCallbackName: str) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed sEventName (str) – sCallbackName (str) –
Returns:	output (bool) –

removeFromDeleteSet(self, anIObject: ORSModel.ors.Managed) → None¶

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

removeUserInfo(self, pTag: str) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pTag (str) –

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:	self (ORSModel.ors.Managed) – an instance of Managed enabled (bool) –

setCanBeDeleted(self, bFlag: bool) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed bFlag (bool) –

setDataDirty()¶: Calls for a setDirty with the flag OrsDataDirty

setDirty(self, dirtyFlag: str) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed dirtyFlag (str) –

setEventCallbackEnabled(self, sEventName: str, sCallbackName: str, bValue: bool) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed sEventName (str) – sCallbackName (str) – bValue (bool) –
Returns:	output (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:	self (ORSModel.ors.Managed) – an instance of Managed value (bool) –

setIsNotModified(self) → None¶

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

setIsRepresentable(self, isRepresentable: bool) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed isRepresentable (bool) –

setIsToBeKeptAliveUntilExit(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pFlag (bool) –

setIsToBeSaved(self, pIsToBeSaved: bool) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed pIsToBeSaved (bool) –

setPrivateTitle(self, newPrivateTitle: str) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed newPrivateTitle (str) –

setPropertyDirty()¶: Calls for a setDirty with the flag OrsPropertyDirty

setTitle(self, newVal: str) → None¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed newVal (str) –

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)

Note

Stores the key/value pair in an internal dictionary. If the key already exists its previous value is overwritten.

setVisibilityDirty()¶: Calls for a setDirty with the flag OrsVisibilityDirty

triggerClassEvent(self, sEventName: str) → bool¶

Parameters:	self (ORSModel.ors.Managed) – an instance of Managed sEventName (str) –
Returns:	output (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
Returns:	output (bool) –

Note

Triggers the callbacks associated to the event name.

MassiveMarchingAutomata¶

class ORSModel.ors.MassiveMarchingAutomata(self) → MassiveMarchingAutomata¶

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

MassiveMarchingAutomata.MassiveMarchingAutomata(self, rhs: ORSModel.ors.Unmanaged) -> MassiveMarchingAutomata

Parameters:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata rhs (Unmanaged) –

cleanSpeedMapChannel(self, outputChannel: ORSModel.ors.Channel) → None¶

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

Parameters:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata outputChannel (ORSModel.ors.Channel) – a distance map channel (an Channel)

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

Parameters:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata lOutputChannelDistanceMap (ORSModel.ors.Channel) – lOutputChannelTraceBack (ORSModel.ors.Channel) – lOutputChannelLabel (ORSModel.ors.Channel) – nbIteration (int) –

getClassNameStatic() → str¶

Returns:	output (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
Returns:	output (float) – the minimum distance between voxels (a double)

Note

Neighbors of distance 1 will have a bias of spacialTerm

Note

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

Note

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

getNeighborCount(self) → int¶

Parameters:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata
Returns:	output (int) –

getROICount(self) → int¶

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

Parameters:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata
Returns:	output (int) – the number of ROIs that have been provided (an char)

Note

A maximum of 10 ROI can be provided.

getVolumeROI(self, index: int) → ROI¶

Retrieves a particularROI from the index specified slot.

Parameters:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata index (int) – the slot index (an unsigned char)
Returns:	output (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI), or NULL if no ROI is at that slot

Note

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

none()¶

MassiveMarchingAutomata.MassiveMarchingAutomata() -> MassiveMarchingAutomata

Parameters:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of 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:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata EuclideanBias (float) – the minimum distance between voxels (a double)

Note

Neighbors of distance 1 will have a bias of spacialTerm.

Note

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

Note

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

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

Note

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

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:	self (ORSModel.ors.MassiveMarchingAutomata) – an instance of MassiveMarchingAutomata index (int) – the slot index (an unsigned char) aVolROI (ORSModel.ors.ROI) – the ROI associated with this slot index (an ROI)

Note

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

Material¶

class ORSModel.ors.Material¶

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.Material(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> Material

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

Material.Material(self) -> Material

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

Material.Material(self, rhs: ORSModel.ors.Managed) -> Material

Parameters:	self (ORSModel.ors.Material) – an instance of Material rhs (Managed) –

getAmbiant(self) → Color¶

Gets the ambiant color of the material.

Parameters:	self (ORSModel.ors.Material) – an instance of Material
Returns:	output (ORSModel.ors.Color) – ambiant (a Color)

getClassNameStatic() → str¶

Returns:	output (str) –

getDiffuse(self) → Color¶

Gets the diffuse color of the material.

Parameters:	self (ORSModel.ors.Material) – an instance of Material
Returns:	output (ORSModel.ors.Color) – diffuse (a Color)

getEmissive(self) → Color¶

Gets the emissive color of the material.

Parameters:	self (ORSModel.ors.Material) – an instance of Material
Returns:	output (ORSModel.ors.Color) – an emissive (a Color)

getPower(self) → float¶

Gets the power property of the material.

Parameters:	self (ORSModel.ors.Material) – an instance of Material
Returns:	output (float) – power value (a float)

getShadowIntensity(self) → float¶

Gets the shadow intensity.

Parameters:	self (ORSModel.ors.Material) – an instance of Material
Returns:	output (float) – an intensity factor (a float)

Note

Should be between 0.0 and 1.0.

getSpecular(self) → Color¶

Gets the specular color of the material.

Parameters:	self (ORSModel.ors.Material) – an instance of Material
Returns:	output (ORSModel.ors.Color) – specular (a Color)

getTexture(self, stage: int) → str¶

Parameters:	self (ORSModel.ors.Material) – an instance of Material stage (int) –
Returns:	output (str) –

getTextureScale(self) → float¶

Gets the texture scale factor.

Parameters:	self (ORSModel.ors.Material) – an instance of Material
Returns:	output (float) – the scale factor (a float)

none()¶

Material.Material() -> Material

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

setAmbiant(self, IColor: ORSModel.ors.Color) → None¶

Sets the ambiant color, in Red-Green-Blue.

Parameters:	self (ORSModel.ors.Material) – an instance of Material IColor (ORSModel.ors.Color) – a color object (a Color)

Note

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

setDiffuse(self, IColor: ORSModel.ors.Color) → None¶

Sets the diffuse color, in Red-Green-Blue.

Parameters:	self (ORSModel.ors.Material) – an instance of Material IColor (ORSModel.ors.Color) – a color object (a Color)

Note

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

setEmissive(self, IColor: ORSModel.ors.Color) → None¶

Sets the emissive color, in Red-Green-Blue.

Parameters:	self (ORSModel.ors.Material) – an instance of Material IColor (ORSModel.ors.Color) – a color object (a Color)

Note

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

setPower(self, value: float) → None¶

Sets the power property of the material.

Parameters:	self (ORSModel.ors.Material) – an instance of Material value (float) – a power value (a float)

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)

Note

Should be between 0.0 and 1.0.

setSpecular(self, IColor: ORSModel.ors.Color) → None¶

Sets the specular color, in Red-Green-Blue.

Parameters:	self (ORSModel.ors.Material) – an instance of Material IColor (ORSModel.ors.Color) – a color object (a Color)

Note

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

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)

Note

Stages are valued between 0 and 7.

setTextureScale(self, value: float) → None¶

Sets the texture scale factor.

Parameters:	self (ORSModel.ors.Material) – an instance of Material value (float) – a scale factor (a float)

Matrix4x4¶

class ORSModel.ors.Matrix4x4¶

brief_description: A wrapper to a 3D matrix. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Matrix4x4.Matrix4x4(self) -> Matrix4x4

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

Matrix4x4.Matrix4x4(self, rhs: ORSModel.ors.Unmanaged) -> Matrix4x4

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 rhs (Unmanaged) –

Matrix4x4.Matrix4x4(self, rhs: ORSModel.ors.Matrix4x4) -> Matrix4x4

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

asRotationMatrix(self, inputVector: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputVector (ORSModel.ors.Vector3) –

copy(self) → Matrix4x4¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
Returns:	output (ORSModel.ors.Matrix4x4) –

createMatrixFromPythonRepresentation(self, aPythonRepresentation: str) → None¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 aPythonRepresentation (str) –

createMatrixFromPythonRepresentationStatic(aPythonRepresentation: str) → Matrix4x4¶

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

getClassNameStatic() → str¶

Returns:	output (str) –

getInverted(self) → Matrix4x4¶

Gets an inverted matrix.

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
Returns:	output (ORSModel.ors.Matrix4x4) – an inverted matrix (an Matrix4x4)

Note

The receiver is not affected.

getIsIdentity(self) → bool¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
Returns:	output (bool) –

getMultiply(self, IMatrix: ORSModel.ors.Matrix4x4) → Matrix4x4¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 IMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getScale(self) → Vector3¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
Returns:	output (ORSModel.ors.Vector3) –

getTransformedBoundedPlane(self, inputBoundedPlane: ORSModel.ors.Rectangle) → Rectangle¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputBoundedPlane (ORSModel.ors.Rectangle) –
Returns:	output (ORSModel.ors.Rectangle) –

getTransformedBox(self, inputBox: ORSModel.ors.Box) → Box¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputBox (ORSModel.ors.Box) –
Returns:	output (ORSModel.ors.Box) –

getTransformedCoordinate(self, inputCoordinate: ORSModel.ors.Vector3) → Vector3¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputCoordinate (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.Vector3) –

getTransformedLine(self, inputLine: ORSModel.ors.Line) → Line¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.Line) –

getTransformedLineSegment(self, inputLineSegment: ORSModel.ors.LineSegment) → LineSegment¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (ORSModel.ors.LineSegment) –

getTransformedOrientedPlane(self, inputOrientedPlane: ORSModel.ors.OrientedPlane) → OrientedPlane¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputOrientedPlane (ORSModel.ors.OrientedPlane) –
Returns:	output (ORSModel.ors.OrientedPlane) –

getTransformedPlane(self, inputPlane: ORSModel.ors.Plane) → Plane¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputPlane (ORSModel.ors.Plane) –
Returns:	output (ORSModel.ors.Plane) –

getTransformedVector(self, inputVector: ORSModel.ors.Vector3) → Vector3¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 inputVector (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.Vector3) –

getTranslation(self) → Vector3¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
Returns:	output (ORSModel.ors.Vector3) –

getTransposed(self) → Matrix4x4¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4
Returns:	output (ORSModel.ors.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)
Returns:	output (float) – a float

Note

Row and column are both between 0 and 3.

multiply(self, IMatrix: ORSModel.ors.Matrix4x4) → None¶

Multiplies the matrix by another matrix.

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 IMatrix (ORSModel.ors.Matrix4x4) – a matrix to multiply with (an Matrix4x4)

Note

The receiver is modified.

none()¶

Matrix4x4.Matrix4x4() -> Matrix4x4

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

setAsRotation(self, axisOfRotation: ORSModel.ors.Vector3, angleInRadian: float) → None¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 axisOfRotation (ORSModel.ors.Vector3) – angleInRadian (float) –

setScale(self, scaleVector: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 scaleVector (ORSModel.ors.Vector3) –

setTranslation(self, translation: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Matrix4x4) – an instance of Matrix4x4 translation (ORSModel.ors.Vector3) –

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

Note

Row and column are both between 0 and 3.

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)

Note

The array of floats should contain 16 float (4 rows X 4 colums).

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.Mesh(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> Mesh

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

Mesh.Mesh(self, rhs: ORSModel.ors.Managed) -> Mesh

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh rhs (Managed) –

convertToVTKPolyData(currentTimeStep, includeScalar=False, vertexXScaleFactor=1.0, vertexYScaleFactor=1.0, vertexZScaleFactor=1.0)¶

findMeshContourPointsAndConnectionOnAPlane(self, cuttingPlane: ORSModel.ors.Plane, anOctreeBox: ORSModel.ors.Octree, iTIndex: int, oPoints: ORSModel.ors.ArrayDouble, oPointsConnection: ORSModel.ors.ArrayUnsignedLONGLONG, outNbOfPts: int, outNbOfConnection: int) → None¶

Find points of the mesh on a plane and all connection between those points.

Parameters:

self (ORSModel.ors.Mesh) – an instance of Mesh
cuttingPlane (ORSModel.ors.Plane) – a cutting plane (Plane)
anOctreeBox (ORSModel.ors.Octree) – an octree, if the octree is none a default one will be created (Octree)
iTIndex (int) – the time step (a unsigned short)
oPoints (ORSModel.ors.ArrayDouble) – output points collection (ArrayDouble)
oPointsConnection (ORSModel.ors.ArrayUnsignedLONGLONG) – output points connection (edges with size = 2) collection (ArrayUnsignedLongLong)
outNbOfPts (int) – number of point that make the contour on plane (int)
outNbOfConnection (int) – number of edges that make the contour on plane (int)

getArea(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, IProgress: ORSModel.ors.Progress) → float¶

Gets the one sided area from closed mesh.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) – the T index to compute (an unsigned short) aWorldTransformMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4) IProgress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress
Returns:	output (float) – the area (a double)

Note

Result for an open mesh is undefined.

getAsMeshProjectedOnPlane(self, aPlane: ORSModel.ors.Plane, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, inMesh: ORSModel.ors.Mesh) → Mesh¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh aPlane (ORSModel.ors.Plane) – iTIndex (int) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) – inMesh (ORSModel.ors.Mesh) –
Returns:	output (ORSModel.ors.Mesh) –

getAsMeshWithEdgesDecimatedSmallerThan(self, value: float, IProgress: ORSModel.ors.Progress, worldTransform: ORSModel.ors.Matrix4x4, inoutMesh: ORSModel.ors.Mesh) → Mesh¶

Decimates all edges with a length smaller than a threshold value.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh value (float) – the threshold value (a double) IProgress (ORSModel.ors.Progress) – worldTransform (ORSModel.ors.Matrix4x4) – inoutMesh (ORSModel.ors.Mesh) –
Returns:	output (ORSModel.ors.Mesh) –

Note

This method is recursive and will decimate edges until all edges length are greater than the supplied threshold value.

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

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) – worldTransform (ORSModel.ors.Matrix4x4) – pOutputROI (ORSModel.ors.ROI) – progress (ORSModel.ors.Progress) –

getBoundingBoxPlusEpsilon(timestep, worldMatrix, epsilon=0.01)¶

getClassNameStatic() → str¶

Returns:	output (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) –
Returns:	output (bool) – TRUE if color is found, FALSE otherwise

Note

The alpha value equals 0 if the vertex is out of range, 1 if vertex is in range.

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)
Returns:	output (ORSModel.ors.ArrayDouble) – the colors data (an ArrayUnsignedLong)

Note

Colors are expressed in RGB or RGBA fashion. Use RGBA when you want each vertex to have a transparency

Note

The array of colors should have the same number of elements as there are vertices, as each vertice has its own color.

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) –
Returns:	output (float) – the area (a float)

Note

Results for an open contour is undefined.

Note

Only works for triangular primitive type mesh.

Note

The algorithm uses winding to find the inside part of faces. Thus the result for meshes with wrong winding is undefined.

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

Returns:

output (ORSModel.ors.Mesh) – the resulting mesh (an VisualMesh)

Note

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

Note

The general plane equation is ax + by + cz + dw = 0.

getCurrentFaceScalarValuesSlot(self) → int¶

gets the current face scalar.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (int) – the scalar slot index (an short)

Note

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

getDefaultColor(self) → Color¶

Gets the mesh default color.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (ORSModel.ors.Color) – a color (an Color)

Note

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

getDefaultMeshAlphaColor(self) → float¶

Queries the mesh to get its default alpha color.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (float) – Default alpha color used for the mesh (a double)

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)
Returns:	output (int) – an uint64_t

getEdgeCountPerFace(self) → int¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (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)
Returns:	output (ORSModel.ors.ArrayUnsignedLong) – an array of int32_t (an ArrayLong)

getExtractedSubMesh(self, IMeshROI: ORSModel.ors.MeshFacesROI, IOutputMesh: ORSModel.ors.Mesh, bExtractSubMeshROI: bool) → Mesh¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh IMeshROI (ORSModel.ors.MeshFacesROI) – IOutputMesh (ORSModel.ors.Mesh) – bExtractSubMeshROI (bool) –
Returns:	output (ORSModel.ors.Mesh) –

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)
Returns:	output (int) – an uint64_t

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)
Returns:	output (float) – the value of a face scalar (a double)

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)
Returns:	output (str) – the desciption (a std::wstring)

getFaceScalarValueMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float¶

method getFaceScalarValueMax

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh nScalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (float) –

getFaceScalarValueMaxs(self, iTIndex: int) → ArrayDouble¶

method getFaceScalarValueMaxs

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

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)
Returns:	output (float) – a double

getFaceScalarValueMins(self, iTIndex: int) → ArrayDouble¶

method getFaceScalarValueMins

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

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)
Returns:	output (float) – the scalar offset value (a double)

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)
Returns:	output (ORSModel.ors.ArrayDouble) – the scalar offset values (an ArrayDouble)

getFaceScalarValueSlope(self, scalarValueSlotIndex: int, iTIndex: int) → float¶

Gets a face scalar slope value.

Parameters:	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)
Returns:	output (float) – the scalar slope value (a double)

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)
Returns:	output (ORSModel.ors.ArrayDouble) – the scalar slope values (an ArrayDouble)

getFaceScalarValueUnit(self, nScalarValueSlotIndex: int, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh nScalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (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)
Returns:	output (ORSModel.ors.Array) – an array of values (an ArrayFloat)

Note

The array of values is of length getFaceCount() * getFaceScalarValuesSlotCount().

Note

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

getFaceScalarValuesAsPandaDataFrame()¶

getFaceScalarValuesDatatype(self, nScalarValueSlotIndex: int, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh nScalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

getFaceScalarValuesSlotCount(self) → int¶

Gets the number of slots for face scalar values.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (int) – the number of slots (an short)

getFaceScalarValuesWindowMax(self, nScalarValueSlotIndex: int, iTIndex: int) → float¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh nScalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (float) –

getFaceScalarValuesWindowMaxs(self, iTIndex: int) → ArrayDouble¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

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)
Returns:	output (float) – a double

getFaceScalarValuesWindowMins(self, iTIndex: int) → ArrayDouble¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

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

getNormalsMomentOfInertia(self, iTIndex: int, scalarSlotIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → Matrix4x4¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) – scalarSlotIndex (int) – aWorldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Matrix4x4) –

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:	self (ORSModel.ors.Mesh) – an instance of Mesh target (ORSModel.ors.Mesh) – mesh target (Mesh ) targetOctree (ORSModel.ors.Octree) – targetOctree(Octree) iTIndex (int) – iTIndex (an unsigned short) pProgress (ORSModel.ors.Progress) – pProgress (Progress)
Returns:	output (ORSModel.ors.ArrayFloat) –

getTransformed(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, pInOutMesh: ORSModel.ors.Mesh) → Mesh¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh aTransformationMatrix (ORSModel.ors.Matrix4x4) – pInOutMesh (ORSModel.ors.Mesh) –
Returns:	output (ORSModel.ors.Mesh) –

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)
Returns:	output (ORSModel.ors.ArrayFloat) – an array of float (an ArrayFloat)

getUseDefaultMeshAlphaColor(self) → bool¶

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

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (bool) – TRUE if a default alpha color is used for the mesh, FALSE otherwise

getUseDefaultMeshColor(self) → bool¶

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

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (bool) – TRUE if the mesh uses its default color, FALSE otherwise

getUseFaceScalarValues(self) → bool¶

Sets the mesh to have face scalar values or not.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh
Returns:	output (bool) – TRUE to use scalar values, FALSE otherwise

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:

self (ORSModel.ors.Mesh) – an instance of Mesh
target (ORSModel.ors.Mesh) – mesh target (Mesh )
targetOctree (ORSModel.ors.Octree) – targetOctree(Octree)
iTIndex (int) – iTIndex (an unsigned short)
pProgress (ORSModel.ors.Progress) – pProgress (Progress)
oMapping (ORSModel.ors.ArrayLong) – pProgress (ArrayLong)
oCollisionPoints (ORSModel.ors.ArrayDouble) – pProgress (ArrayDouble)

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:	self (ORSModel.ors.Mesh) – an instance of Mesh target (ORSModel.ors.Mesh) – mesh target (Mesh ) targetOctree (ORSModel.ors.Octree) – targetOctree(Octree) iTIndex (int) – iTIndex (an unsigned short) pProgress (ORSModel.ors.Progress) – pProgress (Progress)
Returns:	output (ORSModel.ors.ArrayFloat) –

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)
Returns:	output (ORSModel.ors.ArrayFloat) – the normals data (an ArrayFloat)

getVolume(self, aPlane: ORSModel.ors.Plane, timeStep: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4, IProgress: ORSModel.ors.Progress) → float¶

Gets the volume from closed mesh.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh aPlane (ORSModel.ors.Plane) – a progress object (an Progress) or NULL for no progress timeStep (int) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) – IProgress (ORSModel.ors.Progress) –
Returns:	output (float) – the volume (a double)

Note

Result for an open mesh is undefined.

Note

Only works for triangular primitive type mesh.

Note

The algorithm uses winding to find the inside part of faces. Thus the result for meshes with wrong winding is undefined.

getWorldTransform(timestep=0)¶

isWindingSoThatFaceNormalAreOutside(self, iTIndex: int, progress: ORSModel.ors.Progress) → bool¶

Check if face vertex normal direction point outside of the mesh.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) – the time step (a unsigned short) progress (ORSModel.ors.Progress) – a progress object (an Progress) or NULL for no progress
Returns:	output (bool) –

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) –
Returns:	output (int) – the number of labels found (an uint32_t)

Note

The scalar for the specified index should be already initialized.

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:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) – the lookup table (an LookupTable) anILUT (ORSModel.ors.LookupTable) –

Note

Applies a coloring scheme to the mesh, according to its scalar values applied against a lookup table.

mapVertexScalarValuesToColorsWithRange(self, pData: ORSModel.ors.Array, fMinDisplayableValue: float, fMaxDisplayableValue: float, fMinSelectionRangeValue: float, fMaxSelectionRangeValue: float, hideOutOfRangeValues: bool, 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)
hideOutOfRangeValues (bool) – the LookUpTable (a LookupTable)
anILUT (ORSModel.ors.LookupTable) –

none()¶

Mesh.Mesh() -> Mesh

Parameters:	self (ORSModel.ors.Mesh) – an instance of 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)
Returns:	output (ORSModel.ors.Mesh) – the result mesh (a Mesh)

Note

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

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)

Note

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

setDefaultColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the mesh default color.

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh IColor (ORSModel.ors.Color) – a color (an Color)

Note

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

Note

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

Note

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

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:	self (ORSModel.ors.Mesh) – an instance of Mesh value (int) –

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:	self (ORSModel.ors.Mesh) – an instance of Mesh pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

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:	self (ORSModel.ors.Mesh) – an instance of Mesh pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

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:	self (ORSModel.ors.Mesh) – an instance of Mesh pScalarValues (ORSModel.ors.ArrayDouble) – scalar offset values (an ArrayDouble) iTIndex (int) – time step (an unsigned short)

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:	self (ORSModel.ors.Mesh) – an instance of Mesh pScalarValues (ORSModel.ors.ArrayDouble) – scalar slope values (an ArrayDouble) iTIndex (int) – time step (an unsigned short)

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)

Note

The array of values is of length getFaceCount() * getFaceScalarValuesSlotCount().

Note

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

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:	self (ORSModel.ors.Mesh) – an instance of Mesh pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

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:	self (ORSModel.ors.Mesh) – an instance of Mesh pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

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:	self (ORSModel.ors.Mesh) – an instance of Mesh value (bool) –

setVertexScalarValuesFromPandaDataFrame(dataFrame, iTIndex=0)¶

updateVerticesNormal(self, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.Mesh) – an instance of Mesh iTIndex (int) –

MeshFacesROI¶

class ORSModel.ors.MeshFacesROI¶

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.MeshFacesROI(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> MeshFacesROI

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

MeshFacesROI.MeshFacesROI(self) -> MeshFacesROI

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

MeshFacesROI.MeshFacesROI(self, rhs: ORSModel.ors.Managed) -> MeshFacesROI

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI rhs (Managed) –

addFaceIndex(self, nFaceIndex: int, nTIndex: int) → None¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI nFaceIndex (int) – nTIndex (int) –

addFacesIndexes(self, indexes: ORSModel.ors.ArrayUnsignedLong, nNbIndex: int, nTIndex: int) → None¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI indexes (ORSModel.ors.ArrayUnsignedLong) – nNbIndex (int) – nTIndex (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFaceIndexAtPosition(self, pos: int, nTIndex: int) → int¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI pos (int) – nTIndex (int) –
Returns:	output (int) –

getFaceIndexes(self, nTimeStep: int, IInputFaceIndexes: ORSModel.ors.ArrayUnsignedLong) → ArrayUnsignedLong¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI nTimeStep (int) – IInputFaceIndexes (ORSModel.ors.ArrayUnsignedLong) –
Returns:	output (ORSModel.ors.ArrayUnsignedLong) –

getFaceIndexesCount(self, nTIndex: int) → int¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI nTIndex (int) –
Returns:	output (int) –

getHasFaceIndex(self, nFaceIndex: int, nTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI nFaceIndex (int) – nTIndex (int) –
Returns:	output (bool) –

getIntersectionWithMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI IInputMeshROI (ORSModel.ors.MeshFacesROI) – nTimeStep (int) – IOutputMeshROI (ORSModel.ors.MeshFacesROI) –
Returns:	output (ORSModel.ors.MeshFacesROI) –

getInverseMeshFacesROI(self, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI nTimeStep (int) – IOutputMeshROI (ORSModel.ors.MeshFacesROI) –
Returns:	output (ORSModel.ors.MeshFacesROI) –

getIsVisibleForAllDisplays(self) → bool¶

Gets the visibility of the receiver in all displays.

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI
Returns:	output (bool) – TRUE if the receiver is visible is all displays, FALSE otherwise

getIsVisibleForDisplay(self, IDisplay: ORSModel.ors.View) → bool¶

Gets the visibility of the receiver in a given display.

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI IDisplay (ORSModel.ors.View) – the display (an View)
Returns:	output (bool) – TRUE if the receiver is visible, FALSE otherwise

getSubtractionFromMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI IInputMeshROI (ORSModel.ors.MeshFacesROI) – nTimeStep (int) – IOutputMeshROI (ORSModel.ors.MeshFacesROI) –
Returns:	output (ORSModel.ors.MeshFacesROI) –

getUnionWithMeshFacesROI(self, IInputMeshROI: ORSModel.ors.MeshFacesROI, nTimeStep: int, IOutputMeshROI: ORSModel.ors.MeshFacesROI) → MeshFacesROI¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI IInputMeshROI (ORSModel.ors.MeshFacesROI) – nTimeStep (int) – IOutputMeshROI (ORSModel.ors.MeshFacesROI) –
Returns:	output (ORSModel.ors.MeshFacesROI) –

none()¶

MeshFacesROI.MeshFacesROI() -> MeshFacesROI

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

removeAllFaceIndexes(self, nTIndex: int) → None¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI nTIndex (int) –

removeFaceIndex(self, nFaceIndex: int, nTIndex: int) → None¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI nFaceIndex (int) – nTIndex (int) –

removeFaceIndexAtPosition(self, pos: int, nTimeStep: int) → int¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI pos (int) – nTimeStep (int) –
Returns:	output (int) –

setColor(self, aColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI aColor (ORSModel.ors.Color) –

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

Note

This API overrides all prior calls to setIsVisibleForDisplay(), or in other words, any display specific setting is erased.

setIsVisibleForDisplay(self, IDisplay: ORSModel.ors.View, bValue: bool) → None¶

Sets the visibility of the receiver in a given display.

Parameters:	self (ORSModel.ors.MeshFacesROI) – an instance of MeshFacesROI IDisplay (ORSModel.ors.View) – the display (an View) bValue (bool) – TRUE to make the receiver visible, FALSE to hide it

Note

This API overrides a prior call to setIsVisibleForAllDisplays(), for a given display.

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
Returns:	output (bool) – true if operation was successful, false otherwise (the callback already existed)

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
Returns:	output (bool) – true if operation was successful, false otherwise (the callback already existed)

checkFeature(iProduct: int, iFeature: int) → bool¶

Parameters:	iProduct (int) – iFeature (int) –
Returns:	output (bool) –

deleteAllObjects(pFinalExit: bool) → None¶

Parameters:	pFinalExit (bool) –

getActiveWorkerThreadsCount() → int¶

Returns the number of active worker threads.

Returns:	output (int) – a count of active worker threads (an int)

getAvailableCPUCount() → int¶

Returns how many CPUs are available.

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

Note

In order to prepare some computations to be multi-threaded, this method returns how many CPUs are available.

getBuildNumber() → str¶

Returns the Core library internal build number.

Returns:	output (str) – a build number text (a string)

getDLLFilename() → str¶

Returns the Core library file name.

Returns:	output (str) – a fully qualified file path (a string)

getDLLVersion() → str¶

Returns the Core library internal version.

Returns:	output (str) – a version text (a string)

getDebugMode() → bool¶

Checks if the Core library is in debug mode.

Returns:	output (bool) – true if in debug mode, false otherwise

getEpsilon() → float¶

Returns:	output (float) –

getFontNames() → str¶

Returns:	output (str) –

getIsRunningInReleaseMode() → bool¶

Checks if the Core library is running in release mode.

Returns:	output (bool) – true if in release mode, false otherwise

getLicenseExpiry() → int¶

Returns:	output (int) –

getLicenseInformation(iKey: int) → str¶

Parameters:	iKey (int) –
Returns:	output (str) –

getMajorVersion() → str¶

Returns the Core library internal major version.

Returns:	output (str) – a version text (a string)

getMaximumViewportHeight() → int¶

Returns:	output (int) –

getMaximumViewportWidth() → int¶

Returns:	output (int) –

getPresetFileExtension() → str¶

Returns:	output (str) –

getSessionUserName() → str¶

Returns:	output (str) –

getStartupResultCode() → int¶

Returns:	output (int) –

getWasLicenseDowngraded() → bool¶

Returns:	output (bool) –

isNVidia() → bool¶

Returns:	output (bool) –

isNotNone(self) → bool¶

Parameters:	self (ORSModel.ors.Model) – an instance of Model
Returns:	output (bool) –

loadSessionFromFile(aFilename: str) → bool¶

Loads a session file.

Parameters:	aFilename (str) – a fully qualified file path (a string)
Returns:	output (bool) – true if operation was successful, false otherwise

removeCallbackFromClassEvent(aClassName: str, sEventName: str, sCallbackName: str) → bool¶

Removes a callback subscription to a class event.

Parameters:	aClassName (str) – the class name (a string) sEventName (str) – the event name (a string) sCallbackName (str) – the callback name (a string)
Returns:	output (bool) – true if operation was successful, false otherwise (the callback was not found)

removeCallbackFromGlobalEvent(sEventName: str, sCallbackName: str) → bool¶

Removes a callback subscription to a global event.

Parameters:	sEventName (str) – the event name (a string) sCallbackName (str) – the callback name (a string)
Returns:	output (bool) – true if removal was successful, false otherwise (the callback did not exist)

saveSessionToFile(pSessionName: str, aFilename: str) → 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)
Returns:	output (int) – 0 if operation was successful, otherwise an error code

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)

Note

Many algorithms are multi-threaded, use this method if you want to limit the number of CPUs used internally, to allow other applications to be responsive for example.

Note

Setting this value to 0 means to use all CPUs.

setClassEventCallbackEnabled(aClassName: str, sEventName: str, sCallbackName: str, bValue: bool) → bool¶

Enables/disables a callback subscription to a class event.

Parameters:	aClassName (str) – the event name (a string) sEventName (str) – the callback name (a string) sCallbackName (str) – true to enable the callback, false to disable it bValue (bool) –
Returns:	output (bool) – true if operation was successful, false otherwise (the callback was not found)

setDebugMode(pState: bool) → 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
Returns:	output (bool) – true if operation was successful, false otherwise (the callback was not found)

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) –
Returns:	output (bool) –

yieldUIWorker() → None¶: Gives the UI worker control to process any pending tasks that it holds.

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.MultiROI(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> MultiROI

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

MultiROI.MultiROI(self) -> MultiROI

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

MultiROI.MultiROI(self, rhs: ORSModel.ors.Managed) -> MultiROI

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI rhs (Managed) –

addToVolumeROI(self, pOutputROI: ORSModel.ors.ROI, pLabel: int) → None¶

Extract a label and adds it to a VolumeROI.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pOutputROI (ORSModel.ors.ROI) – the output Volume ROI (an ROI) pLabel (int) – the label to extract (an unsigned int)

Note

The ROI is not cleared prior to adding.

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:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pOutputROI (ORSModel.ors.ROI) – the output Volume ROI (an ROI) pIndex (int) – the index (a int64_t)

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:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pOutputROI (ORSModel.ors.ROI) – the output Volume ROI (an ROI) tIndex (int) – the T value (an unsigned short) pVector (ORSModel.ors.Vector3) – the position (an Vector3)

addVolumeROIToLabel(self, aLabel: int, pROI: ORSModel.ors.ROI) → bool¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI aLabel (int) – pROI (ORSModel.ors.ROI) –
Returns:	output (bool) –

appendLabeledMultiROI(self, pLabeledMultiROI: ORSModel.ors.MultiROI, pLabelArray: ORSModel.ors.ArrayUnsignedLong) → None¶

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

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:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pLabelArray (ORSModel.ors.ArrayUnsignedLong) – an array of labels to clear (an ArrayUnsignedLong)

copyInto(self, aMultiROI: ORSModel.ors.MultiROI) → None¶

Copies the receiver into anotherROI.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI aMultiROI (ORSModel.ors.MultiROI) – a destination multiROI (an MultiROI)

fromChannel(self, pChan: ORSModel.ors.Channel) → None¶

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

generateAnalyzer(self, inputChannel: ORSModel.ors.Channel, pROI: ORSModel.ors.ROI, aTimeStep: int, pStats: int, pCompute2DStats: bool, IProgress: ORSModel.ors.Progress) → MultiROIAnalyzer¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI inputChannel (ORSModel.ors.Channel) – pROI (ORSModel.ors.ROI) – aTimeStep (int) – pStats (int) – pCompute2DStats (bool) – IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.MultiROIAnalyzer) –

getAsArray(self, tIndex: int, pOutputArray: ORSModel.ors.ArrayUnsignedLong) → ArrayUnsignedLong¶

Extracts the labels and adds them all to anArray.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI tIndex (int) – time index (an unsigned short) pOutputArray (ORSModel.ors.ArrayUnsignedLong) – an optional output Array (an ArrayUnsignedLong)
Returns:	output (ORSModel.ors.ArrayUnsignedLong) – the resulting Array (an ArrayUnsignedLong)

Note

If an output Array is supplied, data is written to it and returned, otherwise a new Array is created.

Note

The Array is cleared prior to adding.

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)
Returns:	output (ORSModel.ors.Channel) – the resulting channel (an Channel)

Note

If an output channel is supplied, data is written to it and returned, otherwise a new channel is created.

Note

The channel’s data type is determined by the total number of labels within:

getAsCubicMesh(self, bWorld: bool, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → Mesh¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI bWorld (bool) – IProgress (ORSModel.ors.Progress) – IInMesh (ORSModel.ors.Mesh) –
Returns:	output (ORSModel.ors.Mesh) –

getAsCubicMeshSubset(self, IEnabledLabel: ORSModel.ors.ArrayChar, bWorld: bool, IProgress: ORSModel.ors.Progress, IInMesh: ORSModel.ors.Mesh) → Mesh¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI IEnabledLabel (ORSModel.ors.ArrayChar) – bWorld (bool) – IProgress (ORSModel.ors.Progress) – IInMesh (ORSModel.ors.Mesh) –
Returns:	output (ORSModel.ors.Mesh) –

getBoundingBoxOfLabel(self, pTIndex: int, iLabel: int) → Box¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pTIndex (int) – iLabel (int) –
Returns:	output (ORSModel.ors.Box) –

getClassNameStatic() → str¶

Returns:	output (str) –

getClipBox(timestep=0, display=None)¶

Gets the clip box of the ROI or of the MultiROI

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	aClipBox (ORSModel.ors.Box) – the clip box

getClipping(timestep=0, display=None)¶

Gets the origin and the opposite summit of the clip box of the ROI or MultiROI

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	clipOriginSummit (ORSModel.ors.Vector3) – the origin summit of the clip box clipOppositeSummit (ORSModel.ors.Vector3) – the origin opposite summit of the clip box

getCurrentScalarValuesSlot(self) → int¶

gets the current scalar value slot index.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (int) – the scalar slot index (an short)

Note

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

getHideOutOfRangeScalarValues(self) → bool¶

Indicate if out of range values should be hidden.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (bool) – (a bool)

getIntersectionWithLabeledMultiROI(self, pInputLabeledMultiROI: ORSModel.ors.MultiROI, anOutputLabeledMultiROI: ORSModel.ors.MultiROI) → MultiROI¶

Intersects theMultiROI with another MultiROI.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pInputLabeledMultiROI (ORSModel.ors.MultiROI) – the MultiROI to intersect with (a MultiROI) anOutputLabeledMultiROI (ORSModel.ors.MultiROI) – the output MultiROI (a MultiROI), see note below
Returns:	output (ORSModel.ors.MultiROI) – the intersection result

Note

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

getIntersectionWithROI(self, aROI: ORSModel.ors.ROI, anOutputMultiROI: ORSModel.ors.MultiROI) → MultiROI¶

Intersects theMultiROI with a ROI.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI aROI (ORSModel.ors.ROI) – the ROI to intersect with (an ROI) anOutputMultiROI (ORSModel.ors.MultiROI) – the output MultiROI (a MultiROI), see note below
Returns:	output (ORSModel.ors.MultiROI) – the intersection result

Note

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

getIsClipped(timestep=0, display=None)¶

Gets to know if the clip box of the ROI or MultiROI is active

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	isClipped (bool) – if True, the clip box of the ROI or MultiROI is visible; False otherwise.

getIsEmpty(self) → bool¶

Verifies to see if all labels are empty or not.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (bool) – TRUE if no labels within, FALSE otherwise

getLabelAtIndex(self, pIndex: int) → int¶

Gets the label value at a given index.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pIndex (int) – the index (a int64_t)
Returns:	output (int) – the resulting label (an int)

Note

If no label exists at the given index 0 is returned.

getLabelAtPosition(self, tIndex: int, pVector: ORSModel.ors.Vector3) → int¶

Gets the label value at a given World position.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI tIndex (int) – the T value (an unsigned short) pVector (ORSModel.ors.Vector3) – the position (an Vector3)
Returns:	output (int) – the resulting label (an int)

Note

If no label exists at the given position, 0 is returned.

getLabelColor(self, label: int) → Color¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI label (int) –
Returns:	output (ORSModel.ors.Color) –

getLabelCount(self) → int¶

Gets the number of distinct labels within.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (int) – the number of labels (an 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)
Returns:	output (int) – the size of the label (a uint64_t)

getNonEmptyLabelCount(self) → int¶

Gets the number of distinct labels within.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (int) – the number of non empty labels (an int)

getNonEmptyLabels(self, pOutputArray: ORSModel.ors.ArrayUnsignedLong) → ArrayUnsignedLong¶

Returns an array of all non empty labels.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pOutputArray (ORSModel.ors.ArrayUnsignedLong) – an optional output array (an ArrayUnsignedLong)
Returns:	output (ORSModel.ors.ArrayUnsignedLong) – the resulting array (an ArrayUnsignedLong)

Note

If an output array is supplied, data is written to it and returned, otherwise a new array is created.

Note

The array is cleared prior to adding.

getProjectionIn(self, aLabeledMultiROI: ORSModel.ors.MultiROI, sourceTimeOffset: int, pProgress: ORSModel.ors.Progress) → MultiROI¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI aLabeledMultiROI (ORSModel.ors.MultiROI) – sourceTimeOffset (int) – pProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.MultiROI) –

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)
Returns:	output (str) – the scalar description value (a std::wstring)

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)
Returns:	output (float) – the scalar max value (a 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)
Returns:	output (float) – the scalar min value (a 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)
Returns:	output (float) – the scalar offset value (a 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)
Returns:	output (float) – the scalar slope value (a float)

getScalarValueSlotLookUpTable(self, nScalarValueSlotIndex: int, iTIndex: int) → dict¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI nScalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (dict) –

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)
Returns:	output (int) – the scalar value unit (an shortt)

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) –
Returns:	output (ORSModel.ors.OrderedCollection) – an array of values (an OrderedCollection)

Note

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

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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

getScalarValuesSlotCount(self) → int¶

Gets the number of slots for scalar values.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (int) – the number of slots (an short)

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)
Returns:	output (float) – the scalar max value (a 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)
Returns:	output (float) – the scalar min value (a float)

getTotalVoxelCount(self) → int¶

Gets the total size of all labels.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (int) – the total size (a int64_t)

getUseScalarValues(self) → bool¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI
Returns:	output (bool) –

getVoxelCount(self, iTIndex: int) → int¶

Gets the size of all labels for a given T value.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI iTIndex (int) –
Returns:	output (int) – the number of voxels in the MultiROI (a int64_t)

grid(self, celXSize: int, celYSize: int, celZSize: int, minT: int, maxT: int) → None¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI celXSize (int) – celYSize (int) – celZSize (int) – minT (int) – maxT (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)
Returns:	output (bool) – TRUE if the operation succeeded, FALSE otherwise

mapLabelsToColors(self, anILUT: ORSModel.ors.LookupTable) → None¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI anILUT (ORSModel.ors.LookupTable) –

mapLabelsToDiscreteColors(self, anILUT: ORSModel.ors.LookupTable) → None¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI anILUT (ORSModel.ors.LookupTable) –

mapScalarValuesToColors(self, pData: ORSModel.ors.Array, pHightlightOpacityValue: ORSModel.ors.ArrayFloat, pLMROpacityValue: ORSModel.ors.ArrayFloat, fMinDisplayableValue: float, fMaxDisplayableValue: float, anILUT: ORSModel.ors.LookupTable) → None¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pData (ORSModel.ors.Array) – pHightlightOpacityValue (ORSModel.ors.ArrayFloat) – pLMROpacityValue (ORSModel.ors.ArrayFloat) – fMinDisplayableValue (float) – fMaxDisplayableValue (float) – anILUT (ORSModel.ors.LookupTable) –

mapScalarValuesToColorsWithRange(self, pData: ORSModel.ors.Array, fMinDisplayableValue: float, fMaxDisplayableValue: float, fMinSelectionRangeValue: float, fMaxSelectionRangeValue: float, hideOutOfRangeValues: bool, 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)
hideOutOfRangeValues (bool) – indicate if the out of range value should be displayed (a bool)
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:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pData (ORSModel.ors.Array) – pHightlightOpacityValue (ORSModel.ors.ArrayFloat) – pLMROpacityValue (ORSModel.ors.ArrayFloat) – nMinDisplayableValue (int) – nMaxDisplayableValue (int) – anILUT (ORSModel.ors.LookupTable) –

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)
Returns:	output (bool) – TRUE if the operation succeeded, FALSE otherwise

none()¶

MultiROI.MultiROI() -> MultiROI

Parameters:	self (ORSModel.ors.MultiROI) – an instance of 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:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pOutputROI (ORSModel.ors.ROI) – the output Volume ROI (an ROI) pLabel (int) – the label to extract (an unsigned int)

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:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pInputLabeledMultiROI (ORSModel.ors.MultiROI) – the MultiROI to remove (a MultiROI)

removeLabelsAndRenumber(self, pLabelArray: ORSModel.ors.ArrayUnsignedLong) → None¶

Removes the specified labels and renumber the remaining labels in the same order.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pLabelArray (ORSModel.ors.ArrayUnsignedLong) – an array of labels to remove (an ArrayUnsignedLong)

removeVolumeROI(self, pInputROI: ORSModel.ors.ROI) → None¶

Removes a VolumeROI.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI pInputROI (ORSModel.ors.ROI) – the Volume ROI to remove (an ROI)

removeVolumeROIFromLabel(self, aLabel: int, pROI: ORSModel.ors.ROI) → bool¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI aLabel (int) – pROI (ORSModel.ors.ROI) –
Returns:	output (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)

Note

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

setHideOutOfRangeScalarValues(self, value: bool) → None¶

Indicate if out of range values should be hidden.

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI value (bool) –

setLabelColor(self, label: int, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI label (int) – IColor (ORSModel.ors.Color) –

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)

setScalarValueSlotLookUpTable(self, lookUpTable: dict, nScalarValueSlotIndex: int, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.MultiROI) – an instance of MultiROI lookUpTable (dict) – nScalarValueSlotIndex (int) – iTIndex (int) –

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¶

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

MultiROIAnalyzer.MultiROIAnalyzer(self) -> MultiROIAnalyzer

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

MultiROIAnalyzer.MultiROIAnalyzer(self, rhs: ORSModel.ors.Unmanaged) -> MultiROIAnalyzer

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer rhs (Unmanaged) –

computeStatisticsFor(self, IChannel: ORSModel.ors.Channel, pTimeStep: int, IROI: ORSModel.ors.ROI, IProgress: ORSModel.ors.Progress) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer IChannel (ORSModel.ors.Channel) – pTimeStep (int) – IROI (ORSModel.ors.ROI) – IProgress (ORSModel.ors.Progress) –

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¶

Returns:	output (str) –

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer IChannel (ORSModel.ors.Channel) – IMultiROI (ORSModel.ors.MultiROI) – IListOfLabels (ORSModel.ors.ArrayUnsignedLong) – tChannel (int) – tLMR (int) – bins (int) – pMinRange (float) – pMaxRange (float) –
Returns:	output (ORSModel.ors.ArrayUnsignedLONGLONG) –

getEquivalentRadiusMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

getIndiciesCountInLabels(self) → ArrayLONGLONG¶

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

getLabelAspectRatio(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelCenterOfMass(self, pLabel: int) → Vector3¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (ORSModel.ors.Vector3) –

getLabelEntropy(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelEquivalentRadius(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelInertiaEigenValue(self, pLabel: int, vectorIndex: int) → float¶

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

Parameters:	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)
Returns:	output (float) – the eigenvalue (a double)

getLabelInertiaEigenValueMax(self, pLabel: int) → float¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (float) – the eigenvalue (a double)

getLabelInertiaEigenValueMed(self, pLabel: int) → float¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (float) – the eigenvalue (a double)

getLabelInertiaEigenValueMin(self, pLabel: int) → float¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (float) – the eigenvalue (a double)

getLabelInertiaEigenVector(self, pLabel: int, vectorIndex: int) → Vector3¶

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

Parameters:	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)
Returns:	output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)

getLabelInertiaEigenVectorWithMaxEigenValue(self, pLabel: int) → Vector3¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)

getLabelInertiaEigenVectorWithMedEigenValue(self, pLabel: int) → Vector3¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)

getLabelInertiaEigenVectorWithMinEigenValue(self, pLabel: int) → Vector3¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (ORSModel.ors.Vector3) – the eigenvector (a Vector3)

getLabelInertiaEigenVectorWithMinEigenValuePhiAngle(self, pLabel: int) → float¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (float) – the phi angle in radian (a double)

getLabelInertiaEigenVectorWithMinEigenValueThetaAngle(self, pLabel: int) → float¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) – label (an unsigned int)
Returns:	output (float) – the theta angle in radian (a double)

getLabelMaximumVoxel(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelMeanVoxel(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelMinimumVoxel(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelSizeMinMax(self, pMin: int, pMax: int) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (int) – pMax (int) –

getLabelSphericity(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelStandardDeviationVoxel(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelSurfaceArea(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelSurfaceXArea(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelSurfaceYArea(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelSurfaceZArea(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelVarianceVoxel(self, pLabel: int) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (float) –

getLabelWeightedCenterOfMass(self, pLabel: int) → Vector3¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (ORSModel.ors.Vector3) –

getLabelsAspectRatio(self) → ArrayDouble¶

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

getLabelsCenterOfMassX(self) → ArrayDouble¶

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

getLabelsCenterOfMassY(self) → ArrayDouble¶

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

getLabelsCenterOfMassZ(self) → ArrayDouble¶

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

getLabelsEntropy(self) → ArrayDouble¶

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

getLabelsEquivalentRadius(self) → ArrayDouble¶

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

getLabelsInertiaEigenValueMax(self) → ArrayDouble¶

Gets the maximum eigenvalues of the inertia tensor.

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)

getLabelsInertiaEigenValueMed(self) → ArrayDouble¶

Gets the medium eigenvalues of the inertia tensor.

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)

getLabelsInertiaEigenValueMin(self) → ArrayDouble¶

Gets the minimum eigenvalues of the inertia tensor.

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (ORSModel.ors.ArrayDouble) – the eigenvalues (an ArrayDouble)

getLabelsInertiaEigenVectorWithMinEigenValuePhiAngle(self) → ArrayDouble¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (ORSModel.ors.ArrayDouble) – the phi angles in radian (an ArrayDouble)

getLabelsInertiaEigenVectorWithMinEigenValueThetaAngle(self) → ArrayDouble¶

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

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (ORSModel.ors.ArrayDouble) – the theta angles in radian (an ArrayDouble)

getLabelsMaxLocationX(self) → ArrayDouble¶

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

getLabelsMaxLocationY(self) → ArrayDouble¶

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

getLabelsMaxLocationZ(self) → ArrayDouble¶

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

getLabelsMaximumVoxel(self) → ArrayDouble¶

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

getLabelsMeanVoxel(self) → ArrayDouble¶

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

getLabelsMinLocationX(self) → ArrayDouble¶

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

getLabelsMinLocationY(self) → ArrayDouble¶

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

getLabelsMinLocationZ(self) → ArrayDouble¶

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

getLabelsMinimumVoxel(self) → ArrayDouble¶

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

getLabelsSphericity(self) → ArrayDouble¶

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

getLabelsStandardDeviationVoxel(self) → ArrayDouble¶

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

getLabelsSurfaceArea(self) → ArrayDouble¶

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

getLabelsSurfaceXArea(self) → ArrayDouble¶

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

getLabelsSurfaceYArea(self) → ArrayDouble¶

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

getLabelsSurfaceZArea(self) → ArrayDouble¶

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

getLabelsVarianceVoxel(self) → ArrayDouble¶

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

getLabelsWeightedCenterOfMassX(self) → ArrayDouble¶

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

getLabelsWeightedCenterOfMassY(self) → ArrayDouble¶

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

getLabelsWeightedCenterOfMassZ(self) → ArrayDouble¶

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

getMaximumVoxelMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

getMeanVoxelMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

getMinimumVoxelMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

getNumberOfROIIndiciesInLabel(self, pLabel: int) → int¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pLabel (int) –
Returns:	output (int) –

getNumberOfROIIndiciesInLabelsMinMax(self, pMin: int, pMax: int) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (int) – pMax (int) –

getSphericityMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

getStandardDeviationVoxelMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

getSurfaceAreaMax(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getSurfaceAreaMin(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getSurfaceAreaMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

getSurfaceXAreaMax(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getSurfaceXAreaMin(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getSurfaceYAreaMax(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getSurfaceYAreaMin(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getSurfaceZAreaMax(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getSurfaceZAreaMin(self) → float¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer
Returns:	output (float) –

getVarianceVoxelMinMax(self, pMin: float, pMax: float) → None¶

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer pMin (float) – pMax (float) –

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:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of MultiROIAnalyzer IMultiROI (ORSModel.ors.MultiROI) – pStats (int) – pCompute2DStats (bool) –

none()¶

MultiROIAnalyzer.MultiROIAnalyzer() -> MultiROIAnalyzer

Parameters:	self (ORSModel.ors.MultiROIAnalyzer) – an instance of 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¶

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.Node(self, rhs: ORSModel.ors.Managed) -> Node

Parameters:	self (ORSModel.ors.Node) – an instance of Node rhs (Managed) –

attachChild(self, anINode: ORSModel.ors.Node) → bool¶

Attaches a child node.

Parameters:	self (ORSModel.ors.Node) – an instance of Node anINode (ORSModel.ors.Node) – the node to attach (an Node)
Returns:	output (bool) – TRUE if child was attached, FALSE otherwise

Note

Certain parent-child relationships are forbidden, hence the need to verify the result.

Note

Calling this method several times will still result in the child node only appearing once in its parent.

attachChildAtPosition(self, anINode: ORSModel.ors.Node, position: int) → bool¶

Attaches a child node at a given position.

Parameters:	self (ORSModel.ors.Node) – an instance of Node anINode (ORSModel.ors.Node) – the node to attach (an Node) position (int) – the position index (an unsigned int)
Returns:	output (bool) – TRUE if child was attached, FALSE otherwise

Note

Certain parent-child relationships are forbidden, hence the need to verify the result.

Note

Calling this method several times will still result in the child node only appearing once in its parent.

copyGraph(self) → Node¶

Returns a copy of the node, including its graph.

Parameters:	self (ORSModel.ors.Node) – an instance of Node
Returns:	output (ORSModel.ors.Node) – a new node (an Node)

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

detachChild(self, anINode: ORSModel.ors.Node) → bool¶

Detaches a child node.

Parameters:	self (ORSModel.ors.Node) – an instance of Node anINode (ORSModel.ors.Node) – the node to detach (an Node)
Returns:	output (bool) – TRUE if child was detached, FALSE otherwise

getAllChildrenNodes(self) → List¶

Returns a flattened list of the child hierarchy of the node.

Parameters:	self (ORSModel.ors.Node) – an instance of Node
Returns:	output (ORSModel.ors.List) – a list of all nodes below the node (an List)

Note

The child hierarchy is flattened.

Note

Expect no particular ordering of the nodes.

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)
Returns:	output (ORSModel.ors.List) – a list of nodes (an List)

Note

Result can be NULL or an empty list if no match is found.

Note

The search is done breadth-first.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

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)
Returns:	output (ORSModel.ors.List) – a list of all child nodes that can be rendered (an List)

Note

The list contains only Managed objects (they will need to be typecast to the appropriate class).

getAllParentNodes(self) → List¶

Returns a flattened list of the parent hierarchy of the node.

Parameters:	self (ORSModel.ors.Node) – an instance of Node
Returns:	output (ORSModel.ors.List) – a list of all nodes above the node (an List)

Note

The parent hierarchy is flattened.

Note

Expect no particular ordering of the nodes.

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)
Returns:	output (ORSModel.ors.List) – a list of nodes (an List)

Note

Result can be NULL or an empty list if no match is found.

Note

The search is done breadth-first.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

getChildWithGUID(self, aGUID: str) → Node¶

Gets an immediate child node with the given GUID.

Parameters:	self (ORSModel.ors.Node) – an instance of Node aGUID (str) – a GUID (a string)
Returns:	output (ORSModel.ors.Node) – a child node if found (an Node), NULL otherwise

Note

Only immediate children are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

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)
Returns:	output (ORSModel.ors.Node) – a child node if found (an Node), NULL otherwise

Note

Only immediate children are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

getChildrenNodes(self) → List¶

Returns the list of immediate child nodes.

Parameters:	self (ORSModel.ors.Node) – an instance of Node
Returns:	output (ORSModel.ors.List) – a list of nodes (an List)

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)
Returns:	output (ORSModel.ors.List) – a list of nodes (an List)

Note

Result can be NULL or an empty list if no match is found.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (ORSModel.ors.Node) – a node if one exists (an Node), NULL otherwise

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

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)
Returns:	output (ORSModel.ors.Node) – a node if it exists (an Node), NULL otherwise

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

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:	self (ORSModel.ors.Node) – an instance of Node pProgId (str) – the ProgId of the class to test against (a string) anINode (ORSModel.ors.Node) – a target node
Returns:	output (ORSModel.ors.Node) – a node if it exists (an Node), NULL otherwise

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

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)
Returns:	output (ORSModel.ors.Node) – a node if one exists (an Node), NULL otherwise

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

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)
Returns:	output (ORSModel.ors.Node) – a node if it exists (an Node), NULL otherwise

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

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)
Returns:	output (ORSModel.ors.Node) – a node if it exists (an Node), NULL otherwise

Note

Only the immediate children are searched, not the hierarchy.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

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)
Returns:	output (ORSModel.ors.Node) – a node if it exists (an Node), NULL otherwise

Note

Only the immediate parents are searched, not the hierarchy.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

getImmediateParentWithGUID(self, pGUID: str) → Node¶

Gets a parent node with the given GUID.

Parameters:	self (ORSModel.ors.Node) – an instance of Node pGUID (str) – a GUID (a string)
Returns:	output (ORSModel.ors.Node) – a parent node if found (an Node), NULL otherwise

Note

Only immediate parents are searched.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

getIsNodeOneOfMyAscendants(self, anINode: ORSModel.ors.Node) → bool¶

Checks to see if a specified node is in the parent hierarchy of the node.

Parameters:	self (ORSModel.ors.Node) – an instance of Node anINode (ORSModel.ors.Node) –
Returns:	output (bool) – TRUE if the specified node in the parent hierarchy, FALSE otherwise

Note

The parent hierarchy is searched in its entirety for the specified node.

Note

The search is conducted depth-first.

getIsNodeOneOfMyDescendants(self, anINode: ORSModel.ors.Node) → bool¶

Checks to see if a specified node is in the child hierarchy of the node.

Parameters:	self (ORSModel.ors.Node) – an instance of Node anINode (ORSModel.ors.Node) –
Returns:	output (bool) – TRUE if the specified node in the child hierarchy, FALSE otherwise

Note

The child hierarchy is searched in its entirety for the specified node.

Note

The search is conducted depth-first.

getMaxTSize(self) → int¶

Get Maximum T Size of all children node of this node.

Parameters:	self (ORSModel.ors.Node) – an instance of Node
Returns:	output (int) –

getParentNodes(self) → List¶

Gets the immediate parent nodes.

Parameters:	self (ORSModel.ors.Node) – an instance of Node
Returns:	output (ORSModel.ors.List) – a list of nodes (an List) if it exists, NULL otherwise

getParentWithGUID(self, pGUID: str) → Node¶

Gets a parent node (from the hierarchy) with the given GUID.

Parameters:	self (ORSModel.ors.Node) – an instance of Node pGUID (str) – a GUID (a string)
Returns:	output (ORSModel.ors.Node) – a parent node if found (an Node), NULL otherwise

Note

The whole parent hierarchy is searched.

Note

The search is done breadth-first.

Note

You can type the return value of this method to any subclass of ORSNode, if you know the class of the object being retrieved. If its class doesn’t match the type specified the return will be NULL.

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)
Returns:	output (ORSModel.ors.List) – a list of nodes (an List)

Note

Result can be NULL or an empty list if no match is found.

Note

Use constants defined in ORS_def.h for ProgIds (ex: ORSFrameProgId).

none()¶

Node.Node() -> Node

Parameters:	self (ORSModel.ors.Node) – an instance of 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)

Note

See ORS_def.h for default dirty flag (ex: ORSDataDirty).

Note

A dirty message has different results for different objects, but generally causes a refresh on the data.

Note

Message propagation is done depth-first.

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

Note

“Auto-updating” nodes ignore the dirty messages, i.e. they do not refresh themselves.

switchOrderOfPrecedenceOfChildrenNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool¶

Rearranges the order of child nodes.

Parameters:	self (ORSModel.ors.Node) – an instance of Node anINode1 (ORSModel.ors.Node) – a child node (an Node) anINode2 (ORSModel.ors.Node) – a child node (an Node)
Returns:	output (bool) – TRUE if successful, FALSE otherwise

Note

When child nodes are not in the desired order, they can be switched with this method (for example, the order in which they are rendered can be undesired).

Note

Both nodes are swapped in the list of nodes. For example, if nodes are A B C D and this call is made switchOrderOfPrecedenceOfChildrenNodes(A, C), the nodes are then in this order: C B A D.

Note

This method dives down in the child hierarchy until it finds a node where both arguments appear, then performs the switch at that level.

switchOrderOfPrecedenceOfParentNodes(self, anINode1: ORSModel.ors.Node, anINode2: ORSModel.ors.Node) → bool¶

Rearranges the ordering of immediate parent nodes.

Parameters:	self (ORSModel.ors.Node) – an instance of Node anINode1 (ORSModel.ors.Node) – a parent node (an Node) anINode2 (ORSModel.ors.Node) – a parent node (an Node)
Returns:	output (bool) – TRUE if successful, FALSE otherwise

Note

When parent nodes are not in the desired order, they can be switched with this method.

Note

Both nodes are swapped in the list of nodes. For example, if nodes are A B C D and this call is made switchOrderOfPrecedenceOfParentNodes(A, C), the nodes are then in this order: C B A D.

Note

This method acts only on immediate parent nodes, not the entire parent hierarchy.

ORSBaseClass¶

class ORSModel.ors.ORSBaseClass(self) → ORSBaseClass¶

Bases: sip.wrapper

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

isManaged(self) → bool¶

Parameters:	self (ORSModel.ors.ORSBaseClass) – an instance of ORSBaseClass
Returns:	output (bool) –

isNone(self) → bool¶

Parameters:	self (ORSModel.ors.ORSBaseClass) – an instance of ORSBaseClass
Returns:	output (bool) –

Octree¶

class ORSModel.ors.Octree(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → Octree¶

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

Octree.Octree(self) -> Octree

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

Octree.Octree(self, rhs: ORSModel.ors.Managed) -> Octree

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree rhs (Managed) –

buildOctreeBox(self, pGrid: ORSModel.ors.UnstructuredGrid, iTIndex: int, bAppend: bool) → None¶

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree pGrid (ORSModel.ors.UnstructuredGrid) – iTIndex (int) – bAppend (bool) –

buildOctreeBoxMultiThread(self, pGrid: ORSModel.ors.UnstructuredGrid, iTIndex: int, bAppend: bool) → None¶

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree pGrid (ORSModel.ors.UnstructuredGrid) – iTIndex (int) – bAppend (bool) –

buildSpheresOctreeBox(self, pCollection: ORSModel.ors.SequenceableCollection, boxThatContainTheSpheres: ORSModel.ors.Box, iTIndex: int, bAppend: bool) → None¶

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree pCollection (ORSModel.ors.SequenceableCollection) – boxThatContainTheSpheres (ORSModel.ors.Box) – iTIndex (int) – bAppend (bool) –

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) –
Returns:	output (ORSModel.ors.ArrayLong) –

getAtomsIntersectingBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle, iTIndex: int) → List¶

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree aBoundedPlane (ORSModel.ors.Rectangle) – iTIndex (int) –
Returns:	output (ORSModel.ors.List) –

getAtomsIntersectingBox(self, aBox: ORSModel.ors.Box, iTIndex: int) → List¶

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree aBox (ORSModel.ors.Box) – iTIndex (int) –
Returns:	output (ORSModel.ors.List) –

getAtomsIntersectingLine(self, aLine: ORSModel.ors.Line, iTIndex: int) → List¶

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree aLine (ORSModel.ors.Line) – iTIndex (int) –
Returns:	output (ORSModel.ors.List) –

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) –
Returns:	output (ORSModel.ors.List) –

getClassNameStatic() → str¶

Returns:	output (str) –

isEqualTo(self, anOctree: ORSModel.ors.Octree, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.Octree) – an instance of Octree anOctree (ORSModel.ors.Octree) – iTIndex (int) –
Returns:	output (bool) –

none()¶

Octree.Octree() -> Octree

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

OpticalFlow¶

class ORSModel.ors.OpticalFlow(self) → OpticalFlow¶

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

OpticalFlow.OpticalFlow(self, rhs: ORSModel.ors.Unmanaged) -> OpticalFlow

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow rhs (Unmanaged) –

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:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow pIOutChannelsGaussianPyramidIm1 (ORSModel.ors.Channel) – pIOutChannelsGaussianPyramidIm2 (ORSModel.ors.Channel) – pNumberOfLevels (int) –

findMaximalLevelGaussianPyramid(self) → int¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (int) –

findMaximalLevelGaussianPyramidChannelAWithChannelB(self, pIBoundingBoxSearchArea: ORSModel.ors.Box) → int¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow pIBoundingBoxSearchArea (ORSModel.ors.Box) –
Returns:	output (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) –
Returns:	output (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) –
Returns:	output (int) –

getChannelIm1(self) → Channel¶

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

getChannelIm2(self) → Channel¶

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

getClassNameStatic() → str¶

Returns:	output (str) –

getFactorRegularizationSpeedCorrection(self) → float¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (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
Returns:	output (int) –

getMaximalConditionValueRegularizedAtransposeA(self) → float¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (float) –

getMinLevelGaussianPyramid(self) → int¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (int) –

getOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

getOriginPixelsIm1(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) – t (int) –

getOriginPixelsIm2(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) – t (int) –

getPatchWindowHalfsize(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

getPerformZReduction(self) → bool¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (bool) –

getSizeImagesPixels(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

getSizePixelsAverageSpeed(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

getUpsampleSpeedToSameSizeAsBaseChannel(self) → bool¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (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
Returns:	output (bool) –

getUseTranslationX(self) → bool¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (bool) –

getUseTranslationY(self) → bool¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
Returns:	output (bool) –

getXSpeed(self) → Channel¶

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

getYSpeed(self) → Channel¶

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

getZSpeed(self) → Channel¶

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

none()¶

OpticalFlow.OpticalFlow() -> OpticalFlow

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of 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:

self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow
pIBoundingBoxReferenceIm1 (ORSModel.ors.Box) –
pIBoundingBoxSearchArea (ORSModel.ors.Box) –
minimalDistanceToStopOpticalFlow (float) –
minimalRotationToStopOpticalFlow (float) –
maximalNumberOfIterationsOpticalFlow (int) –
bApplyTransformation (bool) –
IProgress (ORSModel.ors.Progress) –

Returns:

output (ORSModel.ors.Matrix4x4) –

setChannelIm1(self, pIInputChannel: ORSModel.ors.Channel) → None¶

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

setChannelIm2(self, pIInputChannel: ORSModel.ors.Channel) → None¶

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

setFactorRegularizationSpeedCorrection(self, value: float) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow value (float) –

setLevelsGaussianPyramid(self, minLevel: int, maxLevel: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow minLevel (int) – maxLevel (int) –

setMaximalConditionValueRegularizedAtransposeA(self, value: float) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow value (float) –

setOriginPixelsAverageSpeedIm1(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

setOriginPixelsIm1(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) – t (int) –

setOriginPixelsIm2(self, x: int, y: int, z: int, t: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) – t (int) –

setPatchWindowHalfsize(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

setPerformZReduction(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow bValue (bool) –

setSizeImagesPixels(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

setSizePixelsAverageSpeed(self, x: int, y: int, z: int) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow x (int) – y (int) – z (int) –

setUpsampleSpeedToSameSizeAsBaseChannel(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow bValue (bool) –

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:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow bValue (bool) –

setUseTranslationX(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow bValue (bool) –

setUseTranslationY(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.OpticalFlow) – an instance of OpticalFlow bValue (bool) –

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.OrderedCollection(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> OrderedCollection

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

OrderedCollection.OrderedCollection(self, rhs: ORSModel.ors.Managed) -> OrderedCollection

Parameters:	self (ORSModel.ors.OrderedCollection) – an instance of OrderedCollection rhs (Managed) –

addAll(self, aSequenceableCollection: ORSModel.ors.SequenceableCollection) → None¶

Parameters:	self (ORSModel.ors.OrderedCollection) – an instance of OrderedCollection aSequenceableCollection (ORSModel.ors.SequenceableCollection) –

addAllFirst(self, aSequenceableCollection: ORSModel.ors.SequenceableCollection) → None¶

Parameters:	self (ORSModel.ors.OrderedCollection) – an instance of OrderedCollection aSequenceableCollection (ORSModel.ors.SequenceableCollection) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

OrderedCollection.OrderedCollection() -> OrderedCollection

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

OrderedCollectionChar¶

class ORSModel.ors.OrderedCollectionChar(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionChar¶

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

OrderedCollectionChar.OrderedCollectionChar(self) -> OrderedCollectionChar

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

OrderedCollectionChar.OrderedCollectionChar(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionChar

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar index (int) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar
Returns:	output (int) –

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar pValue (int) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar index (int) – pValue (int) –

none()¶

OrderedCollectionChar.OrderedCollectionChar() -> OrderedCollectionChar

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

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionChar) – an instance of OrderedCollectionChar pValue (int) –

OrderedCollectionDouble¶

class ORSModel.ors.OrderedCollectionDouble(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionDouble¶

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

OrderedCollectionDouble.OrderedCollectionDouble(self) -> OrderedCollectionDouble

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

OrderedCollectionDouble.OrderedCollectionDouble(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionDouble

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble rhs (Managed) –

add(self, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble pValue (float) –

addBeforeIndex(self, index: int, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble index (int) – pValue (float) –

addFirst(self, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble pValue (float) –

at(self, index: int) → float¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble index (int) –
Returns:	output (float) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble index (int) – pValue (float) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → float¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble
Returns:	output (float) –

getLast(self) → float¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble
Returns:	output (float) –

getOccurrencesOf(self, pValue: float) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble pValue (float) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble index (int) – pValue (float) –

none()¶

OrderedCollectionDouble.OrderedCollectionDouble() -> OrderedCollectionDouble

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

removeAllOccurrencesOf(self, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionDouble) – an instance of OrderedCollectionDouble pValue (float) –

OrderedCollectionFloat¶

class ORSModel.ors.OrderedCollectionFloat(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionFloat¶

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

OrderedCollectionFloat.OrderedCollectionFloat(self) -> OrderedCollectionFloat

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

OrderedCollectionFloat.OrderedCollectionFloat(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionFloat

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat rhs (Managed) –

add(self, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat pValue (float) –

addBeforeIndex(self, index: int, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat index (int) – pValue (float) –

addFirst(self, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat pValue (float) –

at(self, index: int) → float¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat index (int) –
Returns:	output (float) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat index (int) – pValue (float) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → float¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat
Returns:	output (float) –

getLast(self) → float¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat
Returns:	output (float) –

getOccurrencesOf(self, pValue: float) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat pValue (float) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat index (int) – pValue (float) –

none()¶

OrderedCollectionFloat.OrderedCollectionFloat() -> OrderedCollectionFloat

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

removeAllOccurrencesOf(self, pValue: float) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionFloat) – an instance of OrderedCollectionFloat pValue (float) –

OrderedCollectionLONGLONG¶

class ORSModel.ors.OrderedCollectionLONGLONG(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionLONGLONG¶

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

OrderedCollectionLONGLONG.OrderedCollectionLONGLONG(self) -> OrderedCollectionLONGLONG

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

OrderedCollectionLONGLONG.OrderedCollectionLONGLONG(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionLONGLONG

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG index (int) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG
Returns:	output (int) –

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG pValue (int) –
Returns:	output (int) –

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

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG index (int) – pValue (int) –

none()¶

OrderedCollectionLONGLONG.OrderedCollectionLONGLONG() -> OrderedCollectionLONGLONG

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

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLONGLONG) – an instance of OrderedCollectionLONGLONG pValue (int) –

OrderedCollectionLong¶

class ORSModel.ors.OrderedCollectionLong(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionLong¶

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

OrderedCollectionLong.OrderedCollectionLong(self) -> OrderedCollectionLong

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

OrderedCollectionLong.OrderedCollectionLong(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionLong

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong index (int) –
Returns:	output (int) –

atPut(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong
Returns:	output (int) –

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong pValue (int) –
Returns:	output (int) –

insertAt(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong index (int) – pValue (int) –

none()¶

OrderedCollectionLong.OrderedCollectionLong() -> OrderedCollectionLong

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionLong) – an instance of OrderedCollectionLong pValue (int) –

OrderedCollectionShort¶

class ORSModel.ors.OrderedCollectionShort(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionShort¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

OrderedCollectionShort.OrderedCollectionShort(self) -> OrderedCollectionShort

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort

OrderedCollectionShort.OrderedCollectionShort(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionShort

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort index (int) –
Returns:	output (int) –

atPut(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort
Returns:	output (int) –

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort pValue (int) –
Returns:	output (int) –

insertAt(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort index (int) – pValue (int) –

none()¶

OrderedCollectionShort.OrderedCollectionShort() -> OrderedCollectionShort

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionShort) – an instance of OrderedCollectionShort pValue (int) –

OrderedCollectionUnsignedChar¶

class ORSModel.ors.OrderedCollectionUnsignedChar(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionUnsignedChar¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

OrderedCollectionUnsignedChar.OrderedCollectionUnsignedChar(self) -> OrderedCollectionUnsignedChar

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar

OrderedCollectionUnsignedChar.OrderedCollectionUnsignedChar(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionUnsignedChar

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar index (int) –
Returns:	output (int) –

atPut(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar
Returns:	output (int) –

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar pValue (int) –
Returns:	output (int) –

insertAt(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar index (int) – pValue (int) –

none()¶

OrderedCollectionUnsignedChar.OrderedCollectionUnsignedChar() -> OrderedCollectionUnsignedChar

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedChar) – an instance of OrderedCollectionUnsignedChar pValue (int) –

OrderedCollectionUnsignedLONGLONG¶

class ORSModel.ors.OrderedCollectionUnsignedLONGLONG(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionUnsignedLONGLONG¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

OrderedCollectionUnsignedLONGLONG.OrderedCollectionUnsignedLONGLONG(self) -> OrderedCollectionUnsignedLONGLONG

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG

OrderedCollectionUnsignedLONGLONG.OrderedCollectionUnsignedLONGLONG(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionUnsignedLONGLONG

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG index (int) –
Returns:	output (int) –

atPut(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG
Returns:	output (int) –

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG pValue (int) –
Returns:	output (int) –

insertAt(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG index (int) – pValue (int) –

none()¶

OrderedCollectionUnsignedLONGLONG.OrderedCollectionUnsignedLONGLONG() -> OrderedCollectionUnsignedLONGLONG

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLONGLONG) – an instance of OrderedCollectionUnsignedLONGLONG pValue (int) –

OrderedCollectionUnsignedLong¶

class ORSModel.ors.OrderedCollectionUnsignedLong(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionUnsignedLong¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

OrderedCollectionUnsignedLong.OrderedCollectionUnsignedLong(self) -> OrderedCollectionUnsignedLong

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong

OrderedCollectionUnsignedLong.OrderedCollectionUnsignedLong(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionUnsignedLong

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong index (int) –
Returns:	output (int) –

atPut(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong
Returns:	output (int) –

getOccurrencesOf(self, pValue: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong pValue (int) –
Returns:	output (int) –

insertAt(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong index (int) – pValue (int) –

none()¶

OrderedCollectionUnsignedLong.OrderedCollectionUnsignedLong() -> OrderedCollectionUnsignedLong

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedLong) – an instance of OrderedCollectionUnsignedLong pValue (int) –

OrderedCollectionUnsignedShort¶

class ORSModel.ors.OrderedCollectionUnsignedShort(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → OrderedCollectionUnsignedShort¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

OrderedCollectionUnsignedShort.OrderedCollectionUnsignedShort(self) -> OrderedCollectionUnsignedShort

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort

OrderedCollectionUnsignedShort.OrderedCollectionUnsignedShort(self, rhs: ORSModel.ors.Managed) -> OrderedCollectionUnsignedShort

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort rhs (Managed) –

add(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort pValue (int) –

addBeforeIndex(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort index (int) – pValue (int) –

addFirst(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort pValue (int) –

at(self, index: int) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort index (int) –
Returns:	output (int) –

atPut(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort index (int) – pValue (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFirst(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort
Returns:	output (int) –

getLast(self) → int¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort
Returns:	output (int) –

insertAt(self, index: int, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort index (int) – pValue (int) –

none()¶

OrderedCollectionUnsignedShort.OrderedCollectionUnsignedShort() -> OrderedCollectionUnsignedShort

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort

removeAllOccurrencesOf(self, pValue: int) → None¶

Parameters:	self (ORSModel.ors.OrderedCollectionUnsignedShort) – an instance of OrderedCollectionUnsignedShort pValue (int) –

OrientedPlane¶

class ORSModel.ors.OrientedPlane¶

brief_description: Oriented plane manipulation services. author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: May 2010

OrientedPlane.OrientedPlane(self) -> OrientedPlane

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane

OrientedPlane.OrientedPlane(self, rhs: ORSModel.ors.Unmanaged) -> OrientedPlane

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane rhs (Unmanaged) –

copy(self) → OrientedPlane¶

Gets a copy of the receiver.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.OrientedPlane) – an oriented plane (an 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:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane point0 (ORSModel.ors.Vector3) – The first point (an Vector3) point1 (ORSModel.ors.Vector3) – The second point (an Vector3) point2 (ORSModel.ors.Vector3) – The third point (an Vector3) up (ORSModel.ors.Vector3) – The up vector (an Vector3)

Note

The up vector must be perpendicular to the normal vector.

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:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane point (ORSModel.ors.Vector3) – The point of origin (an Vector3) normal (ORSModel.ors.Vector3) – The normal vector (an Vector3) up (ORSModel.ors.Vector3) – The up vector (an Vector3)

Note

The up vector must be perpendicular to the normal vector.

getA(self) → float¶

Gets the A plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (float) – the A value (a double)

getB(self) → float¶

Gets the B plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (float) – the B value (a double)

getC(self) → float¶

Gets the C plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (float) – the C value (a double)

getCenter(self) → Vector3¶

Gets the center position.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Vector3) – the center position (an Vector3)

getClassNameStatic() → str¶

Returns:	output (str) –

getD(self) → float¶

Gets the D plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (float) – the D value (a double)

getDirection0(self) → Vector3¶

Gets the orientedPlane right direction.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction0 vector is normalized.

getDirection1(self) → Vector3¶

Gets the orientedPlane up direction.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction0 vector is normalized.

getDirection2(self) → Vector3¶

Gets the orientedPlane normal direction.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction0 vector is normalized.

getDistanceFromOrientedPlane(self, orientedPlane: ORSModel.ors.OrientedPlane) → float¶

Gets the distance from the provided plane to the receiver.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane orientedPlane (ORSModel.ors.OrientedPlane) –
Returns:	output (float) – a distance (a double)

getDistanceFromPlane(self, plane: ORSModel.ors.Plane) → float¶

Returns the distance from the receiver to the provided plane.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane plane (ORSModel.ors.Plane) – the plane (an Plane)
Returns:	output (float) – a distance (a double)

Note

Returns 0 if the receiver is parallel with the provided plane.

getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float¶

Returns the distance from the receiver to the provided point.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane point (ORSModel.ors.Vector3) – the point (an Vector3)
Returns:	output (float) – a distance (a double)

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:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane aLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if no intersection

getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → Vector3¶

Returns the vector representing the intersection with the provided line segment.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane aLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if no intersection

getIntersectionWithPlanes(self, plane1: ORSModel.ors.Plane, plane2: ORSModel.ors.Plane) → Vector3¶

Returns the point of the intersection with the provided planes.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane plane1 (ORSModel.ors.Plane) – plane2 (ORSModel.ors.Plane) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if no intersection

getIsEqualTo(self, anOrientedPlane: ORSModel.ors.OrientedPlane) → bool¶

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane anOrientedPlane (ORSModel.ors.OrientedPlane) –
Returns:	output (bool) –

getIsParallelWithOrientedPlane(self, orientedPlane: ORSModel.ors.OrientedPlane) → bool¶

Checks if the receiver is parallel with the provided oriented plane.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane orientedPlane (ORSModel.ors.OrientedPlane) –
Returns:	output (bool) – TRUE if parallel, FALSE otherwise

getIsParallelWithPlane(self, plane: ORSModel.ors.Plane) → bool¶

Checks if the receiver is parallel with the provided plane.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane plane (ORSModel.ors.Plane) – the plane (an Plane)
Returns:	output (bool) – TRUE if parallel, FALSE otherwise

getNormal(self) → Vector3¶

Returns the normal of the plane.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Vector3) – A vector (an Vector3)

getPlane(self) → Plane¶

Gets the plane represented by the receiver.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Plane) – a plane (an Plane)

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
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

getProjectionOnPlane(self, point: ORSModel.ors.Vector3) → Vector3¶

Returns the point provided projected on the receiver.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane point (ORSModel.ors.Vector3) – the point (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the projected point (an Vector3)

getRight(self) → Vector3¶

Gets the cross product of the normal and up vectors.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → OrientedPlane¶

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane axisOfRotation (ORSModel.ors.Vector3) – rotationCenter (ORSModel.ors.Vector3) – angle (float) –
Returns:	output (ORSModel.ors.OrientedPlane) –

getTransformed(self, aTransformationMatrix: ORSModel.ors.Matrix4x4) → OrientedPlane¶

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.OrientedPlane) –

getTranslatedToIncludePoint(self, point: ORSModel.ors.Vector3) → OrientedPlane¶

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane point (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.OrientedPlane) –

getUp(self) → Vector3¶

Gets the up vector.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

none()¶

OrientedPlane.OrientedPlane() -> OrientedPlane

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None¶

Applies a rotation to the receiver.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3) aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3) angleInRadian (float) – an angle in radian (a double)

Note

The box is a right handed bounded referential.

setA(self, a: float) → None¶

Sets the A plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane a (float) – the A value (a double)

setB(self, b: float) → None¶

Sets the B plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane b (float) – the B value (a double)

setC(self, c: float) → None¶

Sets the C plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane c (float) – the C value (a double)

setCenter(self, pCenterVector: ORSModel.ors.Vector3) → None¶

Sets the center position.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane pCenterVector (ORSModel.ors.Vector3) – a vector (an Vector3)

setD(self, d: float) → None¶

Sets the D plane value.

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane d (float) – the D value (a double)

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:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane upVector (ORSModel.ors.Vector3) – a vector (an Vector3)

translateToIncludePoint(self, point: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.OrientedPlane) – an instance of OrientedPlane point (ORSModel.ors.Vector3) –

PartialSpaceDijkstra¶

class ORSModel.ors.PartialSpaceDijkstra(self) → PartialSpaceDijkstra¶

Bases: ORSModel.ors.Dijkstra

Parameters:	self (ORSModel.ors.PartialSpaceDijkstra) – an instance of PartialSpaceDijkstra

PartialSpaceDijkstra.PartialSpaceDijkstra(self, rhs: ORSModel.ors.Unmanaged) -> PartialSpaceDijkstra

Parameters:	self (ORSModel.ors.PartialSpaceDijkstra) – an instance of PartialSpaceDijkstra rhs (Unmanaged) –

extractBoundaryFromROI(self, aVolROI: ORSModel.ors.ROI) → None¶

Parameters:	self (ORSModel.ors.PartialSpaceDijkstra) – an instance of PartialSpaceDijkstra aVolROI (ORSModel.ors.ROI) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

PartialSpaceDijkstra.PartialSpaceDijkstra() -> PartialSpaceDijkstra

Parameters:	self (ORSModel.ors.PartialSpaceDijkstra) – an instance of PartialSpaceDijkstra

setRadiusOfInterest(self, radius: int) → None¶

Parameters:	self (ORSModel.ors.PartialSpaceDijkstra) – an instance of PartialSpaceDijkstra radius (int) –

PartialSpaceFastMarching¶

class ORSModel.ors.PartialSpaceFastMarching(self) → PartialSpaceFastMarching¶

Bases: ORSModel.ors.FastMarching

Parameters:	self (ORSModel.ors.PartialSpaceFastMarching) – an instance of PartialSpaceFastMarching

PartialSpaceFastMarching.PartialSpaceFastMarching(self, rhs: ORSModel.ors.Unmanaged) -> PartialSpaceFastMarching

Parameters:	self (ORSModel.ors.PartialSpaceFastMarching) – an instance of PartialSpaceFastMarching rhs (Unmanaged) –

extractBoundaryFromROI(self, aVolROI: ORSModel.ors.ROI) → None¶

Parameters:	self (ORSModel.ors.PartialSpaceFastMarching) – an instance of PartialSpaceFastMarching aVolROI (ORSModel.ors.ROI) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

PartialSpaceFastMarching.PartialSpaceFastMarching() -> PartialSpaceFastMarching

Parameters:	self (ORSModel.ors.PartialSpaceFastMarching) – an instance of PartialSpaceFastMarching

setRadiusOfInterest(self, radius: int) → None¶

Parameters:	self (ORSModel.ors.PartialSpaceFastMarching) – an instance of PartialSpaceFastMarching radius (int) –

Plane¶

class ORSModel.ors.Plane¶

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Plane.Plane(self) -> Plane

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane

Plane.Plane(self, a: float, b: float, c: float, d: float) -> Plane

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane a (float) – b (float) – c (float) – d (float) –

Plane.Plane(self, rhs: ORSModel.ors.Unmanaged) -> Plane

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane rhs (Unmanaged) –

copy(self) → Plane¶

Copies a plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane
Returns:	output (ORSModel.ors.Plane) – A new plane (an Plane)

Note

The copied plane has the same equation as the source plane.

from3Points(self, point0: ORSModel.ors.Vector3, point1: ORSModel.ors.Vector3, point2: ORSModel.ors.Vector3) → None¶

Initializes the plane from 3 points.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane point0 (ORSModel.ors.Vector3) – The first point (an Vector3) point1 (ORSModel.ors.Vector3) – The second point (an Vector3) point2 (ORSModel.ors.Vector3) – The third point (an Vector3)

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:	self (ORSModel.ors.Plane) – an instance of Plane aPointCollection (ORSModel.ors.SequenceableCollection) – A sequence of points coordinates.

fromPointAndNormal(self, point: ORSModel.ors.Vector3, normal: ORSModel.ors.Vector3) → None¶

Initializes the plane from an origin point and a normal vector.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane point (ORSModel.ors.Vector3) – The point of origin (an Vector3) normal (ORSModel.ors.Vector3) – The normal vector (an Vector3)

getA(self) → float¶

Gets the a coefficient of the plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane
Returns:	output (float) – The a coefficient of the plane (a double)

Note

The general plane equation is ax + by + cz + dw = 0.

getB(self) → float¶

Gets the b coefficient of the plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane
Returns:	output (float) – The b coefficient of the plane (a double)

Note

The general plane equation is ax + by + cz + dw = 0.

getC(self) → float¶

Gets the c coefficient of the plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane
Returns:	output (float) – The c coefficient of the plane (a double)

Note

The general plane equation is ax + by + cz + dw = 0.

getClassNameStatic() → str¶

Returns:	output (str) –

getD(self) → float¶

Gets the d coefficient of the plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane
Returns:	output (float) – The d coefficient of the plane (a double)

Note

The general plane equation is ax + by + cz + dw = 0.

getDistanceFromPlane(self, plane: ORSModel.ors.Plane) → float¶

Computes the distance from another plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane plane (ORSModel.ors.Plane) – A plane (an Plane)
Returns:	output (float) – the distance (a double)

getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float¶

Computes the distance from a point.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane point (ORSModel.ors.Vector3) – A point (an Vector3)
Returns:	output (float) – the distance (a double)

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → Vector3¶

Return the vector representing the intersection of the provided line and the receiver.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane aLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if not intersection

getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → Vector3¶

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane aLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if not intersection

getIntersectionWithPlane(self, plane: ORSModel.ors.Plane) → Line¶

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane plane (ORSModel.ors.Plane) –
Returns:	output (ORSModel.ors.Line) –

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:	self (ORSModel.ors.Plane) – an instance of Plane plane1 (ORSModel.ors.Plane) – plane2 (ORSModel.ors.Plane) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3) or NULL if not intersection

getIsEqualTo(self, plane: ORSModel.ors.Plane) → bool¶

Verifies equality between the receiver and a given plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane plane (ORSModel.ors.Plane) –
Returns:	output (bool) – TRUE if the argument plane is equal to the receiver, FALSE otherwise

getIsParallelWithPlane(self, plane: ORSModel.ors.Plane) → bool¶

Checks to see if a given plane is parallel to the received plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane plane (ORSModel.ors.Plane) – A plane (an Plnae)
Returns:	output (bool) – TRUE if both planes are parallel, FALSE otherwise

getNormal(self) → Vector3¶

Returns the normal of the plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane
Returns:	output (ORSModel.ors.Vector3) – A vector (an Vector3)

getPointOnPlaneClosestToOrigin(self) → Vector3¶

Returns the closest point to the origin of the plane.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane
Returns:	output (ORSModel.ors.Vector3) – A point (an Vector3)

getProjectionOnPlane(self, point: ORSModel.ors.Vector3) → Vector3¶

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane point (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.Vector3) –

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Plane¶

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane axisOfRotation (ORSModel.ors.Vector3) – rotationCenter (ORSModel.ors.Vector3) – angle (float) –
Returns:	output (ORSModel.ors.Plane) –

getTranslatedToIncludePoint(self, point: ORSModel.ors.Vector3) → Plane¶

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane point (ORSModel.ors.Vector3) –
Returns:	output (ORSModel.ors.Plane) –

none()¶

Plane.Plane() -> Plane

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None¶

Applies a rotation to the receiver.

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3) aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3) angleInRadian (float) – an angle in radian (a double)

Note

The box is a right handed bounded referential.

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)

Note

The general plane equation is ax + by + cz + dw = 0.

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)

Note

The general plane equation is ax + by + cz + dw = 0.

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)

Note

The general plane equation is ax + by + cz + dw = 0.

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)

Note

The general plane equation is ax + by + cz + dw = 0.

translateToIncludePoint(self, point: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Plane) – an instance of Plane point (ORSModel.ors.Vector3) –

PlaneCollection¶

class ORSModel.ors.PlaneCollection¶

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.PlaneCollection(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> PlaneCollection

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

PlaneCollection.PlaneCollection(self) -> PlaneCollection

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection

PlaneCollection.PlaneCollection(self, rhs: ORSModel.ors.Managed) -> PlaneCollection

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection rhs (Managed) –

addPlane(self, aPlane: ORSModel.ors.Plane, tIndex: int) → None¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection aPlane (ORSModel.ors.Plane) – tIndex (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getColor(self) → Color¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection
Returns:	output (ORSModel.ors.Color) –

getHighlightedPlaneCollection(self, tIndex: int) → OrderedCollectionUnsignedChar¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection tIndex (int) –
Returns:	output (ORSModel.ors.OrderedCollectionUnsignedChar) –

getHighlightedPlaneCount(self, tIndex: int) → int¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection tIndex (int) –
Returns:	output (int) –

getPlane(self, planeIndex: int, tIndex: int) → Plane¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection planeIndex (int) – tIndex (int) –
Returns:	output (ORSModel.ors.Plane) –

getPlaneCount(self, tIndex: int) → int¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection tIndex (int) –
Returns:	output (int) –

getSelectedColor(self) → Color¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection
Returns:	output (ORSModel.ors.Color) –

getSelectedPlaneCollection(self, tIndex: int) → OrderedCollectionUnsignedChar¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection tIndex (int) –
Returns:	output (ORSModel.ors.OrderedCollectionUnsignedChar) –

getSelectedPlaneCount(self, tIndex: int) → int¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection tIndex (int) –
Returns:	output (int) –

getThicknessIn2DView(self) → int¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection
Returns:	output (int) –

none()¶

PlaneCollection.PlaneCollection() -> PlaneCollection

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection

removePlane(self, planeIndex: int, tIndex: int) → None¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection planeIndex (int) – tIndex (int) –

setColor(self, color: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection color (ORSModel.ors.Color) –

setPlane(self, aPlane: ORSModel.ors.Plane, planeIndex: int, tIndex: int) → None¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection aPlane (ORSModel.ors.Plane) – planeIndex (int) – tIndex (int) –

setSelectedColor(self, color: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection color (ORSModel.ors.Color) –

setThicknessIn2DView(self, tickness: int) → None¶

Parameters:	self (ORSModel.ors.PlaneCollection) – an instance of PlaneCollection tickness (int) –

Progress¶

class ORSModel.ors.Progress¶

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.Progress(self) -> Progress

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress

Progress.Progress(self, rhs: ORSModel.ors.Managed) -> Progress

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress rhs (Managed) –

Progress.Progress(self, buffer: int, nBytes: int) -> Progress

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress buffer (bytes) – nBytes (int) –

closeProgress(self) → None¶

Closes the progress bar.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress

Note

This protocol is also called automatically when the interface gets deleted, so it is not necessary to call it.

decrementRangeBy(self, iVal: int) → None¶

Decrements the progress range.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress iVal (int) –

Note

This protocol is only relevant when the progress is not a working progress.

deleteObject(self) → None¶

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress

getCaption(self) → str¶

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (str) –

getClassNameStatic() → str¶

Returns:	output (str) –

getCurrentProgress(self) → int¶

Gets the current progress position.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (int) – the current progress bar position (an uint32_t)

Note

This protocol should not be used with working progress bars, as they do not have a position.

getExtraText(self) → str¶

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (str) –

getID(self) → int¶

Gets the ID.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (int) – the progress ID (an short)

Note

This protocol is only relevant when the progress is started from an ID, not from a string caption.

getIsCancellable(self) → bool¶

Gets if the progress is cancellable.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (bool) – true if progress is cancellable, false otherwise

getIsCancelled(self) → bool¶

Checks if the progress was cancelled by the user.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (bool) – true if progress was cancelled, false otherwise

Note

This protocol is only relevant when the progress is a cancellable progress.

getIsVisible(self) → bool¶

Gets if the progress is visible.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (bool) – true if progress is visible, false otherwise

getIsWorkingBar(self) → bool¶

Gets if the progress is a working progress or not.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (bool) – true if progress is a working progress, false otherwise

getRange(self) → int¶

Gets the progress range.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress
Returns:	output (int) – the range (an uint32_t)

Note

This protocol is only relevant when the progress is not a working progress.

incrementRangeBy(self, iVal: int) → None¶

Increments the progress range.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress iVal (int) –

Note

This protocol is only relevant when the progress is not a working progress.

none()¶

Progress.Progress() -> Progress

Parameters:	self (ORSModel.ors.Progress) – an instance of 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:	self (ORSModel.ors.Progress) – an instance of Progress text (str) – some text (a string)

Note

The extra text is displayed in the progress dialog.

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

Note

This protocol is only relevant when the progress is a cancellable progress.

setIsVisible(self, bVisible: bool) → None¶

Sets if the progress is visible.

Parameters:	self (ORSModel.ors.Progress) – an instance of Progress bVisible (bool) –

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)

Note

This protocol should not be used with working progress bars, as they do not have a position.

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.ROI(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> ROI

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

ROI.ROI(self) -> ROI

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI

ROI.ROI(self, rhs: ORSModel.ors.Managed) -> ROI

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI rhs (Managed) –

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)

Note

The supplied X/Y/Z offset is the offset of the given channel relatively to the originating channel (the one the ROI is based upon), in voxels.

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:	self (ORSModel.ors.ROI) – an instance of ROI path (ORSModel.ors.VisualPath) – box (ORSModel.ors.Box) – plane (ORSModel.ors.Plane) – includeAllTouchingVoxel (bool) – inverse (bool) – bRemove (bool) – IProgress (ORSModel.ors.Progress) – tStep (int) –

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:	self (ORSModel.ors.ROI) – an instance of ROI path (ORSModel.ors.VisualPath) – box (ORSModel.ors.Box) – plane (ORSModel.ors.Plane) – includeAllTouchingVoxel (bool) – inverse (bool) – bRemove (bool) – IProgress (ORSModel.ors.Progress) – tStep (int) –

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:	self (ORSModel.ors.ROI) – an instance of ROI pLine (ORSModel.ors.Line) – None tStep (int) – step

Note

Note that the range values are inclusive.

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)

Note

Note that the range values are inclusive.

addLineSegment(self, lineSegment: ORSModel.ors.LineSegment, tStep: int) → None¶

Adds a line segment to theROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI lineSegment (ORSModel.ors.LineSegment) – the line to remove (an Line) tStep (int) – the time step (an unsigned short)

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)

Note

Note that the range values are inclusive.

addPathContour(self, aPath: ORSModel.ors.VisualPath, aBox: ORSModel.ors.Box, tStep: int) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aPath (ORSModel.ors.VisualPath) – aBox (ORSModel.ors.Box) – tStep (int) –

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)

Note

This method adds a 3D polygon, not a polyhedron. The points must lie on the same plane. The polygon is fill in the plane normal direction

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)

Note

This method adds a 3D polygon, not a polyhedron. The points must lie on the same plane. The polygon is fill in the plane normal direction

addROI(self, aROI: ORSModel.ors.ROI) → None¶

Adds aROI to the current ROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – the ROI to add (an ROI)

Note

The ROI to add will be projected correctly if it doesn’t share the same characteristics.

addROIAtTOffset(self, aROI: ORSModel.ors.ROI, pTOffset: int) → None¶

Adds aROI to the current ROI, but at a specific T offset.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – the ROI to add (an ROI) pTOffset (int) –

Note

The ROI to add will be projected correctly if it doesn’t share the same characteristics.

addROIAtTimeStepAtTOffset(self, aROI: ORSModel.ors.ROI, timeIndex: int, pTOffset: int) → None¶

Adds aROI to the current ROI, but at a specific T offset.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – the ROI to add (an ROI) timeIndex (int) – pTOffset (int) –

Note

The ROI to add will be projected correctly if it doesn’t share the same characteristics.

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)

Note

This method adds a 3D rectangle. The points must lie on the same plane. The polygon is filled in the plane normal direction.

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)

Note

This method adds a 3D rectangle. The points must lie on the same plane. The polygon is filled in the plane normal direction.

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
Returns:	output (ORSModel.ors.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)

Note

The index is linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

Note

If many voxels need to be added, it is better to use the protocols that accept a list of voxels.

addVoxelFromWorldCoordinates(self, pVect: ORSModel.ors.Vector3, timeIndex: int) → None¶

Adds point (supplied in the form of world vector) to theROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pVect (ORSModel.ors.Vector3) – pVect timeIndex (int) – the T index (an unsigned short)

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)

Note

Only those indicies having values within the supplied range are added to the ROI.

addVoxelIntersectingBoundedPlane(self, aPlane: ORSModel.ors.Rectangle, tStep: int) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aPlane (ORSModel.ors.Rectangle) – tStep (int) –

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)

Note

Every voxel within the interval will be added to the Region of Interest.

Note

The indicies are linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

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*)

Note

Every voxel within the interval will be added to the Region of Interest.

Note

The indicies are linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

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)

Note

The indicies are linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

Note

If the array is sorted, addition will perform quicker.

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)

Note

Very similar to addVoxelsFromWorldCoordinates(), but only those indicies having values within the supplied range are added to the ROI.

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:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – a destination ROI (an Volume)

dijkstra3DGrow(self, inputChannel: ORSModel.ors.Channel, volumeToGrowIn: ORSModel.ors.Box, volumeOfTheGrow: float, timeStep: int) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI inputChannel (ORSModel.ors.Channel) – volumeToGrowIn (ORSModel.ors.Box) – volumeOfTheGrow (float) – timeStep (int) –

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)

Note

Every voxel of the channel that touches the ROI is added to it, for the given time step.

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)

Note

The data from the source time step is copied to all the time steps of the ROI.

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)

Note

Every voxel of the ROI that touches the channel is removed from the ROI, for the given time step.

exchangeInternalData(self, aROI: ORSModel.ors.ROI) → bool¶

Exchanges (swaps) internal data between the receiver and the argumentROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – a ROI (an ROI)
Returns:	output (bool) – true if swap was successful, false otherwise

Note

Both ROIs must have same spatial characteristics.

extractCenterLinePaths(self, aSourceROI: ORSModel.ors.ROI, aTargetROI: ORSModel.ors.ROI) → List¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aSourceROI (ORSModel.ors.ROI) – aTargetROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.List) –

extractMinimumLengthPaths(self, aSourceROI: ORSModel.ors.ROI, aTargetROI: ORSModel.ors.ROI) → List¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aSourceROI (ORSModel.ors.ROI) – aTargetROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.List) –

extractSmoothPaths(self, aSourceROI: ORSModel.ors.ROI, aTargetROI: ORSModel.ors.ROI, fastMarchingGeometricBias: float, centered: bool) → List¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aSourceROI (ORSModel.ors.ROI) – aTargetROI (ORSModel.ors.ROI) – fastMarchingGeometricBias (float) – centered (bool) –
Returns:	output (ORSModel.ors.List) –

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)

Note

This method fills the interior of a ROI for each 2D slice aint32_t the supplied direction.

Note

This method fills 2D slices by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

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)

Note

This method fills the interior of a ROI for each 2D slice aint32_t the X axis.

Note

This method fills a ROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

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)

Note

This method fills the interior of a ROI for each 2D slice aint32_t the Y axis.

Note

This method fills a ROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

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)

Note

This method fills the interior of a ROI for each 2D slice aint32_t the Z axis.

Note

This method fills a ROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

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)

Note

This method fills a ROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

Note

When trying to close a 2D ROI (for example a circle), you need to work with a 2D ROI (i.e. Z size = 1).

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)

Note

This method fills a ROI’s interior by looking for escape openings. Using 26 neighbors enforces more rigidity in the algorithm to determine if a neighboring voxel is an opening or not.

Note

This method fills the interior of a ROI on a single 2D plane.

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:	pOutputLow (ORSModel.ors.ArrayUnsignedLong) – an output array for lower indicies (an ArrayUnsignedLong) pOutputHigh (ArrayLONGLONG) – an output array for higher indicies (an ArrayLONGLONG)

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) –
Returns:	output (ORSModel.ors.ROIAnalyzer) –

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)
Returns:	output (ORSModel.ors.Mesh) – the resulting mesh model (an Mesh)

Note

If a target Mesh is supplied, data is written to it and returned, otherwise a new Mesh is created.

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:

output (ORSModel.ors.Mesh) – the resulting mesh model (an Mesh)
pMesh (ORSModel.ors.Mesh) – an optional output mesh model (an Mesh)

Note

The isovalue is used as a threshold, any value below it (inclusive) is not considered.

Note

If a mesh model is supplied as the last argument, the results are written to it, otherwise a new mesh model is created.

Note

Currently only nearest sampling is supported.

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)

Returns:

output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

getAsROIClosedWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, pInRoi: ORSModel.ors.ROI, pTimeStep: int) → ROI¶

Closes theROI according to a supplied 3D kernel.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (an ConvolutionKernel) pInRoi (ORSModel.ors.ROI) – an optional output ROI (an ROI) pTimeStep (int) –
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

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:	self (ORSModel.ors.ROI) – an instance of ROI pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (an ConvolutionKernel) pInRoi (ORSModel.ors.ROI) – an optional output ROI (an ROI) pTimeStep (int) – the time step (an unsigned short) progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

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:	self (ORSModel.ors.ROI) – an instance of ROI pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (an ConvolutionKernel) pInRoi (ORSModel.ors.ROI) – an optional output ROI (an ROI) pTimeStep (int) – the time step (an unsigned short) progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

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
Returns:	output (ORSModel.ors.ROI) – the merged ROI

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

Note

The output ROI will always have a T dimension of 1, and the same X/Y/Z sizes as the source ROI.

Note

Because of the previous note, the output ROI cannot be the same as the receiver ROI (i.e. cannot merge into itself).

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)
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

getAsROIOpenWithKernel(self, pKernel: ORSModel.ors.ConvolutionKernel, pInRoi: ORSModel.ors.ROI, pTimeStep: int) → ROI¶

Opens theROI according to a supplied 3D kernel.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pKernel (ORSModel.ors.ConvolutionKernel) – the kernel (an ConvolutionKernel) pInRoi (ORSModel.ors.ROI) – an optional output ROI (an ROI) pTimeStep (int) – the time step (an unsigned short)
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

The 3D kernel needs not be symmetric, but each dimension must be odd, for the center always represents the current voxel.

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

getAsROIThinned(self, aROI: ORSModel.ors.ROI) → ROI¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) –

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:	self (ORSModel.ors.ROI) – an instance of ROI aBox (ORSModel.ors.Box) – the box to grow timeStep (int) –
Returns:	output (ORSModel.ors.Box) – the resulting Box (a Box)

getCenterOfMass(self, pTimeStep: int) → Vector3¶

Computes theROI’s center of mass.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pTimeStep (int) –
Returns:	output (ORSModel.ors.Vector3) – the center of mass (an XYZ vector) (an Vector3)

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:

self (ORSModel.ors.ROI) – an instance of ROI
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) –

getClassNameStatic() → str¶

Returns:	output (str) –

getClipBox(timestep=0, display=None)¶

Gets the clip box of the ROI or of the MultiROI

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	aClipBox (ORSModel.ors.Box) – the clip box

getClipping(timestep=0, display=None)¶

Gets the origin and the opposite summit of the clip box of the ROI or MultiROI

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	clipOriginSummit (ORSModel.ors.Vector3) – the origin summit of the clip box clipOppositeSummit (ORSModel.ors.Vector3) – the origin opposite summit of the clip box

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)
Returns:	output (ORSModel.ors.MultiROI) – the resulting object (an MultiROI)

Note

This method labels areas of the ROI by finding adjacent voxels and labelling them with sequential numbering.

Note

If a multi ROI object is supplied as the last argument, the results are written to it, otherwise a new one is created.

getContour(self, pPlane: ORSModel.ors.Plane, nTimeStep: int, pfPoints: ORSModel.ors.Array) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pPlane (ORSModel.ors.Plane) – nTimeStep (int) – pfPoints (ORSModel.ors.Array) –

getContour2(self, pBoudedPlane: ORSModel.ors.Rectangle, nTimeStep: int, pfPoints: ORSModel.ors.Array) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pBoudedPlane (ORSModel.ors.Rectangle) – nTimeStep (int) – pfPoints (ORSModel.ors.Array) –

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:	self (ORSModel.ors.ROI) – an instance of ROI pPlane (ORSModel.ors.Plane) – The cut plane (a Plane) nTimeStep (int) – The time step (an int) pfPoints (ORSModel.ors.Array) – The point array to fill (an ArrayFloat) pnIndexes (ORSModel.ors.ArrayLong) – The indexes array to fill (an ArrayLong)

Note

Many contours may be found. The indexes array contains the start index (in the point array) of the nth contour and the number of points it contains at the location 2*n and 2*n+1 respectively.

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:	self (ORSModel.ors.ROI) – an instance of ROI pBoudedPlane (ORSModel.ors.Rectangle) – The cut plane (a Plane) nTimeStep (int) – The time step (an int) pfPoints (ORSModel.ors.Array) – The point array to fill (an ArrayFloat) pnIndexes (ORSModel.ors.ArrayLong) – The indexes array to fill (an ArrayLong)

Note

Many contours may be found. The indexes array contains the start index (in the point array) of the nth contour and the number of points it contains at the location 2*n and 2*n+1 respectively.

getEndPoints(self, aROI: ORSModel.ors.ROI) → ROI¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) –

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) –
Returns:	output (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:

self (ORSModel.ors.ROI) – an instance of ROI
timeStep (int) –

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)

Note

This protocol analyzes the ROI and finds its two most distant points. It returns the coordinates of these two points, and computes the distance between them.

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)

Returns:

output (bool) – true if receiver has data within the range (inclusive), false otherwise

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)
Returns:	output (bool) – true if receiver has data within the range (inclusive), false otherwise

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)
Returns:	output (bool) – true if the ROI contains the index, false otherwise

getHistogramData(self, pNumberOfBins: int, pTimeStep: int, IChannel: ORSModel.ors.Channel) → HistogramData¶

Gets a histogram of theROI’s underlying data (from its channel).

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pNumberOfBins (int) – the number of desired bins (an int) pTimeStep (int) – IChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.HistogramData) – a histogram (an HistogramData)

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:	self (ORSModel.ors.ROI) – an instance of ROI first (ORSModel.ors.Vector3) – second (ORSModel.ors.Vector3) – third (ORSModel.ors.Vector3) – pTimeStep (int) –

Note

The eigen vector are sorted by eigen value, first is the int32_t*ues .. The norm of the vectors are the eigen value

getInitialColor(self) → Color¶

Gets the initialROI color.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (ORSModel.ors.Color) – a color (an Color)

Note

The color is expressed in RGB fashion.

getIntersectionWithROI(self, aROI: ORSModel.ors.ROI, anOutputROI: ORSModel.ors.ROI) → ROI¶

Intersects theROI with another ROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – the ROI to intersect with (an ROI) anOutputROI (ORSModel.ors.ROI) – the output ROI (an ROI), see note below
Returns:	output (ORSModel.ors.ROI) – the intersected ROI

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

Note

The output ROI can be the same as the receiver ROI (i.e. can intersect with another ROI into itself).

getIsClipped(timestep=0, display=None)¶

Gets to know if the clip box of the ROI or MultiROI is active

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
Returns:	isClipped (bool) – if True, the clip box of the ROI or MultiROI is visible; False otherwise.

getIsEmpty(self) → bool¶

Sees if theROI contains data.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (bool) – true if ROI contains no data, false otherwise

getLabel(self) → int¶

Gets theROI label.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (int) – a label (an short)

Note

A ROI label is a unsigned short value that can be associated to the ROI. Each ROI has one label.

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)

Returns:

output (ORSModel.ors.MultiROI) – the resulting object (an MultiROI)

Note

This method labels areas of the ROI by finding adjacent voxels and labelling them with sequential numbering.

Note

If a multi ROI object is supplied as the last argument, the results are written to it, otherwise a new one is created.

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)
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

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)
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

getMaxIndex(self) → int¶

Gets the largest index of theROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (int) – a channel voxel index (a int64_t)

getMaxSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float¶

Gets the maximum source voxel value of theROI for a given channel.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pTimeStep (int) – the T index (an unsigned short) pInputData (ORSModel.ors.Channel) – the source channel (an Channel)
Returns:	output (float) – a voxel value (a double)

Note

The value returned is in the same type as the source channel, but converted to a double.

getMeanSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float¶

Gets the mean source voxel value of theROI for a given channel.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pTimeStep (int) – the T index (an unsigned short) pInputData (ORSModel.ors.Channel) – the source channel (an Channel)
Returns:	output (float) – a voxel value (a double)

Note

The value returned is in the same type as the source channel, but converted to a double.

getMinIndex(self) → int¶

Gets the smallest index of theROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (int) – a channel voxel index (a int64_t)

getMinSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float¶

Gets the minimum source voxel value of theROI for a given channel.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pTimeStep (int) – the T index (an unsigned short) pInputData (ORSModel.ors.Channel) – the source channel (an Channel)
Returns:	output (float) – a voxel value (a double)

Note

The value returned is in the same type as the source channel, but converted to a double.

getProjectionIn(self, pChannel: ORSModel.ors.Channel, sourceTimeOffset: int, pProgress: ORSModel.ors.Progress) → ROI¶

Projects theROI in a channel’s spatial box.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pChannel (ORSModel.ors.Channel) – the target channel (an Channel) sourceTimeOffset (int) – a progress object (an Progress) or NULL for no progress pProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

getReversed(self, pTargetROI: ORSModel.ors.ROI) → ROI¶

Reverses theROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pTargetROI (ORSModel.ors.ROI) – an optional output ROI (an ROI)
Returns:	output (ORSModel.ors.ROI) – the resulting ROI (an ROI)

Note

A reversed ROI contains exactly the data not present in the receiver ROI.

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

getShowContour(self) → bool¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (bool) –

getShowContourCubic(self) → bool¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (bool) –

getShowContourInterpolated(self) → bool¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (bool) –

getSimplePoints(self, aROI: ORSModel.ors.ROI) → ROI¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) –

getSimplifiedGraphMesh(self, aROI: ORSModel.ors.ROI, aResultMesh: ORSModel.ors.Mesh, aSurfaceMesh: ORSModel.ors.Mesh) → ROI¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – aResultMesh (ORSModel.ors.Mesh) – aSurfaceMesh (ORSModel.ors.Mesh) –
Returns:	output (ORSModel.ors.ROI) –

getStandardDeviationSourceDataValue(self, pTimeStep: int, pInputData: ORSModel.ors.Channel) → float¶

Gets the standard deviation of the source voxels of theROI for a given channel.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pTimeStep (int) – the T index (an unsigned short) pInputData (ORSModel.ors.Channel) – the source channel (an Channel)
Returns:	output (float) – a voxel value (a double)

Note

The value returned is in the same type as the source channel, but converted to a double.

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

Returns:

output (ORSModel.ors.ROI) –

getSubtractionFromROI(self, aROI: ORSModel.ors.ROI, pOutputROI: ORSModel.ors.ROI) → ROI¶

Subtracts anotherROI from the receiver ROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – the ROI to subtract (an ROI) pOutputROI (ORSModel.ors.ROI) – the output ROI (an ROI), see note below
Returns:	output (ORSModel.ors.ROI) – the subtracted ROI

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

Note

The output ROI can be the same as the receiver ROI (i.e. can subtract another ROI into itself), but the output ROI cannot be the subtraction ROI.

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
Returns:	output (float) – the total surface area (a double)

Note

The algorithm checks 6 neighbors for each voxel to determine surfaces. If a neighbor is empty, it means that the voxel’s side is a surface.

getTotalVoxelCount(self) → int¶

Gets the total number of voxels within theROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (int) – the number of voxels in the ROI (a int64_t)

getUnionWithROI(self, aROI: ORSModel.ors.ROI, iTOffset: int, anOutputROI: ORSModel.ors.ROI) → ROI¶

Merges theROI with another ROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) – the ROI to merge with (an ROI) iTOffset (int) – the output ROI (an ROI), see note below anOutputROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) – the merged ROI

Note

If a target ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

Note

The output ROI can be the same as the receiver ROI (i.e. can merge with another ROI into itself).

Note

It is assumed that both ROIs share the same characteristics (i.e. size, orientation, etc).

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)
Returns:	output (float) – a double.

Note

The volume is in cubic units of the dimension unit of the underlying channel.

getVoxelCount(self, iTIndex: int) → int¶

Gets the number of voxels within theROI for a given T value.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI iTIndex (int) –
Returns:	output (int) – the number of voxels in the ROI (a int64_t)

Note

This method computes the number of indicies, so if you need the value several times try to cache its return value.

getWillBeDisplayed(self) → bool¶

Gets whether or not theROI is destined to be displayed.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI
Returns:	output (bool) – true if the ROI will be displayed, false otherwise

Note

Regions of interest are to be displayed by default.

Note

Regions of interest that will not be displayed use less memory and have less overhead.

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)

Note

The last two arguments are ignored if second argument is true.

Note

The callback function (argument 1) is called with an interval of indicies beginning and end, with the range being inclusive. A third argument supplied is the result of calling callback function in argument 2. In the case of single-threaded execution, that argument is NULL. The callback function should return true to continue iterating, but can return false to interrupt the iterating.

Note

The second callback function (argument 4) is called at the start of each thread. It is intended for the caller to create user data that is in turn supplied to the callback function at each invocation. The arguments it receives is (number of threads being started, threadNumber), with threadNumber being zero based.

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)

Note

The last two arguments are ignored if second argument is true.

Note

The callback function (argument 1) is called with an interval of indicies beginning and end, with the range being inclusive. A third argument supplied is the result of calling callback function in argument 2. In the case of single-threaded execution, that argument is NULL. The callback function should return true to continue iterating, but can return false to interrupt the iterating.

Note

The second callback function (argument 4) is called at the start of each thread. It is intended for the caller to create user data that is in turn supplied to the callback function at each invocation. The arguments it receives is (number of threads being started, threadNumber), with threadNumber being zero based.

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)
Returns:	output (ORSModel.ors.ROI) – a new ROI (an ROI)

Note

The supplied offset is the offset of the given channel relatively to the originating channel (the one the ROI is based upon), in voxels.

none()¶

ROI.ROI() -> ROI

Parameters:	self (ORSModel.ors.ROI) – an instance of 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:	self (ORSModel.ors.ROI) – an instance of ROI pBox (ORSModel.ors.Box) – label (float) – tStep (int) – intersectingChannel (ORSModel.ors.Channel) – levelingMinRange (float) – levelingMaxRange (float) – pLUT (ORSModel.ors.LookupTable) – intersectingChannelClipBox (ORSModel.ors.Box) –

paintBoxIntersectingMultiROI(self, pBox: ORSModel.ors.Box, label: float, tStep: int, intersectingMultiROI: ORSModel.ors.MultiROI, fHightlightOpacity: float, fHightlightOpacityOutRange: float, intersectingMultiROIClipBox: ORSModel.ors.Box) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pBox (ORSModel.ors.Box) – label (float) – tStep (int) – intersectingMultiROI (ORSModel.ors.MultiROI) – fHightlightOpacity (float) – fHightlightOpacityOutRange (float) – intersectingMultiROIClipBox (ORSModel.ors.Box) –

paintBoxIntersectingROI(self, pBox: ORSModel.ors.Box, label: float, tStep: int, intersectingROI: ORSModel.ors.ROI, intersectingROIClipBox: ORSModel.ors.Box) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pBox (ORSModel.ors.Box) – label (float) – tStep (int) – intersectingROI (ORSModel.ors.ROI) – intersectingROIClipBox (ORSModel.ors.Box) –

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:	self (ORSModel.ors.ROI) – an instance of ROI 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) –

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:	self (ORSModel.ors.ROI) – an instance of ROI worldPos (ORSModel.ors.Vector3) – fRadius (float) – label (float) – tStep (int) – intersectingMultiROI (ORSModel.ors.MultiROI) – fHightlightOpacity (float) – fHightlightOpacityOutRange (float) – intersectingMultiROIClipBox (ORSModel.ors.Box) –

paintSphereIntersectingROI(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int, intersectingROI: ORSModel.ors.ROI, intersectingROIClipBox: ORSModel.ors.Box) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI worldPos (ORSModel.ors.Vector3) – fRadius (float) – label (float) – tStep (int) – intersectingROI (ORSModel.ors.ROI) – intersectingROIClipBox (ORSModel.ors.Box) –

removeAllVoxelsIfInRange(self, timeStep: int, minValue: float, maxValue: float, pChannel: ORSModel.ors.Channel) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI timeStep (int) – minValue (float) – maxValue (float) – pChannel (ORSModel.ors.Channel) –

removeAllVoxelsIfNotInRange(self, timeStep: int, minValue: float, maxValue: float, pChannel: ORSModel.ors.Channel) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI timeStep (int) – minValue (float) – maxValue (float) – pChannel (ORSModel.ors.Channel) –

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:	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)

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)

Note

Note that the range values are inclusive.

removeLineSegment(self, lineSegment: ORSModel.ors.LineSegment, tStep: int) → None¶

Removes a line segment from theROI.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI lineSegment (ORSModel.ors.LineSegment) – the line segment to remove (an Line) tStep (int) – the time step (an unsigned short)

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)

Note

Note that the range values are inclusive.

removeROI(self, aROI: ORSModel.ors.ROI) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aROI (ORSModel.ors.ROI) –

removeSimplePointsWithDistanceMap(self, seedPointROI: ORSModel.ors.ROI, spaceChannel: ORSModel.ors.Channel, outputROI: ORSModel.ors.ROI) → ROI¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI seedPointROI (ORSModel.ors.ROI) – spaceChannel (ORSModel.ors.Channel) – outputROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) –

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)

Note

The index is linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

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)

Note

Only those indicies having values within the supplied range are removed from the ROI.

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)

Note

Every voxel within the interval will be removed from the Region of Interest.

Note

The indicies are linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

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*)

Note

Every voxel within the interval will be removed from the Region of Interest.

Note

The indicies are linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

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)

Note

The indicies are linear within the channel data.

Note

Any changes to a Region of Interest need to be followed by a show() to refresh the screen.

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)

Note

Very similar to removeVoxelsFromWorldCoordinates(), but only those indicies having values within the supplied range are removed from the ROI.

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:	self (ORSModel.ors.ROI) – an instance of ROI IColor (ORSModel.ors.Color) – a color (an Color)

Note

The color is expressed in RGB fashion.

setLabel(self, aLabel: int) → None¶

Sets theROI label.

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI aLabel (int) – a label (an unsigned short)

Note

A ROI label is an unsigned short value that can be associated to the ROI. Each ROI has one label.

setShowContour(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pFlag (bool) –

setShowContourCubic(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pFlag (bool) –

setShowContourInterpolated(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.ROI) – an instance of ROI pFlag (bool) –

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

Note

Regions of interest are to be displayed by default.

Note

Regions of interest that will not be displayed use less memory and have less overhead.

ROIAnalyzer¶

class ORSModel.ors.ROIAnalyzer¶

brief_description: Analyzer for ROIs. author: Nicolas Piché. All other members of ORS participated. version: 1.0 date: May 2010

ROIAnalyzer.ROIAnalyzer(self) -> ROIAnalyzer

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

ROIAnalyzer.ROIAnalyzer(self, rhs: ORSModel.ors.Unmanaged) -> ROIAnalyzer

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer rhs (Unmanaged) –

geVolumeWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getCenterOfMass(self) → Vector3¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (ORSModel.ors.Vector3) –

getCenterOfMassWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getClassNameStatic() → str¶

Returns:	output (str) –

getInertiaTensorPrincipalComponent(self) → Vector3¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (ORSModel.ors.Vector3) –

getInertiaTensorPrincipalComponentWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getLongestDistance(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getLongestDistanceWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getLongestLineSegment(self) → LineSegment¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (ORSModel.ors.LineSegment) –

getLongestSegmentWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getMax(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getMaxInPhysicalUnits(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getMean(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getMeanInPhysicalUnits(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getMeanWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getMin(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getMinInPhysicalUnits(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getMinMaxWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getStandardDeviation(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getStandardDeviationInPhysicalUnits(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getStandardDeviationWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getSurfaceArea(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getSurfaceAreaInPhysicalUnits(self) → float¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (float) –

getSurfaceAreaWasComputed(self) → bool¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (bool) –

getTimeStep(self) → int¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (int) –

getVoxelCount(self) → int¶

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer
Returns:	output (int) –

none()¶

ROIAnalyzer.ROIAnalyzer() -> ROIAnalyzer

Parameters:	self (ORSModel.ors.ROIAnalyzer) – an instance of ROIAnalyzer

Rectangle¶

class ORSModel.ors.Rectangle¶

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

Rectangle.Rectangle(self) -> Rectangle

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle

Rectangle.Rectangle(self, rhs: ORSModel.ors.Unmanaged) -> Rectangle

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle rhs (Unmanaged) –

atomicLoad(self, aFilename: str) → None¶

Loads an object from a file.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aFilename (str) – a file path (a string)

Note

Objects are saved in XML format.

Note

The file should contain only one object. If it contains more than one object, use atomicLoadSpecificNode().

atomicSave(self, aFilename: str) → int¶

Saves the object to a file.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aFilename (str) – a file path (a string)
Returns:	output (int) – a result code (0 if successful)

Note

Objects are saved in XML format.

Note

The file will be overwritten if it exists.

copy(self) → Rectangle¶

Gets a copy of the receiver.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Rectangle) – a box (an Rectangle)

getArea(self) → float¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) –

getBoundedDoublePlaneInBoxReferential(self, inRefBox: ORSModel.ors.Box) → Rectangle¶

Gets a copy of the receiver in the argument referential.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle inRefBox (ORSModel.ors.Box) – a box, the destination referential (an Box)
Returns:	output (ORSModel.ors.Rectangle) – a bounded plane, a copy of the receiver in the argument referential (an Rectangle)

getBox(self, direction2Size: float) → Box¶

Returns a box, with direction2 size provided by the argument, with the same origin as the receiver.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle direction2Size (float) –
Returns:	output (ORSModel.ors.Box) – a box (an Box)

getCenter(self) → Vector3¶

Gets the geometrical middle of the bounded plane.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – a bounded plane center position (an Vector3)

getCenterHalfVoxel(self) → Vector3¶

Gets the middle of the voxel in the middle of the box.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – a box center position (an Vector3)

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:	self (ORSModel.ors.Rectangle) – an instance of Rectangle direction2Size (float) –
Returns:	output (ORSModel.ors.Box) – a centered box (an Box)

getClassNameStatic() → str¶

Returns:	output (str) –

getDirection(self, index: int) → Vector3¶

Gets the bounded plane direction2.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle index (int) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction2 vector is normalized and automaticaly generated using the cross product of direction0 vector and direction1 vector.

getDirection0(self) → Vector3¶

Gets the bounded plane direction2.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction2 vector is normalized and automaticaly generated using the cross product of direction0 vector and direction1 vector.

getDirection0Size(self) → float¶

Gets the bounded plane direction1 vector length.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) – the side 1 length (a double)

Note

This is the size in meters of the bounded plane side 1.

getDirection0SizeInVoxel(self) → float¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) –

getDirection0Spacing(self) → float¶

Gets the receiver direction0 spacing.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) – the side 0 spacing (a double)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

getDirection1(self) → Vector3¶

Gets the bounded plane direction2.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction2 vector is normalized and automaticaly generated using the cross product of direction0 vector and direction1 vector.

getDirection1Size(self) → float¶

Gets the bounded plane direction1 vector length.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) – the side 1 length (a double)

Note

This is the size in meters of the bounded plane side 1.

getDirection1SizeInVoxel(self) → float¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) –

getDirection1Spacing(self) → float¶

Gets the receiver direction0 spacing.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) – the side 0 spacing (a double)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

getDirection2(self) → Vector3¶

Gets the bounded plane direction2.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction2 vector is normalized and automaticaly generated using the cross product of direction0 vector and direction1 vector.

getDirectionSize(self, index: int) → float¶

Gets the bounded plane direction1 vector length.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle index (int) –
Returns:	output (float) – the side 1 length (a double)

Note

This is the size in meters of the bounded plane side 1.

getDirectionSizeVector(self) → Vector3¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) –

getDirectionSpacing(self, index: int) → float¶

Gets the receiver direction0 spacing.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle index (int) –
Returns:	output (float) – the side 0 spacing (a double)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

getDirectionSpacingVector(self) → Vector3¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) –

getDistanceFromPoint(self, point: ORSModel.ors.Vector3) → float¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle point (ORSModel.ors.Vector3) –
Returns:	output (float) –

getIndex(self) → float¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (float) –

getIntersectionWithPlane(self, pPlane: ORSModel.ors.Plane) → LineSegment¶

Returns the line segment representing the intersection of the provided plane and the receiver.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle pPlane (ORSModel.ors.Plane) –
Returns:	output (ORSModel.ors.LineSegment) – a line segment (an LineSegment)

Note

Returns NULL if there is no intersection.

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
Returns:	output (ORSModel.ors.Matrix4x4) – a box center position (an Vector3)

getIsEqualTo(self, aBplane: ORSModel.ors.Rectangle) → bool¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aBplane (ORSModel.ors.Rectangle) –
Returns:	output (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)
Returns:	output (ORSModel.ors.Rectangle) – an interpolated bounded plane (an Rectangle)

getNormal(self) → Vector3¶

Returns the normal of theRectangle.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – A vector (an Vector3)

getOrigin(self) → Vector3¶

Gets the bounded plane origin position.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – the origin (an Vector3)

Note

The origin is in world coordinates.

getOriginOpposite(self) → Vector3¶

Gets the bounded plane origin opposite position.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Vector3) – the origin (an Vector3)

Note

The origin is in world coordinates.

getPlane(self) → Plane¶

Returns the plane on which the bounded plane resides.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Plane) – a plane (an Plane)

getProjectionOnPlane(self, aPoint: ORSModel.ors.Vector3) → Vector3¶

Returns a point which is the argument projected on the plane described by the receiver.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aPoint (ORSModel.ors.Vector3) – a point to project (an Vector3 )
Returns:	output (ORSModel.ors.Vector3) – the projected point (an Vector3)

getPythonRepresentation(self) → str¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (str) –

getSpacingInDirection(self, aDirection: ORSModel.ors.Vector3) → float¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aDirection (ORSModel.ors.Vector3) –
Returns:	output (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
Returns:	output (ORSModel.ors.Vector3) – a summit position (an Vector3)

getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → Rectangle¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Rectangle) –

getVoxelToWorldCoordinates(self, anIndex: ORSModel.ors.Vector3) → Vector3¶

Gets the position of a given voxel.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle anIndex (ORSModel.ors.Vector3) – a voxel position (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the position in world coordinates (an Vector3)

Note

Only useful if the spacing of the direction vectors have been defined.

getWorldToVoxelCoordinates(self, pPointInWorld: ORSModel.ors.Vector3) → Vector3¶

Gets the position of a given world coordinate.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle pPointInWorld (ORSModel.ors.Vector3) – a world coordinate position point (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the position in local coordinates (an Vector3)

Note

Only useful if the spacing of the direction vectors have been defined.

getWorldTranformation(self) → Matrix4x4¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle
Returns:	output (ORSModel.ors.Matrix4x4) –

growToIncludePoint(self, aPoint: ORSModel.ors.Vector3) → None¶

Grows the receiver as to include the provided point.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aPoint (ORSModel.ors.Vector3) –

Note

The provided point is projected on the bounded plane.

none()¶

Rectangle.Rectangle() -> Rectangle

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle

setDirection(self, index: int, pVect: ORSModel.ors.Vector3) → None¶

Sets the bounded plane direction0.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle index (int) – a vector (an Vector3) pVect (ORSModel.ors.Vector3) –

Note

The direction0 vector will be normalized.

setDirection0(self, pVect: ORSModel.ors.Vector3) → None¶

Sets the bounded plane direction0.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction0 vector will be normalized.

setDirection0Size(self, aSize: float) → None¶

Sets the bounded plane direction1 vector length.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aSize (float) – the side 1 length (a double)

Note

This is the size in meters of the bounded plane side 0.

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)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

setDirection1(self, pVect: ORSModel.ors.Vector3) → None¶

Sets the bounded plane direction0.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The direction0 vector will be normalized.

setDirection1Size(self, aSize: float) → None¶

Sets the bounded plane direction1 vector length.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle aSize (float) – the side 1 length (a double)

Note

This is the size in meters of the bounded plane side 0.

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)

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

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) –

Note

This is the size in meters of the bounded plane side 0.

setDirectionSizeVector(self, pVect: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle pVect (ORSModel.ors.Vector3) –

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) –

Note

This value is used to compute transformations from world coordinate space to index space (in the channels).

setDirectionSpacingVector(self, pVect: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle pVect (ORSModel.ors.Vector3) –

setOrigin(self, pVect: ORSModel.ors.Vector3) → None¶

Sets the receiver origin position.

Parameters:	self (ORSModel.ors.Rectangle) – an instance of Rectangle pVect (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The origin should be in world coordinates.

ReferenceFrame¶

class ORSModel.ors.ReferenceFrame¶

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.ReferenceFrame(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> ReferenceFrame

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

ReferenceFrame.ReferenceFrame(self) -> ReferenceFrame

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame

ReferenceFrame.ReferenceFrame(self, rhs: ORSModel.ors.Managed) -> ReferenceFrame

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame rhs (Managed) –

addLocalTranslation(self, pTranslation: ORSModel.ors.Vector3, pTimeStep: int) → None¶

Moves the frame by the specified offsets.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTranslation (ORSModel.ors.Vector3) – a translation vector (an Vector3) pTimeStep (int) – the time step (an unsigned short)

addLocalTranslationForAllTimeStep(self, pTranslation: ORSModel.ors.Vector3) → None¶

Moves the frame by the specified offsets.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTranslation (ORSModel.ors.Vector3) – a translation vector (an Vector3)

addRotation(self, pRotation: ORSModel.ors.Vector3, angle: float, pTimeStep: int) → None¶

Adds a rotation to the frame referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pRotation (ORSModel.ors.Vector3) – the rotation vector (an Vector3) angle (float) – angle (a float) pTimeStep (int) – the time step (an unsigned short)

Note

The rotation is aint32_t the specified vector, in the parent referential.

Note

Rotations are cumulative.

addRotationAroundPoint(self, fromNode: ORSModel.ors.Node, axis: ORSModel.ors.Vector3, centerOfRotation: ORSModel.ors.Vector3, angle: float, pTimeStep: int) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame fromNode (ORSModel.ors.Node) – axis (ORSModel.ors.Vector3) – centerOfRotation (ORSModel.ors.Vector3) – angle (float) – pTimeStep (int) –

addRotationAroundPointForAllTimeStep(self, fromNode: ORSModel.ors.Node, axis: ORSModel.ors.Vector3, centerOfRotation: ORSModel.ors.Vector3, angle: float) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame fromNode (ORSModel.ors.Node) – axis (ORSModel.ors.Vector3) – centerOfRotation (ORSModel.ors.Vector3) – angle (float) –

addRotationForAllTimeStep(self, pRotation: ORSModel.ors.Vector3, angle: float) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pRotation (ORSModel.ors.Vector3) – angle (float) –

addScaling(self, pScale: ORSModel.ors.Vector3, pTimeStep: int) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pScale (ORSModel.ors.Vector3) – pTimeStep (int) –

addScalingAtPoint(self, pScale: ORSModel.ors.Vector3, pPoint: ORSModel.ors.Vector3, pTimeStep: int) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pScale (ORSModel.ors.Vector3) – pPoint (ORSModel.ors.Vector3) – pTimeStep (int) –

addScalingAtPointForAllTimeStep(self, pScale: ORSModel.ors.Vector3, pPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pScale (ORSModel.ors.Vector3) – pPoint (ORSModel.ors.Vector3) –

addScalingForAllTimeStep(self, pScale: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pScale (ORSModel.ors.Vector3) –

getClassNameStatic() → str¶

Returns:	output (str) –

getLocalPosition(self, pTimeStep: int) → Vector3¶

Gets the frame translation (a vector) from the local parent referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTimeStep (int) – the time step (an unsigned short)
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The resulting translation is the frame position in the parent referential.

getMatrix(self, pTimeStep: int) → Matrix4x4¶

Gets the frame matrix.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTimeStep (int) – the time step (an unsigned short)
Returns:	output (ORSModel.ors.Matrix4x4) – a matrix (an Matrix4x4)

getParentFrame(self) → ReferenceFrame¶

Gets the first parent referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
Returns:	output (ORSModel.ors.ReferenceFrame) – a frame (an ReferenceFrame) if one exists, NULL otherwise

getPosition(self, aNode: ORSModel.ors.Node, pTimeStep: int) → Vector3¶

Gets the frame translation (a vector) directly from the world referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame aNode (ORSModel.ors.Node) – pTimeStep (int) –
Returns:	output (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The resulting translation is the frame position in the world referential.

getTSize(self) → int¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame
Returns:	output (int) –

getTransformationFromNodeToThis(self, fromNode: ORSModel.ors.Node, inputOutMatrix: ORSModel.ors.Matrix4x4, pTimeStep: int) → Matrix4x4¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame fromNode (ORSModel.ors.Node) – inputOutMatrix (ORSModel.ors.Matrix4x4) – pTimeStep (int) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getXScale(self, pTimeStep: int) → float¶

Gets the X scale of the frame in the parent referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTimeStep (int) – the time step (an unsigned short)
Returns:	output (float) – a scale (a double)

getYScale(self, pTimeStep: int) → float¶

Gets the Y scale of the frame in the parent referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTimeStep (int) – the time step (an unsigned short)
Returns:	output (float) – a scale (a double)

getZScale(self, pTimeStep: int) → float¶

Gets the Z scale of the frame in the parent referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTimeStep (int) – the time step (an unsigned short)
Returns:	output (float) – a scale (a double)

none()¶

ReferenceFrame.ReferenceFrame() -> ReferenceFrame

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame

reset(self, pTimeStep: int) → None¶

Resets the frame.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTimeStep (int) – the time step (an unsigned short)

Note

Resetting a frame moves it to 0,0,0, and resets its scale, rotation and tranlation.

resetForAllTimeStep(self) → None¶

Resets the frame.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame

Note

Resetting a frame moves it to 0,0,0, and resets its scale, rotation and tranlation.

resetFromBox(self, anIBox: ORSModel.ors.Box, pTimeStep: int) → None¶

Resets the frame to a box’s referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame anIBox (ORSModel.ors.Box) – a box (an Box) pTimeStep (int) – the time step (an unsigned short)

resetFromBoxForAllTimeStep(self, anIBox: ORSModel.ors.Box) → None¶

Resets the frame to a box’s referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame anIBox (ORSModel.ors.Box) – a box (an Box)

setLocalPosition(self, aIVector: ORSModel.ors.Vector3, pTimeStep: int) → None¶

Sets the frame translation from a vector in the local parent referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame aIVector (ORSModel.ors.Vector3) – a vector (an Vector3) pTimeStep (int) – the time step (an unsigned short)

Note

The resulting translation is the frame position in the parent referential.

setLocalPositionForAllTimeStep(self, aIVector: ORSModel.ors.Vector3) → None¶

Sets the frame translation from a vector in the local parent referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame aIVector (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The resulting translation is the frame position in the parent referential.

setMatrix(self, pMatrix: ORSModel.ors.Matrix4x4, pTimeStep: int) → None¶

Sets the frame matrix.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pMatrix (ORSModel.ors.Matrix4x4) – the matrix (an Matrix4x4) pTimeStep (int) – the time step (an unsigned short)

setMatrixForAllTimeStep(self, pMatrix: ORSModel.ors.Matrix4x4) → None¶

Sets the frame matrix.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pMatrix (ORSModel.ors.Matrix4x4) – the matrix (an Matrix4x4)

setOrientationCosine(self, fromNode: ORSModel.ors.Node, direction0Cosine: ORSModel.ors.Vector3, direction1Cosine: ORSModel.ors.Vector3, direction2Cosine: ORSModel.ors.Vector3, pTimeStep: int) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame fromNode (ORSModel.ors.Node) – direction0Cosine (ORSModel.ors.Vector3) – direction1Cosine (ORSModel.ors.Vector3) – direction2Cosine (ORSModel.ors.Vector3) – pTimeStep (int) –

setOrientationCosineForAllTimeStep(self, fromNode: ORSModel.ors.Node, direction0Cosine: ORSModel.ors.Vector3, direction1Cosine: ORSModel.ors.Vector3, direction2Cosine: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame fromNode (ORSModel.ors.Node) – direction0Cosine (ORSModel.ors.Vector3) – direction1Cosine (ORSModel.ors.Vector3) – direction2Cosine (ORSModel.ors.Vector3) –

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:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame aNode (ORSModel.ors.Node) – a node (a Node) aIVector (ORSModel.ors.Vector3) – a vector (an Vector3) pTimeStep (int) – the time step (an unsigned short)

Note

The resulting translation of the frame takes into account all parent referentials.

setPositionForAllTimeStep(self, aNode: ORSModel.ors.Node, aIVector: ORSModel.ors.Vector3) → None¶

Sets the frame translation from a vector directly in the world referential.

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame aNode (ORSModel.ors.Node) – a node (a Node) aIVector (ORSModel.ors.Vector3) – a vector (an Vector3)

Note

The resulting translation of the frame takes into account all parent referentials.

setTSize(self, pTSize: int) → None¶

Parameters:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame pTSize (int) –

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:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame xScale (float) – a scale (a double)

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:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame yScale (float) – a scale (a double)

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:	self (ORSModel.ors.ReferenceFrame) – an instance of ReferenceFrame zScale (float) – a scale (a double)

RenderingEffect¶

class ORSModel.ors.RenderingEffect(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → RenderingEffect¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

RenderingEffect.RenderingEffect(self) -> RenderingEffect

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

RenderingEffect.RenderingEffect(self, rhs: ORSModel.ors.Managed) -> RenderingEffect

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect rhs (Managed) –

addApplicableClassName(self, sClassName: str) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect sClassName (str) –

getClassNameStatic() → str¶

Returns:	output (str) –

getEffectIndex(self) → int¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect
Returns:	output (int) –

getID(self) → str¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect
Returns:	output (str) –

getIsApplicableToVisual(self, visual: ORSModel.ors.Visual) → bool¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect visual (ORSModel.ors.Visual) –
Returns:	output (bool) –

getIsEnabledForView(self, view: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect view (ORSModel.ors.View) –
Returns:	output (bool) –

getShaderCodeForView(self, aView: ORSModel.ors.View, raycastElementId: int, outputElementId: int) → str¶

get the evaluated shader code (in glsl)

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect aView (ORSModel.ors.View) – the view (a ors::view) raycastElementId (int) – raycastElementId: the index of the raycasted element being rendered (volumeN_, volumestructN_, transferFuncN_, rayN) outputElementId (int) – outputElementId: the index of colors[] output register (rgba)
Returns:	output (str) –

getShaderVariableCount(self) → int¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect
Returns:	output (int) –

getShaderVariableDoubleCount(self) → int¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect
Returns:	output (int) –

getShaderVariableDoubleForAll(self, variableName: str) → float¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect variableName (str) –
Returns:	output (float) –

getShaderVariableDoubleForView(self, view: ORSModel.ors.View, variableName: str) → float¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect view (ORSModel.ors.View) – variableName (str) –
Returns:	output (float) –

getShaderVariableDoubleNameAtIndex(self, iIndex: int) → str¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect iIndex (int) –
Returns:	output (str) –

getShaderVariableLUTCount(self) → int¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect
Returns:	output (int) –

getShaderVariableLUTForAll(self, variableName: str) → LookupTable¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect variableName (str) –
Returns:	output (ORSModel.ors.LookupTable) –

getShaderVariableLUTForView(self, view: ORSModel.ors.View, variableName: str) → LookupTable¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect view (ORSModel.ors.View) – variableName (str) –
Returns:	output (ORSModel.ors.LookupTable) –

getShaderVariableLUTNameAtIndex(self, iIndex: int) → str¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect iIndex (int) –
Returns:	output (str) –

none()¶

RenderingEffect.RenderingEffect() -> RenderingEffect

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect

setEffectIndex(self, iValue: int) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect iValue (int) –

setID(self, sId: str) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect sId (str) –

setIsEnabledForView(self, view: ORSModel.ors.View, bState: bool) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect view (ORSModel.ors.View) – bState (bool) –

setShaderCode(self, code: str) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect code (str) –

setShaderVariableDoubleForAll(self, variableName: str, aValue: float) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect variableName (str) – aValue (float) –

setShaderVariableDoubleForView(self, view: ORSModel.ors.View, variableName: str, aValue: float) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect view (ORSModel.ors.View) – variableName (str) – aValue (float) –

setShaderVariableLUTForAll(self, variableName: str, aLUT: ORSModel.ors.LookupTable) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect variableName (str) – aLUT (ORSModel.ors.LookupTable) –

setShaderVariableLUTForView(self, view: ORSModel.ors.View, variableName: str, aLUT: ORSModel.ors.LookupTable) → None¶

Parameters:	self (ORSModel.ors.RenderingEffect) – an instance of RenderingEffect view (ORSModel.ors.View) – variableName (str) – aLUT (ORSModel.ors.LookupTable) –

Saver¶

class ORSModel.ors.Saver¶

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.Saver(self) -> Saver

Parameters:	self (ORSModel.ors.Saver) – an instance of Saver

Saver.Saver(self, rhs: ORSModel.ors.Managed) -> Saver

Parameters:	self (ORSModel.ors.Saver) – an instance of Saver rhs (Managed) –

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¶

Returns:	output (str) –

getXML(self) → str¶

Parameters:	self (ORSModel.ors.Saver) – an instance of Saver
Returns:	output (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)
Returns:	output (bool) – true if file was successfully loaded, false otherwise

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)
Returns:	output (bool) – true if string was successfully loaded, false otherwise

none()¶

Saver.Saver() -> Saver

Parameters:	self (ORSModel.ors.Saver) – an instance of 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)

Note

Should eventually be matched by a call to pop() to go back one level.

Note

All ORS objects can save themselves to file, in an XML format.

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)
Returns:	output (int) – 0 if successful, an error code otherwise (an int)

Note

Note that the file is overwritten if it exists.

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.SequenceableCollection(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> SequenceableCollection

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

SequenceableCollection.SequenceableCollection(self, rhs: ORSModel.ors.Managed) -> SequenceableCollection

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection rhs (Managed) –

asArray(self) → Array¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
Returns:	output (ORSModel.ors.Array) –

asOrderedCollection(self) → OrderedCollection¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
Returns:	output (ORSModel.ors.OrderedCollection) –

atAsDouble(self, index: int) → float¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection index (int) –
Returns:	output (float) –

atPutAsDouble(self, index: int, pValue: float) → None¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection index (int) – pValue (float) –

dtype¶

getAsNDArray()¶

getClassNameStatic() → str¶

Returns:	output (str) –

getMaxValueAsDouble(self) → float¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
Returns:	output (float) –

getMaxValueAsDoubleInRange(self, startIndex: int, endIndex: int) → float¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection startIndex (int) – endIndex (int) –
Returns:	output (float) –

getMinValueAsDouble(self) → float¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection
Returns:	output (float) –

getMinValueAsDoubleInRange(self, startIndex: int, endIndex: int) → float¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection startIndex (int) – endIndex (int) –
Returns:	output (float) –

none()¶

SequenceableCollection.SequenceableCollection() -> SequenceableCollection

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection

removeAt(self, index: int) → None¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection index (int) –

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:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection iNewSize (int) –

Note

The size of the array can be used to lengthen or shorten it. Data contents are preserved.

Note

Avoid calling this method frequently as it is costly, shuffling and allocating memory.

shape¶

sortAscending(self, bSlave: ORSModel.ors.SequenceableCollection, cSlave: ORSModel.ors.SequenceableCollection, dSlave: ORSModel.ors.SequenceableCollection, eSlave: ORSModel.ors.SequenceableCollection) → None¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection bSlave (ORSModel.ors.SequenceableCollection) – cSlave (ORSModel.ors.SequenceableCollection) – dSlave (ORSModel.ors.SequenceableCollection) – eSlave (ORSModel.ors.SequenceableCollection) –

sortDescending(self, bSlave: ORSModel.ors.SequenceableCollection, cSlave: ORSModel.ors.SequenceableCollection, dSlave: ORSModel.ors.SequenceableCollection, eSlave: ORSModel.ors.SequenceableCollection) → None¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection bSlave (ORSModel.ors.SequenceableCollection) – cSlave (ORSModel.ors.SequenceableCollection) – dSlave (ORSModel.ors.SequenceableCollection) – eSlave (ORSModel.ors.SequenceableCollection) –

sortRangeAscending(self, index1: int, index2: int) → None¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection index1 (int) – index2 (int) –

sortRangeDescending(self, index1: int, index2: int) → None¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection index1 (int) – index2 (int) –

swap(self, index: int, index2: int) → None¶

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection index (int) – index2 (int) –

transformCoordinate(self, aTransform: ORSModel.ors.Matrix4x4) → None¶

Apply the 3D coordinate transformation to the elements of the collection.

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection aTransform (ORSModel.ors.Matrix4x4) –

transformVector(self, aTransform: ORSModel.ors.Matrix4x4) → None¶

Apply the 3D coordinate transformation to the elements of the collection.

Parameters:	self (ORSModel.ors.SequenceableCollection) – an instance of SequenceableCollection aTransform (ORSModel.ors.Matrix4x4) –

Shape¶

class ORSModel.ors.Shape¶

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2017

Shape.Shape(self) -> Shape

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape

Shape.Shape(self, rhs: ORSModel.ors.Unmanaged) -> Shape

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape rhs (Unmanaged) –

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)

Note

Objects are saved in XML format.

Note

The file should contain only one object. If it contains more than one object, use atomicLoadSpecificNode().

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)
Returns:	output (int) – a result code (0 if successful)

Note

Objects are saved in XML format.

Note

The file will be overwritten if it exists.

copy(self) → Unmanaged¶

Gets a copy of the receiver.

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape
Returns:	output (ORSModel.ors.Unmanaged) – a shape

getClassNameStatic() → str¶

Returns:	output (str) –

getPythonRepresentation(self) → str¶

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape
Returns:	output (str) –

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Shape¶

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape axisOfRotation (ORSModel.ors.Vector3) – rotationCenter (ORSModel.ors.Vector3) – angle (float) –
Returns:	output (ORSModel.ors.Shape) –

getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → Shape¶

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape aMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Shape) –

none()¶

Shape.Shape() -> Shape

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape

rotate(self, axisInWorld: ORSModel.ors.Vector3, aroundPointInWorld: ORSModel.ors.Vector3, angleInRadian: float) → None¶

Applies a rotation to the receiver.

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3) aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3) angleInRadian (float) – an angle in radian (a double)

Note

The box is a right handed bounded referential.

transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None¶

Applies a transformation to the receiver.

Parameters:	self (ORSModel.ors.Shape) – an instance of Shape transformationMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4)

Note

The transformation can include: translation, rotation and scaling.

Shape2D¶

class ORSModel.ors.Shape2D(self) → Shape2D¶

Bases: ORSModel.ors.Shape

Parameters:	self (ORSModel.ors.Shape2D) – an instance of Shape2D

Shape2D.Shape2D(self, rhs: ORSModel.ors.Unmanaged) -> Shape2D

Parameters:	self (ORSModel.ors.Shape2D) – an instance of Shape2D rhs (Unmanaged) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

Shape2D.Shape2D() -> Shape2D

Parameters:	self (ORSModel.ors.Shape2D) – an instance of Shape2D

Shape3D¶

class ORSModel.ors.Shape3D(self) → Shape3D¶

Bases: ORSModel.ors.Shape

Parameters:	self (ORSModel.ors.Shape3D) – an instance of Shape3D

Shape3D.Shape3D(self, rhs: ORSModel.ors.Unmanaged) -> Shape3D

Parameters:	self (ORSModel.ors.Shape3D) – an instance of Shape3D rhs (Unmanaged) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

Shape3D.Shape3D() -> Shape3D

Parameters:	self (ORSModel.ors.Shape3D) – an instance of Shape3D

Sphere¶

class ORSModel.ors.Sphere¶

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2017

Sphere.Sphere(self) -> Sphere

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere

Sphere.Sphere(self, center: ORSModel.ors.Vector3, radius: float) -> Sphere

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere center (ORSModel.ors.Vector3) – radius (float) –

Sphere.Sphere(self, rhs: ORSModel.ors.Unmanaged) -> Sphere

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere rhs (Unmanaged) –

copy(self) → Sphere¶

Gets a copy of the receiver.

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere
Returns:	output (ORSModel.ors.Sphere) – a shape

getCenter(self) → Vector3¶

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere
Returns:	output (ORSModel.ors.Vector3) –

getClassNameStatic() → str¶

Returns:	output (str) –

getIntersectionWithLine(self, aLine: ORSModel.ors.Line) → LineSegment¶

Return the vector representing the intersection of the provided line and the receiver.

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere aLine (ORSModel.ors.Line) –
Returns:	output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection

getIntersectionWithLineSegment(self, aLineSegment: ORSModel.ors.LineSegment) → LineSegment¶

Return the vector representing the intersection of the provided line segment and the receiver.

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere aLineSegment (ORSModel.ors.LineSegment) –
Returns:	output (ORSModel.ors.LineSegment) – a vector (an Vector3) or NULL if not intersection

getIsEqualTo(self, Sphere: ORSModel.ors.Sphere) → bool¶

Verifies equality between the receiver and a givenSphere.

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere Sphere (ORSModel.ors.Sphere) –
Returns:	output (bool) – TRUE if the argument Sphere is equal to the receiver, FALSE otherwise

getPythonRepresentation(self) → str¶

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere
Returns:	output (str) –

getRadius(self) → float¶

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere
Returns:	output (float) –

getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Sphere¶

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere axisOfRotation (ORSModel.ors.Vector3) – rotationCenter (ORSModel.ors.Vector3) – angle (float) –
Returns:	output (ORSModel.ors.Sphere) –

none()¶

Sphere.Sphere() -> Sphere

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere

rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None¶

Applies a rotation to the receiver.

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3) aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3) angleInRadian (float) – an angle in radian (a double)

Note

The box is a right handed bounded referential.

setCenter(self, center: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere center (ORSModel.ors.Vector3) –

setRadius(self, radius: float) → None¶

Parameters:	self (ORSModel.ors.Sphere) – an instance of Sphere radius (float) –

StatisticalAnalyzer¶

class ORSModel.ors.StatisticalAnalyzer(self) → StatisticalAnalyzer¶

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer

StatisticalAnalyzer.StatisticalAnalyzer(self, rhs: ORSModel.ors.Unmanaged) -> StatisticalAnalyzer

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer rhs (Unmanaged) –

analyze(self, momentsCount: int, median: bool, aCollection: ORSModel.ors.Collection) → None¶

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer momentsCount (int) – median (bool) – aCollection (ORSModel.ors.Collection) –

analyzeSubset(self, momentsCount: int, median: bool, startIndex: int, endIndex: int, aCollection: ORSModel.ors.SequenceableCollection) → None¶

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer momentsCount (int) – median (bool) – startIndex (int) – endIndex (int) – aCollection (ORSModel.ors.SequenceableCollection) –

getClassNameStatic() → str¶

Returns:	output (str) –

getMaximumValue(self) → float¶

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer
Returns:	output (float) –

getMedian(self) → float¶

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer
Returns:	output (float) –

getMinimumValue(self) → float¶

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer
Returns:	output (float) –

getMoment(self, niemeMoment: int) → float¶

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer niemeMoment (int) –
Returns:	output (float) –

none()¶

StatisticalAnalyzer.StatisticalAnalyzer() -> StatisticalAnalyzer

Parameters:	self (ORSModel.ors.StatisticalAnalyzer) – an instance of StatisticalAnalyzer

StructuredGrid¶

class ORSModel.ors.StructuredGrid(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → StructuredGrid¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

StructuredGrid.StructuredGrid(self, rhs: ORSModel.ors.Managed) -> StructuredGrid

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid rhs (Managed) –

copyShapeFromBox(self, pBox: ORSModel.ors.Box, tSize: int) → None¶

Initializes the structured grid’s shape based on a box.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pBox (ORSModel.ors.Box) – a box (a Box) tSize (int) – a T size (an unsigned short)

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:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pStructuredGrid (ORSModel.ors.StructuredGrid) – a source structured grid

Note

Shape includes size, spacing, type, description, position and location.

Note

This method does not handle the structured grid’s data.

getAsChannel(self, inOutStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid¶

Convert a structured grid to a channel.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid inOutStructuredGrid (ORSModel.ors.StructuredGrid) – an optional output channel (an StructuredGrid) IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.StructuredGrid) – the resulting channel (an StructuredGrid)

Note

If an output channel is supplied, data is written to it and returned, otherwise a new channel is created.

Note

If the source structured grid is a channel it returns a copy.

Note

If the source structured grid is a Volume ROI the channel output data type is UNSIGNED CHAR. A value of 1 is written where a label exist in the input Volume ROI, 0 otherwise.

Note

If the source structured grid is a MultiROI the output data type is determined by the total number of labels within:

getAsMultiROI(self, inOutStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid¶

Convert a structured grid to aMultiROI.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid inOutStructuredGrid (ORSModel.ors.StructuredGrid) – an optional output MultiROI (an StructuredGrid) IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.StructuredGrid) – the resulting MultiROI (an StructuredGrid)

Note

If an output MultiROI is supplied, data is written to it and returned, otherwise a new MultiROI is created.

Note

The MultiROI is cleared prior to adding.

Note

If the source structured grid is a channel the output MultiROI will contain a label for every non zero channel values.

Note

If the source structured grid is a Volume ROI it returns a MultiROI of 1 label.

Note

If the source structured grid is a MultiROI it returns a copy.

getAsROI(self, inOutStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid¶

Convert a structured grid to a VolumeROI.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid inOutStructuredGrid (ORSModel.ors.StructuredGrid) – an optional output Volume ROI (an StructuredGrid) IProgress (ORSModel.ors.Progress) – an optional progress object (a Progress)
Returns:	output (ORSModel.ors.StructuredGrid) – the resulting Volume ROI (an StructuredGrid)

Note

If an output ROI is supplied, data is written to it and returned, otherwise a new ROI is created.

Note

The ROI is cleared prior to adding.

Note

If the source structured grid is a channel the output Volume ROI will contain voxel for every non zero channel values.

Note

If the source structured grid is a Volume ROI it returns a copy.

Note

If the source structured grid is a MultiROI it extracts the labels and adds them all to a Volume ROI.

getBoundingBox(self, pTIndex: int) → Box¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pTIndex (int) –
Returns:	output (ORSModel.ors.Box) –

getBox(self) → Box¶

Gets the box.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (ORSModel.ors.Box) – the box (an Box)

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (ORSModel.ors.Box) – the dirty box (a Box)

getHasSameShape(self, pStructuredGrid: ORSModel.ors.StructuredGrid) → bool¶

Verifies if the structured grid has same shape as another structured grid (see note below).

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pStructuredGrid (ORSModel.ors.StructuredGrid) – a comparison structured grid
Returns:	output (bool) – true if the comparison structured grid has same shape as receiver structured grid, false otherwise

Note

Shape comparison includes axis sizes, spacing, position and orientation.

getIndexOfFirstIntersectingNonZeroElement(self, aLine: ORSModel.ors.Line, subBox: ORSModel.ors.Box, timestep: int) → Vector3¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid aLine (ORSModel.ors.Line) – subBox (ORSModel.ors.Box) – timestep (int) –
Returns:	output (ORSModel.ors.Vector3) –

getIsIdenticalTo(self, pStructuredGrid: ORSModel.ors.StructuredGrid) → bool¶

Verifies if the structured grid is identical to another structured grid (see note below).

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pStructuredGrid (ORSModel.ors.StructuredGrid) – a comparison structured grid (a StructuredGrid)
Returns:	output (bool) – TRUE if the comparison structured grid has the same shape and data as receiver structured grid, FALSE otherwise

Note

Comparison of shape and data.

getLabelAtPosition(self, tIndex: int, worldPosition: ORSModel.ors.Vector3) → int¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid tIndex (int) – worldPosition (ORSModel.ors.Vector3) –
Returns:	output (int) –

getOrigin(self) → Vector3¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (ORSModel.ors.Vector3) –

getOriginalBox(self) → Box¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (ORSModel.ors.Box) –

getPositionOfFirstIntersectingNonZeroElement(self, aLine: ORSModel.ors.Line, subBox: ORSModel.ors.Box, timestep: int) → Vector3¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid aLine (ORSModel.ors.Line) – subBox (ORSModel.ors.Box) – timestep (int) –
Returns:	output (ORSModel.ors.Vector3) –

getSliceAtIndex(self, zIndex: int, inStructuredGridSlice: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid zIndex (int) – inStructuredGridSlice (ORSModel.ors.StructuredGrid) – IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.StructuredGrid) –

getSliceIntersectingBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle, inStructuredGridSlice: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → StructuredGrid¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid aBoundedPlane (ORSModel.ors.Rectangle) – inStructuredGridSlice (ORSModel.ors.StructuredGrid) – IProgress (ORSModel.ors.Progress) –
Returns:	output (ORSModel.ors.StructuredGrid) –

getSpaceHasBeenTransformed(self) → bool¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (bool) –

getSpacingInDirection(self, pDirection: ORSModel.ors.Vector3) → float¶

Gets the spacing in the specified direction.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pDirection (ORSModel.ors.Vector3) – the direction vector (an Vector3)
Returns:	output (float) – The spacing (a double)

Note

A structured grid knows its X, Y and Z spacing but can compute the spacing in any direction with this method.

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) – an optional progress object

Returns:

output (ORSModel.ors.StructuredGrid) – a StructuredGrid (see notes)

Note

To prevent creating extra StructuredGrid, the output StructuredGrid can be fed as the second to last argument to the method.

Note

If an output structured grid is not supplied, a StructuredGrid of the same base type will be created, otherwise the data will be fed directly into it.

getTSize(self) → int¶

Gets the T size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (int) – the T size (an short)

Note

The T size is expressed in units.

getTSpacing(self) → float¶

Gets the structured grid’s T spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (float) – T spacing (a double)

Note

Spacing is used for structured grid visual representation.

getTransformationFromOriginalReferential(self) → Matrix4x4¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (ORSModel.ors.Matrix4x4) –

getVoxelToWorldCoordinates(self, anIndex: ORSModel.ors.Vector3) → Vector3¶

Gets a given voxel’s location in DICOM Reference Coordinates System.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid anIndex (ORSModel.ors.Vector3) – the voxel coordinate as a Vector3
Returns:	output (ORSModel.ors.Vector3) – the world coordinates (in a vector) of the voxel (an Vector3)

Note

This method returns the world coordinates of any given voxel. The arguments supplied represent the voxel index, but can be offset by a value between 0 and 1, to discover the exact subvoxel location. For example, to find the exact middle location of the voxel at x30,y50,z65, use getVoxelToWorldCoordinates (30.5, 50.5, 65.5).

getWorldToVoxelCoordinates(self, pPointInWorld: ORSModel.ors.Vector3) → Vector3¶

Gets a given voxel’s index from DICOM Reference Coordinates System.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pPointInWorld (ORSModel.ors.Vector3) – the voxel coordinate encoded in Vector3
Returns:	output (ORSModel.ors.Vector3) – the voxel coordinates (in a vector) of the voxel (an Vector3)

getXSize(self) → int¶

Gets the X size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (int) – the X size (an uint32_t)

Note

The size is expressed in pixels.

getXSpacing(self) → float¶

Gets the structured grid’s X spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (float) – X spacing (a double)

Note

Spacing is used for structured grid visual representation.

getYSize(self) → int¶

Gets the Y size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (int) – the Y size (an uint32_t)

Note

The size is expressed in pixels.

getYSpacing(self) → float¶

Gets the structured grid’s Y spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (float) – Y spacing (a double)

Note

Spacing is used for structured grid visual representation.

getZSize(self) → int¶

Gets the Z size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (int) – the Z size (an uint32_t)

Note

The size is expressed in pixels.

getZSliceThickness(self) → float¶

Gets the structured grid’s Z slice thickness.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (float) – Z slice thickness (a double)

Note

Slice thickness is used for structured grid visual representation.

getZSpacing(self) → float¶

Gets the structured grid’s Z spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
Returns:	output (float) – Z spacing (a double)

Note

Spacing is used for structured grid visual representation.

none()¶

StructuredGrid.StructuredGrid() -> StructuredGrid

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

paintBox(self, pBox: ORSModel.ors.Box, label: float, tStep: int) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pBox (ORSModel.ors.Box) – label (float) – tStep (int) –

paintBoxIfInRange(self, pBox: ORSModel.ors.Box, label: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pBox (ORSModel.ors.Box) – label (float) – tStep (int) – fMinValue (float) – fMaxValue (float) – pRangeChannel (ORSModel.ors.StructuredGrid) –

paintCircleOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pPlane (ORSModel.ors.Rectangle) – worldPos (ORSModel.ors.Vector3) – radius (float) – label (float) – timeIndex (int) – worldPositionArray (ORSModel.ors.ArrayDouble) –

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:

self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
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) –

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:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pPlane (ORSModel.ors.Rectangle) – worldPos (ORSModel.ors.Vector3) – dir0Radius (float) – dir1Radius (float) – axisOrientation (float) – label (float) – timeIndex (int) – worldPositionArray (ORSModel.ors.ArrayDouble) –

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:

self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
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) –

paintPolygonOnPlane(self, pPlane: ORSModel.ors.Rectangle, polygonWorldPos: ORSModel.ors.ArrayDouble, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pPlane (ORSModel.ors.Rectangle) – polygonWorldPos (ORSModel.ors.ArrayDouble) – label (float) – timeIndex (int) – worldPositionArray (ORSModel.ors.ArrayDouble) –

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:

self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
pPlane (ORSModel.ors.Rectangle) –
polygonWorldPos (ORSModel.ors.ArrayDouble) –
label (float) –
timeIndex (int) –
lowerThreshold (float) –
upperThreshold (float) –
pRangeChannel (ORSModel.ors.StructuredGrid) –
worldPositionArray (ORSModel.ors.ArrayDouble) –

paintRectangleOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, dir0Length: float, dir1Length: float, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pPlane (ORSModel.ors.Rectangle) – worldPos (ORSModel.ors.Vector3) – dir0Length (float) – dir1Length (float) – label (float) – timeIndex (int) – worldPositionArray (ORSModel.ors.ArrayDouble) –

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:

self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
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) –

paintShape3D(self, aShape: ORSModel.ors.Shape3D, label: float, tStep: int) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid aShape (ORSModel.ors.Shape3D) – label (float) – tStep (int) –

paintShape3DIfInRange(self, aShape: ORSModel.ors.Shape3D, label: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid aShape (ORSModel.ors.Shape3D) – label (float) – tStep (int) – fMinValue (float) – fMaxValue (float) – pRangeChannel (ORSModel.ors.StructuredGrid) –

paintSphere(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid worldPos (ORSModel.ors.Vector3) – fRadius (float) – label (float) – tStep (int) –

paintSphereIfInRange(self, worldPos: ORSModel.ors.Vector3, fRadius: float, label: float, tStep: int, fMinValue: float, fMaxValue: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid worldPos (ORSModel.ors.Vector3) – fRadius (float) – label (float) – tStep (int) – fMinValue (float) – fMaxValue (float) – pRangeChannel (ORSModel.ors.StructuredGrid) –

paintSquareOnPlane(self, pPlane: ORSModel.ors.Rectangle, worldPos: ORSModel.ors.Vector3, radius: float, label: float, timeIndex: int, worldPositionArray: ORSModel.ors.ArrayDouble) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pPlane (ORSModel.ors.Rectangle) – worldPos (ORSModel.ors.Vector3) – radius (float) – label (float) – timeIndex (int) – worldPositionArray (ORSModel.ors.ArrayDouble) –

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:

self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid
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) –

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:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid worldPositionArray (ORSModel.ors.ArrayDouble) – label (float) – timeIndex (int) –

paintVoxelsFromWorldCoordinatesIfInRange(self, worldPositionArray: ORSModel.ors.ArrayDouble, label: float, timeIndex: int, lowerThreshold: float, upperThreshold: float, pRangeChannel: ORSModel.ors.StructuredGrid) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid worldPositionArray (ORSModel.ors.ArrayDouble) – label (float) – timeIndex (int) – lowerThreshold (float) – upperThreshold (float) – pRangeChannel (ORSModel.ors.StructuredGrid) –

projectInto(self, aDestinationStructuredGrid: ORSModel.ors.StructuredGrid, IProgress: ORSModel.ors.Progress) → None¶

Copies the receiver into the destination, keeping the destination shape.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid aDestinationStructuredGrid (ORSModel.ors.StructuredGrid) – a destination StructuredGrid (a StructuredGrid) IProgress (ORSModel.ors.Progress) –

setBox(self, IInBox: ORSModel.ors.Box) → None¶

Sets the box.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid IInBox (ORSModel.ors.Box) – the box (an Box)

setCurrentShapeAsOriginal(self) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid

setOrigin(self, origin: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid origin (ORSModel.ors.Vector3) –

setTSize(self, pTSize: int) → None¶

Sets the T size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pTSize (int) – T size (an unsigned short)

Note

The T size is expressed in units.

setTSpacing(self, pTSpacing: float) → None¶

Sets the structured grid’s T spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pTSpacing (float) – T spacing (a double)

Note

Spacing is used for structured grid visual representation.

setXSize(self, pXSize: int) → None¶

Sets the X size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pXSize (int) – X size (an uint32_t)

Note

The size is expressed in pixels.

setXSpacing(self, pXSpacing: float) → None¶

Sets the structured grid’s X spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pXSpacing (float) – X spacing (a double)

Note

Spacing is used for structured grid visual representation.

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)

Note

The size is expressed in pixels.

setYSize(self, pYSize: int) → None¶

Sets the Y size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pYSize (int) – Y size (an uint32_t)

Note

The size is expressed in pixels.

setYSpacing(self, pYSpacing: float) → None¶

Sets the structured grid’s Y spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pYSpacing (float) – Y spacing (a double)

Note

Spacing is used for structured grid visual representation.

setZSize(self, pZSize: int) → None¶

Sets the Z size of the structured grid.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pZSize (int) – Z size (an uint32_t)

Note

The size is expressed in pixels.

setZSliceThickness(self, pZThickness: float) → None¶

Sets the structured grid’s Z slice thickness.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pZThickness (float) – Z slice thickness (a double)

Note

Slice thickness is used for structured grid visual representation.

setZSpacing(self, pZSpacing: float) → None¶

Sets the structured grid’s Z spacing.

Parameters:	self (ORSModel.ors.StructuredGrid) – an instance of StructuredGrid pZSpacing (float) – Z spacing (a double)

Note

Spacing is used for structured grid visual representation.

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) → TraceBackChannelAnalyzer¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer

TraceBackChannelAnalyzer.TraceBackChannelAnalyzer(self, rhs: ORSModel.ors.Unmanaged) -> TraceBackChannelAnalyzer

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer rhs (Unmanaged) –

findAllLeaves(self, aChannel: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI) → ROI¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer aChannel (ORSModel.ors.Channel) – inputROI (ORSModel.ors.ROI) –
Returns:	output (ORSModel.ors.ROI) –

forwardSelectionFromRoi(self, linputChannelTraceForward: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI) → None¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer linputChannelTraceForward (ORSModel.ors.Channel) – inputROI (ORSModel.ors.ROI) – outputROI (ORSModel.ors.ROI) –

forwardSelectionFromRoiToDistance(self, linputChannelTraceForward: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI, distance: int) → None¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer linputChannelTraceForward (ORSModel.ors.Channel) – inputROI (ORSModel.ors.ROI) – outputROI (ORSModel.ors.ROI) – distance (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

TraceBackChannelAnalyzer.TraceBackChannelAnalyzer() -> TraceBackChannelAnalyzer

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer

selectPointFurtherOrNearerThanMinDistance(self, linputChannelTraceBack: ORSModel.ors.Channel, indices: int, indicesSize: int, minDistance: int, outputROI: ORSModel.ors.ROI, further: bool) → None¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer linputChannelTraceBack (ORSModel.ors.Channel) – indices (int) – indicesSize (int) – minDistance (int) – outputROI (ORSModel.ors.ROI) – further (bool) –

traceBackTotraceForward(self, linputChannelTraceBack: ORSModel.ors.Channel, loutputChannelTraceForward: ORSModel.ors.Channel) → None¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer linputChannelTraceBack (ORSModel.ors.Channel) – loutputChannelTraceForward (ORSModel.ors.Channel) –

tracebackCPU(self, linputChannelTraceBack: ORSModel.ors.Channel, inputROI: ORSModel.ors.ROI, outputROI: ORSModel.ors.ROI, outputVoteChannel: ORSModel.ors.Channel, gatherAlgo: bool) → ROI¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer linputChannelTraceBack (ORSModel.ors.Channel) – inputROI (ORSModel.ors.ROI) – outputROI (ORSModel.ors.ROI) – outputVoteChannel (ORSModel.ors.Channel) – gatherAlgo (bool) –
Returns:	output (ORSModel.ors.ROI) –

tracebackPath(self, linputChannelTraceBack: ORSModel.ors.Channel, worldPosition: ORSModel.ors.Vector3, aPath: ORSModel.ors.VisualPath, pathWorldMatrix: ORSModel.ors.Matrix4x4, gatherAlgo: bool) → None¶

Parameters:	self (ORSModel.ors.TraceBackChannelAnalyzer) – an instance of TraceBackChannelAnalyzer linputChannelTraceBack (ORSModel.ors.Channel) – worldPosition (ORSModel.ors.Vector3) – aPath (ORSModel.ors.VisualPath) – pathWorldMatrix (ORSModel.ors.Matrix4x4) – gatherAlgo (bool) –

Unmanaged¶

class ORSModel.ors.Unmanaged¶

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.Unmanaged(self, rhs: ORSModel.ors.Unmanaged) -> Unmanaged

Parameters:	self (ORSModel.ors.Unmanaged) – an instance of Unmanaged rhs (Unmanaged) –

createObjectFromPythonRepresentation(aUnmanagedObjectInPythonRepresentation: str) → Unmanaged¶

Parameters:	aUnmanagedObjectInPythonRepresentation (str) –
Returns:	output (Unmanaged) –

classmethod getAllSubclasses(outputCollection=None)¶

classmethod getClassDenomination()¶

static getClassFromProgId(progId)¶

getClassName(self) → str¶

Parameters:	self (ORSModel.ors.Unmanaged) – an instance of Unmanaged
Returns:	output (str) –

getClassNameStatic() → str¶

Returns:	output (str) –

classmethod getIsSubclassOf(parentClass)¶

isNone(self) → bool¶

Parameters:	self (ORSModel.ors.Unmanaged) – an instance of Unmanaged
Returns:	output (bool) –

isNotNone(self) → bool¶

Parameters:	self (ORSModel.ors.Unmanaged) – an instance of Unmanaged
Returns:	output (bool) –

none()¶

Unmanaged.Unmanaged() -> Unmanaged

Parameters:	self (ORSModel.ors.Unmanaged) – an instance of Unmanaged

UnstructuredGrid¶

class ORSModel.ors.UnstructuredGrid(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → UnstructuredGrid¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

UnstructuredGrid.UnstructuredGrid(self, rhs: ORSModel.ors.Managed) -> UnstructuredGrid

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid rhs (Managed) –

getBoundingBox(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → Box¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – aWorldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Box) –

getCenterOfMass(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → Vector3¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – aWorldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Vector3) –

getClassNameStatic() → str¶

Returns:	output (str) –

getClipBox(timestep=0, display=None)¶

Gets the clip box of the channel

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – a view in which to test (a View) aWorldTransform (ORSModel.ors.Matrix4x4) – the point (an Vector3) pPoint (ORSModel.ors.Vector3) – true if coordinate is supplied in local coordinates, false if in world coordinates
Returns:	output (int) – a vertex index (a int32_t)

Note

Return value is -1 if an error occurs of if mesh is empty.

getCurrentVertexScalarValuesSlot(self) → int¶

gets the current vertex scalar.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
Returns:	output (int) – the scalar slot index (an uint32_t)

Note

The scalar index is zero-based, and thus should be less than getVertexScalarValuesSlotCount().

getHideOutOfRangeVertexScalarValues(self) → bool¶

Indicate if out of range values should be hiden.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
Returns:	output (bool) – (a bool)

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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – aWorldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Box) –

getMomentOfInertia(self, iTIndex: int, aWorldTransform: ORSModel.ors.Matrix4x4) → Matrix4x4¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – aWorldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getTSize(self) → int¶

Gets the number of time steps for the mesh.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
Returns:	output (int) – a number (an short)

getUseVertexScalarValues(self) → bool¶

Sets the mesh to have vertex scalar values or not.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
Returns:	output (bool) – true to use scalar values, false otherwise

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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – the time step (an unsigned short)
Returns:	output (int) – an uint64_t

getVertexDatatype(self) → int¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
Returns:	output (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)
Returns:	output (float) – the value of a vertex scalar (a float)

getVertexScalarValueDescription(self, scalarValueSlotIndex: int, iTIndex: int) → str¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (str) –

getVertexScalarValueMax(self, scalarValueSlotIndex: int, iTIndex: int) → float¶

method getVertexScalarValueMax

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (float) –

getVertexScalarValueMaxs(self, iTIndex: int) → ArrayDouble¶

method getVertexScalarValueMaxs

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

getVertexScalarValueMin(self, scalarValueSlotIndex: int, iTIndex: int) → float¶

method getVertexScalarValueMin

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (float) –

getVertexScalarValueMins(self, iTIndex: int) → ArrayDouble¶

method getVertexScalarValueMins

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

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)
Returns:	output (float) – the scalar offset value (a float)

getVertexScalarValueOffsets(self, iTIndex: int) → ArrayDouble¶

Get the vertex scalar offset values.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – the time step (an unsigned short)
Returns:	output (ORSModel.ors.ArrayDouble) – the scalar offset value (a float)

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)
Returns:	output (float) – the scalar slope value (a float)

getVertexScalarValueSlopes(self, iTIndex: int) → ArrayDouble¶

Get the vertex scalar slope values.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – the time step (an unsigned short)
Returns:	output (ORSModel.ors.ArrayDouble) – the scalar slope value (a float)

getVertexScalarValueUnit(self, scalarValueSlotIndex: int, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (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) –
Returns:	output (ORSModel.ors.Array) – an array of values (an ArrayFloat)

Note

The array of values is of length getVertexCount() * getVertexScalarValuesSlotCount().

Note

The scalar value in the slot s of the vertex v is located at the index (getVertexScalarValuesSlotCount() * v) + s of the array.

getVertexScalarValuesDatatype(self, iSlotIndex: int, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iSlotIndex (int) – iTIndex (int) –
Returns:	output (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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

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)
Returns:	output (float) – a double

getVertexScalarValuesSlotCount(self) → int¶

Gets the number of slots for vertex scalar values.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid
Returns:	output (int) – the number of slots (an uint32_t)

getVertexScalarValuesWindowMax(self, scalarValueSlotIndex: int, iTIndex: int) → float¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (float) –

getVertexScalarValuesWindowMaxs(self, iTIndex: int) → ArrayDouble¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

getVertexScalarValuesWindowMin(self, scalarValueSlotIndex: int, iTIndex: int) → float¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – iTIndex (int) –
Returns:	output (float) –

getVertexScalarValuesWindowMins(self, iTIndex: int) → ArrayDouble¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) –
Returns:	output (ORSModel.ors.ArrayDouble) –

getVertices(self, iTIndex: int) → Array¶

Gets the vertices.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid iTIndex (int) – the time step (an unsigned short)
Returns:	output (ORSModel.ors.Array) – an array of float (an ArrayFloat)

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.UnstructuredGrid() -> UnstructuredGrid

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of 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)

Note

Each vertice is offset by the given relative coordinates.

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)

Note

The scalar index is zero-based, and thus should be less than getVertexScalarValuesSlotCount().

setHideOutOfRangeVertexScalarValues(self, value: bool) → None¶

Indicate if out of range values should be hiden.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid value (bool) –

setTSize(self, tSize: int) → None¶

Sets the number of time steps for the mesh.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid tSize (int) – a number (an unsigned short)

setUseVertexScalarValues(self, value: bool) → None¶

Gets the status of vertex scalar values usage.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid value (bool) –

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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid nVertexDatatype (int) –

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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – value (str) – iTIndex (int) –

setVertexScalarValueMax(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None¶

method setVertexScalarValueMax

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – value (float) – iTIndex (int) –

setVertexScalarValueMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None¶

method setVertexScalarValueMaxs

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

setVertexScalarValueMin(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None¶

method setVertexScalarValueMin

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – value (float) – iTIndex (int) –

setVertexScalarValueMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None¶

method setVertexScalarValueMins

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pScalarValues (ORSModel.ors.ArrayDouble) – scalar offset value (a float) iTIndex (int) – time step (an unsigned short)

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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pScalarValues (ORSModel.ors.ArrayDouble) – scalar slope value (a float) iTIndex (int) – time step (an unsigned short)

setVertexScalarValueUnit(self, scalarValueSlotIndex: int, value: int, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – value (int) – iTIndex (int) –

setVertexScalarValues(self, pScalarValues: ORSModel.ors.Array, iSlotIndex: int, iTIndex: int) → None¶

Sets the values of a vertex scalar.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pScalarValues (ORSModel.ors.Array) – an array of values (an ArrayFloat) iSlotIndex (int) – the the time step (an unsigned short) iTIndex (int) –

Note

The array of values is of length getVertexCount() * getVertexScalarValuesSlotCount().

Note

The scalar value in the slot s of the vertex v is located at the index (getVertexScalarValuesSlotCount() * v) + s of the array.

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:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid value (int) – the number of slots (an uint32_t)

setVertexScalarValuesWindowMax(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – value (float) – iTIndex (int) –

setVertexScalarValuesWindowMaxs(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

setVertexScalarValuesWindowMin(self, scalarValueSlotIndex: int, value: float, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid scalarValueSlotIndex (int) – value (float) – iTIndex (int) –

setVertexScalarValuesWindowMins(self, pScalarValues: ORSModel.ors.ArrayDouble, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pScalarValues (ORSModel.ors.ArrayDouble) – iTIndex (int) –

setVertices(self, pVertices: ORSModel.ors.Array, iTIndex: int) → None¶

Sets the vertices.

Parameters:	self (ORSModel.ors.UnstructuredGrid) – an instance of UnstructuredGrid pVertices (ORSModel.ors.Array) – the vertices(an ArrayFloat) iTIndex (int) – the time step (an unsigned short)

Vector3¶

class ORSModel.ors.Vector3¶

brief_description: A wrapper to a 3D vector. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

Vector3.Vector3(self) -> Vector3

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3

Vector3.Vector3(self, rhs: ORSModel.ors.Unmanaged) -> Vector3

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 rhs (Unmanaged) –

Vector3.Vector3(self, x: float, y: float, z: float) -> Vector3

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 x (float) – y (float) – z (float) –

Vector3.Vector3(self, x: float, y: float) -> Vector3

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 x (float) – y (float) –

add(self, aVector: ORSModel.ors.Vector3) → None¶

Adds a vector to the receiver.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 aVector (ORSModel.ors.Vector3) – a vector (an Vector3)

copy(self) → Vector3¶

Returns a new vector identical to the receiver (a copy).

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (ORSModel.ors.Vector3) –

createVector3FromPythonRepresentation(self, aPythonRepresentation: str) → None¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 aPythonRepresentation (str) –

getAPerpendicular(self) → Vector3¶

Computes a perpendicular from the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (ORSModel.ors.Vector3) – a perpendicular vector (an Vector3)

getAdditionWith(self, aVector: ORSModel.ors.Vector3) → Vector3¶

Gets the result of adding a vector to the receiver.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 aVector (ORSModel.ors.Vector3) – a vector (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the resulting vector (an Vector3)

Note

The receiver is not modified.

getAngleWith(self, pVect: ORSModel.ors.Vector3) → float¶

Computes the angle with another vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 pVect (ORSModel.ors.Vector3) – a vector (an Vector3)
Returns:	output (float) – the angle (a double)

getClassNameStatic() → str¶

Returns:	output (str) –

getCrossProductWith(self, pVect: ORSModel.ors.Vector3) → Vector3¶

Computes the cross product with another vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 pVect (ORSModel.ors.Vector3) – a vector (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the cross product (a double)

getDistanceFrom(self, pVect: ORSModel.ors.Vector3) → float¶

Computes the distance to another vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 pVect (ORSModel.ors.Vector3) – another vector (an Vector3)
Returns:	output (float) – the distance (a double)

getDotProductWith(self, pVect: ORSModel.ors.Vector3) → float¶

Computes the dot product with another vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 pVect (ORSModel.ors.Vector3) – a vector (an Vector3)
Returns:	output (float) – the dot product (a double)

getIsEqualTo(self, aVector: ORSModel.ors.Vector3) → bool¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 aVector (ORSModel.ors.Vector3) –
Returns:	output (bool) –

getLargestComponent(self) → float¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) – the biggest component of the vector

getLength(self) → float¶

Gets the vector’s length.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) – the length (a double)

getLinearInterpolationWith(self, point1: ORSModel.ors.Vector3, normalizePosition: float) → Vector3¶

Computes the lerp with another vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 point1 (ORSModel.ors.Vector3) – a vector (an Vector3) normalizePosition (float) – a interpolation factor [0,1](a double)
Returns:	output (ORSModel.ors.Vector3) – the lerp vector (an Vector3)

getNegated(self) → Vector3¶

Gets the receiver negated in a new vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (ORSModel.ors.Vector3) – the resulting vector (an Vector3)

Note

The receiver is not modified.

getNormalized(self) → Vector3¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (ORSModel.ors.Vector3) –

getPhi(self) → float¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) –

getPythonRepresentation(self) → str¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (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:	self (ORSModel.ors.Vector3) – an instance of Vector3 anAxis (ORSModel.ors.Vector3) – an axis vector (an Vector3) centerOfRotation (ORSModel.ors.Vector3) – an centerOfRotation vector (an Vector3) angleInRadian (float) – an angle in radian (a double)
Returns:	output (ORSModel.ors.Vector3) – the product of the rotation (an Vector3)

getScaledBy(self, scaleFactor: float) → Vector3¶

Gets the result of sacling a vector to the receiver.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 scaleFactor (float) – a scale a double
Returns:	output (ORSModel.ors.Vector3) – the resulting vector (an Vector3)

Note

The receiver is not modified.

getSmallestComponent(self) → float¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) – the smallest component of the vector

getSubtractionFrom(self, aVector: ORSModel.ors.Vector3) → Vector3¶

Gets the result of subtracting a vector from the receiver.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 aVector (ORSModel.ors.Vector3) – a vector (an Vector3)
Returns:	output (ORSModel.ors.Vector3) – the resulting vector (an Vector3)

Note

The receiver is not modified.

getTheta(self) → float¶

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) –

getX(self) → float¶

Gets the X value from the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) – a double

getY(self) → float¶

Gets the Y value from the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) – a double

getZ(self) → float¶

Gets the Z value from the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3
Returns:	output (float) – a double

is_(another)¶

is_not(another)¶

negate(self) → None¶

Negates the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3

none()¶

Vector3.Vector3() -> Vector3

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3

normalize(self) → None¶

Normalizes the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3

Note

A normalized vector has norm (length) 1.

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:	self (ORSModel.ors.Vector3) – an instance of Vector3 value (float) – a double value

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)

Note

W is set to zero

setY(self, value: float) → None¶

Sets the Y value of the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 value (float) – a double value

setZ(self, value: float) → None¶

Sets the Z value of the vector.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 value (float) – a double value

subtract(self, aVector: ORSModel.ors.Vector3) → None¶

Subtracts a vector from the receiver.

Parameters:	self (ORSModel.ors.Vector3) – an instance of Vector3 aVector (ORSModel.ors.Vector3) – a vector (an Vector3)

VectorField¶

class ORSModel.ors.VectorField(self) → VectorField¶

Bases: ORSModel.ors.UnstructuredGrid

Parameters:	self (ORSModel.ors.VectorField) – an instance of VectorField

VectorField.VectorField(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VectorField

Parameters:	self (ORSModel.ors.VectorField) – an instance of VectorField buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VectorField.VectorField(self, rhs: ORSModel.ors.Managed) -> VectorField

Parameters:	self (ORSModel.ors.VectorField) – an instance of VectorField rhs (Managed) –

copyInto(self, aDestinationUnstructuredGrid: ORSModel.ors.Node) → None¶

Copies the receiver unstructured grid into another unstructured grid.

Parameters:	self (ORSModel.ors.VectorField) – an instance of VectorField aDestinationUnstructuredGrid (ORSModel.ors.Node) – a destination unstructured grid

getClassNameStatic() → str¶

Returns:	output (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:	self (ORSModel.ors.VectorField) – an instance of VectorField iTIndex (int) – the time step (an unsigned short)
Returns:	output (ORSModel.ors.ArrayDouble) – an array of double (an ArrayDouble)

none() → VectorField¶

Returns:	output (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:	self (ORSModel.ors.VectorField) – an instance of VectorField pVectors (ORSModel.ors.ArrayDouble) – the vectors(an ArrayDouble) iTIndex (int) – the time step (an unsigned short)

View¶

class ORSModel.ors.View¶

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.View(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> View

Parameters:	self (ORSModel.ors.View) – an instance of View buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

View.View(self) -> View

Parameters:	self (ORSModel.ors.View) – an instance of View

View.View(self, rhs: ORSModel.ors.Managed) -> View

Parameters:	self (ORSModel.ors.View) – an instance of View rhs (Managed) –

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

Note

When looking at 4D data (3D plus a time dimension), one can cycle through the time dimension in this fashion.

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)
Returns:	output (ORSModel.ors.Image) – an image (an Image)

Note

This method saves a snapshot sized to specifications. The resulting image is always full resolution, no matter what size is given.

Note

If an output image is support, the resulting snapshot is written to that output image. That same output image will be the return value.

fitBoundedPlaneInView(self, IBoundedPlane: ORSModel.ors.Rectangle) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View IBoundedPlane (ORSModel.ors.Rectangle) –

fitBoundedPlaneInViewLogged(rectangle, logging=True)¶

fitBoxInView(self, aBox: ORSModel.ors.Box) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) –

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
Returns:	output (ORSModel.ors.Color) – a color (an Color)

get3DBackgroundColor1(self) → Color¶

Gets the view’s 3D first background color.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Color) – a color (an Color)

get3DBackgroundColor2(self) → Color¶

Gets the view’s 3D first background color.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Color) – a color (a Color)

get3DBackgroundColorMode(self) → int¶

Gets the view’s 3D background color mode.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – color mode (a short, see note below)

Note

The color mode has 3 different meanings: -2 says the color is uniform (i.e. the second color is ignored), -1 says the color is gradient radial (the two colors are used), any value between 0 and 359 says the color is gradient linear (the two colors are used), and that value indicates the angle of the gradient.

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)
Returns:	output (ORSModel.ors.List) – a list of all child nodes that are visible (an List)

Note

The list contains only Managed objects (they will need to be typecast to the appropriate class).

getAmbientLightColor(self) → Color¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Color) –

getAngleDimensionUnit(self) → DimensionUnit¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.DimensionUnit) –

getAutoFocus(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getBorderColor(self) → Color¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Color) –

getBorderWidth(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getBoundedPlaneOfFirstSliceOfBox(self, aBox: ORSModel.ors.Box) → Rectangle¶

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) –
Returns:	output (ORSModel.ors.Rectangle) –

getBoundedPlaneOfLastSliceOfBox(self, aBox: ORSModel.ors.Box) → Rectangle¶

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) –
Returns:	output (ORSModel.ors.Rectangle) –

getBoundedPlaneOfSliceOfBox(self, aBox: ORSModel.ors.Box, sliceIndex: int) → Rectangle¶

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) – sliceIndex (int) –
Returns:	output (ORSModel.ors.Rectangle) –

getBoxAbleToContainAllEnabledVisualReachableByRender(self, inbox: ORSModel.ors.Box) → Box¶

Parameters:	self (ORSModel.ors.View) – an instance of View inbox (ORSModel.ors.Box) –
Returns:	output (ORSModel.ors.Box) –

getCamera(self) → Camera¶

Gets the picked Overlay in a view.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Camera) – the GUID of the overlay if successful, should be a VisualOVerlay but this idl doesn’t allow it

getCameraSpaceLightPos(self) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Vector3) –

getCineMode(self) → int¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getContext()¶

getCurrentTimeStep(self) → int¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) –

getDiffuseFactor(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getDiffuseLightColor(self) → Color¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Color) –

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)
Returns:	output (ORSModel.ors.DimensionUnit) – the current dimension unit (DimensionUnit)

Note

See the ORS_def.h file for enum CxvUniverse_Dimension_type values.

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)
Returns:	output (int) – the current CxvUniverse_Dimension unit (a int32_t)

Note

To obtain the object, call DimensionUnit::getUnitFor().

Note

See the ORS_def.h file for enum CxvUniverse_Dimension and CxvUniverse_Dimension_type values.

getDisplayedAxis(self, aBox: ORSModel.ors.Box) → int¶

Gets the axis direction of the view.

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) –
Returns:	output (int) – the axis (a char)

Note

The axis value is 0 for Sagittal, 1 for Coronal or 2 for Axial.

getDrawFocusRect(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getEnableFocus(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (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
Returns:	output (int) – the number of pixels (a int32_t)

getFocalDistance(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getFocusSigma(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getHWND(self) → int¶

Gets the view handle.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – the handle of the window (a ORS_COM_ARG)

getImageNumberingAscending(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIntersliceDistance(self, box: ORSModel.ors.Box) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View box (ORSModel.ors.Box) –
Returns:	output (float) –

getIsBorderEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsChildReachableByRenderer(self, INode: ORSModel.ors.Node) → bool¶

Verifies if a child node is renderable.

Parameters:	self (ORSModel.ors.View) – an instance of View INode (ORSModel.ors.Node) – a node in the child hierarchy of the view (a Node)
Returns:	output (bool) – true if the node is renderable, false otherwise

getIsEnabled(self) → bool¶

Queries the view to know if it is enabled.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) – true if the view is enabled, false otherwise

Note

Disabled views are “inert”, they react to very few events and display nothing.

getIsFrozen(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsIn2DViewMode(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsIn3DViewMode(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsInAcquisitionPlaneOf(self, aChannel: ORSModel.ors.Channel) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View aChannel (ORSModel.ors.Channel) –
Returns:	output (bool) –

getIsInNoViewMode(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsInThinMIPViewMode(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsOrientationAndPositionLocked(self) → bool¶

Gets the view’s position and orientation lock status.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) – true if the view position and orientation is locked, false otherwise

Note

When a view position is locked, one cannot set its oblique info.

getIsOrientationLocked(self) → bool¶

Gets the view’s orientation lock status.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) – true if the view orientation is locked, false otherwise

Note

When a view orientation is locked, one cannot set its oblique info.

getIsOrthoProjection(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsPositionLocked(self) → bool¶

Gets the view’s position lock status.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) – true if the view position is locked, false otherwise

Note

When a view position is locked, one cannot set its oblique info.

getIsRenderingTiled(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsShadowEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getIsTrackingLight(self) → bool¶

Queries if the view is in tracking light mode or not.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) – true if the view is in tracking light mode, false otherwise

getLODEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getLODMode(self) → int¶

Gets the view LOD mode.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – an LOD mode (a int32_t)

Note

LOD stands for Level Of Detail. It defines how much detail is displayed when moving the visual artifacts in the view. The lower the level, the faster the visual will move.

Note

See the ORS_def.h file, it contains defines (in the form CXV_DISPLAY_LOD_XXX) for valid values.

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)
Returns:	output (float) – the number of pixels that match the length (a double)

getLengthDimensionUnit(self) → DimensionUnit¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.DimensionUnit) –

getLightFollowCamera(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getLightMaxDistance(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getLightPosition(self) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Vector3) –

getLocalPositionArrayTransformedToXY(self, pVisual: ORSModel.ors.Visual, pLocalPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pTimeStep: int, pOutputXYPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection¶

Parameters:	self (ORSModel.ors.View) – an instance of View pVisual (ORSModel.ors.Visual) – pLocalPositions (ORSModel.ors.SequenceableCollection) – nPtsCount (int) – pTimeStep (int) – pOutputXYPositions (ORSModel.ors.SequenceableCollection) –
Returns:	output (ORSModel.ors.SequenceableCollection) –

getLocalPositionFromVisualLocalPosition(self, pVisual: ORSModel.ors.Visual, anotherVisual: ORSModel.ors.Visual, pAlocalPositionInAnotherVisual: ORSModel.ors.Vector3, pTimeStep: int) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View pVisual (ORSModel.ors.Visual) – anotherVisual (ORSModel.ors.Visual) – pAlocalPositionInAnotherVisual (ORSModel.ors.Vector3) – pTimeStep (int) –
Returns:	output (ORSModel.ors.Vector3) –

getLocalPositionFromWorldPosition(self, pVisual: ORSModel.ors.Visual, pWorldPosition: ORSModel.ors.Vector3, pTimeStep: int) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View pVisual (ORSModel.ors.Visual) – pWorldPosition (ORSModel.ors.Vector3) – pTimeStep (int) –
Returns:	output (ORSModel.ors.Vector3) –

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:	self (ORSModel.ors.View) – an instance of View IVisual (ORSModel.ors.Visual) – the visual (an Visual) pCoord (ORSModel.ors.Vector3) – a coordinate (an Vector3) oY (float) –
Returns:	output (bool) – true if the local Z coordinate is currently visible, false otherwise pTimeStep (int) – the X 2D coordinate (a double) oX (float) – the Y 2D coordinate (a double)

Note

The values are returned in the last two parameters supplied.

getMaxTimeStep(self) → int¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) –

getMillisecondsElapsedSinceLastDraw(self) → int¶

Returns the time elapsed since the last draw, in milliseconds.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – the elapsed time, in milliseconds (an int)

getNeedRefresh(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getNextSliceDirectionOfBox(self, aBox: ORSModel.ors.Box) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) –
Returns:	output (ORSModel.ors.Vector3) –

getOrthoZoomFactor(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (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) –
Returns:	output (ORSModel.ors.Intersection) – an intersection (an Intersection)

Note

Returns an intersection describing what is currently under the mouse cursor in the view.

getPickVisualData(self, aIVisual: ORSModel.ors.Visual, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → Intersection¶

Gets the pick region from a visual in the view.

Parameters:	self (ORSModel.ors.View) – an instance of View aIVisual (ORSModel.ors.Visual) – a visual (an Visual) pixelXPositionInDisplay (int) – pixelYPositionInDisplay (int) –
Returns:	output (ORSModel.ors.Intersection) – an intersection (an Intersection)

Note

Returns an intersection describing what is currently being picked in the visual supplied. If the given visual is not being picked, getHit() on the intersection will return FALSE.

getProjectionMatrix(self) → Matrix4x4¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Matrix4x4) –

getProjectionMode2D(self) → int¶

Gets the 2D projection mode of the view.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – the current 2D projection mode (an int)

Note

See CxvVolumeProjection_Mode in ORS_def.h for supported volume projection modes.

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
Returns:	output (int) – an char (an OrsRenderMode, see ors_def.h)

getRestTime(self) → int¶

Gets the rendering idle time.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – a number of milliseconds (a LONG)

Note

The rendering idle time is the period of time between cycles. Increasing this value makes the renderer less responsive.

Note

Default value is 22 ms.

getScreenLengthTransformedToWorldLength(self, inLength: float) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View inLength (float) –
Returns:	output (float) –

getShadowMapSize(self) → int¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) –

getShadowOpacity(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getShadowPrecision(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getShadowStrength(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getShininess(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getShowOrientationIndicators(self) → bool¶

Gets the visibility of the orientation indicators.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) – true if the orientation indicators are visible, false otherwise

getShowViewFPS(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) –

getSlabThickness(self) → float¶

Gets the view’s slab thickness.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) – the slab thickness, in microns (a double)

Note

Note that this value represents the half slab thickness, in microns.

getSliceCountOfBox(self, aBox: ORSModel.ors.Box) → int¶

Gets the number of slices of a given box.

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) – the visual box (an Box)
Returns:	output (int) – the number of slices in the box, in the current camera direction

getSliceIndexOfBox(self, aBox: ORSModel.ors.Box) → float¶

Gets the current slice position of a given box.

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) – the visual box (an Box)
Returns:	output (float) – the current slice position in the box

getSpecularFactor(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getSpecularLightColor(self) → Color¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Color) –

getSpotlightFactor(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getSurfaceDimensionUnit(self) → DimensionUnit¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.DimensionUnit) –

getUseSuperSampling(self) → bool¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (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)
Returns:	output (float) – the value converted to meters (a double)

Note

This method is the reverse of getValueInMeterConvertedToCurrentUnit().

Note

The value to be converted is assumed to be expressed in the view’s current dimension unit. For example, if the view’s current unit is cm, getValueInCurrentUnitConvertedToMeter(1.0) will return 0.01 (1 meter -> 100 cm).

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)
Returns:	output (float) – the value converted (a double)

Note

The value to be converted is always assumed to be expressed in meters, the reference internal unit. For example, if the view’s current unit is cm, getValueInMeterConvertedToCurrentUnit(1.0) will return 100 (1 meter -> 100 cm).

Note

This method is the reverse of getValueInCurrentUnitConvertedToMeter().

getViewActualWidth(self) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) –

getViewAlignedBoxThatContainsAllEnabledVisualsReachableByRenderer(self) → Box¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Box) –

getViewBoundedPlaneInWorldCoordinates(self) → Rectangle¶

Returns a plane bounded to the view, in world coordinates.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Rectangle) – a plane (an Rectangle)

getViewCenter(self) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Vector3) –

getViewMatrix(self) → Matrix4x4¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Matrix4x4) –

getViewMode(self) → int¶

Gets the view’s volume mode.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – a CxvView_Mode (a int32_t)

Note

See the ORS_def.h file for valid values.

getViewNormal(self) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Vector3) –

getViewOrientedBoxThatContainsBox(self, aBox: ORSModel.ors.Box) → Box¶

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) –
Returns:	output (ORSModel.ors.Box) –

getViewOrientedPlane(self) → OrientedPlane¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.OrientedPlane) –

getViewPlane(self) → Plane¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Plane) –

getViewRepresentationColor(self) → Color¶

Gets the view’s representation color.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.Color) – a color (a Color)

Note

This call is used to query the color that represents the view.

getVolumeDimensionUnit(self) → DimensionUnit¶

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (ORSModel.ors.DimensionUnit) –

getWorldLengthTransformedToScreenLength(self, inLength: float) → float¶

Parameters:	self (ORSModel.ors.View) – an instance of View inLength (float) –
Returns:	output (float) –

getWorldPositionArrayTransformedToXY(self, pWorldPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pOutputXYPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection¶

Parameters:	self (ORSModel.ors.View) – an instance of View pWorldPositions (ORSModel.ors.SequenceableCollection) – nPtsCount (int) – pOutputXYPositions (ORSModel.ors.SequenceableCollection) –
Returns:	output (ORSModel.ors.SequenceableCollection) –

getWorldPositionFromLocalPosition(self, pVisual: ORSModel.ors.Visual, pLocalPosition: ORSModel.ors.Vector3, pTimeStep: int) → Vector3¶

Parameters:	self (ORSModel.ors.View) – an instance of View pVisual (ORSModel.ors.Visual) – pLocalPosition (ORSModel.ors.Vector3) – pTimeStep (int) –
Returns:	output (ORSModel.ors.Vector3) –

getWorldPositionTransformedToXY(self, pPosition: ORSModel.ors.Vector3, oX: float, oY: float) → bool¶

Transforms a world coordinate in 2D coordinates.

Parameters:	self (ORSModel.ors.View) – an instance of View pPosition (ORSModel.ors.Vector3) – a position (an Vector3)
Returns:	output (bool) – true if the world Z coordinate is currently visible, false otherwise oX (float) – the X 2D coordinate (a double) oY (float) – the Y 2D coordinate (a double)

Note

The values are returned in the last two parameters supplied.

getXSize(self) → int¶

Gets the view X size.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – the X size, in pixels (an short)

getXYArrayTransformedToLocalPosition(self, pVisual: ORSModel.ors.Visual, pXYPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pTimeStep: int, pOutputLocalPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection¶

Parameters:	self (ORSModel.ors.View) – an instance of View pVisual (ORSModel.ors.Visual) – pXYPositions (ORSModel.ors.SequenceableCollection) – nPtsCount (int) – pTimeStep (int) – pOutputLocalPositions (ORSModel.ors.SequenceableCollection) –
Returns:	output (ORSModel.ors.SequenceableCollection) –

getXYArrayTransformedToWorldPosition(self, pXYPositions: ORSModel.ors.SequenceableCollection, nPtsCount: int, pOutputWorldPositions: ORSModel.ors.SequenceableCollection) → SequenceableCollection¶

Parameters:	self (ORSModel.ors.View) – an instance of View pXYPositions (ORSModel.ors.SequenceableCollection) – nPtsCount (int) – pOutputWorldPositions (ORSModel.ors.SequenceableCollection) –
Returns:	output (ORSModel.ors.SequenceableCollection) –

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)
Returns:	output (ORSModel.ors.Vector3) – a position in world coordinate(an Vector3)

Note

The world coordinate is projected on the current view bounded plane.

getYSize(self) → int¶

Gets the view Y size.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (int) – the Y size, in pixels (an short)

getZoomAtCursorPosition(self) → bool¶

Gets the zoom reaction value.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (bool) – true if zoom is centered to the mouse cursor, or false if centered on view

getZoomFactor(self) → float¶

Gets the current zoom factor.

Parameters:	self (ORSModel.ors.View) – an instance of View
Returns:	output (float) – zoom factor (a double)

imshow(structuredGrid, lut=None)¶

incrementTimeStep(self) → None¶

Increments the view’s time step counter.

Parameters:	self (ORSModel.ors.View) – an instance of View

Note

When looking at 4D data (3D plus a time dimension), one can cycle through the time dimension in this fashion.

none()¶

View.View() -> View

Parameters:	self (ORSModel.ors.View) – an instance of 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:	self (ORSModel.ors.View) – an instance of View IColor (ORSModel.ors.Color) – a color (an Color)

Note

The color should be expressed as RGB (the alpha is not used here).

set3DBackgroundColor(self, iMode: int, IColor1: ORSModel.ors.Color, IColor2: ORSModel.ors.Color) → None¶

Sets the view’s 3D background color.

Parameters:	self (ORSModel.ors.View) – an instance of View iMode (int) – a mode (a short) IColor1 (ORSModel.ors.Color) – a color (an Color) IColor2 (ORSModel.ors.Color) – a color (an Color)

Note

The colors should be expressed as RGB (the alpha is not used here).

setAmbientLightColor(self, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View IColor (ORSModel.ors.Color) –

setAutoFocus(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (bool) –

setBorderColor(self, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View IColor (ORSModel.ors.Color) –

setBorderWidth(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setCamera(self, aCamera: ORSModel.ors.Camera) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aCamera (ORSModel.ors.Camera) –

setCameraLogged(camera, logging=True)¶

setCameraSpaceLightPos(self, pPosition: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View pPosition (ORSModel.ors.Vector3) –

setCaptionTextFontName(self, sFontName: str) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View sFontName (str) –

setCineMode(self, mode: int) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View mode (int) –

setCurrentTimeStep(self, value: int) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (int) –

setDiffuseFactor(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setDiffuseLightColor(self, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View IColor (ORSModel.ors.Color) –

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*)

Note

See the ORS_def.h file for enum CxvUniverse_Dimension and CxvUniverse_Dimension_type values.

setDrawFocusRect(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (bool) –

setEnableFocus(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (bool) –

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:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setFocusSigma(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setImageNumberingAscending(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (bool) –

setIsBorderEnabled(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (bool) –

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

Note

Disabled views are “inert”, they react to very few events and display nothing.

setIsFrozen(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (bool) –

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

Note

When a view position is locked, one cannot set its oblique info.

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

Note

When a view orientation is locked, one cannot set its oblique info.

setIsOrthoProjection(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (bool) –

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

Note

When a view position is locked, one cannot set its oblique info.

setIsShadowEnabled(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (bool) –

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:	self (ORSModel.ors.View) – an instance of View aValue (bool) –

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*)

Note

LOD stands for Level Of Detail. It defines how much detail is displayed when moving the visual artifacts in the view. The lower the level, the faster the visual will move.

Note

See the ORS_def.h file, it contains defines (in the form CXV_DISPLAY_LOD_XXX) for valid values.

setLightFollowCamera(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (bool) –

setLightMaxDistance(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setLightPosition(self, aLightPosition: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aLightPosition (ORSModel.ors.Vector3) –

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:	self (ORSModel.ors.View) – an instance of View anOrientedPlane (ORSModel.ors.OrientedPlane) – aBox (ORSModel.ors.Box) –

setOrientedPlaneWithBoxLogged(orientedPlane, box, logging=True)¶

setOrthoZoomFactor(self, value: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (float) –

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)

Note

See CxvVolumeProjection_Mode in ORS_def.h for supported volume projection modes.

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:	self (ORSModel.ors.View) – an instance of View value (int) –

setShadowMapSize(self, value: int) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (int) –

setShadowOpacity(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setShadowPrecision(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setShadowStrength(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setShininess(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

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:	self (ORSModel.ors.View) – an instance of View bShow (bool) –

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)

Note

Note that this value should represent the half slab thickness, in microns.

setSlabThicknessLogged(thickness, logging=True)¶

setSliceIndexOfBox(self, aBox: ORSModel.ors.Box, sliceIndex: float) → None¶

Sets the current slice position for a given box.

Parameters:	self (ORSModel.ors.View) – an instance of View aBox (ORSModel.ors.Box) – the visual box (an Box) sliceIndex (float) – the slice position in the box to set

setSliceIndexOfBoxLogged(box, sliceIndex, logging=True)¶

setSpecularFactor(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setSpecularLightColor(self, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View IColor (ORSModel.ors.Color) –

setSpotlightFactor(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (float) –

setUseSuperSampling(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View aValue (bool) –

setViewActualWidth(self, value: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (float) –

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*)

Note

See the ORS_def.h file for valid values.

setViewModeLogged(viewMode, logging=True)¶

setViewOrientedPlane(self, anOrientedPlane: ORSModel.ors.OrientedPlane, aSlabThickness: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View anOrientedPlane (ORSModel.ors.OrientedPlane) – aSlabThickness (float) –

setViewOrientedPlaneLogged(orientedPlane, thickness, logging=True)¶

setViewPlanePosition(self, worldPosition: ORSModel.ors.Vector3, centerView: bool) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View worldPosition (ORSModel.ors.Vector3) – centerView (bool) –

setViewPlanePositionLogged(point, center, logging=True)¶

setViewRepresentationColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the view’s representation color.

Parameters:	self (ORSModel.ors.View) – an instance of View IColor (ORSModel.ors.Color) – a color (an Color)

Note

This call is used to specify the color that represents the view

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:	self (ORSModel.ors.View) – an instance of View value (bool) – true or false

Note

The zoom either takes its center from the cursor position or from the center of the view.

setZoomFactor(self, value: float) → None¶

Parameters:	self (ORSModel.ors.View) – an instance of View value (float) –

Visual¶

class ORSModel.ors.Visual¶

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.Visual(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> Visual

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

Visual.Visual(self) -> Visual

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual

Visual.Visual(self, rhs: ORSModel.ors.Managed) -> Visual

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual rhs (Managed) –

getAction(self) → str¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (str) –

getAllParentViewsWhereVisualIsVisible(self) → List¶

Gets a list of views where the visual appears.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (ORSModel.ors.List) – a list of views (an List)

getAssociatedState(self) → str¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (str) –

getBoundingBox(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Box¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Box) –

getBoundingBoxInView(self, aView: ORSModel.ors.View) → Box¶

Gets the bounding box of the visual in the orientation of the view.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual aView (ORSModel.ors.View) – the view (a View)
Returns:	output (ORSModel.ors.Box) – the bounding box (a Box) or NULL if no view is provided

getClassNameStatic() → str¶

Returns:	output (str) –

getClipBox(timestep=0, display=None)¶

Gets the clip box of the visual

Parameters:	timestep (int) – the time index display (ORSModel.ors.View) – a view
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:	self (ORSModel.ors.Visual) – an instance of Visual anINode (ORSModel.ors.Node) – the target node (an Node)
Returns:	output (ORSModel.ors.ReferenceFrame) – a frame (an ReferenceFrame) or NULL if no frame is found

getFrameTransformationFromNode(self, towardNode: ORSModel.ors.Node, pTimeStep: int) → Matrix4x4¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual towardNode (ORSModel.ors.Node) – pTimeStep (int) –
Returns:	output (ORSModel.ors.Matrix4x4) –

getHighlightColor(self) → Color¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (ORSModel.ors.Color) –

getIsHighlightable(self) → bool¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) –

getIsHighlightedInView(self, aView: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual aView (ORSModel.ors.View) –
Returns:	output (bool) –

getIsPickable(self) → bool¶

Gets the visual’s pickable state.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) – true if the visual is pickable, false otherwise

getIsSelected(self) → bool¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) –

getIsShadowEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) –

getIsVisibleForAllViews(self) → bool¶

Gets the visibility of the receiver in all views.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) – true if the receiver is visible is all views, false otherwise

getIsVisibleForView(self, IView: ORSModel.ors.View) → bool¶

Gets the visibility of the receiver in a given view.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual IView (ORSModel.ors.View) – the view (a View)
Returns:	output (bool) – true if the receiver is visible, false otherwise

getMaterial(self) → Material¶

Gets the visual’s material.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (ORSModel.ors.Material) – a material (an Material) or NULL is none exists

getPickTolerance(self) → float¶

Gets the pick tolerance.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (float) – a number of pixels (a double between 0 and 1)

Note

The pick tolerance is the radius, around any visual portion, where the mouse cursor can grab the visual. It’s expressed in pixels.

getShowIn2D(self) → bool¶

Gets the visual visibility mode in 2D views.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) – true if the visual is visible in 2D views, false otherwise

getShowIn3D(self) → bool¶

Gets the visual visibility mode in 2D views.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) – true if the visual is visible in 2D views, false otherwise

getTSize(self) → int¶

Gets the T size.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (int) – T size (an short)

getZEnabled(self) → bool¶

Gets the visual’s Z buffer state.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) – true if Z buffer is enabled, false otherwise

Note

Default value is true.

Note

Z buffering means that the renderer records pixel depth to hide geometry that is behind other geometry. When Z buffer is disabled, the visual is displayed above all geometry ALREADY RENDERED (this statement is important), even if it should not.

initializeVisual(self) → bool¶

Initializes the visual.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual
Returns:	output (bool) –

none()¶

Visual.Visual() -> Visual

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual

resetVisibility(self) → None¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual

setAction(self, anAction: str) → None¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual anAction (str) –

setAssociatedState(self, aGlobalState: str) → None¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual aGlobalState (str) –

setHighlightColor(self, color: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual color (ORSModel.ors.Color) –

setIsHighlightable(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual value (bool) –

setIsHighlightedInView(self, aView: ORSModel.ors.View, aFlag: bool) → None¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual aView (ORSModel.ors.View) – aFlag (bool) –

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:	self (ORSModel.ors.Visual) – an instance of Visual aBool (bool) –

setIsShadowEnabled(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual value (bool) –

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

Note

This API overrides all prior calls to setIsVisibleForViews(), or in other words, any view specific setting is erased.

setIsVisibleForView(self, IView: ORSModel.ors.View, bValue: bool) → None¶

Sets the visibility of the receiver in a given view.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual IView (ORSModel.ors.View) – the view (n View) bValue (bool) – true to make the receiver visible, false to hide it

Note

This API overrides a prior call to setIsVisibleForAllViews(), for a given view.

setIsVisibleForViewLogged(view, flag, logging=True)¶

setMaterial(self, aIMaterial: ORSModel.ors.Material) → None¶

Sets the visual’s material.

Parameters:	self (ORSModel.ors.Visual) – an instance of Visual aIMaterial (ORSModel.ors.Material) – a material (an Material)

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)

Note

The pick tolerance is the radius, around any visual portion, where the mouse cursor can grab the visual. It’s expressed in pixels.

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

Note

Default value is true.

Note

Z buffering means that the renderer records pixel depth to hide geometry that is behind other geometry. When Z buffer is disabled, the visual is displayed above all geometry ALREADY RENDERED (this statement is important), even if it should not.

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¶

brief_description: Represents an angle and its measurement. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Aug 2006

VisualAngle.VisualAngle(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualAngle

Parameters:	self (ORSModel.ors.VisualAngle) – an instance of VisualAngle buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualAngle.VisualAngle(self) -> VisualAngle

Parameters:	self (ORSModel.ors.VisualAngle) – an instance of VisualAngle

VisualAngle.VisualAngle(self, rhs: ORSModel.ors.Managed) -> VisualAngle

Parameters:	self (ORSModel.ors.VisualAngle) – an instance of VisualAngle rhs (Managed) –

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) –

Note

Points should be supplied in triplets, for respectively the X, Y and Z position.

getAngleValue(self, iTIndex: int) → float¶

Gets the value of the angle.

Parameters:	self (ORSModel.ors.VisualAngle) – an instance of VisualAngle iTIndex (int) –
Returns:	output (float) – the angle value (a float)

Note

The angle value is always in radian.

getClassNameStatic() → str¶

Returns:	output (str) –

getIsSplitted(self, iTIndex: int) → bool¶

Queries the angle to see if it is splitted or not.

Parameters:	self (ORSModel.ors.VisualAngle) – an instance of VisualAngle iTIndex (int) –
Returns:	output (bool) – TRUE if the angle is splitted, FALSE otherwise (see note)

Note

A splitted angle is not joined at the center, it is the angle between two vectors.

none()¶

VisualAngle.VisualAngle() -> VisualAngle

Parameters:	self (ORSModel.ors.VisualAngle) – an instance of 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) –

Note

A splitted angle is not joined at the center, it is the angle between two vectors.

VisualArrow¶

class ORSModel.ors.VisualArrow(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualArrow¶

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualArrow.VisualArrow(self) -> VisualArrow

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow

VisualArrow.VisualArrow(self, rhs: ORSModel.ors.Managed) -> VisualArrow

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getFixedDirection(self) → float¶

Return the arrow’s fixed direction (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow
Returns:	output (float) –

getFixedLength(self) → float¶

Return the arrow’s fixed length (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow
Returns:	output (float) – the arrow length (a double), a normalized value between 0 and 1, representing the proportion of the arrow.

getIsFixedDirection(self) → bool¶

Queries the arrow to know if it has a fixed direction or not (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow
Returns:	output (bool) – true if arrow has a fixed direction, false otherwise

getIsFixedLength(self) → bool¶

Queries the arrow to know if it has a fixed length or not (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow
Returns:	output (bool) – true if arrow has a fixed length, false otherwise

getPositionOnVisual(self, iTIndex: int) → Vector3¶

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow iTIndex (int) –
Returns:	output (ORSModel.ors.Vector3) –

none()¶

VisualArrow.VisualArrow() -> VisualArrow

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow

setFixedDirection(self, dir: float) → None¶

Sets the arrow’s fixed direction (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow dir (float) – the arrow direction (a double), a value between 0 and 359, representing the rotation of the arrow.

setFixedLength(self, fLength: float) → None¶

Sets the arrow’s fixed length (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow fLength (float) – the arrow length (a double), a normalized value between 0 and 1, representing the proportion of the arrow.

setIsFixedDirection(self, bfixed: bool) → None¶

Sets the arrow to have a fixed direction or not (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow bfixed (bool) – true to have a fixed direction, false otherwise

setIsFixedLength(self, bfixed: bool) → None¶

Sets the arrow to have a fixed length or not (in 3D only).

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow bfixed (bool) – true to have a fixed length, false otherwise

setIsPickingVisual(self, value: bool, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow value (bool) – iTIndex (int) –

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:	self (ORSModel.ors.VisualArrow) – an instance of VisualArrow x (float) – y (float) – z (float) –

VisualBox¶

class ORSModel.ors.VisualBox(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualBox¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualBox.VisualBox(self) -> VisualBox

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox

VisualBox.VisualBox(self, rhs: ORSModel.ors.Managed) -> VisualBox

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox rhs (Managed) –

getBox(self, iTIndex: int) → Box¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –
Returns:	output (ORSModel.ors.Box) –

getClassNameStatic() → str¶

Returns:	output (str) –

getGridRectangleSize(self) → float¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox
Returns:	output (float) –

getHighlightedBoxFace(self, faceIndex: int, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox faceIndex (int) – iTIndex (int) –
Returns:	output (bool) –

getHighlightedBoxFaceCount(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –
Returns:	output (int) –

getIsMiddleAnchorHighlited(self, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –
Returns:	output (bool) –

getPickedFace(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –
Returns:	output (int) –

getRangeMode(self, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –
Returns:	output (bool) –

getSelectedBoxFace(self, faceIndex: int, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox faceIndex (int) – iTIndex (int) –
Returns:	output (bool) –

getSelectedBoxFaceCount(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –
Returns:	output (int) –

getShowFaceAnchors(self) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox
Returns:	output (bool) –

getShowGrid(self) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox
Returns:	output (bool) –

none()¶

VisualBox.VisualBox() -> VisualBox

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox

pickBoxFace(self, pDisplay: ORSModel.ors.View, xPixelPositionInDisplay: int, yPixelPositionInDisplay: int) → int¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox pDisplay (ORSModel.ors.View) – xPixelPositionInDisplay (int) – yPixelPositionInDisplay (int) –
Returns:	output (int) –

pickBoxMiddleAnchor(self, pDisplay: ORSModel.ors.View, xPixelPositionInDisplay: int, yPixelPositionInDisplay: int) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox pDisplay (ORSModel.ors.View) – xPixelPositionInDisplay (int) – yPixelPositionInDisplay (int) –
Returns:	output (bool) –

pickSpecificBoxFace(self, pDisplay: ORSModel.ors.View, faceIndex: int, xPixelPositionInDisplay: int, yPixelPositionInDisplay: int) → bool¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox pDisplay (ORSModel.ors.View) – faceIndex (int) – xPixelPositionInDisplay (int) – yPixelPositionInDisplay (int) –
Returns:	output (bool) –

setBox(self, aBox: ORSModel.ors.Box, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox aBox (ORSModel.ors.Box) – iTIndex (int) –

setGridRectangleSize(self, aSize: float) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox aSize (float) –

setHighlightedBoxFace(self, faceIndex: int, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox faceIndex (int) – iTIndex (int) –

setIsMiddleAnchorHighlited(self, aValue: bool, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox aValue (bool) – iTIndex (int) –

setPickedFace(self, faceIndex: int, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox faceIndex (int) – iTIndex (int) –

setRangeMode(self, aFlag: bool, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox aFlag (bool) – iTIndex (int) –

setSelectedBoxFace(self, faceIndex: int, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox faceIndex (int) – iTIndex (int) –

setShowFaceAnchors(self, showFaceAnchors: bool) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox showFaceAnchors (bool) –

setShowGrid(self, flag: bool) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox flag (bool) –

unHighlightAllBoxFace(self, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –

unSelectAllBoxFace(self, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualBox) – an instance of VisualBox iTIndex (int) –

VisualCapsule¶

class ORSModel.ors.VisualCapsule(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualCapsule¶

Parameters:	self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualCapsule.VisualCapsule(self) -> VisualCapsule

Parameters:	self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule

VisualCapsule.VisualCapsule(self, rhs: ORSModel.ors.Managed) -> VisualCapsule

Parameters:	self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule rhs (Managed) –

getCapsule(self, iTIndex: int) → Capsule¶

Parameters:	self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule iTIndex (int) –
Returns:	output (ORSModel.ors.Capsule) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

VisualCapsule.VisualCapsule() -> VisualCapsule

Parameters:	self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule

setCapsule(self, aCapsule: ORSModel.ors.Capsule, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualCapsule) – an instance of VisualCapsule aCapsule (ORSModel.ors.Capsule) – iTIndex (int) –

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.VisualChannel(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualChannel

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualChannel.VisualChannel(self) -> VisualChannel

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

VisualChannel.VisualChannel(self, rhs: ORSModel.ors.Managed) -> VisualChannel

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel rhs (Managed) –

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:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aChannel1 (ORSModel.ors.Channel) – a channel (an Channel) aChannel2 (ORSModel.ors.Channel) – a channel (an Channel) aChannel3 (ORSModel.ors.Channel) – a channel (an Channel) aChannel4 (ORSModel.ors.Channel) – a channel (an Channel)
Returns:	output (bool) – TRUE if attach operation succeeded, FALSE otherwise

Note

A standard attachChild() with the channel is also performed by this method.

Note

The number of channels attached dictates the type of volume created: 1 channel results in a gray-scaled volume, 3 channels results in an RGB volume and 4 channels in an RGBA volume.

copyShapeFromChannel(self, pISourceChannel: ORSModel.ors.Channel) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel pISourceChannel (ORSModel.ors.Channel) –

detachChannel(self, anIChannel: ORSModel.ors.Channel) → bool¶

Detaches a child channel from the volume.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel anIChannel (ORSModel.ors.Channel) – a channel (an Channel)
Returns:	output (bool) – TRUE if detach was successful, FALSE otherwise

Note

A standard detachChild() from the channel is also performed by this method.

eraseWindowLevelDataForView(self, aView: ORSModel.ors.View) → None¶

Erases the window level data specific to a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) –

get2DLODEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

get2DLODSlabEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

get2DOpacityFactorForAllViews(self) → float¶

Gets the opacity of the volume for all views.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (float) – the opacity value (a double, between 0 and 1)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

get2DOpacityFactorForView(self, aView: ORSModel.ors.View) → float¶

Gets the opacity of the volume for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View)
Returns:	output (float) – the opacity value (a double, between 0 and 1)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

get2DWindowLevel2ValuesNormalized(self, pWindowWidth: float, pWindowCenter: float) → None¶

Gets the current second 2D window level values (width and center) normalized between 0 and 1.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel pWindowWidth (float) – pWindowCenter (float) –

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

Note

Return values are written to the supplied arguments.

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:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel pWindowWidth (float) – pWindowCenter (float) –

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

Note

Return values are written to the supplied arguments.

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:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View) pWindowWidth (float) – pWindowCenter (float) –

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

Note

Return values are written to the supplied arguments.

get3DClassificationMode(self) → int¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (int) –

get3DOpacityFactorForAllViews(self) → float¶

Gets the opacity of the volume for all views.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (float) – the opacity value (a double, between 0 and 1)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

get3DOpacityFactorForView(self, aView: ORSModel.ors.View) → float¶

Gets the opacity of the volume for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View)
Returns:	output (float) – the opacity value (a double, between 0 and 1)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

get3DShadingModeForView(self, aView: ORSModel.ors.View) → int¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) –
Returns:	output (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:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel pWindowWidth (float) – pWindowCenter (float) –

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

Note

Return values are written to the supplied arguments.

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:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View) pWindowWidth (float) – pWindowCenter (float) –

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

Note

Return values are written to the supplied arguments.

getBox(self) → Box¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (ORSModel.ors.Box) –

getCanCreateVisualChannel(self, anIChannel: ORSModel.ors.Channel, nNbChannels: int) → bool¶

Returns true if a volume 3D can be created with the given values.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel anIChannel (ORSModel.ors.Channel) – a channel (an Channel) nNbChannels (int) – total number of channels (an unsigned char)
Returns:	output (bool) – TRUE if a volume can be created, FALSE otherwise

Note

Some channels must be connected and channels type must be supported to create a volume.

Note

The second argument implies that all channels will be shaped similarly to the channel argument.

Note

Supports all channel types.

getCanCreateVolume(self, anIChannel: ORSModel.ors.Channel, nNbChannels: int) → bool¶

Returns true if a volume can be created with the given values.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel anIChannel (ORSModel.ors.Channel) – a channel (an Channel) nNbChannels (int) – total number of channels (an unsigned char)
Returns:	output (bool) – TRUE if a volume can be created, FALSE otherwise

Note

Some channels must be connected and channels type must be supported to create a volume.

Note

The second argument implies that all channels will be shaped similarly to the channel argument.

Note

supported channel types:

getClassNameStatic() → str¶

Returns:	output (str) –

getEdgeContrastForAllViews(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

getEdgeContrastForView(self, aView: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) –
Returns:	output (bool) –

getFilteringMode(self) → int¶

Gets the current filtering mode.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (int) – the current filtering mode (a int32_t)

Note

See CxvFiltering_Mode in ORS_def.h for supported filtering modes.

getGradientModeForAllViews(self) → int¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (int) –

getGradientModeForView(self, aView: ORSModel.ors.View) → int¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) –
Returns:	output (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:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel pChannel (ORSModel.ors.Channel) – a comparison channel (an Channel)
Returns:	output (bool) – TRUE if the comparison channel has same shape as receiver visual, FALSE otherwise

Note

Shape comparison includes axis sizes, spacing, type, position and orientation.

getInverseSegmentationLighting(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

getIs2DRangeSelectionEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

getIsoValueForAllViews(self) → float¶

Gets the IsoValue of the volume for all views.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (float) – the iso value (a double, between 0 and 1)

getIsoValueForView(self, aView: ORSModel.ors.View) → float¶

Gets the IsoValue of the volume for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View)
Returns:	output (float) – the iso value (a double, between 0 and 1)

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) –
Returns:	output (bool) –

getProjectionMode(self) → int¶

Gets the projection mode.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (int) – the projection mode (an int)

Note

See CxvVolumeProjection_Mode in ORS_def.h for supported volume projection modes.

getSourceDataPosition(self) → Vector3¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (ORSModel.ors.Vector3) –

getSourceDataXSize(self) → int¶

Gets the visual’s total X size.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (int) – the X size (an short)

getSourceDataXSpacing(self) → float¶

Gets the visual’s X spacing.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (float) – the X spacing (a double)

getSourceDataYSize(self) → int¶

Gets the visual’s total Y size.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (int) – the Y size (an short)

getSourceDataYSpacing(self) → float¶

Gets the visual’s Y spacing.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (float) – the Y spacing (a double)

getSourceDataZSize(self) → int¶

Gets the visual’s total Z size.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (int) – the Z size (an short)

getSourceDataZSpacing(self) → float¶

Gets the visual’s Z spacing.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (float) – the Z spacing (a double)

getSurfacenessThresholdForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (float) –

getSurfacenessThresholdForView(self, aView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) –
Returns:	output (float) –

getUseHighQualityIn3D(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

getUseTriCubicFilteringIn2D(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

getUseTriCubicFilteringIn3D(self) → bool¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel
Returns:	output (bool) –

none()¶

VisualChannel.VisualChannel() -> VisualChannel

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

reset2DWindowLevelForAllViews(self) → None¶

Resets the 3D window level for all views.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

Note

If the volume’s channel has a suggested leveling value, it will be used, otherwise the leveling will be set to show the full range of data.

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

reset2DWindowLevelForView(self, aView: ORSModel.ors.View) → None¶

Resets the 2D window level for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View)

Note

If the volume’s channel has a suggested leveling value, it will be used, otherwise the leveling will be set to show the full range of data.

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

reset3DWindowLevelForAllViews(self) → None¶

Resets the 3D window level for all views.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel

Note

If the volume’s channel has a suggested leveling value, it will be used, otherwise the leveling will be set to show the full range of data.

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

reset3DWindowLevelForView(self, aView: ORSModel.ors.View) → None¶

Resets the 2D window level for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View)

Note

If the volume’s channel has a suggested leveling value, it will be used, otherwise the leveling will be set to show the full range of data.

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

set2DLODEnabled(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (bool) –

set2DLODSlabEnabled(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (bool) –

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)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

set2DOpacityFactorForView(self, aView: ORSModel.ors.View, value: float) → None¶

Sets the opacity of the volume for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View) value (float) – the opacity value (a double, between 0 and 1)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

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

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

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

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

set2DWindowLevelToShowFullRangeForView(self, aView: ORSModel.ors.View) → None¶

Sets the 3D window level to show the full range of data, for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View)

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

set3DClassificationMode(self, aMode: int) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aMode (int) –

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)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

set3DOpacityFactorForView(self, aView: ORSModel.ors.View, value: float) → None¶

Sets the opacity of the volume for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View) value (float) – the opacity value (a double, between 0 and 1)

Note

An opacity of 0 makes the volume fully transparent, while 1 makes it fully opaque.

set3DOpacityFactorForViewLogged(view, opacity, logging=True)¶

set3DShadingModeForView(self, aView: ORSModel.ors.View, aMode: int) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – aMode (int) –

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

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

set3DWindowLevelToShowFullRangeForView(self, aView: ORSModel.ors.View) → None¶

Sets the 3D window level to show the full range of data, for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View)

Note

Volumes support two leveling modes, one for 3D views and the other for 2D views.

setEdgeContrastForAllViews(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (bool) –

setEdgeContrastForView(self, aView: ORSModel.ors.View, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – value (bool) –

setFilteringMode(self, iMode: int) → None¶

Sets the current filtering mode.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel iMode (int) – a filtering mode (a int32_t*)

Note

See CxvFiltering_Mode in ORS_def.h for supported filtering modes.

setGradientModeForAllViews(self, aValue: int) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aValue (int) –

setGradientModeForView(self, aView: ORSModel.ors.View, aValue: int) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – aValue (int) –

setInverseSegmentationLighting(self, bInverse: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel bInverse (bool) –

setIs2DRangeSelectionEnabled(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel pFlag (bool) –

setIsoValueForAllViews(self, value: float) → None¶

Sets the IsoValue of the volume for all views.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (float) – the iso value (a double, between 0 and 1)

setIsoValueForView(self, aView: ORSModel.ors.View, value: float) → None¶

Sets the IsoValue of the volume for a given view.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – the view (an View) value (float) – the iso value (a double, between 0 and 1)

setPlaneChannelForView(self, pView: ORSModel.ors.View, pChannel: ORSModel.ors.Channel) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel pView (ORSModel.ors.View) – pChannel (ORSModel.ors.Channel) –

setProjectionMode(self, iMode: int) → None¶

Sets the projection mode.

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel iMode (int) – a projection mode (an int)

Note

See CxvVolumeProjection_Mode in ORS_def.h for supported volume projection modes.

setSurfacenessThresholdForAllViews(self, value: float) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (float) –

setSurfacenessThresholdForView(self, aView: ORSModel.ors.View, value: float) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel aView (ORSModel.ors.View) – value (float) –

setUseHighQualityIn3D(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (bool) –

setUseTriCubicFilteringIn2D(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (bool) –

setUseTriCubicFilteringIn3D(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualChannel) – an instance of VisualChannel value (bool) –

shape¶

VisualColorBar¶

class ORSModel.ors.VisualColorBar¶

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.VisualColorBar(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualColorBar

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualColorBar.VisualColorBar(self) -> VisualColorBar

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

VisualColorBar.VisualColorBar(self, rhs: ORSModel.ors.Managed) -> VisualColorBar

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar rhs (Managed) –

getAllViewsUsingLookupTable(self, aLUT: ORSModel.ors.LookupTable) → List¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar aLUT (ORSModel.ors.LookupTable) –
Returns:	output (ORSModel.ors.List) –

getBold(self) → bool¶

Gets the bold status of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (bool) – true if color bar is in bold, false otherwise

getBorder(self) → bool¶

Gets the border status of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (bool) – true if color bar has a border, false otherwise

getCanBeVisibleForAllViews(self) → bool¶

Gets whether or not the color bar can be visible.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (bool) – true if color bar can be make visible, false otherwise

getCanBeVisibleForView(self, pView: ORSModel.ors.View) → bool¶

Gets whether or not the color bar can be visible.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (bool) – true if color bar can be make visible, false otherwise

getClassNameStatic() → str¶

Returns:	output (str) –

getDecimalPrecision(self) → int¶

Gets the decimal precision of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (int) – the number of decimal places (an short)

getDrawTextShadow(self) → bool¶

Gets if the scale bar is showing text shadow.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (bool) – TRUE if text shadows are visible, FALSE otherwise

getHeightAsViewFractionForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) –

getHeightAsViewFractionForView(self, pView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (float) –

getIsEnabledForAllViews(self) → bool¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (bool) –

getIsEnabledForView(self, pView: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (bool) –

getItalic(self) → bool¶

Gets the italic status of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (bool) – true if color bar is italic, false otherwise

getLineThickness(self) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) –

getLookupTableForAllViews(self) → LookupTable¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (ORSModel.ors.LookupTable) –

getLookupTableForView(self, pView: ORSModel.ors.View) → LookupTable¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.LookupTable) –

getOffset(self) → float¶

Gets the color bar offset.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) – the offset (a float)

getPositionForAllViews(self) → Vector3¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (ORSModel.ors.Vector3) –

getPositionForView(self, pView: ORSModel.ors.View) → Vector3¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.Vector3) –

getRangeDimensionUnitForAllViews(self) → int¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (int) –

getRangeDimensionUnitForView(self, pView: ORSModel.ors.View) → int¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (int) –

getRangeMaxForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) –

getRangeMaxForView(self, pView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (float) –

getRangeMinForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) –

getRangeMinForView(self, pView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (float) –

getSlope(self) → float¶

Gets the color bar slope.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) – the slope (a float)

getTextColor(self) → Color¶

Gets the text color of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (ORSModel.ors.Color) – a color object (an Color)

getTextFontName(self) → str¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (str) –

getTextFontSize(self) → float¶

Gets the text font size, in screen one thousandths.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) – the font size (a double between 0 and 1)

getTextMinimumFontSize(self) → int¶

Gets the minimum text font size, in font points.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (int) – the font size

getTextShadowColor(self) → Color¶

Gets the text shadow color of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (ORSModel.ors.Color) – a color object (an Color)

getTickCount(self) → int¶

Gets the number of visible ticks on the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (int) – the number of ticks (an short)

getTransparent(self) → bool¶

Gets the transparency status of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (bool) – true if color bar is transparent, false otherwise

getWidthAsViewFractionForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar
Returns:	output (float) –

getWidthAsViewFractionForView(self, pView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –
Returns:	output (float) –

none()¶

VisualColorBar.VisualColorBar() -> VisualColorBar

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

setBold(self, value: bool) → None¶

Sets the color bar to be bold or not.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar value (bool) – TRUE to be in bold, FALSE otherwise

setBorder(self, value: bool) → None¶

Sets the color bar to have a border or not.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar value (bool) – true to have a border, false otherwise

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:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – true if color bar can be make visible, false otherwise aValue (bool) –

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:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar bFlag (bool) – true to show text shadows, false otherwise

setHeightAsViewFractionForAllViews(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar aValue (float) –

setHeightAsViewFractionForView(self, pView: ORSModel.ors.View, aValue: float) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – aValue (float) –

setIsEnabledForAllViews(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar aValue (bool) –

setIsEnabledForView(self, pView: ORSModel.ors.View, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – aValue (bool) –

setItalic(self, value: bool) → None¶

Sets the color bar to be italic or not.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar value (bool) – true to be italic, false otherwise

setLineThickness(self, value: float) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar value (float) –

setLookupTableForAllViews(self, aLUT: ORSModel.ors.LookupTable) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar aLUT (ORSModel.ors.LookupTable) –

setLookupTableForView(self, pView: ORSModel.ors.View, aLUT: ORSModel.ors.LookupTable) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – aLUT (ORSModel.ors.LookupTable) –

setLookupTableForViewLogged(view, lut, logging=True)¶

setOffset(self, anOffset: float) → None¶

Sets the color bar offset.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar anOffset (float) – the offset (a float)

setOrientationToHorizontalForAllViews(self) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

setOrientationToHorizontalForView(self, pView: ORSModel.ors.View) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –

setOrientationToVerticalForAllViews(self) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

setOrientationToVerticalForView(self, pView: ORSModel.ors.View) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –

setPositionForAllViews(self, aPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar aPoint (ORSModel.ors.Vector3) –

setPositionForView(self, pView: ORSModel.ors.View, aPoint: ORSModel.ors.Vector3) → None¶

Set the color bar position in view.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – the view aPoint (ORSModel.ors.Vector3) –

setRangeDimensionUnitForAllViews(self, value: int) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar value (int) –

setRangeDimensionUnitForView(self, pView: ORSModel.ors.View, value: int) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – value (int) –

setRangeForAllViews(self, min: float, max: float, unit: int) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar min (float) – max (float) – unit (int) –

setRangeForView(self, pView: ORSModel.ors.View, min: float, max: float, unit: int) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – min (float) – max (float) – unit (int) –

setSlope(self, aSlope: float) → None¶

Sets the color bar slope.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar aSlope (float) – the slope (a float)

setTextColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the text color of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar IColor (ORSModel.ors.Color) – a color object (an Color) its item color.

setTextFontName(self, sFontName: str) → None¶

Sets the text font name.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar sFontName (str) – the font name (a string)

setTextFontSize(self, fontSize: float) → None¶

Sets the text font size, in screen one thousandths.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar fontSize (float) – the font size (a double between 0 and 1)

setTextMinimumFontSize(self, fontSize: int) → None¶

Sets the minimum font size, in font points.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar fontSize (int) – the font size

setTextShadowColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the text shadow color of the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar IColor (ORSModel.ors.Color) – a color object (an Color)

setTickCount(self, value: int) → None¶

Sets the number of visible ticks on the color bar.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar value (int) – the number of ticks (an unsigned short)

setTransparent(self, value: bool) → None¶

Sets the color bar to be transparent or not.

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar value (bool) – true to be transparent, false otherwise

setWidthAsViewFractionForAllViews(self, aValue: float) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar aValue (float) –

setWidthAsViewFractionForView(self, pView: ORSModel.ors.View, aValue: float) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) – aValue (float) –

updateRampForAllViews(self) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar

updateRampForView(self, pView: ORSModel.ors.View) → None¶

Parameters:	self (ORSModel.ors.VisualColorBar) – an instance of VisualColorBar pView (ORSModel.ors.View) –

VisualCylinder¶

class ORSModel.ors.VisualCylinder(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualCylinder¶

Parameters:	self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualCylinder.VisualCylinder(self) -> VisualCylinder

Parameters:	self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder

VisualCylinder.VisualCylinder(self, rhs: ORSModel.ors.Managed) -> VisualCylinder

Parameters:	self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getCylinder(self, iTIndex: int) → Cylinder¶

Parameters:	self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder iTIndex (int) –
Returns:	output (ORSModel.ors.Cylinder) –

none()¶

VisualCylinder.VisualCylinder() -> VisualCylinder

Parameters:	self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder

setCylinder(self, aCylinder: ORSModel.ors.Cylinder, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualCylinder) – an instance of VisualCylinder aCylinder (ORSModel.ors.Cylinder) – iTIndex (int) –

VisualGrid¶

class ORSModel.ors.VisualGrid¶

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.VisualGrid(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualGrid

Parameters:	self (ORSModel.ors.VisualGrid) – an instance of VisualGrid buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualGrid.VisualGrid(self) -> VisualGrid

Parameters:	self (ORSModel.ors.VisualGrid) – an instance of VisualGrid

VisualGrid.VisualGrid(self, rhs: ORSModel.ors.Managed) -> VisualGrid

Parameters:	self (ORSModel.ors.VisualGrid) – an instance of VisualGrid rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

VisualGrid.VisualGrid() -> VisualGrid

Parameters:	self (ORSModel.ors.VisualGrid) – an instance of VisualGrid

VisualLabel¶

class ORSModel.ors.VisualLabel¶

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.VisualLabel(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualLabel

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualLabel.VisualLabel(self) -> VisualLabel

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel

VisualLabel.VisualLabel(self, rhs: ORSModel.ors.Managed) -> VisualLabel

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel rhs (Managed) –

getBindedNode(self) → Node¶

Gets the node associated to the label.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
Returns:	output (ORSModel.ors.Node) – a node (an Node)

Note

A label can thus be associated to any node.

getClassNameStatic() → str¶

Returns:	output (str) –

getIsCollapsed(self, iTIndex: int) → bool¶

Gets the label’s collapsed status.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel iTIndex (int) –
Returns:	output (bool) – TRUE if label is collapsed, FALSE if it’s expanded

getLabelSortMode(self) → int¶

Gets the label sort mode (see note).

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
Returns:	output (int) – the sort mode (an short)

Note

3 modes are currently supported:

getLabelTextFontName(self) → str¶

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
Returns:	output (str) –

getLabelTextFontSize(self) → int¶

Gets the font size.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
Returns:	output (int) – the font size (a short)

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
Returns:	output (bool) –

getShowLines(self) → bool¶

Gets the label lines visibility.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel
Returns:	output (bool) – TRUE if lines are shown, FALSE otherwise

Note

This represents the line between the label and the object it points to.

moveLabelToCursorPositionInDisplay(self, pDisplay: ORSModel.ors.View, pixelXPositionInDisplay: int, pixelYPositionInDisplay: int) → None¶

Moves the label to the current cursor position in a given display.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel pDisplay (ORSModel.ors.View) – pixelXPositionInDisplay (int) – pixelYPositionInDisplay (int) –

none()¶

VisualLabel.VisualLabel() -> VisualLabel

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of 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

Note

A label can thus be associated to any node.

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:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel iMode (int) – the sort mode (an unsigned short)

Note

3 modes are currently supported:

setLabelTextFontName(self, sName: str) → None¶

Sets the text font name of the label.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel sName (str) – the font name (a string)

setLabelTextFontSize(self, pValue: int) → None¶

Sets the font size.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel pValue (int) – the font size (a short)

setPositionInDisplay(self, IDisplay: ORSModel.ors.View, xPos: float, yPos: float) → None¶

Sets the position of the receiver in a given display.

Parameters:	self (ORSModel.ors.VisualLabel) – an instance of VisualLabel IDisplay (ORSModel.ors.View) – a display (an View) xPos (float) – the X position (a double) yPos (float) – the Y position (a double)

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

Note

This controls the line between the label and the object it points to.

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.VisualLegend(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualLegend

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualLegend.VisualLegend(self) -> VisualLegend

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend

VisualLegend.VisualLegend(self, rhs: ORSModel.ors.Managed) -> VisualLegend

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getLabelAtIndex(self, index: int) → str¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend index (int) –
Returns:	output (str) –

getLabelCount(self) → int¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend
Returns:	output (int) –

getViewOrderAtIndex(self, index: int) → int¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend index (int) –
Returns:	output (int) –

getViewOrderSize(self) → int¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend
Returns:	output (int) –

none()¶

VisualLegend.VisualLegend() -> VisualLegend

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend

setLabelAtIndex(self, index: int, label: str) → None¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend index (int) – label (str) –

setLabelCount(self, labelCount: int) → None¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend labelCount (int) –

setViewOrderAtIndex(self, index: int, viewOrder: int) → None¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend index (int) – viewOrder (int) –

setViewOrderSize(self, iNewSize: int) → None¶

Parameters:	self (ORSModel.ors.VisualLegend) – an instance of VisualLegend iNewSize (int) –

VisualMesh¶

class ORSModel.ors.VisualMesh(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualMesh¶

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualMesh.VisualMesh(self) -> VisualMesh

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

VisualMesh.VisualMesh(self, rhs: ORSModel.ors.Managed) -> VisualMesh

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh rhs (Managed) –

getBoundingBoxPlusEpsilon(timestep, worldMatrix, epsilon=0.01)¶

getBuildOctree(self) → bool¶

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (bool) –

getClassNameStatic() → str¶

Returns:	output (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)
Returns:	output (ORSModel.ors.Color) – the color (an Color)

getCullMode(self) → int¶

Gets the culling mode of the mesh.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (int) – the mode (a int32_t)

Note

See the enum CxvMeshCull_Mode in ORS_def.h for valid values.

getCurrentAlphaFuncValue(self) → int¶

Sets the transparency of the mesh.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (int) – a value from 0 to 255

getFillModeForAllViews(self) → int¶

Gets the mesh fill mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (int) – the fill mode (a int32_t)

Note

See the enum CxvMeshFill_Mode in ORS_def.h for valid values.

getFillModeForView(self, pView: ORSModel.ors.View) → int¶

Gets the mesh fill mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh pView (ORSModel.ors.View) – a view (a View)
Returns:	output (int) – the fill mode (a int32_t)

Note

See the enum CxvMeshFill_Mode in ORS_def.h for valid values.

getIsFillModePoint(self, pView: ORSModel.ors.View) → bool¶

Queries the mesh to know if it is in point mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh pView (ORSModel.ors.View) – a view (a View)
Returns:	output (bool) – true if in point mode, false otherwise

getIsFillModeSolid(self, pView: ORSModel.ors.View) → bool¶

Queries the mesh to know if it is in solid mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh pView (ORSModel.ors.View) – a view (a View)
Returns:	output (bool) – true if in solid mode, false otherwise

getIsFillModeWireFrame(self, pView: ORSModel.ors.View) → bool¶

Queries the mesh to know if it is in wire frame mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh pView (ORSModel.ors.View) –
Returns:	output (bool) – true if wire frame, false otherwise

getIsPerVertexTransparent(self) → bool¶

Gets the status of transparency.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (bool) – true if the transparency is being read from the RGBA color, false otherwise

Note

If this setting is used, make sure that each vertex has a color defined as RGBA.

getIsTransparent(self) → bool¶

Gets the transparency state of the mesh.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (bool) – true if mesh is transparent, false otherwise

getOpacity(self) → float¶

Gets the opacity of the mesh.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (float) – the opacity (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

getOpacityOutRange(self) → float¶

Gets the opacity for unselected area of the mesh.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (float) – the opacity (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

getShowColorIn2D(self) → bool¶

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (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
Returns:	output (bool) – true if the mesh is visible in 2D views during mouse movement, false otherwise

getThickness(self) → float¶

Gets the thickness of lines in 2D mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (float) – the thickness, in pixel units (an double)

getUseLighting(self) → bool¶

Gets the mesh lighting mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh
Returns:	output (bool) – true if lighting is on, false otherwise

getWorldTransform(timestep=0)¶

none()¶

VisualMesh.VisualMesh() -> VisualMesh

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh

setBuildOctree(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh value (bool) –

setCullMode(self, iMode: int) → None¶

Sets the culling mode for the mesh.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh iMode (int) – a mode (a int32_t*)

Note

See the enum CxvMeshCull_Mode in ORS_def.h for valid values.

setCurrentAlphaFuncValue(self, value: int) → None¶

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh value (int) –

setFillModeForAllViews(self, pFillMode: int) → None¶

Sets the mesh fill mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh pFillMode (int) – the fill mode (a int32_t*)

Note

See the enum CxvMeshFill_Mode in ORS_def.h for valid values.

setFillModeForView(self, pView: ORSModel.ors.View, pFillMode: int) → None¶

Sets the mesh fill mode.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh pView (ORSModel.ors.View) – a view (a View) pFillMode (int) – the fill mode (a int32_t*)

Note

See the enum CxvMeshFill_Mode in ORS_def.h for valid values.

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

Note

If this setting is used, make sure that each vertex has a color defined as RGBA.

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:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh value (float) – an opacity value (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

setOpacityOutRange(self, value: float) → None¶

Sets the opacity of the mesh.

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh value (float) – an opacity value (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

setShowColorIn2D(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh value (bool) –

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:	self (ORSModel.ors.VisualMesh) – an instance of VisualMesh timeStep (int) –

VisualOverlay¶

class ORSModel.ors.VisualOverlay¶

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.VisualOverlay(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualOverlay

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualOverlay.VisualOverlay(self) -> VisualOverlay

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

VisualOverlay.VisualOverlay(self, rhs: ORSModel.ors.Managed) -> VisualOverlay

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getExtent(self) → Vector3¶

Gets the extent of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (ORSModel.ors.Vector3) – an extent (an Vector3)

getExtentInBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle) → Vector3¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aBoundedPlane (ORSModel.ors.Rectangle) –
Returns:	output (ORSModel.ors.Vector3) –

getHighlightedAnchor(self, anchorIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay anchorIndex (int) –
Returns:	output (bool) –

getHighlightedAnchorCount(self) → int¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (int) –

getHighlightedBorder(self, borderIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay borderIndex (int) –
Returns:	output (bool) –

getHighlightedBorderCount(self) → int¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (int) –

getIsSelectedAndShapeAndPositionEditionEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (bool) –

getIsShapeAndPositionEditable(self) → bool¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (bool) –

getIsShapeAndPositionEditionEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (bool) –

getKeepAspectRatio(self) → bool¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (bool) –

getMaximumPixelSize(self) → Vector3¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (ORSModel.ors.Vector3) –

getMinimumPixelSize(self) → Vector3¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (ORSModel.ors.Vector3) –

getOpacity(self) → float¶

Gets the opacity of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (float) – the opacity (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

getOverlayMode(self) → int¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (int) –

getPosition(self) → Vector3¶

Gets the position of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (ORSModel.ors.Vector3) – a position (an Vector3)

getPositionInBoundedPlane(self, aBoundedPlane: ORSModel.ors.Rectangle) → Vector3¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aBoundedPlane (ORSModel.ors.Rectangle) –
Returns:	output (ORSModel.ors.Vector3) –

getPreserveGeometry(self) → bool¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (bool) –

getRenderingRectangle(self, aView: ORSModel.ors.View) → Rectangle¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aView (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.Rectangle) –

getSelectedColor(self) → Color¶

Gets the selected color of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (ORSModel.ors.Color) – the color (a Color)

getShapeAndPositionEditionAssociatedState(self) → str¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay
Returns:	output (str) –

none()¶

VisualOverlay.VisualOverlay() -> VisualOverlay

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay

pickAnchor(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay pView (ORSModel.ors.View) – xPixelPositionInView (int) – yPixelPositionInView (int) –
Returns:	output (int) –

pickBorder(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay pView (ORSModel.ors.View) – xPixelPositionInView (int) – yPixelPositionInView (int) –
Returns:	output (int) –

setExtent(self, aVect: ORSModel.ors.Vector3) → None¶

Sets the extent of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aVect (ORSModel.ors.Vector3) – an extent (an Vector3)

setHighlightedAnchor(self, anchorIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay anchorIndex (int) –

setHighlightedBorder(self, borderIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay borderIndex (int) –

setIsShapeAndPositionEditable(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay value (bool) –

setIsShapeAndPositionEditionEnabled(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay value (bool) –

setKeepAspectRatio(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aValue (bool) –

setMaximumPixelSize(self, aVect: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aVect (ORSModel.ors.Vector3) –

setMinimumPixelSize(self, aVect: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aVect (ORSModel.ors.Vector3) –

setOpacity(self, value: float) → None¶

Sets the opacity of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay value (float) – an opacity value (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

setOverlayMode(self, aMode: int) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aMode (int) –

setPosition(self, pPosition: ORSModel.ors.Vector3) → None¶

Sets the position of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay pPosition (ORSModel.ors.Vector3) – a position (an Vector3)

setPreserveGeometry(self, aValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aValue (bool) –

setSelectedColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the selected color of the overlay.

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay IColor (ORSModel.ors.Color) – the color (a Color)

setShapeAndPositionEditionAssociatedState(self, aState: str) → None¶

Parameters:	self (ORSModel.ors.VisualOverlay) – an instance of VisualOverlay aState (str) –

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¶

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.VisualPath(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualPath

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualPath.VisualPath(self) -> VisualPath

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath

VisualPath.VisualPath(self, rhs: ORSModel.ors.Managed) -> VisualPath

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath rhs (Managed) –

addPathMarker(self, parameter: float, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath parameter (float) – iTIndex (int) –

addPoint(self, pPoint: ORSModel.ors.Vector3, iTIndex: int) → None¶

Adds a point.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pPoint (ORSModel.ors.Vector3) – a point (an Vector3) iTIndex (int) –

Note

Points are manual, while control points are automatic, i.e. the control points will end up generating individual points (on the Bezier curve).

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

addPointForAllTimeStep(self, pPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pPoint (ORSModel.ors.Vector3) –

addPointForControlPoint(self, controlPointIndex: int, iTIndex: int, aPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath controlPointIndex (int) – iTIndex (int) – aPoint (ORSModel.ors.Vector3) –

applyConvolution(self, aKernel: ORSModel.ors.ConvolutionKernel, timeStep: int) → None¶

Apply the kernel to the path position.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath aKernel (ORSModel.ors.ConvolutionKernel) – a one dimension kernel timeStep (int) – timestep

clearAll(self, iTIndex: int) → None¶

Clears all points and control points.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) –

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

clearAllForAllTimeStep(self) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath

closestPointOnPathInCurvedOnScreen(self, pView: ORSModel.ors.View, pixelXPositionInView: int, pixelYPositionInView: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pView (ORSModel.ors.View) – pixelXPositionInView (int) – pixelYPositionInView (int) –
Returns:	output (int) –

getAllCurvedViewsOfPath(self) → List¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (ORSModel.ors.List) –

getAllShortAxialViewsOfPath(self) → List¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (ORSModel.ors.List) –

getArea(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → float¶

Returns the area of the path.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (float) – the area of the path (a double)

Note

If the path is not closed, this method returns 0

getBezierSamplingLength(self) → float¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (float) –

getBuildOctree(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (bool) –

getClassNameStatic() → str¶

Returns:	output (str) –

getControlPointIndexFromPointIndex(self, id: int, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath id (int) – iTIndex (int) –
Returns:	output (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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – safearray of index of the control point ( int32_t) aTransformationMatrix* (ORSModel.ors.Matrix4x4) – pIndicesArray (ORSModel.ors.ArrayLong) –
Returns:	output (ORSModel.ors.ArrayDouble) – safearray of triplet of the X Y Z position of the point ( double )

Note

Points are manual, while control points are automatic, i.e. the control points will end up generating individual points (on the Bezier curve).

Note

Control point indicies are zero based.

Note

If indices array is NULL, this method assumes an array of all indices.

getControlPointRadiusAtIndex(self, index: int, iTIndex: int) → float¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –
Returns:	output (float) –

getCurrentPointIndex(self) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (int) –

getDistanceAlongPathBetweenPosition(self, s0: float, s1: float, iTIndex: int) → float¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath s0 (float) – s1 (float) – iTIndex (int) –
Returns:	output (float) –

getDistanceBetweenPosition(self, s0: float, s1: float, iTIndex: int, pMatrix: ORSModel.ors.Matrix4x4) → float¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath s0 (float) – s1 (float) – iTIndex (int) – pMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (float) –

getHideLine(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (bool) –

getHightlightedPathMarkerIndex(self) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (int) –

getIndexOfClosestPoint(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, pointToCompareTo: ORSModel.ors.Vector3, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath aTransformationMatrix (ORSModel.ors.Matrix4x4) – pointToCompareTo (ORSModel.ors.Vector3) – iTIndex (int) –
Returns:	output (int) –

getIndexOfFarthestPoint(self, aTransformationMatrix: ORSModel.ors.Matrix4x4, pointToCompareTo: ORSModel.ors.Vector3, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath aTransformationMatrix (ORSModel.ors.Matrix4x4) – pointToCompareTo (ORSModel.ors.Vector3) – iTIndex (int) –
Returns:	output (int) –

getIndexOfPathMarkerWithCaption(self, aCaption: str, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath aCaption (str) – iTIndex (int) –
Returns:	output (int) –

getIntersectionPointsOfContourForBoundedPlane(self, aBP: ORSModel.ors.Rectangle, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pfOutputPoints: ORSModel.ors.OrderedCollectionDouble) → OrderedCollectionDouble¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath aBP (ORSModel.ors.Rectangle) – iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) – pfOutputPoints (ORSModel.ors.OrderedCollectionDouble) –
Returns:	output (ORSModel.ors.OrderedCollectionDouble) –

getIsBezier(self) → bool¶

Gets the path’s Bezier curve status.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (bool) – TRUE if path follows a Bezier curve, FALSE otherwise

getIsClosed(self) → bool¶

Gets if the path is closed.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (bool) – TRUE if the path is closed, FALSE otherwise

getIsToBeShownInCurvedView(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (bool) –

getLength(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → float¶

Returns the total length of the path.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (float) – the length of the path (a double)

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) –
Returns:	output (float) – the position of the given control point (a double, see below)

Note

This method returns the normalized position (between 0 and 1) of a given control point on the path.

Note

Control point indicies are zero based.

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) –
Returns:	output (float) – the position of the given point (a float, see below)

Note

This method returns the normalized position (between 0 and 1) of a given point on the path.

Note

Point indicies are zero based.

getPathMarkerCaption(self, index: int, iTIndex: int) → str¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –
Returns:	output (str) –

getPathMarkerColor(self, index: int, iTIndex: int) → Color¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –
Returns:	output (ORSModel.ors.Color) –

getPathMarkerCount(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) –
Returns:	output (int) –

getPathMarkerPosition(self, index: int, iTIndex: int) → float¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –
Returns:	output (float) –

getPathMarkerReferenceLineIsHightlighted(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (bool) –

getPathMarkerReferenceLineOffsetForView(self, pView: ORSModel.ors.View) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pView (ORSModel.ors.View) –
Returns:	output (int) –

getPathMarkerRegionID(self, index: int, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –
Returns:	output (int) –

getPathMarkerRegionMode(self, index: int, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –
Returns:	output (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) –
Returns:	output (float) –

getPathMarkerScalarCount(self) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (int) –

getPathMarkerVisible(self, index: int, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –
Returns:	output (bool) –

getPathPointCenterOfMass(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Vector3) –

getPathPointGlobalOrientation(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Vector3) –

getPathPoints(self, iTIndex: int) → OrderedCollectionDouble¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) –
Returns:	output (ORSModel.ors.OrderedCollectionDouble) –

getPickPathMarker(self, pDisp: ORSModel.ors.View, pixelXPositionInView: int, pixelYPositionInView: int) → int¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pDisp (ORSModel.ors.View) – pixelXPositionInView (int) – pixelYPositionInView (int) –
Returns:	output (int) –

getPointAtIndex(self, index: int, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3¶

Gets a given point’s coordinates.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – the index of the point (an uint32_t) iTIndex (int) – a transformation matrix (an Matrix4x4) aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Vector3) – a point (an Vector3)

Note

Points are manual, while control points are automatic, i.e. the control points will end up generating individual points (on the Bezier curve).

Note

Point indicies are zero based.

getPointCount(self, iTIndex: int) → int¶

Gets the number of points.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) –
Returns:	output (int) – the number of points (an uint32_t)

getPointPositionsList(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pnIndexes: ORSModel.ors.ArrayLong) → ArrayDouble¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) – pnIndexes (ORSModel.ors.ArrayLong) –
Returns:	output (ORSModel.ors.ArrayDouble) –

getPositionOnPath(self, parameter: float, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → Vector3¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath parameter (float) – iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (ORSModel.ors.Vector3) –

getPositionOnPathNearestTo(self, aLocation: ORSModel.ors.Vector3, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4) → float¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath aLocation (ORSModel.ors.Vector3) – iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (float) –

getPositionOnViewForCurvedChannel(self, pNormalizedPositionOnPath: float, aView: ORSModel.ors.View, aCurvedChannel: ORSModel.ors.Channel) → Vector3¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pNormalizedPositionOnPath (float) – aView (ORSModel.ors.View) – aCurvedChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Vector3) –

getPositionOnViewOfControlPointForCurvedChannel(self, controlPointIndex: int, aView: ORSModel.ors.View, aCurvedChannel: ORSModel.ors.Channel) → Vector3¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath controlPointIndex (int) – aView (ORSModel.ors.View) – aCurvedChannel (ORSModel.ors.Channel) –
Returns:	output (ORSModel.ors.Vector3) –

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:	position (ORSModel.ors.Vector3) – the positional vector (an Vector3) up (ORSModel.ors.Vector3) – the up vector (an Vector3) right (ORSModel.ors.Vector3) – the right vector (an Vector3) tangent (ORSModel.ors.Vector3) – the tangent vector (an Vector3)

Note

Results are written to the vector arguments.

Note

The first argument should be between 0.0f and 1.0f, with desired level of granulariy.

Note

This method allows one to find the exact location and direction at any given portion of the path.

getPositionsOnPath(self, pPositions: ORSModel.ors.ArrayDouble, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pfOutputPoints: ORSModel.ors.ArrayDouble) → ArrayDouble¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pPositions (ORSModel.ors.ArrayDouble) – iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) – pfOutputPoints (ORSModel.ors.ArrayDouble) –
Returns:	output (ORSModel.ors.ArrayDouble) –

getShowAllIn2D(self) → bool¶

Gets the Show All status of the path.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (bool) – TRUE if the path is shown fully, FALSE otherwise

Note

If the path is set to “ShowAll”, it will be fully visible in 2D but its color will fade towards black as it gets further from the current slice.

getShowPathMarkerReferenceLine(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath
Returns:	output (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) –

Returns:

output (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) –

Returns:

output (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

Returns:

output (ORSModel.ors.Mesh) – Resulting 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) –

Returns:

output (ORSModel.ors.Mesh) –

insertControlPointForAllTimeStep(self, index: int, pPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – pPoint (ORSModel.ors.Vector3) –

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pDisp (ORSModel.ors.View) – index (int) – pixelXPositionInView (int) – pixelYPositionInView (int) – canPassOver (bool) –

none()¶

VisualPath.VisualPath() -> VisualPath

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath

rebuildBezier(self, iTIndex: int) → None¶

Rebuilds the Bezier curve.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) –

rebuildBezierForAllTimeStep(self) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath

rebuildNonBezier(self, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) –

rebuildNonBezierForAllTimeStep(self) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath

removeAllPathMarkers(self, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) –

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) –

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath value (float) –

setBuildOctree(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath value (bool) –

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath aSize (int) –

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – safearray of index of the control point ( int32_t) aTransformationMatrix* (ORSModel.ors.Matrix4x4) – safearray of triplet of the X Y Z position of the point ( float) pIndicesArray (ORSModel.ors.ArrayLong) – pfPoints (ORSModel.ors.ArrayDouble) –

Note

Points are manual, while control points are automatic, i.e. the control points will end up generating individual points (on the Bezier curve).

Note

Control point indicies are zero based.

Note

If indices array is NULL, this method assumes an array of all indices.

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – radius (float) –

setFirstUpVector(self, anIVector: ORSModel.ors.Vector3, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath anIVector (ORSModel.ors.Vector3) – iTIndex (int) –

setHideLine(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath value (bool) –

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

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath flag (bool) –

setPathMarkerCaption(self, index: int, iTIndex: int, caption: str) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) – caption (str) –

setPathMarkerColor(self, index: int, iTIndex: int, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) – IColor (ORSModel.ors.Color) –

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath value (bool) –

setPathMarkerReferenceLineOffsetForView(self, pView: ORSModel.ors.View, value: int) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath pView (ORSModel.ors.View) – value (int) –

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:	self (ORSModel.ors.VisualPath) – an instance of VisualPath s (int) –

setPathMarkerVisible(self, index: int, iTIndex: int, s: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – iTIndex (int) – s (bool) –

setPointAtIndex(self, index: int, iTIndex: int, pPoint: ORSModel.ors.Vector3) → None¶

Sets a given point’s coordinates.

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – the index of the point (an uint32_t) iTIndex (int) – a point (an Vector3) pPoint (ORSModel.ors.Vector3) –

Note

Points are manual, while control points are automatic, i.e. the control points will end up generating individual points (on the Bezier curve).

Note

Point indicies are zero based.

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

setPointAtIndexForAllTimeStep(self, index: int, pPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath index (int) – pPoint (ORSModel.ors.Vector3) –

setPointPositionsList(self, iTIndex: int, aTransformationMatrix: ORSModel.ors.Matrix4x4, pnIndexes: ORSModel.ors.ArrayLong, pfPoints: ORSModel.ors.ArrayDouble) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath iTIndex (int) – aTransformationMatrix (ORSModel.ors.Matrix4x4) – pnIndexes (ORSModel.ors.ArrayLong) – pfPoints (ORSModel.ors.ArrayDouble) –

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

Note

If the path is set to “ShowAll”, it will be fully visible in 2D but its color will fade towards black as it gets further from the current slice.

setShowPathMarkerReferenceLine(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPath) – an instance of VisualPath value (bool) –

VisualPlane¶

class ORSModel.ors.VisualPlane(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualPlane¶

Bases: ORSModel.ors.VisualShape2D

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualPlane.VisualPlane(self) -> VisualPlane

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane

VisualPlane.VisualPlane(self, rhs: ORSModel.ors.Managed) -> VisualPlane

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getEnabled(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane
Returns:	output (bool) –

getIsClipping(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane
Returns:	output (bool) –

getIsEditable(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane
Returns:	output (bool) –

getOrientedPlane(self, iTIndex: int) → OrientedPlane¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane iTIndex (int) –
Returns:	output (ORSModel.ors.OrientedPlane) –

getShowBorder(self) → bool¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane
Returns:	output (bool) –

none()¶

VisualPlane.VisualPlane() -> VisualPlane

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane

setEnabled(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane pFlag (bool) –

setIsClipping(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane pFlag (bool) –

setIsEditable(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane pFlag (bool) –

setOrientedPlane(self, aPlane: ORSModel.ors.OrientedPlane, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane aPlane (ORSModel.ors.OrientedPlane) – iTIndex (int) –

setShowBorder(self, pFlag: bool) → None¶

Parameters:	self (ORSModel.ors.VisualPlane) – an instance of VisualPlane pFlag (bool) –

VisualPoints¶

class ORSModel.ors.VisualPoints(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualPoints¶

Parameters:	self (ORSModel.ors.VisualPoints) – an instance of VisualPoints buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualPoints.VisualPoints(self) -> VisualPoints

Parameters:	self (ORSModel.ors.VisualPoints) – an instance of VisualPoints

VisualPoints.VisualPoints(self, rhs: ORSModel.ors.Managed) -> VisualPoints

Parameters:	self (ORSModel.ors.VisualPoints) – an instance of VisualPoints rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

VisualPoints.VisualPoints() -> VisualPoints

Parameters:	self (ORSModel.ors.VisualPoints) – an instance of VisualPoints

VisualROI¶

class ORSModel.ors.VisualROI(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualROI¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualROI.VisualROI(self) -> VisualROI

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI

VisualROI.VisualROI(self, rhs: ORSModel.ors.Managed) -> VisualROI

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI rhs (Managed) –

fillLookupTableWithLabelColors(self, IStructuredGrid: ORSModel.ors.MultiROI, IView: ORSModel.ors.View, pLUT: ORSModel.ors.LookupTable, labelOffset: int) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IStructuredGrid (ORSModel.ors.MultiROI) – IView (ORSModel.ors.View) – pLUT (ORSModel.ors.LookupTable) – labelOffset (int) –

getClassNameStatic() → str¶

Returns:	output (str) –

getColorForAllViews(self) → Color¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (ORSModel.ors.Color) –

getColorForView(self, IView: ORSModel.ors.View) → Color¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.Color) –

getHighlightOpacityForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (float) –

getHighlightOpacityForView(self, IView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (float) –

getHighlightOpacityOutRangeForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (float) –

getHighlightOpacityOutRangeForView(self, IView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (float) –

getIsVisibleIn2DForAllViews(self) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (bool) –

getIsVisibleIn2DForView(self, IView: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (bool) –

getIsVisibleIn3DForAllViews(self) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (bool) –

getIsVisibleIn3DForView(self, IView: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (bool) –

getLabelColor(self, IStructuredGrid: ORSModel.ors.MultiROI, IView: ORSModel.ors.View, label: int) → Color¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IStructuredGrid (ORSModel.ors.MultiROI) – IView (ORSModel.ors.View) – label (int) –
Returns:	output (ORSModel.ors.Color) –

getPlaneChannelForGUID(self, aGUID: str, createIfAbsent: bool) → Channel¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI aGUID (str) – createIfAbsent (bool) –
Returns:	output (ORSModel.ors.Channel) –

getROIOpacityForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (float) –

getROIOpacityForView(self, IView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (float) –

getROIOpacityOutRangeForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (float) –

getROIOpacityOutRangeForView(self, IView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (float) –

getShowContourForAllViews(self) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (bool) –

getShowContourForView(self, IView: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (bool) –

getVolumeOpacityForAllViews(self) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI
Returns:	output (float) –

getVolumeOpacityForView(self, IView: ORSModel.ors.View) → float¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) –
Returns:	output (float) –

none()¶

VisualROI.VisualROI() -> VisualROI

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI

presentInChannel(self, aChannel: ORSModel.ors.Channel, aView: ORSModel.ors.View) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI aChannel (ORSModel.ors.Channel) – aView (ORSModel.ors.View) –

presentInImage(self, anImage: ORSModel.ors.Image, aView: ORSModel.ors.View) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI anImage (ORSModel.ors.Image) – aView (ORSModel.ors.View) –
Returns:	output (bool) –

setColorForAllViews(self, color: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI color (ORSModel.ors.Color) –

setColorForView(self, IView: ORSModel.ors.View, color: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – color (ORSModel.ors.Color) –

setHighlightOpacityForAllViews(self, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI opacity (float) –

setHighlightOpacityForView(self, IView: ORSModel.ors.View, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – opacity (float) –

setHighlightOpacityOutRangeForAllViews(self, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI opacity (float) –

setHighlightOpacityOutRangeForView(self, IView: ORSModel.ors.View, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – opacity (float) –

setIsVisibleIn2DForAllViews(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI bValue (bool) –

setIsVisibleIn2DForView(self, IView: ORSModel.ors.View, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – bValue (bool) –

setIsVisibleIn3DForAllViews(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI bValue (bool) –

setIsVisibleIn3DForView(self, IView: ORSModel.ors.View, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – bValue (bool) –

setROIOpacityForAllViews(self, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI opacity (float) –

setROIOpacityForView(self, IView: ORSModel.ors.View, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – opacity (float) –

setROIOpacityOutRangeForAllViews(self, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI opacity (float) –

setROIOpacityOutRangeForView(self, IView: ORSModel.ors.View, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – opacity (float) –

setShowContourForAllViews(self, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI bValue (bool) –

setShowContourForView(self, IView: ORSModel.ors.View, bValue: bool) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – bValue (bool) –

setVolumeOpacityForAllViews(self, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI opacity (float) –

setVolumeOpacityForView(self, IView: ORSModel.ors.View, opacity: float) → None¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI IView (ORSModel.ors.View) – opacity (float) –

updateChannel(self, aChannel: ORSModel.ors.Channel, aContourLabelChannel: ORSModel.ors.Channel, aContourChannel: ORSModel.ors.Channel, IView: ORSModel.ors.View, haveToDoAll: bool) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI aChannel (ORSModel.ors.Channel) – aContourLabelChannel (ORSModel.ors.Channel) – aContourChannel (ORSModel.ors.Channel) – IView (ORSModel.ors.View) – haveToDoAll (bool) –
Returns:	output (bool) –

updateChannel2DForGUIDFromPlane(self, aGUID: str, aBplane: ORSModel.ors.Rectangle, currentTimeStep: int, haveToDoAll: bool) → bool¶

Parameters:	self (ORSModel.ors.VisualROI) – an instance of VisualROI aGUID (str) – aBplane (ORSModel.ors.Rectangle) – currentTimeStep (int) – haveToDoAll (bool) –
Returns:	output (bool) –

VisualRegion¶

class ORSModel.ors.VisualRegion¶

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.VisualRegion(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualRegion

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualRegion.VisualRegion(self) -> VisualRegion

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion

VisualRegion.VisualRegion(self, rhs: ORSModel.ors.Managed) -> VisualRegion

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion rhs (Managed) –

addRegionIn3DOrthoProjectionToROIIntersectingChannel(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:

self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
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) –

addRegionIn3DOrthoProjectionToROIIntersectingLabeldMultiROI(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:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion pCamera (ORSModel.ors.Camera) – inside (bool) – outputROI (ORSModel.ors.ROI) – currentTimeStep (int) – intersectingMultiROI (ORSModel.ors.MultiROI) – fHightlightOpacity (float) – fHightlightOpacityOutRange (float) – clipBox (ORSModel.ors.Box) –

addRegionIn3DOrthoProjectionToROIIntersectingROI(self, pCamera: ORSModel.ors.Camera, inside: bool, outputROI: ORSModel.ors.ROI, currentTimeStep: int, intersectingROI: ORSModel.ors.ROI, clipBox: ORSModel.ors.Box) → None¶

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion pCamera (ORSModel.ors.Camera) – inside (bool) – outputROI (ORSModel.ors.ROI) – currentTimeStep (int) – intersectingROI (ORSModel.ors.ROI) – clipBox (ORSModel.ors.Box) –

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:

self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
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) –

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:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion pCamera (ORSModel.ors.Camera) – inside (bool) – outputROI (ORSModel.ors.ROI) – currentTimeStep (int) – intersectingMultiROI (ORSModel.ors.MultiROI) – fHightlightOpacity (float) – fHightlightOpacityOutRange (float) – clipBox (ORSModel.ors.Box) –

addRegionIn3DPerspectiveProjectionToROIIntersectingROI(self, pCamera: ORSModel.ors.Camera, inside: bool, outputROI: ORSModel.ors.ROI, currentTimeStep: int, intersectingROI: ORSModel.ors.ROI, clipBox: ORSModel.ors.Box) → None¶

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion pCamera (ORSModel.ors.Camera) – inside (bool) – outputROI (ORSModel.ors.ROI) – currentTimeStep (int) – intersectingROI (ORSModel.ors.ROI) – clipBox (ORSModel.ors.Box) –

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) –

Note

Points should be supplied in triplets, for respectively the X, Y and Z position.

getArea(self, timeStep: int, worldTransform: ORSModel.ors.Matrix4x4) → float¶

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion timeStep (int) – worldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (float) –

getClassNameStatic() → str¶

Returns:	output (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)

Returns:

output (ORSModel.ors.HistogramData) – a histogram (an HistogramData)

getIsOn3DView(self) → bool¶

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
Returns:	output (bool) –

getPerimeter(self, timeStep: int, worldTransform: ORSModel.ors.Matrix4x4) → float¶

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion timeStep (int) – worldTransform (ORSModel.ors.Matrix4x4) –
Returns:	output (float) –

getShape(self) → int¶

Gets the shape of the region.

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion
Returns:	output (int) – an CxvRegion_Shape value (an int)

Note

See the ORS_def.h file for valid CxvRegion_Shape values.

insertControlPointForAllTimeStep(self, pPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion pPoint (ORSModel.ors.Vector3) –

none()¶

VisualRegion.VisualRegion() -> VisualRegion

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion

setControlPoints(self, pfPoints: ORSModel.ors.ArrayDouble, iTIndex: int) → None¶

Sets the points of the region.

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion pfPoints (ORSModel.ors.ArrayDouble) – the number of triplets in the array (a int32_t) iTIndex* (int) – an array of point triplets (a float*)

Note

The array should consist of triplets of X, Y and Z positions.

Note

The array is not managed by the underlying object, i.e. you are responsible for releasing it.

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

setIsOn3DView(self, value: bool) → None¶

Insert a point to the region between the two nearest existing points.

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion value (bool) – the point (an Vector3)

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

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) –

Note

Planes are expressed by the general equation ax + by + cz + dw = 0.

setShape(self, shape: int) → None¶

Sets the shape of the region.

Parameters:	self (ORSModel.ors.VisualRegion) – an instance of VisualRegion shape (int) – an CxvRegion_Shape value (an int)

Note

See the ORS_def.h file for valid CxvRegion_Shape values.

Note

Any change to a primitive should be followed by update() to reflect the changes visually.

VisualRuler¶

class ORSModel.ors.VisualRuler¶

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.VisualRuler(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualRuler

Parameters:	self (ORSModel.ors.VisualRuler) – an instance of VisualRuler buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualRuler.VisualRuler(self) -> VisualRuler

Parameters:	self (ORSModel.ors.VisualRuler) – an instance of VisualRuler

VisualRuler.VisualRuler(self, rhs: ORSModel.ors.Managed) -> VisualRuler

Parameters:	self (ORSModel.ors.VisualRuler) – an instance of VisualRuler rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getLength(self, iTIndex: int, aWorldTransformMatrix: ORSModel.ors.Matrix4x4) → float¶

Gets the length value of the ruler.

Parameters:	self (ORSModel.ors.VisualRuler) – an instance of VisualRuler iTIndex (int) – aWorldTransformMatrix (ORSModel.ors.Matrix4x4) –
Returns:	output (float) – the length of the ruler (a double)

Note

The length of the ruler is always returned in meters. You can use a view to convert to other units.

getShowTicks(self) → bool¶

Gets the display status of the ruler’s ticks.

Parameters:	self (ORSModel.ors.VisualRuler) – an instance of VisualRuler
Returns:	output (bool) – true if ticks are shown, false otherwise

getTickCount(self) → int¶

Gets the number of visible ticks on the ruler.

Parameters:	self (ORSModel.ors.VisualRuler) – an instance of VisualRuler
Returns:	output (int) – the number of ticks (an uint32_t)

none()¶

VisualRuler.VisualRuler() -> VisualRuler

Parameters:	self (ORSModel.ors.VisualRuler) – an instance of 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:	self (ORSModel.ors.VisualRuler) – an instance of VisualRuler value (int) – the number of ticks (an uint32_t)

VisualScaleBar¶

class ORSModel.ors.VisualScaleBar(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualScaleBar¶

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualScaleBar.VisualScaleBar(self) -> VisualScaleBar

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar

VisualScaleBar.VisualScaleBar(self, rhs: ORSModel.ors.Managed) -> VisualScaleBar

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar rhs (Managed) –

getAutoAdjustFloatingLength(self) → bool¶

Gets if the scalebar auto-adjusts or not.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (bool) – TRUE if scale bar auto-adjusts, FALSE otherwise

getClassNameStatic() → str¶

Returns:	output (str) –

getColor(self) → Color¶

Gets the scale bar color.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (ORSModel.ors.Color) – a color object (a Color)

getDrawTextShadow(self) → bool¶

Gets if the scale bar is showing text shadow.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (bool) – TRUE if text shadows are visible, FALSE otherwise

getFloatingLength(self) → float¶

Gets the scalebar’s length when floating.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (float) – the scale bar length (a double)

Note

The length is always expressed in meters.

getIsFloating(self) → bool¶

Gets if the scalebar is floating.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (bool) – TRUE if the scale bar is floating, FALSE otherwise

getPrecision(self) → int¶

Gets the length precision.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (int) – a number of decimals (an char)

Note

The precision is only used during displaying values, internally full precision is preserved.

getScaleBarPositionInView(self, pView: ORSModel.ors.View) → Vector3¶

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar pView (ORSModel.ors.View) –
Returns:	output (ORSModel.ors.Vector3) –

getTextColor(self) → Color¶

Gets the text color of the scale bar.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (ORSModel.ors.Color) – a color object (an Color)

Note

The text color is used for the length.

getTextFontName(self) → str¶

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (str) –

getTextFontSize(self) → float¶

Gets the font size, in screen one thousandths.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (float) – the font size (a double between 0 and 1)

getTextMinimumFontSize(self) → int¶

Gets the minimum text font size, in font points.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (int) – the font size

getTextShadowColor(self) → Color¶

Gets the text shadow color of the scale bar.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar
Returns:	output (ORSModel.ors.Color) – a color object (an Color)

none()¶

VisualScaleBar.VisualScaleBar() -> VisualScaleBar

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of 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:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar IColor (ORSModel.ors.Color) – a color object (a Color)

setDrawTextShadow(self, bFlag: bool) → None¶

Toggles displaying shadows for the text.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar bFlag (bool) – TRUE to show text shadows, FALSE otherwise

setFloatingLength(self, floatLength: float) → None¶

Sets the scalebar’s length when floating.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar floatLength (float) – the scale bar length (a double)

Note

The length is always expressed in meters.

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:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar iPrecision (int) – the number of decimals (an unsigned char)

Note

The precision is only used during displaying values of a floating scale bar, internally full precision is preserved.

setScaleBarPositionInView(self, pView: ORSModel.ors.View, aPoint: ORSModel.ors.Vector3) → None¶

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar pView (ORSModel.ors.View) – aPoint (ORSModel.ors.Vector3) –

setTextColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the text color of the scale bar.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar IColor (ORSModel.ors.Color) – a color object (an Color)

Note

The text color is used for the caption.

setTextFontName(self, sFontName: str) → None¶

Sets the font name.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar sFontName (str) – the font name (a string)

setTextFontSize(self, fontSize: float) → None¶

Sets the font size, in screen one thousandths.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar fontSize (float) – the font size (a double between 0 and 1)

setTextMinimumFontSize(self, fontSize: int) → None¶

Sets the minimum font size, in font points.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar fontSize (int) – the font size

setTextShadowColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the text shadow color of the scale bar.

Parameters:	self (ORSModel.ors.VisualScaleBar) – an instance of VisualScaleBar IColor (ORSModel.ors.Color) – a color object (an Color)

VisualShape¶

class ORSModel.ors.VisualShape(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualShape¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualShape.VisualShape(self) -> VisualShape

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape

VisualShape.VisualShape(self, rhs: ORSModel.ors.Managed) -> VisualShape

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape rhs (Managed) –

addAffectedVisual(self, pObject: ORSModel.ors.Managed) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape pObject (ORSModel.ors.Managed) –

getAffectedVisualsGUID(self) → str¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape
Returns:	output (str) –

getClassNameStatic() → str¶

Returns:	output (str) –

getColor(self) → Color¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape
Returns:	output (ORSModel.ors.Color) –

getHighlightedAnchor(self, anchorIndex: int, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape anchorIndex (int) – iTIndex (int) –
Returns:	output (bool) –

getHighlightedAnchorCount(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape iTIndex (int) –
Returns:	output (int) –

getHighlightedBorder(self, borderIndex: int, iTIndex: int) → bool¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape borderIndex (int) – iTIndex (int) –
Returns:	output (bool) –

getHighlightedBorderCount(self, iTIndex: int) → int¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape iTIndex (int) –
Returns:	output (int) –

getIsInverted(self) → bool¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape
Returns:	output (bool) –

getSelectedColor(self) → Color¶

Gets the selected color of the shape.

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape
Returns:	output (ORSModel.ors.Color) – the color (a Color)

getShaderCode(self, aView: ORSModel.ors.View, raycastElementId: int, outputElementId: int) → str¶

get the evaluated shader code (in glsl)

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape aView (ORSModel.ors.View) – the view (a ors::view) raycastElementId (int) – raycastElementId: the index of the raycasted element being rendered (volumeN_, volumestructN_, transferFuncN_, rayN) outputElementId (int) – outputElementId: the index of colors[] output register (rgba)
Returns:	output (str) –

getShape(self, timestep: int) → Shape¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape timestep (int) –
Returns:	output (ORSModel.ors.Shape) –

getShapeAffectsVisual(self, pObject: ORSModel.ors.Managed) → bool¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape pObject (ORSModel.ors.Managed) –
Returns:	output (bool) –

getShapeIndex(self) → int¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape
Returns:	output (int) –

none()¶

VisualShape.VisualShape() -> VisualShape

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape

pickAnchor(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape pView (ORSModel.ors.View) – xPixelPositionInView (int) – yPixelPositionInView (int) –
Returns:	output (int) –

pickBorder(self, pView: ORSModel.ors.View, xPixelPositionInView: int, yPixelPositionInView: int) → int¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape pView (ORSModel.ors.View) – xPixelPositionInView (int) – yPixelPositionInView (int) –
Returns:	output (int) –

pickSpecificBorder(self, pView: ORSModel.ors.View, borderIndex: int, xPixelPositionInView: int, yPixelPositionInView: int) → bool¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape pView (ORSModel.ors.View) – borderIndex (int) – xPixelPositionInView (int) – yPixelPositionInView (int) –
Returns:	output (bool) –

removeAffectedVisual(self, pObject: ORSModel.ors.Managed) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape pObject (ORSModel.ors.Managed) –

setAffectedVisualsGUID(self, guids: str) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape guids (str) –

setColor(self, color: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape color (ORSModel.ors.Color) –

setHighlightedAnchor(self, anchorIndex: int, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape anchorIndex (int) – iTIndex (int) –

setHighlightedBorder(self, borderIndex: int, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape borderIndex (int) – iTIndex (int) –

setIsInverted(self, bIsInverted: bool) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape bIsInverted (bool) –

setSelectedColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the selected color of the shape.

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape IColor (ORSModel.ors.Color) – the color (a Color)

setShape(self, aShape: ORSModel.ors.Shape, timestep: int) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape aShape (ORSModel.ors.Shape) – timestep (int) –

setShapeIndex(self, iIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape iIndex (int) –

unHighlightAllAnchor(self, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape iTIndex (int) –

unHighlightAllBorder(self, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualShape) – an instance of VisualShape iTIndex (int) –

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.VisualShape2D(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualShape2D

Parameters:	self (ORSModel.ors.VisualShape2D) – an instance of VisualShape2D buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualShape2D.VisualShape2D(self) -> VisualShape2D

Parameters:	self (ORSModel.ors.VisualShape2D) – an instance of VisualShape2D

VisualShape2D.VisualShape2D(self, rhs: ORSModel.ors.Managed) -> VisualShape2D

Parameters:	self (ORSModel.ors.VisualShape2D) – an instance of VisualShape2D rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

VisualShape2D.VisualShape2D() -> VisualShape2D

Parameters:	self (ORSModel.ors.VisualShape2D) – an instance of 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.VisualShape3D(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualShape3D

Parameters:	self (ORSModel.ors.VisualShape3D) – an instance of VisualShape3D buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualShape3D.VisualShape3D(self) -> VisualShape3D

Parameters:	self (ORSModel.ors.VisualShape3D) – an instance of VisualShape3D

VisualShape3D.VisualShape3D(self, rhs: ORSModel.ors.Managed) -> VisualShape3D

Parameters:	self (ORSModel.ors.VisualShape3D) – an instance of VisualShape3D rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

none()¶

VisualShape3D.VisualShape3D() -> VisualShape3D

Parameters:	self (ORSModel.ors.VisualShape3D) – an instance of VisualShape3D

VisualSphere¶

class ORSModel.ors.VisualSphere(self, buffer: int, nBytes: int, bPreserveIdentity: bool) → VisualSphere¶

Parameters:	self (ORSModel.ors.VisualSphere) – an instance of VisualSphere buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualSphere.VisualSphere(self) -> VisualSphere

Parameters:	self (ORSModel.ors.VisualSphere) – an instance of VisualSphere

VisualSphere.VisualSphere(self, rhs: ORSModel.ors.Managed) -> VisualSphere

Parameters:	self (ORSModel.ors.VisualSphere) – an instance of VisualSphere rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getSphere(self, iTIndex: int) → Sphere¶

Parameters:	self (ORSModel.ors.VisualSphere) – an instance of VisualSphere iTIndex (int) –
Returns:	output (ORSModel.ors.Sphere) –

none()¶

VisualSphere.VisualSphere() -> VisualSphere

Parameters:	self (ORSModel.ors.VisualSphere) – an instance of VisualSphere

setSphere(self, aSphere: ORSModel.ors.Sphere, iTIndex: int) → None¶

Parameters:	self (ORSModel.ors.VisualSphere) – an instance of VisualSphere aSphere (ORSModel.ors.Sphere) – iTIndex (int) –

VisualText¶

class ORSModel.ors.VisualText¶

brief_description: To display text on the renderer. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

VisualText.VisualText(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualText

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualText.VisualText(self) -> VisualText

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText

VisualText.VisualText(self, rhs: ORSModel.ors.Managed) -> VisualText

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText rhs (Managed) –

getClassNameStatic() → str¶

Returns:	output (str) –

getDrawShadow(self) → bool¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (bool) –

getHorizontalAlignment(self) → int¶

Gets the horizontal alignment of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (int) – 0 for left-aligned, 1 for center-aligned or 2 for right-aligned

Note

Default value is left-aligned.

getIsOriginAtTop(self) → bool¶

Gets whether or not the text is top-aligned.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (bool) – TRUE if the text is top-aligned, FALSE otherwise

Note

If not top-aligned, the text is bottom-aligned.

getText(self) → str¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (str) –

getTextColor(self) → Color¶

Gets the text color of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (ORSModel.ors.Color) – a color object (an Color)

getTextFontName(self) → str¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (str) –

getTextFontSize(self) → float¶

Gets the text font size, in screen one thousandths.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (float) – the size (a double between 0 and 1)

getTextMinimumFontSize(self) → int¶

Gets the minimum text font size, in font points.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (int) – the font size

getTextShadowColor(self) → Color¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (ORSModel.ors.Color) –

getType(self) → str¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (str) –

getU(self) → float¶

Gets the U coordinate of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (float) – a coordinate (a float)

Note

The U coordinate is same as X coordinate. In this case the coordinate is relative.

Note

Range goes from 0.0 (left) to 1.0 (right).

Note

For left-aligned items, the U coordinates designates the left side. For right-aligned items, it designates the right side. For center-aligned items, it designates the center.

getV(self) → float¶

Gets the V coordinate of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText
Returns:	output (float) – a coordinate (a float)

Note

The V coordinate is same as Y coordinate. In this case the coordinate is relative.

Note

Range goes from 0.0 (top) to 1.0 (bottom).

Note

The YPosition is computed to the horizontal center of the text. Hence values of 0.0 or 1.0 are likely to position the text outside of the renderer window (not appearing).

none()¶

VisualText.VisualText() -> VisualText

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText

setDrawShadow(self, bFlag: bool) → None¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText bFlag (bool) –

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

Note

Default is left-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

Note

If not top-aligned, the text is bottom-aligned.

setText(self, sText: str) → None¶

Sets the text of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText sText (str) – some text (a string)

setTextColor(self, IColor: ORSModel.ors.Color) → None¶

Sets the text color of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText IColor (ORSModel.ors.Color) – a color object (an Color)

Note

If the instance created by an ORSTextPresenter, it will supply its item color.

setTextFontName(self, sName: str) → None¶

Sets the text font name of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText sName (str) – the font name (a string)

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:	self (ORSModel.ors.VisualText) – an instance of VisualText fontSize (int) – the font size

setTextShadowColor(self, IColor: ORSModel.ors.Color) → None¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText IColor (ORSModel.ors.Color) –

setType(self, aType: str) → None¶

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText aType (str) –

setU(self, fValue: float) → None¶

Sets the U coordinate of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText fValue (float) – a coordinate (a float)

Note

The U coordinate is same as X coordinate. In this case the coordinate is relative.

Note

Range goes from 0.0 (left) to 1.0 (right).

Note

For left-aligned items, the U coordinates designates the left side. For right-aligned items, it designates the right side. For center-aligned items, it designates the center.

setV(self, fValue: float) → None¶

Sets the V coordinate of the item.

Parameters:	self (ORSModel.ors.VisualText) – an instance of VisualText fValue (float) – a coordinate (a float)

Note

The V coordinate is same as Y coordinate. In this case the coordinate is relative.

Note

Range goes from 0.0 (top) to 1.0 (bottom).

Note

The YPosition is computed to the horizontal center of the text. Hence values of 0.0 or 1.0 are likely to position the text outside of the renderer window (not appearing).

VisualVectorField¶

class ORSModel.ors.VisualVectorField¶

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.VisualVectorField(self, buffer: int, nBytes: int, bPreserveIdentity: bool) -> VisualVectorField

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField buffer (bytes) – nBytes (int) – bPreserveIdentity (bool) –

VisualVectorField.VisualVectorField(self) -> VisualVectorField

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

VisualVectorField.VisualVectorField(self, rhs: ORSModel.ors.Managed) -> VisualVectorField

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField rhs (Managed) –

getBuildOctree(self) → bool¶

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (bool) –

getClassNameStatic() → str¶

Returns:	output (str) –

getCurrentAlphaFuncValue(self) → int¶

Sets the transparency of the mesh.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (int) – a value from 0 to 255

getOpacity(self) → float¶

Gets the opacity of the mesh.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (float) – the opacity (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

getOpacityOutRange(self) → float¶

Gets the opacity for unselected area of the mesh.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (float) – the opacity (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

getRenderingColor(self) → Color¶

Gets the rendering color of the vector field.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (ORSModel.ors.Color) – the color as an Color object

getShowIn2DDuringMotion(self) → bool¶

Gets the visibility of the mesh in 2D views during mouse motion.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (bool) – true if the mesh is visible in 2D views during mouse movement, false otherwise

getThickness(self) → float¶

Gets the thickness of lines in 2D mode.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (float) – the thickness, in pixel units (an double)

getUseLighting(self) → bool¶

Gets the mesh lighting mode.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (bool) – true if lighting is on, false otherwise

getVectorTransform(self) → Matrix4x4¶

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField
Returns:	output (ORSModel.ors.Matrix4x4) –

none()¶

VisualVectorField.VisualVectorField() -> VisualVectorField

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField

setBuildOctree(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField value (bool) –

setOpacity(self, value: float) → None¶

Sets the opacity for unselected range of the mesh.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField value (float) – an opacity value (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

setOpacityOutRange(self, value: float) → None¶

Sets the opacity of the mesh.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField value (float) – an opacity value (a float)

Note

Ranges from 0.0f (no opacity) to 1.0f (100% opacity).

Note

The mesh does not consider any opacity changes unless it is set to be transparent (see setIsTransparent()).

setRenderingColor(self, aColor: ORSModel.ors.Color) → None¶

set rendering color

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField aColor (ORSModel.ors.Color) –

setShowColorIn2D(self, value: bool) → None¶

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField value (bool) –

setThickness(self, value: float) → None¶

Sets the thickness of lines in 2D mode.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField value (float) – the thickness, in pixel units (an double)

setUseLighting(self, useLighting: bool) → None¶

Sets the mesh lighting mode.

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField useLighting (bool) – true to use lighting, false otherwise

setVectorTransform(self, aMatrix: ORSModel.ors.Matrix4x4) → None¶

Parameters:	self (ORSModel.ors.VisualVectorField) – an instance of VisualVectorField aMatrix (ORSModel.ors.Matrix4x4) –

Watershed¶

class ORSModel.ors.Watershed(self) → Watershed¶