find_symmetries_object_model_3dT_find_symmetries_object_model_3dFindSymmetriesObjectModel3dFindSymmetriesObjectModel3dfind_symmetries_object_model_3d (Operator)

Name

find_symmetries_object_model_3dT_find_symmetries_object_model_3dFindSymmetriesObjectModel3dFindSymmetriesObjectModel3dfind_symmetries_object_model_3d — find_symmetries_object_model_3d detects symmetries of a 3D model with parameterizable accuracy and return them in form of a dictionary.

Signature

find_symmetries_object_model_3d( : : ObjectModel3D, GenParamName, GenParamValue : SymmetryInfo)

Herror T_find_symmetries_object_model_3d(const Htuple ObjectModel3D, const Htuple GenParamName, const Htuple GenParamValue, Htuple* SymmetryInfo)

void FindSymmetriesObjectModel3d(const HTuple& ObjectModel3D, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* SymmetryInfo)

static HDictArray HObjectModel3D::FindSymmetriesObjectModel3d(const HObjectModel3DArray& ObjectModel3D, const HTuple& GenParamName, const HTuple& GenParamValue)

HDict HObjectModel3D::FindSymmetriesObjectModel3d(const HString& GenParamName, const HString& GenParamValue) const

HDict HObjectModel3D::FindSymmetriesObjectModel3d(const char* GenParamName, const char* GenParamValue) const

HDict HObjectModel3D::FindSymmetriesObjectModel3d(const wchar_t* GenParamName, const wchar_t* GenParamValue) const   ( Windows only)

static void HOperatorSet.FindSymmetriesObjectModel3d(HTuple objectModel3D, HTuple genParamName, HTuple genParamValue, out HTuple symmetryInfo)

static HDict[] HObjectModel3D.FindSymmetriesObjectModel3d(HObjectModel3D[] objectModel3D, HTuple genParamName, HTuple genParamValue)

HDict HObjectModel3D.FindSymmetriesObjectModel3d(string genParamName, string genParamValue)

def find_symmetries_object_model_3d(object_model_3d: MaybeSequence[HHandle], gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[str, float, int]]) -> Sequence[HHandle]

def find_symmetries_object_model_3d_s(object_model_3d: MaybeSequence[HHandle], gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[str, float, int]]) -> HHandle

Description

find_symmetries_object_model_3dfind_symmetries_object_model_3dFindSymmetriesObjectModel3dFindSymmetriesObjectModel3dfind_symmetries_object_model_3d analyzes an ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d with parameterizable precision.

The generic parameter pair GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value is used to set additional parameters for the analysis. GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name contains the tuple of parameter names that shall be set and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the corresponding values. The following values are possible for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name:

'max_n_gon'"max_n_gon""max_n_gon""max_n_gon""max_n_gon":

The maximum number of symmetrical poses that can be found in one plane of rotation before classifying the symmetry as continuous.

Suggested values: 15, 25

Default: 21

Restriction: 2 < 'max_n_gon'"max_n_gon""max_n_gon""max_n_gon""max_n_gon"

If the ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d handle is valid and triangles or polygons are present, a dictionary describing the found symmetric properties of the model is returned. After successful execution, the dictionary contains a selection of the following entries.

'symmetry_type'"symmetry_type""symmetry_type""symmetry_type""symmetry_type":

This key is always present after successful execution of find_symmetries_object_model_3dfind_symmetries_object_model_3dFindSymmetriesObjectModel3dFindSymmetriesObjectModel3dfind_symmetries_object_model_3d. The possible values stored under this key are:

'none'"none""none""none""none":

No symmetries were found for the given ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d.

'discrete'"discrete""discrete""discrete""discrete":

A set of discrete symmetries was found.

'cone'"cone""cone""cone""cone":

The ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d has the symmetry class of a cone, being rotationally invariant around a 3D line.

'cylinder'"cylinder""cylinder""cylinder""cylinder":

The ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d has the symmetry class of a cylinder, being rotationally invariant around a 3D line additionally to a flip around the center of symmetry perpendicular to the line.

'sphere'"sphere""sphere""sphere""sphere":

The ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d has the symmetry class of a sphere.

'discrete_poses'"discrete_poses""discrete_poses""discrete_poses""discrete_poses":

If 'symmetry_type'"symmetry_type""symmetry_type""symmetry_type""symmetry_type" is 'discrete'"discrete""discrete""discrete""discrete": a tuple of poses that the the ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d is invariant to.

'symmetry_center'"symmetry_center""symmetry_center""symmetry_center""symmetry_center":

The point inside the ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d that is invariant to all symmetrical poses. This key is always present after successful execution of find_symmetries_object_model_3dfind_symmetries_object_model_3dFindSymmetriesObjectModel3dFindSymmetriesObjectModel3dfind_symmetries_object_model_3d.

'symmetry_axis'"symmetry_axis""symmetry_axis""symmetry_axis""symmetry_axis":

If 'symmetry_type'"symmetry_type""symmetry_type""symmetry_type""symmetry_type" is 'cone'"cone""cone""cone""cone" or 'cylinder'"cylinder""cylinder""cylinder""cylinder", the direction of the 3D line describing the symmetry.

Execution Information

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d (input_control)  object_model_3d(-array) → HObjectModel3D, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the ObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d to be analyzed.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the generic parameters to be set.

Default: []

List of values: 'max_n_gon'"max_n_gon""max_n_gon""max_n_gon""max_n_gon"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  string(-array) → HTupleMaybeSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)

Values of the generic parameters to be set.

Default: []

Suggested values: 21

SymmetryInfoSymmetryInfoSymmetryInfosymmetryInfosymmetry_info (output_control)  dict(-array) → HDict, HTupleSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the dictionary containing the symmetry information.

Example (HDevelop)

* Example on how to use find_symmetries_object_model_3d to analyze the symmetry of an object_model_3d.
read_object_model_3d ('tile_spacer', 'm', [], [], ObjectModel3D, Status)
find_symmetries_object_model_3d (ObjectModel3D, [], [], SymmetryInfo)

Result

find_symmetries_object_model_3dfind_symmetries_object_model_3dFindSymmetriesObjectModel3dFindSymmetriesObjectModel3dfind_symmetries_object_model_3d returns the described dictionary if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

read_object_model_3dread_object_model_3dReadObjectModel3dReadObjectModel3dread_object_model_3d

Possible Successors

create_deep_matching_3dcreate_deep_matching_3dCreateDeepMatching3dCreateDeepMatching3dcreate_deep_matching_3d, set_surface_model_paramset_surface_model_paramSetSurfaceModelParamSetSurfaceModelParamset_surface_model_param

Module

3D Metrology