get_deformable_surface_model_paramT_get_deformable_surface_model_paramGetDeformableSurfaceModelParamGetDeformableSurfaceModelParam (Operator)

Name

get_deformable_surface_model_paramT_get_deformable_surface_model_paramGetDeformableSurfaceModelParamGetDeformableSurfaceModelParam — Return the parameters and properties of a deformable surface model.

Signature

get_deformable_surface_model_param( : : DeformableSurfaceModel, GenParamName : GenParamValue)

Herror T_get_deformable_surface_model_param(const Htuple DeformableSurfaceModel, const Htuple GenParamName, Htuple* GenParamValue)

void GetDeformableSurfaceModelParam(const HTuple& DeformableSurfaceModel, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HDeformableSurfaceModel::GetDeformableSurfaceModelParam(const HTuple& GenParamName) const

HTuple HDeformableSurfaceModel::GetDeformableSurfaceModelParam(const HString& GenParamName) const

HTuple HDeformableSurfaceModel::GetDeformableSurfaceModelParam(const char* GenParamName) const

HTuple HDeformableSurfaceModel::GetDeformableSurfaceModelParam(const wchar_t* GenParamName) const   (Windows only)

static void HOperatorSet.GetDeformableSurfaceModelParam(HTuple deformableSurfaceModel, HTuple genParamName, out HTuple genParamValue)

HTuple HDeformableSurfaceModel.GetDeformableSurfaceModelParam(HTuple genParamName)

HTuple HDeformableSurfaceModel.GetDeformableSurfaceModelParam(string genParamName)

Description

The operator get_deformable_surface_model_paramget_deformable_surface_model_paramGetDeformableSurfaceModelParamGetDeformableSurfaceModelParamGetDeformableSurfaceModelParam returns parameters and properties of the surface model DeformableSurfaceModelDeformableSurfaceModelDeformableSurfaceModelDeformableSurfaceModeldeformableSurfaceModel. The surface model must have been created with, for example, create_deformable_surface_modelcreate_deformable_surface_modelCreateDeformableSurfaceModelCreateDeformableSurfaceModelCreateDeformableSurfaceModel.

The following values are possible for GenParamNameGenParamNameGenParamNameGenParamNamegenParamName:

'diameter'"diameter""diameter""diameter""diameter":

Diameter of the model point cloud. The diameter is the length of the diagonal of the axis-parallel bounding box.

'sampled_model'"sampled_model""sampled_model""sampled_model""sampled_model":

The 3D points sampled from the model for matching. This returns a 3D object model that contains all points sampled from the model surface for matching.

'training_models'"training_models""training_models""training_models""training_models":

This returns all 3D object models that were used for the training of the deformable surface model. This includes the 3D object model passed to and sampled by create_deformable_surface_modelcreate_deformable_surface_modelCreateDeformableSurfaceModelCreateDeformableSurfaceModelCreateDeformableSurfaceModel, and the 3D object models added with add_deformable_surface_model_sampleadd_deformable_surface_model_sampleAddDeformableSurfaceModelSampleAddDeformableSurfaceModelSampleAddDeformableSurfaceModelSample.

'reference_points_x'"reference_points_x""reference_points_x""reference_points_x""reference_points_x":
'reference_points_y'"reference_points_y""reference_points_y""reference_points_y""reference_points_y":
'reference_points_z'"reference_points_z""reference_points_z""reference_points_z""reference_points_z":

Returns the x-, y- or z-coordinates of all reference points added with the operator add_deformable_surface_model_reference_pointadd_deformable_surface_model_reference_pointAddDeformableSurfaceModelReferencePointAddDeformableSurfaceModelReferencePointAddDeformableSurfaceModelReferencePoint.

Execution Information

Parameters

DeformableSurfaceModelDeformableSurfaceModelDeformableSurfaceModelDeformableSurfaceModeldeformableSurfaceModel (input_control)  deformable_surface_model HDeformableSurfaceModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the deformable surface model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of the parameter.

Default value: 'sampled_model' "sampled_model" "sampled_model" "sampled_model" "sampled_model"

List of values: 'diameter'"diameter""diameter""diameter""diameter", 'reference_points_x'"reference_points_x""reference_points_x""reference_points_x""reference_points_x", 'reference_points_y'"reference_points_y""reference_points_y""reference_points_y""reference_points_y", 'reference_points_z'"reference_points_z""reference_points_z""reference_points_z""reference_points_z", 'sampled_model'"sampled_model""sampled_model""sampled_model""sampled_model", 'sampled_pose_refinement'"sampled_pose_refinement""sampled_pose_refinement""sampled_pose_refinement""sampled_pose_refinement", 'training_models'"training_models""training_models""training_models""training_models"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  attribute.value(-array) HTupleHTupleHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong)

Value of the parameter.

Result

get_deformable_surface_model_paramget_deformable_surface_model_paramGetDeformableSurfaceModelParamGetDeformableSurfaceModelParamGetDeformableSurfaceModelParam returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

create_deformable_surface_modelcreate_deformable_surface_modelCreateDeformableSurfaceModelCreateDeformableSurfaceModelCreateDeformableSurfaceModel, read_deformable_surface_modelread_deformable_surface_modelReadDeformableSurfaceModelReadDeformableSurfaceModelReadDeformableSurfaceModel, add_deformable_surface_model_reference_pointadd_deformable_surface_model_reference_pointAddDeformableSurfaceModelReferencePointAddDeformableSurfaceModelReferencePointAddDeformableSurfaceModelReferencePoint

Possible Successors

find_deformable_surface_modelfind_deformable_surface_modelFindDeformableSurfaceModelFindDeformableSurfaceModelFindDeformableSurfaceModel, refine_deformable_surface_modelrefine_deformable_surface_modelRefineDeformableSurfaceModelRefineDeformableSurfaceModelRefineDeformableSurfaceModel, write_deformable_surface_modelwrite_deformable_surface_modelWriteDeformableSurfaceModelWriteDeformableSurfaceModelWriteDeformableSurfaceModel

See also

create_deformable_surface_modelcreate_deformable_surface_modelCreateDeformableSurfaceModelCreateDeformableSurfaceModelCreateDeformableSurfaceModel

Module

3D Metrology