OrsCreateAnAnisotropyVectorFieldFromAROIOrMesh_1810d1420a9a11ec9cc4683e26fb6e0d

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:

Aug 31 2021 16:29

dragonflyVersion:

2021.3.0.1043 (D) Debug

UUID:

1810d1420a9a11ec9cc4683e26fb6e0d

Class Code

class OrsPythonPlugins.OrsCreateAnAnisotropyVectorFieldFromAROIOrMesh_1810d1420a9a11ec9cc4683e26fb6e0d.OrsCreateAnAnisotropyVectorFieldFromAROIOrMesh_1810d1420a9a11ec9cc4683e26fb6e0d.OrsCreateAnAnisotropyVectorFieldFromAROIOrMesh_1810d1420a9a11ec9cc4683e26fb6e0d(*args, **kwargs)
classmethod OrsCreateAnAnisotropyVectorFieldFromAROIOrMesh(listSelectedObjectsRepr)

Contextual menu.

This code will be executed when a contextual menu has to be displayed.

The menu item instances used in this method should be taken from menu item definitions declared in this plugin and filled with proper values (section, action, enabled, …). If multiple menu items have to be used by this method, they should be defined using the same pattern.

Parameters:

listSelectedObjectsRepr – list of selected objects (this argument is given as string representation)

Returns:

output – None, a single menu item instance, or a list of menu item instances

classmethod OrsCreateAnAnisotropyVectorFieldFromAROIOrMesh_menuItemDefinition()

Declaration of a plugin menu item.

This method has to be decorated by “menuItem(menuItemDefinition=True)”.

Returns:

output – Menu item instance

interfacemethod computeAnisotropyMappingFromSurfaceNormalsOnMesh(aMesh: Mesh, areaOfAnalysisBox: VisualBox, areaOfAnalysisSpacing: float, useSingleVoxelInDirectionWithSmallerBoxLength: bool, radiusOfInfluence: float, mappingsUseProjectionBasedAnisotropyComputation: bool) → Tuple[Channel, VectorField, Channel, Channel, VectorField, Channel]

Computes a map of the anisotropy of a mesh using the surface normals

Parameters:

  • aMesh (ORSModel.ors.Mesh) – a bone contour

  • areaOfAnalysisBox (ORSModel.ors.VisualBox) – visual box to use

  • areaOfAnalysisSpacing (float) – distance between the points in the analysis area

  • useSingleVoxelInDirectionWithSmallerBoxLength (bool) – if True, a single voxel will be used in the direction having the smaller length; otherwise, the same spacing will be used in that direction.

  • radiusOfInfluence (float) – distance from the analysis point to the last considered anisotropy element

  • mappingsUseProjectionBasedAnisotropyComputation (bool) – anisotropy computation method. If True, the projection based method is used; if False, the eigenvalues from the tensor of inertia are taken.

Returns:
interfacemethod computeAnisotropyMappingFromSurfaceNormalsOnROI(aROI: ROI, areaOfAnalysisBox: VisualBox, areaOfAnalysisSpacing: float, useSingleVoxelInDirectionWithSmallerBoxLength: bool, radiusOfInfluence: float, mappingsUseProjectionBasedAnisotropyComputation: bool, meshSmoothingRepetitions: int) → Tuple[Channel, VectorField, Channel, Channel, VectorField, Channel]

Computes a map of the anisotropy of a ROI using the surface normals

Parameters:

  • aROI (ORSModel.ors.ROI) – bone segmentation

  • areaOfAnalysisBox (ORSModel.ors.VisualBox) – visual box to use

  • areaOfAnalysisSpacing (float) – distance between the points in the analysis area

  • useSingleVoxelInDirectionWithSmallerBoxLength (bool) – if True, a single voxel will be used in the direction having the smaller length; otherwise, the same spacing will be used in that direction.

  • radiusOfInfluence (float) – distance from the analysis point to the last considered anisotropy element

  • mappingsUseProjectionBasedAnisotropyComputation (bool) – anisotropy computation method. If True, the projection based method is used; if False, the eigenvalues from the tensor of inertia are taken.

  • meshSmoothingRepetitions (int) – number of times the mesh obtained from the ROI should be smoothed before computing the anisotropy

Returns:
classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –