OrsGenericMenuItems

Supports the use of generic menu items generated by the OrsGenericMenuGenerator plugin

author:

Dragonfly Team

contact:

https://dragonfly.comet.tech

email:

support.dragonfly@comet.tech

organization:

Comet Technologies Canada Inc.

address:

460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7

copyright:

Comet Technologies Canada Inc. All rights reserved 2023.

date:

May 14 2016 12:11

dragonflyVersion:

3.0

UUID:

3c87d774761411e7bd90448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsGenericMenuItems.OrsGenericMenuItems.OrsGenericMenuItems(*args, **kwargs)
classmethod evaluateMenuActionString(actionString, menuString)

Evaluates a string from the help menu

Parameters:

  • actionString (str) – the string to evaluate

  • menuString (str) – provenance of the action string. Used in case of exception while evaluating

classmethod importAllLoggingClasses()

This method is called to make any class extension available for macro playing. It should:

  1. import all class extension;

  2. return a list of classes where logging is supported.

Returns:

output (list of classes) – list of classes where logging is supported by the current plugin

Generic Menu Items

abasicOtsu_2ddea6215af711ee944afc3497105300

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.abasicOtsu_2ddea6215af711ee944afc3497105300.abasicOtsu_2ddea6215af711ee944afc3497105300
interfacemethod basicOtsuAPS(aChannel: Channel, timeStep: int = 0) → MultiROI

Automated Porosity Segmentation: Apply the Single Material (Basic Otsu) method

Parameters:

  • aChannel (ORSModel.ors.Channel) – The Channel to apply the method from

  • timeStep (int) – The time step of the dataset

Returns:

output (ORSModel.ors.MultiROI) – the output MultiROI that is the result of the Single Material (Basic Otsu) method

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

interfacemethod removeBackgroundAndApplyStyle(aROI: ROI) → ROI

Remove the background noise from lower Otsu and set color of the porosity ROI

Parameters:

aROI (ORSModel.ors.ROI) – The ROI created from lower Otsu

Returns:

output (ORSModel.ors.ROI) – the output ROI that is the result of the removal and style application

addAConstantEdgeScalarSlot_09aa2968785911eaa6c900d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addAConstantEdgeScalarSlot_09aa2968785911eaa6c900d861065303.addAConstantEdgeScalarSlot_09aa2968785911eaa6c900d861065303
interfacemethod addAConstantEdgeScalarSlot(aGraph: Graph, value: float, name: str) → None

Add a constant edge scalar slot to a graph

Deprecated since version 2024.1: Use EdgeConstantMeasurementAbstract.computeConstantMeasurement

Parameters:

  • aGraph (ORSModel.ors.Graph) – a Graph

  • value (float) – a number

  • name (str) – a name

addaconstantmeasurementfromintersection_3d09317ec53011ea9bfe0c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addaconstantmeasurementfromintersection_3d09317ec53011ea9bfe0c9d9276653a.addaconstantmeasurementfromintersection_3d09317ec53011ea9bfe0c9d9276653a
interfacemethod addMeasurementFromIntersectionWithROI(aROI: ROI, aMesh: Mesh) → None

Add a constant vertex scalar slot

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

addAConstantVertexScalarSlot_b2b325e46c4c11e99af3448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addAConstantVertexScalarSlot_b2b325e46c4c11e99af3448a5b87686a.addAConstantVertexScalarSlot_b2b325e46c4c11e99af3448a5b87686a
interfacemethod addAConstantVertexScalarSlot(unStruct: UnstructuredGrid, value: float, name: str) → None

Add a constant vertex scalar slot

Deprecated since version 2024.1: Use VertexConstantMeasurementAbstract.computeConstantMeasurement

Parameters:

addARandomVertexScalarSlot_b4x321e4g74c11e99af5448a5b8m4p62

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addARandomVertexScalarSlot_b4x321e4g74c11e99af5448a5b8m4p62.addARandomVertexScalarSlot_b4x321e4g74c11e99af5448a5b8m4p62
interfacemethod addARandomVertexScalarSlot(unStruct: UnstructuredGrid, minValue: float, maxValue: float, name: str) → None

Add a random vertex scalar slot between a range (min, max)

Parameters:

  • unStruct (ORSModel.ors.UnstructuredGrid) – a UnstructuredGrid

  • minValue (float) – a number that represent the min of the random range

  • maxValue (float) – a number that represent the max of the random range

  • name (str) – a name

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be

applied.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item

will be applied.

addShapeToiROI_4878510a01ed11e8bc0e0cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addShapeToiROI_4878510a01ed11e8bc0e0cc47aab53c3.addShapeToiROI_4878510a01ed11e8bc0e0cc47aab53c3
interfacemethod addShapeToROI(roi: ROI, shape: Shape3D, timestep: int) → None

Adds an instance of Shape3D to a ROI

Parameters:
interfacemethod addVisualShapeToROI(roi: ROI, visualShape3D: VisualShape3D, timestep: int) → None

Adds an instance of VisualShape3D to a ROI

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

addShapeToMultiROILabel_5a66d354de2f11e99a93309c23d29268

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addShapeToMultiROILabel_5a66d354de2f11e99a93309c23d29268.addShapeToMultiROILabel_5a66d354de2f11e99a93309c23d29268
interfacemethod addShapeToMultiROILabel(aShape: Shape3D, multiROI: MultiROI, label: int, timestep: int) → None

add a Shape3D to a MultiROI Label

Parameters:
interfacemethod addVisualShapeToMultiROILabel(aVisualShape: VisualShape3D, multiROI: MultiROI, label: int, timestep: int) → None

add a VisualShape to a MultiROI Label

Parameters:
classmethod getMenuItemForObject(aMultiROI, selected_labels_count)

Returns the menu item :param aMultiROI: a MultiROI :param selected_labels_count: int :return: Menu

classmethod menuItemEntryPoint(aGUID)

Will be executed when the menu item is selected. :param aGUID: guid of the underlying MultiROI.

addTriplePointContactAngleVertexScalarValue_556ccc1bac5511eb87360c9d9276734f

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addTriplePointContactAngleVertexScalarValue_556ccc1bac5511eb87360c9d9276734f.addTriplePointContactAngleVertexScalarValue_556ccc1bac5511eb87360c9d9276734f
interfacemethod addTriplePointContactAngleVertexScalarValue(aGraph: Graph, electrolyteROI: ROI, firstConductorROI: ROI, secondConductorROI: ROI, progress: Progress) → None

Add vertex scalar values to the graph, describing triple point contact angle

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

addVertexConnectivityScalarSlotToGraph_20001c086c4911e9a89d448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.addVertexConnectivityScalarSlotToGraph_20001c086c4911e9a89d448a5b87686a.addVertexConnectivityScalarSlotToGraph_20001c086c4911e9a89d448a5b87686a
interfacemethod addConnectivitiesToGraph(aGraph: Graph) → None

Add a scalar slot that tell the connectivity count of each vertices

Parameters:

aGraph (ORSModel.ors.Graph) – a Graph

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

advancedOtsu_3446a2415bb011eebce1fc3497105300

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.advancedOtsu_3446a2415bb011eebce1fc3497105300.advancedOtsu_3446a2415bb011eebce1fc3497105300
interfacemethod advancedOtsuAPS(aChannel: Channel, timeStep: int = 0) → MultiROI

Automated Porosity Segmentation: Apply the Single Material (Advanced Otsu) method

Parameters:

  • aChannel (ORSModel.ors.Channel) – The Channel to apply the method from

  • timeStep (int) – The time step of the dataset

Returns:

output (ORSModel.ors.MultiROI) – the output MultiROI that is the result of the Single Material (Advanced Otsu) method

interfacemethod applyStyle(roi_porosity: ROI, roi_material: ROI) → Tuple[ROI, ROI]

Set the colors and visibility of the porosity and material ROIs

Parameters:
Returns:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

interfacemethod separatePorosityAndMaterial(aROI: ROI, aChannel: Channel, timeStep: int = 0, aProgress: Progress = None) → Tuple[ROI, ROI]

Perform morphological operations to separate the material and the porosity

Parameters:
Returns:

alignAxisOfMesh_94a5bb9efbed11e88c98ace010b22dc1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.alignAxisOfMesh_94a5bb9efbed11e88c98ace010b22dc1.alignAxisOfMesh_94a5bb9efbed11e88c98ace010b22dc1
interfacemethod alignAxis(fixedMesh: Mesh, movingMesh: Mesh, timestep: int) → None

Align meshes using their inerti tensor

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

alignAxisOfRoi_1de86770fbd711e79a810cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.alignAxisOfRoi_1de86770fbd711e79a810cc47aab53c3.alignAxisOfRoi_1de86770fbd711e79a810cc47aab53c3
interfacemethod alignAxisOfInertia(fixedROI: ROI, movingROI: ROI, timestep: int) → None

Align the movingROI and fixedROI inertia tensor

Parameters:

  • fixedROI (ORSModel.ors.ROI) – reference ROI

  • movingROI (ORSModel.ors.ROI) – the ROI to move

  • movingROI – the ROI to move

  • timestep (int) – timestep of reference

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

alignCurrentViewNormalWithRulerLength_ac2d27c8d62811e986aa448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.alignCurrentViewNormalWithRulerLength_ac2d27c8d62811e986aa448a5b87686a.alignCurrentViewNormalWithRulerLength_ac2d27c8d62811e986aa448a5b87686a
interfacemethod alignCurrentViewNormalWithRuler(ruler: VisualRuler, layoutGenealogicalName: str) → None

Aligns the current view normal to the ruler.

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

alignStructuredGridWithWorldAxis_f4ee4af41aec11f0b1deb0dcef6e1d2d

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.alignStructuredGridWithWorldAxis_f4ee4af41aec11f0b1deb0dcef6e1d2d.alignStructuredGridWithWorldAxis_f4ee4af41aec11f0b1deb0dcef6e1d2d
interfacemethod alignWithWorldAxis(structuredGrid: StructuredGrid) → None

Align a StructuredGrid with world axis: (1 0 0), (0 1 0), (0 0 1)

Parameters:

structuredGrid (ORSModel.ors.StructuredGrid) – The StructuredGrid to align

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

alignViewWithCurrentVisualPointsLeastMeanSquarePlane_053d7978347a11e997ab0cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.alignViewWithCurrentVisualPointsLeastMeanSquarePlane_053d7978347a11e997ab0cc47aab53c3.alignViewWithCurrentVisualPointsLeastMeanSquarePlane_053d7978347a11e997ab0cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod setViewFromVisualPoints(viewGenealogicalName: str, visualPoints: VisualPoints, timestep: int) → None
Parameters:

  • viewGenealogicalName (str) – a view name

  • visualPoints (ORSModel.ors.VisualPoints) – a VisualPoint object

  • timestep (int) – current time step

alignWithView

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.alignWithView.AlignWithView
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)

To Be reimplemented :param aCollectionOfObjects: :return:

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects –

Returns:

output – str

align_centroid_175ebbe4cba311e7af0b107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.align_centroid_175ebbe4cba311e7af0b107b441a0862.align_centroid_175ebbe4cba311e7af0b107b441a0862
interfacemethod alignByCentroid(alignObject: Union[ROI, MultiROI, Channel, Mesh, VisualShape3D], referenceObject: Union[ROI, MultiROI, Channel, Mesh, VisualShape3D], iTIndex: int = 0) → None

Align centroid of alignObject with the centroid of referenceObject. Translation only is supported

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

angleOfNormalsAgainstZAxis_d7a49940d29611e9bae1ace010b21c91

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.angleOfNormalsAgainstZAxis_d7a49940d29611e9bae1ace010b21c91.angleOfNormalsAgainstZAxis_d7a49940d29611e9bae1ace010b21c91
interfacemethod addAngleOfNormalsAgainstZAxisVErtexScalarValue(mesh: Mesh) → None

Add vertex normal angle between Z Axis as a scalar value

Parameters:

mesh (ORSModel.ors.Mesh) – source Mesh

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

applytransformationfrom_bcab2758e4e811e7bdee107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.applytransformationfrom_bcab2758e4e811e7bdee107b441a0862.applytransformationfrom_bcab2758e4e811e7bdee107b441a0862
interfacemethod applyTransformationFrom(refObj: Union[ROI, MultiROI, Channel, Mesh, Annotation], movingObj: Union[ROI, MultiROI, Channel, Mesh, Annotation]) → None

Apply all transformation matrix 4x4 of an ors object (refObj) to an other (movingObj)

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

applytranslationtoscalarvalues_a1132d96526711ea8cc40c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.applytranslationtoscalarvalues_a1132d96526711ea8cc40c9d9276653a.applytranslationtoscalarvalues_a1132d96526711ea8cc40c9d9276653a
interfacemethod applyTranslationToScalarValues(currentObject: UnstructuredGrid, helperClass: OrsUnstructuredGridScalarValueHelper, referenceSlotIndex: int, slope: float, offset: float, tStep: int) → None
Parameters:

  • currentObject (ORSModel.ors.UnstructuredGrid) – an unstructured grid

  • helperClass (transient OrsUnstructuredGridScalarValueHelper) – scalar values helper class

  • referenceSlotIndex (int) – scalar value slot index

  • slope (float) – slope

  • offset (float) – offset

  • tStep (int) – time step

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

attachPlaneToVisual_325acbe2aba422e6af0c227c341a1762

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.attachPlaneToVisual_325acbe2aba422e6af0c227c341a1762.attachPlaneToVisual_325acbe2aba422e6af0c227c341a1762
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

changeunitofscalarvaluesslot_1d0227f4d66111eabd230c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.changeunitofscalarvaluesslot_1d0227f4d66111eabd230c9d9276653a.changeunitofscalarvaluesslot_1d0227f4d66111eabd230c9d9276653a
interfacemethod changeUnitOfScalarValuesSlot(currentObject: UnstructuredGrid, slotIndex: int, scalarValueDimensionUnit: DimensionUnit = None, tStep: int = 0) → None

Sets a dimension unit to a scalar slot of an UnstructuredGrid or MultiROI

Parameters:
interfacemethod changeUnitOfScalarValuesSlotOfMultiROI(currentObject: MultiROI, helperClass: OrsLabeledMultiRoiScalarValueHelper, slotIndex: int, scalarValueDimensionUnit: DimensionUnit = None, tStep: int = 0, unitID: CxvUniverse_Dimension = None) → None

Sets a unitID to a scalar slot of a MultiROI

Deprecated since version 2026.1.

Changed in version Using: a DimensionUnit instance instead of a CxvUniverse_Dimension IntEnum

Parameters:

  • currentObject (ORSModel.ors.MultiROI) – a multiROI

  • helperClass (transient OrsLabeledMultiRoiScalarValueHelper) – scalar values helper class

  • slotIndex (int) – slot index of scalar values

  • scalarValueDimensionUnit (ORSModel.ors.DimensionUnit) – dimension unit to convert to

  • tStep (int) – time step

  • unitID (IntEnum CxvUniverse_Dimension) [deprecated: use scalarValueDimensionUnit instead] – unitID to convert to

interfacemethod changeUnitOfScalarValuesSlotOfUnstructuredGrid(currentObject: UnstructuredGrid, helperClass: OrsUnstructuredGridScalarValueHelper, slotIndex: int, scalarValueDimensionUnit: DimensionUnit = None, tStep: int = 0, unitID: CxvUniverse_Dimension = None) → None

Sets a unitID to a scalar slot of an UnstructuredGrid

Deprecated since version 2026.1.

Changed in version Using: a DimensionUnit instance instead of a CxvUniverse_Dimension IntEnum

Parameters:

  • currentObject (ORSModel.ors.UnstructuredGrid) – an unstructured grid

  • helperClass (transient OrsUnstructuredGridScalarValueHelper) – scalar values helper class

  • slotIndex (int) – slot index of scalar values

  • scalarValueDimensionUnit (ORSModel.ors.DimensionUnit) – dimension unit to convert to

  • tStep (int) – time step

  • unitID (IntEnum CxvUniverse_Dimension) [deprecated: use scalarValueDimensionUnit instead] – unitID to convert to

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

closeHolesROI_c4110caee83411e8b915b3445026216c

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.closeHolesROI_c4110caee83411e8b915b3445026216c.closeHolesROI_c4110caee83411e8b915b3445026216c
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

combineAutomatedPorositySegmentation_1528286d9dac4c4fad85cd009e663cd4

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.combineAutomatedPorositySegmentation_1528286d9dac4c4fad85cd009e663cd4.combineAutomatedPorositySegmentation_1528286d9dac4c4fad85cd009e663cd4
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

computeGaussianCurvature_429e1126c75d11e9864aace010b21c91

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.computeGaussianCurvature_429e1126c75d11e9864aace010b21c91.computeGaussianCurvature_429e1126c75d11e9864aace010b21c91
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

computeGraphFromROI_af930840b05511e8b3cd448a5b5d70c0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.computeGraphFromROI_af930840b05511e8b3cd448a5b5d70c0.computeGraphFromROI_af930840b05511e8b3cd448a5b5d70c0
interfacemethod computeGraphFromROI(aROI: ROI, aProgress: Progress = None) → Graph

Computes the connectivity graph from a ROI

Parameters:
Returns:

aGraph (ORSModel.ors.Graph) – resulting graph

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, on which the menu item can be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation on which the menu item will be applied.

computeInterfacialSurface_52eb037a6e7d11e8ae36107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.computeInterfacialSurface_52eb037a6e7d11e8ae36107b441a0862.computeInterfacialSurface_52eb037a6e7d11e8ae36107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected.+ :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

computeMeanCurvature_879e6fcec75c11e9864aace010b21c91

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.computeMeanCurvature_879e6fcec75c11e9864aace010b21c91.computeMeanCurvature_879e6fcec75c11e9864aace010b21c91
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

computeraytracingthickness_5db3bc80c23e11eb91080c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.computeraytracingthickness_5db3bc80c23e11eb91080c9d9276653a.computeraytracingthickness_5db3bc80c23e11eb91080c9d9276653a
interfacemethod computeRayTracingThickness(aMesh: Mesh, tStep: int) → None

Compute the thickness by ray-tracing of the mesh and add it as a new scalar values slot.

Parameters:

  • aMesh (ORSModel.ors.Mesh) – a mesh on which to compute the thickness

  • tStep (int) – time step

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

convexHull_2e49bedcbf4011e79a12c860009a272e

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.convexHull_2e49bedcbf4011e79a12c860009a272e.convexHull_2e49bedcbf4011e79a12c860009a272e
interfacemethod convexHullROI(aROI: ROI, binning: int) → ROI

Return the convex hull of a ROI as a filled ROI

Parameters:

  • aROI (ORSModel.ors.ROI) – the source ROI

  • binning (int) – the binning of the operation

Returns:

newROI (ORSModel.ors.ROI) – the created ROI

interfacemethod getConvexHullAsAFilledMultiROI(aMROI: MultiROI, binning: int) → MultiROI

Return the convex hull of a MultiROI as a filled MultiROI

Parameters:
Returns:

newMultiROI (ORSModel.ors.MultiROI) – the created MultiROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu, Menu2

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

convex_hull_empty_709f991ec95511e78823107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.convex_hull_empty_709f991ec95511e78823107b441a0862.convex_hull_empty_709f991ec95511e78823107b441a0862
interfacemethod getConvexHullAsAnAnOuterShellEmptyROI(aROI: ROI, binning: int) → ROI

Return the convex hull of a ROI as an Outer Shell ROI

Parameters:

  • aROI (ORSModel.ors.ROI) – the source ROI

  • binning (int) – the binning of the operation

Returns:

newROI (ORSModel.ors.ROI) – the created ROI

interfacemethod getConvexHullAsAnOuterShellMultiROI(aMROI: MultiROI, binning: int) → MultiROI

Return the convex hull of a Multi-ROI as an Outer Shell ROI

Parameters:
Returns:

newMultiROI (ORSModel.ors.MultiROI) – the convex hull created

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be

applied.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

convex_hull_mesh_8e0ea490c95e11e7ac9e107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.convex_hull_mesh_8e0ea490c95e11e7ac9e107b441a0862.convex_hull_mesh_8e0ea490c95e11e7ac9e107b441a0862
interfacemethod convexHullMultiROIToAMesh(aMROI: MultiROI, binning: int) → MultiROI

Creates a new ROI or MultiROI by cropping an original ROI or MultiROI with his bounding box.

Parameters:
Returns:

newMultiROI (ORSModel.ors.MultiROI) – the created MultiROI

interfacemethod convexHullROIToAMesh(aROI: ROI, binning: int) → None

Creates Mesh by cropping an original ROI or MultiROI with his bounding box.

Parameters:

  • aROI (ORSModel.ors.ROI) – the source ROI

  • binning (int) – the binning of the operation

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be

applied.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item

will be applied.

copyVisualOverlay_3fe18b2ed6d611e7ba11107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.copyVisualOverlay_3fe18b2ed6d611e7ba11107b441a0862.copyVisualOverlay_3fe18b2ed6d611e7ba11107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be

applied.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

createaruler_32589bccda7d11eabfe3ace010b21c91

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createaruler_32589bccda7d11eabfe3ace010b21c91.createaruler_32589bccda7d11eabfe3ace010b21c91
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

createAVisualBezierPatchFromAVisualRectangle_50424c73a94211ebba6f00d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createAVisualBezierPatchFromAVisualRectangle_50424c73a94211ebba6f00d861065303.createAVisualBezierPatchFromAVisualRectangle_50424c73a94211ebba6f00d861065303
interfacemethod createVisualBezierPatchFromVisualRectangle(aVisualRegion: VisualRegion, xNodeCount: int = 5, yNodeCount: int = 5) → VisualBezierPatch

Creates a VisualBezierPatch from a VisualRegion

Parameters:

  • aVisualRegion (ORSModel.ors.VisualRegion) – a VisualRegion to define the projection surface of the Visual

  • xNodeCount (int) – number of control points in the x axis of the rectangle

  • yNodeCount (int) – number of control points in the y axis of the rectangle

Returns:

aVisualBezierPatch (ORSModel.ors.VisualBezierPatch) – created VisualBezierPatch

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

CreateChannelsFromScalars_e7c2a2401b5c11ea94b20c9d927663a1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.CreateChannelsFromScalars_e7c2a2401b5c11ea94b20c9d927663a1.CreateChannelsFromScalars_e7c2a2401b5c11ea94b20c9d927663a1
interfacemethod createChannelFromScalar(multiROI: MultiROI, scalarIndex: int) → None

Create Channel From Scalar

Parameters:
interfacemethod createChannelsFromSelectedScalars(multiROI: MultiROI) → None

Create Channels From selected Scalars

Parameters:

multiROI (ORSModel.ors.MultiROI) – source Multi-ROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)
Returns:

output – Menu item

interfacemethod getScalarsValuesDescriptions(multiROI: MultiROI) → None

Fill Multi-ROI with new label

Parameters:

multiROI (ORSModel.ors.MultiROI) – source Multi-ROI

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected.

createeuclideanlengthscalarvalues_88dbed4064a411ea97ff0c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createeuclideanlengthscalarvalues_88dbed4064a411ea97ff0c9d9276653a.CreateEuclideanLengthScalarValues_88dbed4064a411ea97ff0c9d9276653a
interfacemethod createEuclidianLengthScalarValues(currentObject: Graph, tStep: int) → None

Deprecated since version 2024.1: Use EdgeLengthMeasurement.computeEdgeLengthMeasurement

Parameters:

createGraphFromMultiROI

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createGraphFromMultiROI.CreateGraphFromMultiROI
interfacemethod createGraphFromMultiROI(multiROI: MultiROI, aProgress: Progress = None) → Graph

Creates a Graph from MultiROI

Parameters:
Returns:

aGraphFromMultiROI (ORSModel.ors.Graph) – created Graph

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects –

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects –

Returns:

output – str

createMultiROIFromROIs

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createMultiROIFromROIs.CreateMultiROIFromROIs
interfacemethod createMultiROIFromROIs(aListOfROIs: List[ROI], IProgress: Progress = None, keepEmpty: bool = False) → MultiROI

Creates a MultiROI by copying each input ROI in a label

Parameters:

  • aListOfROIs (ORSModel.ors.ROI) [count=[0, None]] – list of ROIs to put in each label

  • IProgress (ORSModel.ors.Progress) – progress object

  • keepEmpty (bool) – flag to keep empty labels in multi ROI

Returns:

aMultiROI (ORSModel.ors.MultiROI) – created MultiROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects –

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects –

Returns:

output – str

createROIFromAnnotation_7ca2021f944f11ee877b64bc58c0ae6c

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createROIFromAnnotation_7ca2021f944f11ee877b64bc58c0ae6c.createROIFromAnnotation_7ca2021f944f11ee877b64bc58c0ae6c
interfacemethod createROIFromAnnotation(annotation: Annotation, refObj: StructuredGrid) → ROI

Create an ROI from an annotation

Parameters:
Returns:

roi (ORSModel.ors.ROI) – new roi

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

createROIFromTouchingVoxel_ef0d93b2a8ba11eda498ac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createROIFromTouchingVoxel_ef0d93b2a8ba11eda498ac12039c05e0.CreateROIFromTouchingVoxel_ef0d93b2a8ba11eda498ac12039c05e0
interfacemethod createROIFromTouchingVoxel(aMultiROI: MultiROI) → ROI

Create a ROI containing the touching voxels of touching labels

Parameters:

aMultiROI (ORSModel.ors.MultiROI) – the structuredGrid to derived

Returns:

outROI (ORSModel.ors.ROI) – a ROI containing the touching voxel

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

createRulerBetweenSpheres_7f6612135ea511edb349ac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createRulerBetweenSpheres_7f6612135ea511edb349ac12039c05e0.createRulerBetweenSpheres_7f6612135ea511edb349ac12039c05e0
interfacemethod createRulerBetweenSpheres(sphere1: VisualSphere, sphere2: VisualSphere, timestep: int) → ORSModel.ors.VisualRuler | None

Creates a ruler between the centers of two visual spheres

Parameters:
Returns:

output (ORSModel.ors.VisualRuler) – Created ruler or None if creation fails

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected

Returns:

output – if True, the menu item will be displayed

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item

Parameters:

aCollectionOfObjects – a list of objects currently being selected

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected

createVisualBoxFromBoundingBox_df18ee80548711e8b181107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createVisualBoxFromBoundingBox_df18ee80548711e8b181107b441a0862.createVisualBoxFromBoundingBox_df18ee80548711e8b181107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

createVisualBoxFromBox_df18ee80548711e8b181107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createVisualBoxFromBox_df18ee80548711e8b181107b441a0862.createVisualBoxFromBox_df18ee80548711e8b181107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

createVisualBoxFromClipBox_df18ee80548711e8b181107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createVisualBoxFromClipBox_df18ee80548711e8b181107b441a0862.createVisualBoxFromClipBox_df18ee80548711e8b181107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

createVisualRBFRectangleFromRectangleAnnotation_6c95e9a9ac7711eba773181deae8b779

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.createVisualRBFRectangleFromRectangleAnnotation_6c95e9a9ac7711eba773181deae8b779.createVisualRBFRectangleFromRectangleAnnotation_6c95e9a9ac7711eba773181deae8b779
interfacemethod createVisualRBFRectangleFromVisualRectangle(aVisualRegion: VisualRegion, xNodeCount: int = 3, yNodeCount: int = 3) → VisualRBFRectangle

Creates a VisualRBFRectangle from a VisualRegion

Parameters:

  • aVisualRegion (ORSModel.ors.VisualRegion) – a VisualRegion to define the projection surface of the Visual

  • xNodeCount (int) – number of control points in the x axis of the rectangle

  • yNodeCount (int) – number of control points in the y axis of the rectangle

Returns:

aVisualRBFRectangle (ORSModel.ors.VisualRBFRectangle) – created VisualRBFRectangle

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

create_dense_multiroi_bced11c20d5611ea9fd5c86000a21918

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.create_dense_multiroi_bced11c20d5611ea9fd5c86000a21918.create_dense_multiroi_bced11c20d5611ea9fd5c86000a21918
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

cropRoiOrMultiROIToBoundingBox_8f5b7ad4372011e7bd890cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.cropRoiOrMultiROIToBoundingBox_8f5b7ad4372011e7bd890cc47aab53c3.cropRoiOrMultiROIToBoundingBox_8f5b7ad4372011e7bd890cc47aab53c3
interfacemethod cropROIOrMultiROIToBoundingBox(aSourceROIOrMultiROI: Union[ROI, MultiROI], needToBePublished: bool = True) → Union[ROI, MultiROI]

Creates a new ROI or MultiROI by cropping an original ROI or MultiROI with his bounding box.

Parameters:
Returns:

newROIOrMultiROI (ORSModel.ors.ROI, ORSModel.ors.MultiROI) – the created ROI or MultiROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu will be applied.

cutInvertMeshWithVisualBox_fe34fda15542abcd2c3b2e414d6e03d2

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.cutInvertMeshWithVisualBox_fe34fda15542abcd2c3b2e414d6e03d2.cutInvertMeshWithVisualBox_fe34fda15542abcd2c3b2e414d6e03d2
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

cutMeshWithVisualBox_baef2363232128fb8c3b1d2d416403cd

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.cutMeshWithVisualBox_baef2363232128fb8c3b1d2d416403cd.cutMeshWithVisualBox_baef2363232128fb8c3b1d2d416403cd
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

cutplanefrompoints_4ef8c666425e11e88267448a5b877501

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.cutplanefrompoints_4ef8c666425e11e88267448a5b877501.cutplanefrompoints_4ef8c666425e11e88267448a5b877501
classmethod createOneSliceChannelFromChannelandVisualPoint(channel, visualPoints)

Creates a new Channel of one slice from a plane computed by the least square of the visualPoints.

Parameters:

  • channel – the source Channel

  • visualPoints – the annotation points

Returns:

newChannel (ORSModel.ors.Channel) – the created channel

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

deletescalarvalueslot_52bf8334f71611e79588107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.deletescalarvalueslot_52bf8334f71611e79588107b441a0862.deletescalarvalueslot_52bf8334f71611e79588107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

dijkstraShortestPathMap_637b81782f6e11e7bb92ace010b22dc1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.dijkstraShortestPathMap_637b81782f6e11e7bb92ace010b22dc1.dijkstraShortestPathMap_637b81782f6e11e7bb92ace010b22dc1
interfacemethod dijkstra(channel: Channel, roi: ROI, roiMask: ROI) → Channel

Compute the Dijkstra shortest path from roi in channel landscape

Parameters:
Returns:

shortestPathMap (ORSModel.ors.Channel) – the shortest path map from roi in channel landscap

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

distanceFromPointSet_f5f248c2ffcb11e9bf110cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.distanceFromPointSet_f5f248c2ffcb11e9bf110cc47aab53c3.distanceFromPointSet_f5f248c2ffcb11e9bf110cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod scalarForDistance(unstrutured: UnstructuredGrid, visualPoint: VisualPoints, currentTimeStep: int) → None

Copies the first dataset into the second dataset.

Parameters:

editVisualBox_9dd6bd8c1e9711e9b025107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.editVisualBox_9dd6bd8c1e9711e9b025107b441a0862.editVisualBox_9dd6bd8c1e9711e9b025107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

executeCommand

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.executeCommand.ExecuteCommand
classmethod getMenuItem()

Returns the menu item, a Menu object :return: Menu

exportGDT

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportGDT.ExportGDT
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)

To Be reimplemented :param aCollectionOfObjects: :return:

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects –

Returns:

output – str

exportimagetovtk_619fe5941df711eb80110c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportimagetovtk_619fe5941df711eb80110c9d9276653a.exportimagetovtk_619fe5941df711eb80110c9d9276653a
interfacemethod generateVTKFile(ORSChannel: Channel, selectedFilename: str) → bool
Parameters:

  • ORSChannel (ORSModel.ors.Channel) – a Channel

  • selectedFilename (file saving) – file selected in file dialog

Anonymize selectedFilename:

True

Returns:

output (bool) – True if successful, False otherwise

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item

will be applied.

exportIntensityDistributionToCSV_ed26fc57776711ef80d1fc3497105300

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportIntensityDistributionToCSV_ed26fc57776711ef80d1fc3497105300.exportIntensityDistributionToCSV_ed26fc57776711ef80d1fc3497105300
classmethod exportIntensityDistributionToCSV(intensities: ArrayDouble, counts: ArrayUnsignedLONGLONG, filename)

Export the intensity distribution to a CSV file.

Parameters:
Anonymize filename:

True

classmethod getIntensityDistribution(aChannel: Channel = None, aMask: ROI = None)

Get the intensity distribution of o Channel with or without a mask.

Parameters:
Returns:

output (tuple) – A tuple containing a success flag (bool), intensities (ArrayDouble), and counts (ArrayUnsignedLONGLONG).

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

exportLabelHistogramLineBased_5b48ed805a6711ebb16800d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportLabelHistogramLineBased_5b48ed805a6711ebb16800d861065303.exportLabelHistogramLineBased_5b48ed805a6711ebb16800d861065303
interfacemethod exportSelectedLabelsHistogramsToCSVLineBased(multiROI: MultiROI, channel: Channel, filename: str, timeStep: int) → None

Export labels histogram line based, where each line refers to a label. The columns are labeled with the minimum value of the corresponding bin.

Parameters:

  • multiROI (ORSModel.ors.MultiROI) – MultiROI to extract the histogram from

  • channel (ORSModel.ors.Channel) – the channel to extract the histogram from

  • filename (file saving) – CSV file name

  • timeStep (int) – time step

Anonymize filename:

True

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

exportROIAsBinary_cfdc4c58867011e888c684a6c8f5618e

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportROIAsBinary_cfdc4c58867011e888c684a6c8f5618e.exportROIAsBinary_cfdc4c58867011e888c684a6c8f5618e
interfacemethod exportROIAsBinary(refChannel: Channel, refROI: ROI) → None

Export a ROI as Binary

Parameters:
interfacemethod exportROIAsBinaryV2(refROI: ROI) → bool

Export a ROI as Binary

Parameters:

refROI (ORSModel.ors.ROI) – a ROI

Returns:

output (bool) – True if the export worked. False otherwise

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

exportscalarvalues_a26c8f7c029611eba7fc0c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportscalarvalues_a26c8f7c029611eba7fc0c9d9276653a.exportscalarvalues_a26c8f7c029611eba7fc0c9d9276653a
interfacemethod exportScalarValues(currentObject: UnstructuredGrid, slotsToExport: List[int], exportWithCoordinates: bool, tStep: int) → None
Parameters:

  • currentObject (ORSModel.ors.UnstructuredGrid) – an unstructued grid

  • slotsToExport (int) [count=[1, None]] – list of the slots to export

  • exportWithCoordinates (bool) – export with XYZ coordinates

  • tStep (int) – time step

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

exportTetrahedralMesh_913ff686e38011eca96f3085a98ef62d

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportTetrahedralMesh_913ff686e38011eca96f3085a98ef62d.exportTetrahedralMesh_913ff686e38011eca96f3085a98ef62d
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item

could be applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Return the menu item. :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod interfaceTo3DMeshNetGenWriter(pInput3DMesh: FaceVertexMesh, pTimeStamp: int, pFileName: str, pMeshFileFormat: str) → None

Transform the input FaceVertexMesh mesh into tetrahedra and boundary triangles such as to build a NetGen 3D mesh. Then, use the NetGen file writer to output this 3D mesh into a file readable by the rest of the world.

Parameters:

  • pInput3DMesh (ORSModel.ors.FaceVertexMesh) – A FaceVertexMesh that contains a partial implementation of a compact half-face tetrahedral mesh.

  • pTimeStamp (int) – The time index

  • pFileName (str) – Complete path, file name and file extension in one string.

  • pMeshFileFormat (str) – File format to use.

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

exportToCZI_7553214c3ce811e88398448a5bd787f8

exportVectorField_798fa4243e1d11ea86fc448a5b8e0ef8

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.exportVectorField_798fa4243e1d11ea86fc448a5b8e0ef8.exportVectorField_798fa4243e1d11ea86fc448a5b8e0ef8
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extract3DUnwrapFromStructuredGrid_396e3034751a11ea9d3488d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extract3DUnwrapFromStructuredGrid_396e3034751a11ea9d3488d861065303.extract3DUnwrapFromStructuredGrid_396e3034751a11ea9d3488d861065303
classmethod getIsSelectionValid(aCollectionOfObjects, implementation=None)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation=None)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extractActionLogForObject_f1915708ba4c11ea8d1c309c235e8fdb

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extractActionLogForObject_f1915708ba4c11ea8d1c309c235e8fdb.extractActionLogForObject_f1915708ba4c11ea8d1c309c235e8fdb
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extractBoxFromChannel_bdfbc9a8110b11e8819130e37aed33ab

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extractBoxFromChannel_bdfbc9a8110b11e8819130e37aed33ab.extractBoxFromChannel_bdfbc9a8110b11e8819130e37aed33ab

This class is kept for compatibility with older version macro’s. The new version of the functionality are in the class extractStructuredGridFromShape_a2f058ba3c3b11e9bf73448a5b87686a.

interfacemethod createDatasetFromVisualBox(sourceDataset: Channel, visualBox: VisualBox, timestep: int, title: str) → Channel

Extracts the subset of a dataset in the region defined by a box

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.Channel) – created Channel from VisualBox

interfacemethod createMultiROIFromVisualBox(sourceDataset: MultiROI, visualBox: VisualBox, timestep: int, title: str) → MultiROI

Extracts the subset of a MultiROI in the region defined by a box

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.MultiROI) – created MultiROI from VisualBox

interfacemethod createROIFromVisualBox(sourceDataset: ROI, visualBox: VisualBox, timestep: int, title: str) → ROI

Extracts the subset of a ROI in the region defined by a box

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.ROI) – created ROI from VisualBox

ExtractDatasetFromPath_b4667e648b2911eb911e00d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.ExtractDatasetFromPath_b4667e648b2911eb911e00d861065303.ExtractDatasetFromPath_b4667e648b2911eb911e00d861065303
interfacemethod extractDatasetFromPath(visualPath: VisualPath, aDataset: Channel, radiusInPixel: int, timestep: int) → Channel

Copies the first dataset into the second dataset.

Parameters:
Returns:

outData (ORSModel.ors.Channel) – created Channel

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extractROIs_026bbe94998911e881c30cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extractROIs_026bbe94998911e881c30cc47aab53c3.extractROIs_026bbe94998911e881c30cc47aab53c3
interfacemethod extractROIsFromChannel(sourceDataset: Channel) → List[ROI]

Extracts a ROI per dataset intensity

Parameters:

sourceDataset (ORSModel.ors.Channel) – source dataset

Returns:

listOfROIs (ORSModel.ors.ROI) [count=[0, None]] – list of ROI

interfacemethod extractROIsFromMultiROI(source_multiROI: MultiROI) → List[ROI]

Extracts a ROI per MultiROI (not empty) label

Parameters:

source_multiROI (ORSModel.ors.MultiROI) – source dataset

Returns:

listOfROIs (ORSModel.ors.ROI) [count=[0, None]] – list of ROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extractSlabAroundCenter_f3bc9ad1cfde11ed90a9ac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extractSlabAroundCenter_f3bc9ad1cfde11ed90a9ac12039c05e0.extractSlabAroundCenter_f3bc9ad1cfde11ed90a9ac12039c05e0
interfacemethod extractChannelSlabAroundDirection2AtAngle(aChannel: Channel, angle: float, timestep: int, slabSliceCount: int) → Channel

Extract Slab from the middle of a Channel around the z axis (direction 2), for a given timestep

Parameters:

  • aChannel (ORSModel.ors.Channel) – source aChannel

  • angle (float) – the angle of the slab, in radian

  • timestep (int) – time step top extract from

  • slabSliceCount (int) – number of slice in output

Returns:

newChannel (ORSModel.ors.Channel) – the created Channel slab

interfacemethod extractMultiROISlabAroundDirection2AtAngle(aMROI: MultiROI, angle: float, timestep: int, slabSliceCount: int) → MultiROI

Extract Slab from the middle of a MultiROI around the z axis (direction 2), for a given timestep

Parameters:

  • aMROI (ORSModel.ors.MultiROI) – source MultiROI

  • angle (float) – the angle of the slab, in radian

  • timestep (int) – time step top extract from

  • slabSliceCount (int) – number of slice in output

Returns:

newMROI (ORSModel.ors.MultiROI) – the created MultiROI slab

interfacemethod extractROISlabAroundDirection2AtAngle(aROI: ROI, angle: float, timestep: int, slabSliceCount: int) → ROI

Extract Slab from the middle of a ROI around the z axis (direction 2), for a given timestep

Parameters:

  • aROI (ORSModel.ors.ROI) – source aROI

  • angle (float) – the angle of the slab, in radian

  • timestep (int) – time step top extract from

  • slabSliceCount (int) – number of slice in output

Returns:

newROI (ORSModel.ors.ROI) – the created ROI slab

interfacemethod extractSlabAroundDirection2AtAngle(aStructuredGrid: StructuredGrid, angle: float, timestep: int, slabSliceCount: int) → StructuredGrid

Extract Slab from the middle of a StructuredGrid around the z axis (direction 2), for a given timestep

Parameters:

  • aStructuredGrid (ORSModel.ors.StructuredGrid) – source StructuredGrid

  • angle (float) – the angle of the slab, in radian

  • timestep (int) – time step top extract from

  • slabSliceCount (int) – number of slice in output

Returns:

newStructuredGrid (ORSModel.ors.StructuredGrid) – the created StructuredGrid slab

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

extractsliceofchannelfromvisualplane_cde343eecfa941d3bafa4bdeb263d94c

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extractsliceofchannelfromvisualplane_cde343eecfa941d3bafa4bdeb263d94c.ExtractSliceOfChannelFromVisualPlane_cde343eecfa941d3bafa4bdeb263d94c
interfacemethod createOneSliceChannelFromChannelandVisualChannel(channel: Channel, visualPlane: VisualPlane, toBePublished: bool = True) → Channel

Creates a new Channel of one slice from a plane computed by the least square of the visualPoints.

Parameters:
Returns:

newChannel (ORSModel.ors.Channel) – the created channel

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extractStructuredGridFromShape_a2f058ba3c3b11e9bf73448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extractStructuredGridFromShape_a2f058ba3c3b11e9bf73448a5b87686a.extractStructuredGridFromShape_a2f058ba3c3b11e9bf73448a5b87686a
interfacemethod createDatasetFromVisualBox(sourceDataset: Channel, visualBox: VisualBox, timestep: int, title: str, interpolationMode: CxvFiltering_Mode = CxvFiltering_Mode.CXV_FILTER_LINEAR) → Channel

Extracts the subset of a dataset in the region defined by a box

Parameters:

  • sourceDataset (ORSModel.ors.Channel) – source dataset

  • visualBox (ORSModel.ors.VisualBox) – a visualBox

  • timestep (int) – a timeStep

  • title (str) – a title

  • interpolationMode (IntEnum CxvFiltering_Mode) – an interpolation Mode (linear, point or cubic)

Anonymize title:

True

Returns:

aDataset (ORSModel.ors.Channel) – created Channel from VisualBox

interfacemethod createDatasetFromVisualCapsule(sourceDataset: Channel, visualCapsule: VisualCapsule, timestep: int, title: str, interpolationMode: CxvFiltering_Mode = CxvFiltering_Mode.CXV_FILTER_LINEAR) → Channel

Extracts the subset of a dataset in the region defined by a Capsule

Parameters:

  • sourceDataset (ORSModel.ors.Channel) – source dataset

  • visualCapsule (ORSModel.ors.VisualCapsule) – a visualCapsule

  • timestep (int) – a timeStep

  • title (str) – a title

  • interpolationMode (IntEnum CxvFiltering_Mode) – an interpolation Mode (linear, point or cubic)

Anonymize title:

True

Returns:

aDataset (ORSModel.ors.Channel) – created Channel from VisualBox

interfacemethod createDatasetFromVisualCylinder(sourceDataset: Channel, visualCylinder: VisualCylinder, timestep: int, title: str, interpolationMode: CxvFiltering_Mode = CxvFiltering_Mode.CXV_FILTER_LINEAR) → Channel

Extracts the subset of a dataset in the region defined by a visualCylinder

Parameters:

  • sourceDataset (ORSModel.ors.Channel) – source dataset

  • visualCylinder (ORSModel.ors.VisualCylinder) – a visualCylinder

  • timestep (int) – a timeStep

  • title (str) – a title

  • interpolationMode (IntEnum CxvFiltering_Mode) – an interpolation Mode (linear, point or cubic)

Anonymize title:

True

Returns:

aDataset (ORSModel.ors.Channel) – created Channel from VisualBox

interfacemethod createDatasetFromVisualSphere(sourceDataset: Channel, visualSphere: VisualSphere, timestep: int, title: str, interpolationMode: CxvFiltering_Mode = CxvFiltering_Mode.CXV_FILTER_LINEAR) → Channel

Extracts the subset of a dataset in the region defined by a visualSphere

Parameters:

  • sourceDataset (ORSModel.ors.Channel) – source dataset

  • visualSphere (ORSModel.ors.VisualSphere) – a visualSphere

  • timestep (int) – a timeStep

  • title (str) – a title

  • interpolationMode (IntEnum CxvFiltering_Mode) – an interpolation Mode (linear, point or cubic)

Anonymize title:

True

Returns:

aDataset (ORSModel.ors.Channel) – created Channel from VisualBox

interfacemethod createMultiROIFromVisualBox(sourceDataset: MultiROI, visualBox: VisualBox, timestep: int, title: str) → MultiROI

Extracts the subset of a MultiROI in the region defined by a visualBox

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.MultiROI) – created MultiROI from VisualBox

interfacemethod createMultiROIFromVisualCapsule(sourceDataset: MultiROI, visualCapsule: VisualCapsule, timestep: int, title: str) → MultiROI

Extracts the subset of a MultiROI in the region defined by a visualCapsule

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.MultiROI) – created MultiROI from VisualBox

interfacemethod createMultiROIFromVisualCylinder(sourceDataset: MultiROI, visualCylinder: VisualCylinder, timestep: int, title: str) → MultiROI

Extracts the subset of a MultiROI in the region defined by a visualCylinder

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.MultiROI) – created MultiROI from VisualBox

interfacemethod createMultiROIFromVisualSphere(sourceDataset: MultiROI, visualSphere: VisualSphere, timestep: int, title: str) → MultiROI

Extracts the subset of a MultiROI in the region defined by a visualSphere

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.MultiROI) – created MultiROI from VisualBox

interfacemethod createROIFromVisualBox(sourceDataset: ROI, visualBox: VisualBox, timestep: int, title: str) → ROI

Extracts the subset of a ROI in the region defined by a box

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.ROI) – created ROI from VisualBox

interfacemethod createROIFromVisualCapsule(sourceDataset: ROI, visualCapsule: VisualCapsule, timestep: int, title: str) → ROI

Extracts the subset of a ROI in the region defined by a visualCapsule

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.ROI) – created ROI from VisualBox

interfacemethod createROIFromVisualCylinder(sourceDataset: ROI, visualCylinder: VisualCylinder, timestep: int, title: str) → ROI

Extracts the subset of a ROI in the region defined by a visualCylinder

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.ROI) – created ROI from VisualBox

interfacemethod createROIFromVisualSphere(sourceDataset: ROI, visualSphere: VisualSphere, timestep: int, title: str) → ROI

Extracts the subset of a ROI in the region defined by a visualSphere

Parameters:
Anonymize title:

True

Returns:

aDataset (ORSModel.ors.ROI) – created ROI from VisualBox

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item can

be applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item

Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item will be applied.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extractStructuredGridProjectionFromShape_6174e45443ee11ebb77000d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extractStructuredGridProjectionFromShape_6174e45443ee11ebb77000d861065303.extractStructuredGridProjectionFromShape_6174e45443ee11ebb77000d861065303
interfacemethod extractProjectionChannelFromShape(shape3D: Shape3D, sourceDataset: Channel, timestep: int) → Channel

Extract Channel from the surface of the Shape3D

Parameters:
Returns:

outDataset (ORSModel.ors.Channel) – the projection channel

interfacemethod extractProjectionChannelFromVisualShape(aVisualShape3D: VisualShape3D, sourceDataset: Channel, timestep: int) → Channel

Extract Channel from the surface of the VisualShape3D

Parameters:
Returns:

outDataset (ORSModel.ors.Channel) – the projection channel

interfacemethod extractProjectionMultiROIFromShape(shape3D: Shape3D, sourceDataset: MultiROI, timestep: int) → MultiROI

Extract MultiROI from the surface of the Shape3D

Parameters:
Returns:

outDataset (ORSModel.ors.MultiROI) – the projection MultiROI

interfacemethod extractProjectionMultiROIFromVisualShape(aVisualShape3D: VisualShape3D, sourceDataset: MultiROI, timestep: int) → MultiROI

Extract MultiROI from the surface of the VisualShape3D

Parameters:
Returns:

outDataset (ORSModel.ors.MultiROI) – the projection MultiROI

interfacemethod extractProjectionROIFromShape(shape3D: Shape3D, sourceDataset: ROI, timestep: int) → ROI

Extract ROI from the surface of the Shape3D

Parameters:
Returns:

outDataset (ORSModel.ors.ROI) – the projection roi

interfacemethod extractProjectionROIFromVisualShape(aVisualShape3D: VisualShape3D, sourceDataset: ROI, timestep: int) → ROI

Extract ROI from the surface of the VisualShape3D

Parameters:
Returns:

outDataset (ORSModel.ors.ROI) – the projection ROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

extract_xml_from_ors_file

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.extract_xml_from_ors_file.ExtractXMLFromORSFile
classmethod getMenuItem()
Returns:

output – Menu

fastMarchingSpeedMap_c0be02122f7711e79b4cace010b22dc1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.fastMarchingSpeedMap_c0be02122f7711e79b4cace010b22dc1.fastMarchingSpeedMap_c0be02122f7711e79b4cace010b22dc1
interfacemethod fastMarching(channel: Channel, roi: ROI) → Channel

Compute the FastMarching speed map from roi in channel landscape

All paths in that group are copied.

Parameters:
Returns:

shortestPathMap (ORSModel.ors.Channel) – the speed map map from roi in channel landscape

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

feretBox_60036864b11811e8bf35107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.feretBox_60036864b11811e8bf35107b441a0862.FeretBox_60036864b11811e8bf35107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be

applied.

Returns:

output – Menu

interfacemethod takeFeretBoxShapeOfObject(visualBox: VisualBox, object: Union[UnstructuredGrid, ROI, MultiROI], iTIndex: int) → bool

Make a visual box take the feret shape of an unstructured grid, a roi or a multi-roi.

Parameters:
Returns:

output (bool) – True if worked, else false

FillMultiRoiWithNewLabel_d8886120061c11ea940d0c9d927663a1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.FillMultiRoiWithNewLabel_d8886120061c11ea940d0c9d927663a1.FillMultiRoiWithNewLabel_d8886120061c11ea940d0c9d927663a1
interfacemethod fillMultiRoiWithNewLabel(multiROI: MultiROI) → None

Fill Multi-ROI with new label

Parameters:

multiROI (ORSModel.ors.MultiROI) – source Multi-ROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)
Returns:

output – Menu item

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected.

findPathROiBetweenRois_52b387fa501e11e9915face010b21c91

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.findPathROiBetweenRois_52b387fa501e11e9915face010b21c91.findPathROiBetweenRois_52b387fa501e11e9915face010b21c91
classmethod dijkstraPath(channel, roiStart, roiEnd, roiMask)

for backward compatibility

interfacemethod dijkstraPathwithGeometricalBias(channel: Channel, roiStart: ROI, roiEnd: ROI, roiMask: ROI, geometricalBias: float) → ROI

Compute the Dijkstra shortest path from roiStart to roiEnd in roiMask in channel landscape.

Deprecated since version 2024.2: use DistanceMapHelper.generateROIAndPathBetweenROIsAlongLanscape instead

Parameters:
Returns:

outROI (ORSModel.ors.ROI) – the shortest path roi

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu will be applied.

fitcylinderfrompointannotation_3352982651c811eb87ee0c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.fitcylinderfrompointannotation_3352982651c811eb87ee0c9d9276653a.FitCylinderFromPointAnnotation_3352982651c811eb87ee0c9d9276653a
interfacemethod generateCylinder(visualPoints: VisualPoints, tStep: int) → VisualCylinder

Generate a cylinder from a set of points.

Parameters:
Returns:

visualCylinder (ORSModel.ors.VisualCylinder) – new VisualCylinder

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

fitcylinderfromunstructuredrid_aefd426bc42aa3df2b765b2b331763dc

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.fitcylinderfromunstructuredrid_aefd426bc42aa3df2b765b2b331763dc.fitcylinderfromunstructuredrid_aefd426bc42aa3df2b765b2b331763dc
interfacemethod generateCylinderFromUnstructuredGrid(grid: UnstructuredGrid, tStep: int) → VisualCylinder

Generate a plane from a set of points.

Parameters:
Returns:

visualCylinder (ORSModel.ors.VisualCylinder) – new VisualCylinder

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

fitplanefrompointannotation_cbd14874534126fc8a5a0d1d123443ba

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.fitplanefrompointannotation_cbd14874534126fc8a5a0d1d123443ba.FitPlaneFromPointAnnotation_cbd14874534126fc8a5a0d1d123443ba
interfacemethod generatePlaneFromPoints(visualPoints: VisualPoints, tStep: int) → VisualPlane

Generate a plane from a set of points.

Parameters:
Returns:

visualPlane (ORSModel.ors.VisualPlane) – new VisualPlane

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

fitplanefromunstructuredrid_bac2516ab3b412cf1a2a0a2b4212b3ca

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.fitplanefromunstructuredrid_bac2516ab3b412cf1a2a0a2b4212b3ca.fitplanefromnstructuredrid_bac2516ab3b412cf1a2a0a2b4212b3ca
interfacemethod generatePlaneFromUnstructuredGrid(grid: UnstructuredGrid, tStep: int) → VisualPlane

Generate a plane from a set of points.

Parameters:
Returns:

visualPlane (ORSModel.ors.VisualPlane) – new VisualPlane

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

fitspherefrompointannotation_dad34866544311eb8a4f0c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.fitspherefrompointannotation_dad34866544311eb8a4f0c9d9276653a.FitSphereFromPointAnnotation_dad34866544311eb8a4f0c9d9276653a
interfacemethod generateSphere(visualPoints: VisualPoints, tStep: int) → VisualSphere

Generate a sphere from a set of points.

Parameters:
Returns:

visualSphere (ORSModel.ors.VisualSphere) – new VisualSphere

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

fitspherefromunstructuredrid_ecdedf83d65ba4da2c3221bc4261abb

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.fitspherefromunstructuredrid_ecdedf83d65ba4da2c3221bc4261abb.fitspherefromunstructuredrid_ecdedf83d65ba4da2c3221bc4261abb
interfacemethod generateSphereFromUnstructuredGrid(grid: UnstructuredGrid, tStep: int) → VisualSphere

Generate a plane from a set of points.

Parameters:
Returns:

visualSphere (ORSModel.ors.VisualSphere) – new VisualSphere

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

forwardSH_a6cb9caaa3b411ec929afc349710ebf3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.forwardSH_a6cb9caaa3b411ec929afc349710ebf3.forwardSH_a6cb9caaa3b411ec929afc349710ebf3
classmethod getMenuItem()
Returns:

output – Menu item

generateDragonflyVSCodeWorkspace

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.generateDragonflyVSCodeWorkspace.GenerateDragonflyVSCodeWorkspace
classmethod getMenuItem()

Returns the menu item, a Menu object :return: Menu

generateinterfacialmesh_84b0f16e403a11e99ecf107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.generateinterfacialmesh_84b0f16e403a11e99ecf107b441a0862.GenerateInterfacialMesh_84b0f16e403a11e99ecf107b441a0862
classmethod generateAndPublishInterfacialSurface(collectionString)

Generates and Publish an interfacial surface between ROIs and multiROIs. This function also ask the user for the wished output mesh type. For now, marching cubes (normal) mesh, cubic mesh and normal sampled are supported.

Parameters:

collectionString – a list of objects representation currently being selected, i.e. on which the menu item will be applied.

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be

applied.

Returns:

output – Menu

generateMeshTubeFromPath_aa81f8e888cb11ebbd140c9d9276734f

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.generateMeshTubeFromPath_aa81f8e888cb11ebbd140c9d9276734f.generateMeshTubeFromPath_aa81f8e888cb11ebbd140c9d9276734f
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

generateSurfaceMeshFromRBFRectangle_d29bf1816bbc11efbb8f08bfb84feabc

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.generateSurfaceMeshFromRBFRectangle_d29bf1816bbc11efbb8f08bfb84feabc.generateSurfaceMeshFromRBFRectangle_d29bf1816bbc11efbb8f08bfb84feabc
interfacemethod generateMeshFromRBFRectangle(aRBFRectangle: RBFRectangle, xNodeCount: int = 3, yNodeCount: int = 3) → FaceVertexMesh

Create a FaceVertexMesh form an RBFRectangle

Parameters:

  • aRBFRectangle (ORSModel.ors.RBFRectangle) – a RBFRectangle from wich we will extract the mesh from

  • xNodeCount (int) – number of mesh vertices along the x-axis of the underlying rectangle

  • yNodeCount (int) – number of mesh vertices along the y-axis of the underlying rectangle

Returns:

aFaceVertexMesh (ORSModel.ors.FaceVertexMesh) – created FaceVertexMesh

interfacemethod generateMeshFromVisualRBFRectangle(aVisualRBFRectangle: VisualRBFRectangle, xNodeCount: int = 3, yNodeCount: int = 3, iTIndex: int = 0) → FaceVertexMesh

Create a FaceVertexMesh form a VisualRBFRectangle

Parameters:

  • aVisualRBFRectangle (ORSModel.ors.VisualRBFRectangle) – a VisualRBFRectangle from wich we will extract the mesh from

  • xNodeCount (int) – number of mesh vertices along the x-axis of the underlying rectangle

  • yNodeCount (int) – number of mesh vertices along the y-axis of the underlying rectangle

  • iTIndex (int) – current time step

Returns:

aFaceVertexMesh (ORSModel.ors.FaceVertexMesh) – created FaceVertexMesh

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

GeodesicDistanceMap_f75ab5acdd3011e89d66448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.GeodesicDistanceMap_f75ab5acdd3011e89d66448a5b87686a.GeodesicDistanceMap_f75ab5acdd3011e89d66448a5b87686a
interfacemethod geodesicDistance(sourceROI: ROI, seedROI: ROI, timestep: int) → Channel

Computes the geodesic distance in the source ROI from the seedROI

Parameters:
Returns:

geodesicChannel (ORSModel.ors.Channel) – the geodesic channel

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

getEulerCaracteristicNumberFromROI_420025aec76411e9864aace010b21c91

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.getEulerCaracteristicNumberFromROI_420025aec76411e9864aace010b21c91.getEulerCaracteristicNumberFromROI_420025aec76411e9864aace010b21c91
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

getEulerCaracteristicNumber_46873e20c75d11e9864aace010b21c91

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.getEulerCaracteristicNumber_46873e20c75d11e9864aace010b21c91.getEulerCaracteristicNumber_46873e20c75d11e9864aace010b21c91
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

getNonManifoldEdgesCount_dba27dc2863211e88292107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.getNonManifoldEdgesCount_dba27dc2863211e88292107b441a0862.getNonManifoldEdgesCount_dba27dc2863211e88292107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

gpgpuChannelAOF_e2fe22234c5623a68d3bbcd141d31ee2

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelAOF_e2fe22234c5623a68d3bbcd141d31ee2.gpgpuChannelAOF_e2fe22234c5623a68d3bbcd141d31ee2
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelCanny2DFilter_d4da41237b42b3f54b2ccde430d22ae1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelCanny2DFilter_d4da41237b42b3f54b2ccde430d22ae1.gpgpuChannelCanny2DFilter_d4da41237b42b3f54b2ccde430d22ae1
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelDilate2DFilter_e5dc33112a35a3f23a3cbcf330c11fe2

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelDilate2DFilter_e5dc33112a35a3f23a3cbcf330c11fe2.gpgpuChannelDilate2DFilter_e5dc33112a35a3f23a3cbcf330c11fe2
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelDilate3DFilter_d2ca43118b21b4a23abcbca132d27ff3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelDilate3DFilter_d2ca43118b21b4a23abcbca132d27ff3.gpgpuChannelDilate3DFilter_d2ca43118b21b4a23abcbca132d27ff3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelDistanceMap_b7cd17542a4231b57cafbaf264e32fa3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelDistanceMap_b7cd17542a4231b57cafbaf264e32fa3.gpgpuChannelDistanceMap_b7cd17542a4231b57cafbaf264e32fa3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelErode2DFilter_b3dc41222b41b4f44acc5ca134c12fd4

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelErode2DFilter_b3dc41222b41b4f44acc5ca134c12fd4.gpgpuChannelErode2DFilter_b3dc41222b41b4f44acc5ca134c12fd4
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelErode3DFilter_a1ec42374c22c3a14bdc3cd121d13aa1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelErode3DFilter_a1ec42374c22c3a14bdc3cd121d13aa1.gpgpuChannelErode3DFilter_a1ec42374c22c3a14bdc3cd121d13aa1
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelErode_372fbea7ced511ef8a25709cd1ef89d5

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelErode_372fbea7ced511ef8a25709cd1ef89d5.gpgpuChannelErode_372fbea7ced511ef8a25709cd1ef89d5
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelGaussian2D_a1cd13144e6511e79c4cade020c31dd2

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelGaussian2D_a1cd13144e6511e79c4cade020c31dd2.gpgpuChannelGaussian2D_a1cd13144e6511e79c4cade020c31dd2
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelGaussian3D_e4dc23268f6511f22c3dbda170c42de2

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelGaussian3D_e4dc23268f6511f22c3dbda170c42de2.gpgpuChannelGaussian3D_e4dc23268f6511f22c3dbda170c42de2
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelLaplacian2DFilter_d1ab32241a2145b14e2fcde144d26af2

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelLaplacian2DFilter_d1ab32241a2145b14e2fcde144d26af2.gpgpuChannelLaplacian2DFilter_d1ab32241a2145b14e2fcde144d26af2
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelLaplacian3DFilter_c2ab410241b3115c24a4dcdd234e21ce2

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelLaplacian3DFilter_c2ab410241b3115c24a4dcdd234e21ce2.gpgpuChannelLaplacian3DFilter_c2ab410241b3115c24a4dcdd234e21ce2
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelMarchingCube_c1dc15671d4321b42c4ffda214e48fc1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelMarchingCube_c1dc15671d4321b42c4ffda214e48fc1.gpgpuChannelMarchingCube_c1dc15671d4321b42c4ffda214e48fc1
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelMedianFilter3D_d1da32276e4324c14e1fccf760c21bc4

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelMedianFilter3D_d1da32276e4324c14e1fccf760c21bc4.gpgpuChannelMedianFilter3D_d1da32276e4324c14e1fccf760c21bc4
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelMedianFilter_b3cd22155f3515f23d4ebce540c21ef1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelMedianFilter_b3cd22155f3515f23d4ebce540c21ef1.gpgpuChannelMedianFilter_b3cd22155f3515f23d4ebce540c21ef1
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelOpen3DFilter_a4db63139b23b5bc3adcacb216e27ee4

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelOpen3DFilter_a4db63139b23b5bc3adcacb216e27ee4.gpgpuChannelOpen3DFilter_a4db63139b23b5bc3adcacb216e27ee4
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelSkeletonization_c4aa13242d4512b72d3cced243a41fe8

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelSkeletonization_c4aa13242d4512b72d3cced243a41fe8.gpgpuChannelSkeletonization_c4aa13242d4512b72d3cced243a41fe8
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelSobelFilter_a2dd14154f8522e19d4dace110c41ea1

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelSobelFilter_a2dd14154f8522e19d4dace110c41ea1.gpgpuChannelSobelFilter_a2dd14154f8522e19d4dace110c41ea1
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelThinning2DFilter_c7fd12471d23d1b25ced1aab32d17bc9

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelThinning2DFilter_c7fd12471d23d1b25ced1aab32d17bc9.gpgpuChannelThinning2DFilter_c7fd12471d23d1b25ced1aab32d17bc9
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuChannelUltimateErode2DFilter_f4ea52345c14c1b22bdd1ca243a34ed4

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuChannelUltimateErode2DFilter_f4ea52345c14c1b22bdd1ca243a34ed4.gpgpuChannelUltimateErode2DFilter_f4ea52345c14c1b22bdd1ca243a34ed4
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuROIDilate2DFilter_e2dd61334d65d4a31cdb21b263d12fd8

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuROIDilate2DFilter_e2dd61334d65d4a31cdb21b263d12fd8.gpgpuROIDilate2DFilter_e2dd61334d65d4a31cdb21b263d12fd8
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

gpgpuROIErode2DFilter_d1cc52111c55c4f44bcd12a263d12fd4

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.gpgpuROIErode2DFilter_d1cc52111c55c4f44bcd12a263d12fd4.gpgpuROIErode2DFilter_d1cc52111c55c4f44bcd12a263d12fd4
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu will be applied. :return: Menu

grainMapperChangeIPFColorScheme_93d6d84c283d11ebb655309c23d29268

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.grainMapperChangeIPFColorScheme_93d6d84c283d11ebb655309c23d29268.grainMapperChangeIPFColorScheme_93d6d84c283d11ebb655309c23d29268
classmethod changeColorScheme(aGUID, scheme)

Will be executed when the menu item is selected. :param aGUID: guid of the underlying MultiROI.

classmethod getMenuItemForObject(aMultiROI, selected_labels_count)

Returns the menu item :param aMultiROI: a MultiROI :param selected_labels_count: int :return: Menu

graphasspereandcylinderinaroiwithfixedradius_b490cf0a526611ea8cc40c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.graphasspereandcylinderinaroiwithfixedradius_b490cf0a526611ea8cc40c9d9276653a.graphasspereandcylinderinaroiwithfixedradius_b490cf0a526611ea8cc40c9d9276653a
interfacemethod copyGraphInROI(graph: Graph, roi: ROI, radius: float, aProgress: Progress) → None
Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Return the menu item :param aCollectionOfObjects: a list of those objects currently being selected, i.e. on which the menu will be applied. :param implementation: aSubClass of AbstractPlugin in the current context (optional) :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

graphasspereandcylinderinaroiwithscalarslot_946c76e2526711ea8cc40c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.graphasspereandcylinderinaroiwithscalarslot_946c76e2526711ea8cc40c9d9276653a.graphasspereandcylinderinaroiwithscalarslot_946c76e2526711ea8cc40c9d9276653a
interfacemethod copyGraphInROI(graph: Graph, roi: ROI, scalarValueType: str, referenceSlotIndex: int, maxValue: int, aProgress: Progress) → None
Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

graphCSVExporter_e4b1c67e459211ed87b4448a5bd787f8

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.graphCSVExporter_e4b1c67e459211ed87b4448a5bd787f8.graphCSVExporter_e4b1c67e459211ed87b4448a5bd787f8
classmethod exportGraphToCSV(graphObject, timeStep, parent=None)

Calls the Exportation of the graph to CSV while controlling the progress bar

interfacemethod exporteGraphValuestoCSV(aGraph: Graph, fileName: str, iTIndex: int = 0, progress: Progress = None) → Tuple[bool, str]

Fetches graph components information and exports it to csv

Parameters:

  • aGraph (ORSModel.ors.Graph) – the graph to export

  • fileName (file saving) – destination CSV file name

  • iTIndex (int) – the time index

  • progress (ORSModel.ors.Progress) – the progress bar control

Anonymize fileName:

True

Returns:

  • worked (bool) – the success of the export

  • error (str) – error message (if any)

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

graphTurtuosityStatisticsWeigthed_d98d02f57a3e11ecb5ae00d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.graphTurtuosityStatisticsWeigthed_d98d02f57a3e11ecb5ae00d861065303.graphTurtuosityStatisticsWeigthed_d98d02f57a3e11ecb5ae00d861065303
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

graphTurtuosityStatistics_ae43865f7a3e11ecb10700d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.graphTurtuosityStatistics_ae43865f7a3e11ecb10700d861065303.graphTurtuosityStatistics_ae43865f7a3e11ecb10700d861065303
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

growLabelWithLocalOtsu_c4c65204a9ef11ecbf1cac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.growLabelWithLocalOtsu_c4c65204a9ef11ecbf1cac12039c05e0.growLabelWithLocalOtsu_c4c65204a9ef11ecbf1cac12039c05e0
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod growLabelWithLocalOtsu(multiROI: MultiROI, dataset: Channel, dilateCount: int, isLowerOtsu: bool, currentTime: int) → None

Grow the MultiROI selected labels with specified dilate count with local otsu

Parameters:

  • multiROI (ORSModel.ors.MultiROI) – multiROI with labels to grow

  • dataset (ORSModel.ors.Channel) – dataset used for otsu threshold

  • dilateCount (int) – dilate count

  • isLowerOtsu (bool) – lower or upper otsu to apply

  • currentTime (int) – timestep to apply to

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

growVisualBoxToContain_466e0ba849a211e99783448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.growVisualBoxToContain_466e0ba849a211e99783448a5b87686a.growVisualBoxToContain_466e0ba849a211e99783448a5b87686a
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod growToContainStructuredGrid(visualBox: VisualBox, aStructuredGrid: StructuredGrid, timestep: int) → None

grow the VisualBox to contain the argument

Parameters:
interfacemethod growToContainUnstructuredGrid(visualBox: VisualBox, anUnstructuredGrid: UnstructuredGrid, timestep: int) → None

grow the VisualBox to contain the argument

Parameters:
interfacemethod growToContainVisualShape3D(visualBox: VisualBox, a3DVisualShape: VisualShape3D, timestep: int) → None

grow the VisualBox to contain the argument

Parameters:
classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

histogramNormalization_71fb0292012211e8a1640cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.histogramNormalization_71fb0292012211e8a1640cc47aab53c3.histogramNormalization_71fb0292012211e8a1640cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod normalizeHistogram(toModify: Channel, template: Channel, timeStep: int = 0) → None

Normalize toModify so that it histogram match the on of the template data set

Parameters:

ImportGraphFromCSV_725a35509e6511e99ec5c860006dfcdd

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.ImportGraphFromCSV_725a35509e6511e99ec5c860006dfcdd.ImportGraphFromCSV_725a35509e6511e99ec5c860006dfcdd
classmethod getMenuItem()
Returns:

output – Menu item

classmethod menuItemEntryPoint()

Will be executed when the menu item is selected.

ImportPointsFromCSV_263bc4319f352b202ce4d761046daace

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.ImportPointsFromCSV_263bc4319f352b202ce4d761046daace.ImportPointsFromCSV_263bc4319f352b202ce4d761046daace
classmethod getMenuItem()
Returns:

output – Menu item

classmethod menuItemEntryPoint()

Will be executed when the menu item is selected.

iterativeSnapMeshToGradient_9ffab9d86c8511efbc5d08bfb84feabc

labelsegmentsoftrabecularstructure_237fde42dba611e8b3d9448a5b5d70c0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.labelsegmentsoftrabecularstructure_237fde42dba611e8b3d9448a5b5d70c0.labelsegmentsoftrabecularstructure_237fde42dba611e8b3d9448a5b5d70c0
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod labelSegmentsOfROI(aROI: ROI, aProgress: Progress = None) → MultiROI

Labels the segments of a ROI

Parameters:
Returns:

aMultiROI (ORSModel.ors.MultiROI) – labelled segments

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

localmaxmaproi_dc42f31838d911e887f00cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.localmaxmaproi_dc42f31838d911e887f00cc47aab53c3.localmaxmaproi_dc42f31838d911e887f00cc47aab53c3
interfacemethod createLocalMaxROI(sourceDataset: Channel, threshold: float) → ROI

Create a ROI that contain the local max point of the input channel

Parameters:

  • sourceDataset (ORSModel.ors.Channel) – source dataset

  • threshold (float) – the threshold for the max point extraction

Returns:

roiLocalMax (ORSModel.ors.ROI) – a new ROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

localmaxmap_ce89ba3038d911e8bb800cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.localmaxmap_ce89ba3038d911e8bb800cc47aab53c3.localmaxmap_ce89ba3038d911e8bb800cc47aab53c3
interfacemethod createLocalMax(sourceDataset: Channel, threshold: float) → Channel

Create a Channel that contain the local max point of the input channel

Parameters:

  • sourceDataset (ORSModel.ors.Channel) – source dataset

  • threshold (float) – the threshold for the max point extraction

Returns:

localMax (ORSModel.ors.Channel) – a new Channel

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

lookAtCenterOfMAss_161c7fe6fbd711e7a06c0cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.lookAtCenterOfMAss_161c7fe6fbd711e7a06c0cc47aab53c3.lookAtCenterOfMAss_161c7fe6fbd711e7a06c0cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

makeVisualBoxAbleToContain_c5f23e12483511e9bfea448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.makeVisualBoxAbleToContain_c5f23e12483511e9bfea448a5b87686a.makeVisualBoxAbleToContain_c5f23e12483511e9bfea448a5b87686a
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod makeAbleToContainStructuredGrid(visualBox: VisualBox, aStructuredGrid: StructuredGrid, timestep: int) → None

Copies the first dataset into the second dataset.

Parameters:
interfacemethod makeAbleToContainUnstructuredGrid(visualBox: VisualBox, anUnstructuredGrid: UnstructuredGrid, timestep: int) → None

Copies the first dataset into the second dataset.

Parameters:
interfacemethod makeAbleToContainVisualShape3D(visualBox: VisualBox, a3DVisualShape: VisualShape3D, timestep: int) → None

Copies the first dataset into the second dataset.

Parameters:
classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

mapEdgeScalarValuesFrom_4b0b81ad3c6211eeac8ffc34971049dc

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.mapEdgeScalarValuesFrom_4b0b81ad3c6211eeac8ffc34971049dc.mapEdgeScalarValuesFrom_4b0b81ad3c6211eeac8ffc34971049dc
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

interfacemethod mapDatasetValuesToGraphEdges(sourceUnstructuredGrid: UnstructuredGrid, referenceChannel: Channel, referenceChannelTIndex: int, sourceUnstructuredGridTIndex: int, defaulfScalarValue: float = 1.0) → bool

Maps values from a dataset (reference) as vertex scalar values to an unstructured grid (source)

Parameters:

  • sourceUnstructuredGrid (ORSModel.ors.UnstructuredGrid) – a source unstructured grid

  • referenceChannel (ORSModel.ors.Channel) – a reference Channel

  • referenceChannelTIndex (int) – the time step of the reference dataset

  • sourceUnstructuredGridTIndex (int) – the time step of the source unstructured grid

  • defaulfScalarValue (float) – A default value if no match is possible between a vertex and the dataset

Returns:

output (bool) – True if the mapping works, else False

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

mappingscalarvaluesfromanothermesh_94f4f222eb2711e78c97107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.mappingscalarvaluesfromanothermesh_94f4f222eb2711e78c97107b441a0862.mappingscalarvaluesfromanothermesh_94f4f222eb2711e78c97107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod mapAListOfScalarSlotFromAMeshToAnother(sourceMesh: Mesh, referenceMesh: Mesh, listOfSlotId: List[int], referenceTIndex: int, sourceTIndex: int, defaultScalarValue: float) → bool

Maps vertices scalar values of a reference mesh to a source mesh

Parameters:

  • sourceMesh (ORSModel.ors.Mesh) – a source mesh

  • referenceMesh (ORSModel.ors.Mesh) – a reference mesh

  • listOfSlotId (int) [count=[1, None]] – a list of scalar slot index

  • referenceTIndex (int) – the time step of the reference mesh

  • sourceTIndex (int) – the time step of the source mesh

  • defaultScalarValue (float) – A default value if no match is possible between a vertex and the Multi ROI label

Returns:

output (bool) – True if the mapping works, else False

interfacemethod mapAListOfScalarSlotFromAMultiROIToAMesh(sourceMesh: Mesh, referenceMultiROI: MultiROI, listOfSlotId: List[int], referenceMultiROITIndex: int, sourceMeshTIndex: int, defaulfScalarValue: float = 1.0) → bool

Deprecated : use mapAListOfScalarSlotFromAMultiROIToAnUnstructuredGrid instead Maps a list of scalar values from a reference multi ROI to a source mesh

Parameters:

  • sourceMesh (ORSModel.ors.Mesh) – a source mesh

  • referenceMultiROI (ORSModel.ors.MultiROI) – a reference MultiROI

  • listOfSlotId (int) [count=[1, None]] – a list of scalar slots index to map

  • referenceMultiROITIndex (int) – the time step of the reference multiROI

  • sourceMeshTIndex (int) – the time step of the source mesh

  • defaulfScalarValue (float) – A default value if no match is possible between a vertex and the Multi ROI label

Returns:

output (bool) – True if the mapping works, else False

interfacemethod mapAListOfScalarSlotFromAMultiROIToAnUnstructuredGrid(sourceUnstructuredGrid: UnstructuredGrid, referenceMultiROI: MultiROI, listOfSlotId: List[int], referenceMultiROITIndex: int, sourceUnstructuredGridTIndex: int, defaulfScalarValue: float = 1.0) → bool

Maps a list of scalar values from a reference multi ROI to a source unstructured grid (as vertex scalar values)

Parameters:

  • sourceUnstructuredGrid (ORSModel.ors.UnstructuredGrid) – a source unstructured grid

  • referenceMultiROI (ORSModel.ors.MultiROI) – a reference MultiROI

  • listOfSlotId (int) [count=[1, None]] – a list of scalar slots index to map

  • referenceMultiROITIndex (int) – the time step of the reference multiROI

  • sourceUnstructuredGridTIndex (int) – the time step of the source unstructured grid

  • defaulfScalarValue (float) – A default value if no match is possible between a vertex and the Multi ROI label

Returns:

output (bool) – True if the mapping works, else False

interfacemethod mapDatasetValuesToAnUnstructuredGrid(sourceUnstructuredGrid: UnstructuredGrid, referenceChannel: Channel, referenceChannelTIndex: int, sourceUnstructuredGridTIndex: int, defaulfScalarValue: float = 1.0) → bool

Maps values from a dataset (reference) as vertex scalar values to an unstructured grid (source)

Parameters:

  • sourceUnstructuredGrid (ORSModel.ors.UnstructuredGrid) – a source unstructured grid

  • referenceChannel (ORSModel.ors.Channel) – a reference Channel

  • referenceChannelTIndex (int) – the time step of the reference dataset

  • sourceUnstructuredGridTIndex (int) – the time step of the source unstructured grid

  • defaulfScalarValue (float) – A default value if no match is possible between a vertex and the dataset

Returns:

output (bool) – True if the mapping works, else False

interfacemethod mappingScalarValuesFromAMeshToAnOther(sourceMesh: Mesh, referenceMesh: Mesh, referenceMeshSlotIndex: int, referenceTIndex: int, sourceTIndex: int, defaultScalarValue: float) → bool

Deprecated : use mapAListOfScalarSlotFromAMeshToAnother instead Maps vertices scalar values of a reference mesh to a source mesh

Parameters:

  • sourceMesh (ORSModel.ors.Mesh) – a source mesh

  • referenceMesh (ORSModel.ors.Mesh) – a reference mesh

  • referenceMeshSlotIndex (int) – a scalar slot index

  • referenceTIndex (int) – the time step of the reference mesh

  • sourceTIndex (int) – the time step of the source mesh

  • defaultScalarValue (float) – A default value if no match is possible between a vertex and the Multi ROI label

Returns:

output (bool) – True if the mapping works, else False

interfacemethod mappingScalarValuesFromAMultiROIToAMesh(sourceMesh: Mesh, referenceMultiROI: MultiROI, multiROISlotIndexToMap: int, referenceMultiROITIndex: int, sourceMeshTIndex: int, defaulfScalarValue: float = 1.0) → bool

Deprecated : use mapAListOfScalarSlotFromAMultiROIToAMesh instead Maps scalar values of a reference multi ROI to a source mesh

Parameters:

  • sourceMesh (ORSModel.ors.Mesh) – a source mesh

  • referenceMultiROI (ORSModel.ors.MultiROI) – a reference MultiROI

  • multiROISlotIndexToMap (int) – a scalar slot index

  • referenceMultiROITIndex (int) – the time step of the reference multiROI

  • sourceMeshTIndex (int) – the time step of the source mesh

  • defaulfScalarValue (float) – A default value if no match is possible between a vertex and the Multi ROI label

Returns:

output (bool) – True if the mapping works, else False

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

maskROIWithShape_0a959576d09e11e8bf94c860009a272e

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.maskROIWithShape_0a959576d09e11e8bf94c860009a272e.maskROIWithShape_0a959576d09e11e8bf94c860009a272e
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod maskChannelWithShape(channel: Channel, shape: Shape3D, timestep: int) → None

Masks the given Channel with a Shape

Parameters:
interfacemethod maskChannelWithVisualShape(channel: Channel, visualShape: VisualShape3D, timestep: int) → None

Masks the given Channel with a VisualShape

Parameters:
interfacemethod maskMultiROIWithShape(mroi: MultiROI, shape: Shape3D, timestep: int) → None

Masks the given MultiROI with a Shape

Parameters:
interfacemethod maskMultiROIWithVisualShape(mroi: MultiROI, visualShape: VisualShape3D, timestep: int) → None

Masks the given MultiROI with a VisualShape

Parameters:
classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

mergeMeshes_6eebfddfbc8211ee9d49ac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.mergeMeshes_6eebfddfbc8211ee9d49ac12039c05e0.mergeMeshes_6eebfddfbc8211ee9d49ac12039c05e0
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

interfacemethod mergeMeshes(aCollectionOfMeshes: List[FaceVertexMesh]) → FaceVertexMesh

Generate a mesh which is the concatenation of all the input meshes. ScalarValue are not copied to the merge mesh.

Parameters:

aCollectionOfMeshes (ORSModel.ors.FaceVertexMesh) [count=[1, None]] – a list of meshes to be merged

Returns:

retMesh (ORSModel.ors.FaceVertexMesh) – The FaceVertexMesh output, the result of the merge operation

meshClean_1acbfdaace5421efbc41ba12559a33f0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.meshClean_1acbfdaace5421efbc41ba12559a33f0.meshClean_1acbfdaace5421efbc41ba12559a33f0
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

MeshRayCastingSimu_71da4ef14eb611ef8bc7709cd1ef89d5

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.MeshRayCastingSimu_71da4ef14eb611ef8bc7709cd1ef89d5.MeshRayCastingSimu_71da4ef14eb611ef8bc7709cd1ef89d5
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

meshSignedDeviationMap_1d314b70ecd211e7bedb107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.meshSignedDeviationMap_1d314b70ecd211e7bedb107b441a0862.meshSignedDeviationMap_1d314b70ecd211e7bedb107b441a0862
interfacemethod computeSignedDeviationMap(sourceORSMesh: Mesh, referenceORSMesh: Mesh, maxSearchLength: float = 0.005, iTIndex: int = 0) → None

Compute a signed deviation map between two meshes. Results are put as scalar values slot of the source mesh

Parameters:

  • sourceORSMesh (ORSModel.ors.Mesh) – Mesh that will contain the result of the deviation map

  • referenceORSMesh (ORSModel.ors.Mesh) – The reference

  • maxSearchLength (float) – Maximum search length in Meter

  • iTIndex (int) – The current time step

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

mesh_deviation_map_15e1655ace0511e7a67d107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.mesh_deviation_map_15e1655ace0511e7a67d107b441a0862.mesh_deviation_map_15e1655ace0511e7a67d107b441a0862
interfacemethod computeDeviationMap(sourceORSMesh: Mesh, referenceORSMesh: Mesh, maxSearchLength: float = 0.005, iTIndex: int = 0) → None

Compute a deviation map between two meshes. Results are put as scalars values slot of the source mesh

Parameters:

  • sourceORSMesh (ORSModel.ors.Mesh) – Mesh that will contain the result of the deviation map

  • referenceORSMesh (ORSModel.ors.Mesh) – The reference

  • maxSearchLength (float) – Maximum search length in Meter

  • iTIndex (int) – The current time step

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

mesh_vertex_normal_deviation_map_1328f1fea62e11eca540ac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.mesh_vertex_normal_deviation_map_1328f1fea62e11eca540ac12039c05e0.mesh_vertex_normal_deviation_map_1328f1fea62e11eca540ac12039c05e0
interfacemethod computeVertexNormalDeviationMap(sourceORSMesh: Mesh, referenceORSMesh: Mesh, iTIndex: int = 0) → None

Compute a deviation map between two meshes, along the vertex normal of the source mesh. Results are put as scalar values slot of the source mesh

Parameters:

  • sourceORSMesh (ORSModel.ors.Mesh) – Mesh that will contain the result of the deviation map

  • referenceORSMesh (ORSModel.ors.Mesh) – The reference

  • iTIndex (int) – The current time step

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

mesh_vertex_normal_signed_deviation_map_16a14a7ea62e11ec973fac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.mesh_vertex_normal_signed_deviation_map_16a14a7ea62e11ec973fac12039c05e0.mesh_vertex_normal_signed_deviation_map_16a14a7ea62e11ec973fac12039c05e0
interfacemethod computeVertexNormalSignedDeviationMap(sourceORSMesh: Mesh, referenceORSMesh: Mesh, iTIndex: int = 0) → None

Compute a signed deviation map between two meshes, along the vertex normal of the source mesh. Results are put as scalar values slot of the source mesh

Parameters:

  • sourceORSMesh (ORSModel.ors.Mesh) – Mesh that will contain the result of the deviation map

  • referenceORSMesh (ORSModel.ors.Mesh) – The reference

  • iTIndex (int) – The current time step

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

mineralogy_reader_ae38453beb5a11ed822b64bc58c0ae6c

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.mineralogy_reader_ae38453beb5a11ed822b64bc58c0ae6c.mineralogy_reader_ae38453beb5a11ed822b64bc58c0ae6c
interfacemethod applyMineralogyMap(reference_channel: Channel, imageFile: str, legendFile: str, multiROITitle: str, progress: Progress = None) → Tuple[MultiROI, str]

Creates the multiROI and fills the labels

Parameters:

  • reference_channel (ORSModel.ors.Channel) – the reference channel

  • imageFile (file) – the colored channel file path

  • legendFile (file) – an Excel file path used to fill the multiROI labels

  • multiROITitle (str) – the title of the multiROI

  • progress (ORSModel.ors.Progress) – an optional progress bar

Returns:

  • filledMultiROI (ORSModel.ors.MultiROI) – the filled multi-roi

  • errorMessage (str) – the error message

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

multiOtsu_0b2e49e6095811ee8b3fac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.multiOtsu_0b2e49e6095811ee8b3fac12039c05e0.multiOtsu_0b2e49e6095811ee8b3fac12039c05e0
interfacemethod createMultiOtsuMultiROI(channel: Channel, classes: int) → MultiROI

Creates a multiROI from the given channel using multiotsu.

Parameters:

  • channel (ORSModel.ors.Channel) – the channel to do multi otsu on

  • classes (int) – number of classes to create

Returns:

outMultiROI (ORSModel.ors.MultiROI) – the filled multi-roi

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

multiROIGetMergedLabels_8a0d30d2a4bd11e881c30cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.multiROIGetMergedLabels_8a0d30d2a4bd11e881c30cc47aab53c3.multiROIGetMergedLabels_8a0d30d2a4bd11e881c30cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod mergeLabelsOfMultiROI(aMultiROi: MultiROI, aROIorMultiROI: Union[ROI, MultiROI]) → MultiROI

Normalize toModify so that it histogram match the on of the template data set

Parameters:
Returns:

mergedMultiROI (ORSModel.ors.MultiROI) – a new MultiROI

openAllUsersFolder

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.openAllUsersFolder.OpenAllUsersFolder
classmethod getMenuItem()

Returns the menu item, a Menu object :return: Menu

openCurrentUserFolder

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.openCurrentUserFolder.OpenCurrentUserFolder
classmethod getMenuItem()

Returns the menu item, a Menu object :return: Menu

openHelpDeveloperDocumentation_cbd79940875211e7a3ec448a5b5d70c0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.openHelpDeveloperDocumentation_cbd79940875211e7a3ec448a5b5d70c0.openHelpDeveloperDocumentation_cbd79940875211e7a3ec448a5b5d70c0
classmethod getMenuItem()
Returns:

output – Menu item

classmethod menuItemEntryPoint()

Will be executed when the menu item is selected.

OpenTerminalOnLinux_46c24526f33a11e8b32a74d435ecf773

OrsChangeMeshWinding_0137178a2e0611e88f00107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.OrsChangeMeshWinding_0137178a2e0611e88f00107b441a0862.OrsChangeMeshWinding_0137178a2e0611e88f00107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod invertWinding(aMeshModel: Mesh) → None

Invert winding sens of a mesh

Parameters:

aMeshModel (ORSModel.ors.Mesh) – mesh that contain vertex normal to flip

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

overwriteChannelWithChannel_9f9b1b26128e11e8a0950cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.overwriteChannelWithChannel_9f9b1b26128e11e8a0950cc47aab53c3.overwriteChannelWithChannel_9f9b1b26128e11e8a0950cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod overwriteDatasetWitDataset(sourceDataset: Channel, destinationDataset: Channel) → None

Overwrite the destination dataset with the source dataset

Parameters:

phiThetaChannelFromXYZChannel_73e1f59b106911ee884dac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.phiThetaChannelFromXYZChannel_73e1f59b106911ee884dac12039c05e0.phiThetaChannelFromXYZChannel_73e1f59b106911ee884dac12039c05e0
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

interfacemethod getPhiThetaOrientationFromXYZVectorField(chanX: Channel, chanY: Channel, chanZ: Channel) → Tuple[Channel, Channel]

Get Phi Theta Orientation from VectorField Components.

Parameters:
Returns:
classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

pixelWiseMomen_d79ec900013211e8b1ef0cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.pixelWiseMomen_d79ec900013211e8b1ef0cc47aab53c3.pixelWiseMomen_d79ec900013211e8b1ef0cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod mean(datasets: List[Channel], IProgress: Progress = None) → Channel

Compute a voxel wise mean dataset from the datasets in input

Parameters:
Returns:

outChannel (ORSModel.ors.Channel) – The created Channel

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod moment(datasets: List[Channel], moment: int, IProgress: Progress = None) → Channel

Compute a voxel wise mean dataset from the datasets in input

Parameters:
Returns:

outChannel (ORSModel.ors.Channel) – The created Channel

rbfChannelFromPointAnnotation_8942e2d1c02111ecbb823c7c3f49fac6

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.rbfChannelFromPointAnnotation_8942e2d1c02111ecbb823c7c3f49fac6.rbfChannelFromPointAnnotation_8942e2d1c02111ecbb823c7c3f49fac6
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod rbfChannelFromVisualPointsAndChannel(visualPoints: VisualPoints, channel: Channel, halfKernelSize: int, timestep: int) → Channel

Create an RBF volume from the values in the channel

Parameters:
Returns:

rbfVolume (ORSModel.ors.Channel) – a new Channel

rbfCompensationOfChannelFromVisualPoints_72d60ea0c0d111ecb53dac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.rbfCompensationOfChannelFromVisualPoints_72d60ea0c0d111ecb53dac12039c05e0.rbfCompensationOfChannelFromVisualPoints_72d60ea0c0d111ecb53dac12039c05e0
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod rbfCompensatedChannelFromVisualPointsAndChannel(visualPoints: VisualPoints, channel: Channel, halfKernelSize: int, timestep: int) → Channel

Create an RBF channel version of input channel from the values in the channel

Parameters:
Returns:

rbfVolume (ORSModel.ors.Channel) – a new Channel

reconstructionlog_9de6885e892f11e9a683107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.reconstructionlog_9de6885e892f11e9a683107b441a0862.ReconstructionLog_9de6885e892f11e9a683107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item

will be applied.

redistributeControlPoints_a20f694de01c11eb8fea00d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.redistributeControlPoints_a20f694de01c11eb8fea00d861065303.redistributeControlPoints_a20f694de01c11eb8fea00d861065303
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

remeshWithPoisson_43e87e100eec11ee8538ac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.remeshWithPoisson_43e87e100eec11ee8538ac12039c05e0.remeshWithPoisson_43e87e100eec11ee8538ac12039c05e0
interfacemethod createRemeshingOfMeshWithPoisson(aMesh: Mesh, depth: int = 8, scale: float = 1.1, solverDivide: int = 7, isoDivide: int = 12, samplesPerNode: float = 1.0, confidence: bool = False, timestep: int = 0, progress: Progress = None) → Mesh

Create a new mesh by remeshing with Poisson algorithm

Parameters:

  • aMesh (ORSModel.ors.Mesh) – mesh to remesh

  • depth (int) – depth of filter

  • scale (float) – scaling filter

  • solverDivide (int) – solver divide of filter

  • isoDivide (int) – iso divide of filter

  • samplesPerNode (float) – sample per node for filter

  • confidence (bool) – use confidence for filter

  • timestep (int) – current time step

  • progress (ORSModel.ors.Progress) – a progress bar

Returns:

aNewMesh (ORSModel.ors.Mesh) – structured grid with rotated slabs

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

removeShapeFromiROI_b6f992e6021411e8a12d0cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.removeShapeFromiROI_b6f992e6021411e8a12d0cc47aab53c3.removeShapeFromiROI_b6f992e6021411e8a12d0cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod removeShapeFromROI(roi: Union[ROI, MultiROI], shape: Shape3D, timestep: int) → None

Removes an instance of VisualShape3D from a ROI or MultiROI

Parameters:
interfacemethod removeShapeFromStructuredGrid(structure: Union[ROI, MultiROI, Channel], shape: Shape3D, timestep: int) → None

Removes an instance of Shape3D from a ROI, MultiROI or Channel

Parameters:
interfacemethod removeVisualShapeFromROI(roi: Union[ROI, MultiROI], visualShape3D: VisualShape3D, timestep: int) → None

Removes an instance of VisualShape3D from a ROI or MultiROI

Parameters:
interfacemethod removeVisualShapeFromStructuredGrid(structure: Union[ROI, MultiROI, Channel], visualShape3D: VisualShape3D, timestep: int) → None

Removes an instance of VisualShape3D from a ROI, MultiROI or a Channel

Parameters:

removeShapeFromMultiROILabels_51b00868bfa011ea832e9cb6d0697612

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.removeShapeFromMultiROILabels_51b00868bfa011ea832e9cb6d0697612.removeShapeFromMultiROILabels_51b00868bfa011ea832e9cb6d0697612
classmethod getMenuItemForObject(aMultiROI, selected_labels_count)

Returns the menu item :param aMultiROI: a MultiROI :param selected_labels_count: int :return: Menu

classmethod menuItemEntryPoint(aGUID)

Will be executed when the menu item is selected. :param aGUID: guid of the underlying MultiROI.

interfacemethod removeShapeFromMultiROILabels(aShape: Shape3D, multiROI: MultiROI, labels: ArrayUnsignedLong, destination_label: int, timestep: int) → None

Remove a Shape3D from one or more MultiROI Label(s)

Parameters:
interfacemethod removeVisualShapeFromMultiROILabels(aVisualShape: VisualShape3D, multiROI: MultiROI, labels: ArrayUnsignedLong, destination_label: int, timestep: int) → None

Remove a VisualShape from one or more MultiROI label(s)

Parameters:

removeTouchingROIOrMultiROI_6a6f2062928b11e881c30cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.removeTouchingROIOrMultiROI_6a6f2062928b11e881c30cc47aab53c3.removeTouchingROIOrMultiROI_6a6f2062928b11e881c30cc47aab53c3
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod removeTouchingObject(subject: Union[ROI, MultiROI], target: Union[ROI, MultiROI], timestep: int = 0, progress: Progress = None) → None

Remove objects in ROI/MultiROI that are touching target ROI/MultiROI

Parameters:

removevoxelsbelowlocalcenterofrange_8cab1930ee6011e8a8f4b3445026216c

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.removevoxelsbelowlocalcenterofrange_8cab1930ee6011e8a8f4b3445026216c.RemoveVoxelsBelowLocalCenterOfRange_8cab1930ee6011e8a8f4b3445026216c
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod removeVoxelsBelowLocalCenterOfRange(aROI: ROI, aChannel: Channel, kernelRadius: int, timestep: int, aProgress: Progress = None) → None

Removes the voxels of the ROI where the intensity in the Channel is lower than the center of the local range.

This is typically used to remove beam hardening artifacts.

Parameters:

  • aROI (ORSModel.ors.ROI) – ROI to modify

  • aChannel (ORSModel.ors.Channel) – dataset of intensities

  • kernelRadius (int) – radius of the kernel, in voxels. Should be smaller than the size of the ROI.

  • timestep (int) – what timestep to modify

  • aProgress (ORSModel.ors.Progress) – progress object

replaceNaNFromFloatChannel_d6157056e70211ee8a9aac12039c05e0

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.replaceNaNFromFloatChannel_d6157056e70211ee8a9aac12039c05e0.replaceNaNFromFloatChannel_d6157056e70211ee8a9aac12039c05e0
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

interfacemethod replaceNaN(sourceDataset: Channel, replacementValue: float) → None

Replace all occurence of NaN values in the provided dataset with replacementValue

Parameters:

  • sourceDataset (ORSModel.ors.Channel) – source dataset

  • replacementValue (float) – the replacement value

rgbImageToMultiROIColor_cc87d536503e11ef8c58c85ea9714a93

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.rgbImageToMultiROIColor_cc87d536503e11ef8c58c85ea9714a93.rgbImageToMultiROIColor_cc87d536503e11ef8c58c85ea9714a93
interfacemethod createMultiROIFromRGBChannels(redChannel: Channel, greenChannel: Channel, blueChannel: Channel, timeStep: int, progress: Progress) → MultiROI

Extract slices along axis, compute the centroid for each slice and add a path control point at each centroid

Parameters:
Returns:

multiROI (ORSModel.ors.MultiROI) – generated multiroi

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

ridgemaproi_c9cf66ca38d911e89a4e0cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.ridgemaproi_c9cf66ca38d911e89a4e0cc47aab53c3.ridgemaproi_c9cf66ca38d911e89a4e0cc47aab53c3
interfacemethod createRidgeMapROI(sourceDataset: Channel) → ROI

Create a ROI that contain the ridge of the input channel

Parameters:

sourceDataset (ORSModel.ors.Channel) – source dataset

Returns:

ridgeMapROI (ORSModel.ors.ROI) – a new ROI

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

ridgemap_b27bd93a38d911e8a1ef0cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.ridgemap_b27bd93a38d911e8a1ef0cc47aab53c3.ridgemap_b27bd93a38d911e8a1ef0cc47aab53c3
interfacemethod createRidgeMap(sourceDataset: Channel) → Channel

Create a Channel that contain the ridge of the input channel

Parameters:

sourceDataset (ORSModel.ors.Channel) – source dataset

Returns:

ridgeMap (ORSModel.ors.Channel) – a new Channel

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

roiThroatWeightedTortuosity_25fb6cd8ff2611e9bcd60c9d9276734f

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.roiThroatWeightedTortuosity_25fb6cd8ff2611e9bcd60c9d9276734f.roiThroatWeightedTortuosity_25fb6cd8ff2611e9bcd60c9d9276734f
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

roiTurtuosity_9bfa389ac06311e9a721448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.roiTurtuosity_9bfa389ac06311e9a721448a5b87686a.roiTurtuosity_9bfa389ac06311e9a721448a5b87686a
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

savemeshwithcolor_fc267eba533c11eaab080c9d9276653a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.savemeshwithcolor_fc267eba533c11eaab080c9d9276653a.savemeshwithcolor_fc267eba533c11eaab080c9d9276653a
interfacemethod exportMeshWithColor(meshGUID: str, lutGUID: str) → None

Copies the first dataset into the second dataset.

Parameters:

  • meshGUID (str) – GUID of mesh

  • lutGUID (str) – GUID of lookup table

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

setText_67bbae08a4db11e796b130e37aed33ab

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.setText_67bbae08a4db11e796b130e37aed33ab.setText_67bbae08a4db11e796b130e37aed33ab
classmethod getIsSelectionValid(objs)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod setPitch(pitch: float, inDegrees: bool) → None

set the pitch value

Deprecated since version 2025.1: Use ViewHelper.setPitch

Parameters:

  • pitch (float) –

  • inDegrees (bool) – True if it’s in degrees, false in radians

interfacemethod setRoll(roll: float, inDegrees: bool) → None

set roll

Deprecated since version 2025.1: Use ViewHelper.setRoll

Parameters:

  • roll (float) –

  • inDegrees (bool) – True if it’s in degrees, false in radians

interfacemethod setSlice(slice: int) → None

set slice number

Deprecated since version 2025.1: Use ViewHelper.setSlice

Parameters:

slice (int) –

interfacemethod setTimeStep(timestep: int) → None

Set timestep

Deprecated since version 2025.1: Use ViewHelper.setTimeStep

Parameters:

timestep (int) –

interfacemethod setYaw(yaw: float, inDegrees: bool) → None

set the yaw value

Deprecated since version 2025.1: Use ViewHelper.setYaw

Parameters:

  • yaw (float) –

  • inDegrees (bool) – True if it’s in degrees, false in radians

SimpleInpainter

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.SimpleInpainter.SimpleInpainter
interfacemethod computeInpaint(aDataset: Channel, aROI: ROI, radius: float, IProgress: Progress = None) → None

Performs the inpainting of a dataset over the pixels identified by the ROI.

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)

To Be reimplemented :param aCollectionOfObjects: :return:

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects –

Returns:

output – str

classmethod inpaint(aCollectionOfObjects)

Will be executed when the menu item is selected.

Parameters:

aCollectionOfObjects – a list of objects representation currently being selected, i.e. on which the menu will be applied.

skeletonizeAndPruneROI_c21a703676b311ef90b8c85ea9714a93

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.skeletonizeAndPruneROI_c21a703676b311ef90b8c85ea9714a93.skeletonizeAndPruneROI_c21a703676b311ef90b8c85ea9714a93
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod skeletonizeAndPrunROI(aROI: ROI, numberOfPathsToKeep: int = 1, timeStep: int = 0, aProgress: Progress = None) → ROI

Computes the connectivity graph from a ROI

Parameters:

  • aROI (ORSModel.ors.ROI) – source ROI

  • numberOfPathsToKeep (int) – keep n longest paths when pruning

  • timeStep (int) – time step

  • aProgress (ORSModel.ors.Progress) – progress object

Returns:

skeletonROI (ORSModel.ors.ROI) – pruned ROI

sobelThresholdMethod_83b262dd5bc911eeaa4efc3497105300

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.sobelThresholdMethod_83b262dd5bc911eeaa4efc3497105300.sobelThresholdMethod_83b262dd5bc911eeaa4efc3497105300
interfacemethod applyStyle(roi_porosity: ROI) → None

Set the colors and visibility of the porosity ROI

Parameters:

roi_porosity (ORSModel.ors.ROI) – the ROI of the porosity

interfacemethod computeSobel(aChannel: Channel, is3D: bool = True, sigma: int = 1) → Channel

Apply Sobel filter (with Gaussian before) and output the resulting new channel

Parameters:

  • aChannel (ORSModel.ors.Channel) – The origin channel to calculate the Sobel filter on

  • is3D (bool) – Determines if the sobel should be 2D or 3D

  • sigma (int) – sigma used for the gaussian kernel

Returns:

output (ORSModel.ors.Channel) – the output Channel that is the result of the Sobel filtering

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

  • implementation – a subclass of AbstractPlugin in the current context.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context. :return: Menu

interfacemethod getPorosity(aROI: ROI, time_idx: int = 0) → ROI

Perform morphological operations to extract the porosity from the Sobel image

Parameters:

  • aROI (ORSModel.ors.ROI) – The initial ROI from the Upper Otsu of Sobel

  • time_idx (int) – The time step

Returns:

aROI (ORSModel.ors.ROI) – The ROI with only the Porosity

classmethod menuItemEntryPoint(collectionString, implementation)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied. :param implementation: a subclass of AbstractPlugin in the current context.

interfacemethod sobelOtsuAPS(aChannel: Channel, timeStep: int = 0) → MultiROI

Automated Porosity Segmentation: Apply the Single Material (Sobel) method

Parameters:

  • aChannel (ORSModel.ors.Channel) – The Channel to apply the method from

  • timeStep (int) – The time step of the dataset

Returns:

output (ORSModel.ors.MultiROI) – the output MultiROI that is the result of the Single Material (Sobel) method

splitNonConnectedLabel_b078688adc5e11e8813a448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.splitNonConnectedLabel_b078688adc5e11e8813a448a5b87686a.splitNonConnectedLabel_b078688adc5e11e8813a448a5b87686a
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

interfacemethod splitNotConnectedLabels(aMultiROI: MultiROI, aProgress: Progress = None) → MultiROI

Each label is separated with the connected component analysis and these components are added to the output MultiROI

Parameters:
Returns:

splittedMultiROI (ORSModel.ors.MultiROI) – the splittedMultiROI

startCMD

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.startCMD.StartCMD
classmethod getMenuItem()

Returns the menu item, a Menu object :return: Menu

startCMDAsAdministrator

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.startCMDAsAdministrator.StartCMDAsAdmin
classmethod getMenuItem()

Returns the menu item, a Menu object :return: Menu

takeShapeOfMinimalBox_264ff9b8a66511e88120107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.takeShapeOfMinimalBox_264ff9b8a66511e88120107b441a0862.TakeShapeOfMinimalBox_264ff9b8a66511e88120107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be

applied.

Returns:

output – Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item

will be applied.

interfacemethod takeMinimalBoxShapeOfObject(visualBox: VisualBox, object: Union[UnstructuredGrid, ROI, MultiROI], iTIndex: int) → bool

Make a visual box take the minimal shape of an unstructured grid, a roi or amulti-roi. Also know as a oriented bounding box

Parameters:
Returns:

output (bool) – True if worked, else false

trackAreaFromAVisualRectangle_2b4f1e180a8f4f7a9e33b6ed8d24bbd0

transfertScalarValues_b9d7c4b8086411e8a3a7107b441a0862

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.transfertScalarValues_b9d7c4b8086411e8a3a7107b441a0862.transfertScalarValues_b9d7c4b8086411e8a3a7107b441a0862
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be

applied. :return: if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

triplePointGraphWithThroatThickness_d6d5fab04b2811e9a4eb448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.triplePointGraphWithThroatThickness_d6d5fab04b2811e9a4eb448a5b87686a.triplePointGraphWithThroatThickness_d6d5fab04b2811e9a4eb448a5b87686a
interfacemethod createThreePhaseBoundaryGraphWithThroatThickness(electrolyteROI: ROI, firstConductorROI: ROI, secondConductorROI: ROI, progress: Progress) → Tuple[Graph, int]

Create the graph that describes the Three phase boundary and generate the graph scalar value that describes the interface thickness

Parameters:
Returns:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

triplePointGraph_b0b470b41f3011e98926448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.triplePointGraph_b0b470b41f3011e98926448a5b87686a.triplePointGraph_b0b470b41f3011e98926448a5b87686a
interfacemethod createThreePhaseBoundaryGraph(electrolyteROI: ROI, firstConductorROI: ROI, secondConductorROI: ROI, progress: Progress) → Tuple[Graph, int]

Create the graph that describes the Three phase boundary

Parameters:
Returns:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

triplePointROI_caeb1600857411eab47500d861065303

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.triplePointROI_caeb1600857411eab47500d861065303.triplePointROI_caeb1600857411eab47500d861065303
interfacemethod createThreePhaseBoundaryROI(electrolyteROI: ROI, firstConductorROI: ROI, secondConductorROI: ROI, progress: Progress) → Tuple[ROI, int]

Create the ROI that describes the Three phase boundary

Parameters:
Returns:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

vectorFieldFromChannel_2e63983aeff211e78eb60cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.vectorFieldFromChannel_2e63983aeff211e78eb60cc47aab53c3.vectorFieldFromChannel_2e63983aeff211e78eb60cc47aab53c3
interfacemethod generateVectorFieldFromChannels(chanX: Channel, chanY: Channel, chanZ: Channel, chanmodul: Channel, samplingX: int, samplingY: int, samplingZ: int) → VectorField

Create a VectorField from input Channels

Parameters:
Returns:

aNewVectorField (ORSModel.ors.VectorField) – the created vectorField

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

visPtGenFromMultiROI_2c939f265d2f11ec8aa4f48e38ed1b30

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.visPtGenFromMultiROI_2c939f265d2f11ec8aa4f48e38ed1b30.visPtGenFromMultiROI_2c939f265d2f11ec8aa4f48e38ed1b30
interfacemethod extractCentroidsFromMultiROI(mr: MultiROI, progress: Optional[Progress] = None) → VisualPoints

Extracts the ROI-Centroids From a MultiROI

Parameters:
Returns:

vp (ORSModel.ors.VisualPoints) – a new set of Visual Points

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

voxelsNeighborCountGreaterThanOrEqualTo_756490aea88011e882d6448a5b87686a

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.voxelsNeighborCountGreaterThanOrEqualTo_756490aea88011e882d6448a5b87686a.voxelsNeighborCountGreaterThanOrEqualTo_756490aea88011e882d6448a5b87686a
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

interfacemethod getVoxelsNeighborCountGreaterThanOrEqualTo(aROI: ROI, neighborCount: int, progress: Progress) → ROI

Create a ROI that contain the voxel of aROI that have a neighbor count greater than or equal to neighborCount

Parameters:
Returns:

selectedOnNeighborCount (ORSModel.ors.ROI) – a new ROI

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

watershedtransform2d_a3a6b450b36a46ceac815608a24c911f

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.watershedtransform2d_a3a6b450b36a46ceac815608a24c911f.watershedtransform2d_a3a6b450b36a46ceac815608a24c911f

Watershed Transform 2D

interfacemethod computeWatershed2D(multiROI: MultiROI, channelLandscape, timestep, IProgress=None)

Computes the watershed transformation of a MultiROI over a landscape, slice by slice.

Parameters:
interfacemethod computeWatershed2DWithMask(multiROI: MultiROI, channelLandscape, maskROI, timestep, IProgress=None)

Computes the watershed transformation of a MultiROI over a landscape, slice by slice, with a mask.

Parameters:
classmethod extractSliceAsChannel(channel, sliceIndex, timestep, IProgress=None)

Extract a single slice from a Channel as a new Channel.

classmethod extractSliceAsMultiROI(multiROI, sliceIndex, timestep, IProgress=None)

Extract a single slice from a MultiROI as a new MultiROI.

classmethod extractSliceAsROI(roi, sliceIndex, timestep, IProgress=None)

Extract a single slice from an ROI as a new ROI.

classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

  • aCollectionOfObjects – a list of those objects currently being selected

  • implementation – an instance of OrsGenericMenuItem in the current context (optional)

Returns:

output –

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected.

watershedtransform_bd366e54a3c411e7bac30cc47aab53c3

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.watershedtransform_bd366e54a3c411e7bac30cc47aab53c3.watershedtransform_bd366e54a3c411e7bac30cc47aab53c3
interfacemethod computeWatershed(multiROI: MultiROI, channelLandscape: Channel, timestep: int) → None

Computes the watershed transformation of a MultiROI over a landscape.

Parameters:
interfacemethod computeWatershedWithMask(multiROI: MultiROI, channelLandscape: Channel, maskROI: ROI, timestep: int) → None

Computes the watershed transformation of a MultiROI over a landscape.

Parameters:
classmethod getIsSelectionValid(aCollectionOfObjects, implementation)
Parameters:

aCollectionOfObjects – a list of objects currently being selected, i.e. on which the menu item could be applied.

Returns:

output – if True, the menu item will be displayed.

classmethod getMenuItemForSelection(aCollectionOfObjects, implementation)

Returns the menu item :param aCollectionOfObjects: a list of objects currently being selected, i.e. on which the menu item will be applied. :return: Menu

classmethod menuItemEntryPoint(collectionString)

Will be executed when the menu item is selected. :param collectionString: a list of objects representation currently being selected, i.e. on which the menu item will be applied.

whatIsNew_dba393acbf8b11ee969dfc3497105300

class OrsPythonPlugins.OrsGenericMenuItems.menuItems.whatIsNew_dba393acbf8b11ee969dfc3497105300.whatIsNew_dba393acbf8b11ee969dfc3497105300
classmethod getMenuItem()
Returns:

output – Menu item

classmethod menuItemEntryPoint()

Will be executed when the menu item is selected.