Skip to content

get_deformable_surface_model_paramGetDeformableSurfaceModelParamGetDeformableSurfaceModelParamget_deformable_surface_model_paramT_get_deformable_surface_model_param🔗

Short description🔗

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

Signature🔗

get_deformable_surface_model_param( deformable_surface_model DeformableSurfaceModel, attribute.name GenParamName, out attribute.value GenParamValue )void GetDeformableSurfaceModelParam( const HTuple& DeformableSurfaceModel, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetDeformableSurfaceModelParam( HTuple deformableSurfaceModel, HTuple genParamName, out HTuple genParamValue )def get_deformable_surface_model_param( deformable_surface_model: HHandle, gen_param_name: MaybeSequence[str] ) -> Sequence[Union[str, float, int]]

def get_deformable_surface_model_param_s( deformable_surface_model: HHandle, gen_param_name: MaybeSequence[str] ) -> Union[str, float, int]Herror T_get_deformable_surface_model_param( 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)

HTuple HDeformableSurfaceModel.GetDeformableSurfaceModelParam( HTuple genParamName )

HTuple HDeformableSurfaceModel.GetDeformableSurfaceModelParam( string genParamName )

Description🔗

The operator get_deformable_surface_model_paramGetDeformableSurfaceModelParam returns parameters and properties of the surface model DeformableSurfaceModeldeformableSurfaceModeldeformable_surface_model. The surface model must have been created with, for example, create_deformable_surface_modelCreateDeformableSurfaceModel.

The following values are possible for GenParamNamegenParamNamegen_param_name:

Execution information🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

DeformableSurfaceModeldeformableSurfaceModeldeformable_surface_model (input_control) deformable_surface_model → (handle)HTuple (HHandle)HDeformableSurfaceModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the deformable surface model.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Name of the parameter.

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

GenParamValuegenParamValuegen_param_value (output_control) attribute.value(-array) → (real / string / integer)HTuple (double / HString / Hlong)HTuple (double / string / int / long)Sequence[Union[str, float, int]]Htuple (double / char* / Hlong)

Value of the parameter.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_deformable_surface_modelCreateDeformableSurfaceModel, read_deformable_surface_modelReadDeformableSurfaceModel, add_deformable_surface_model_reference_pointAddDeformableSurfaceModelReferencePoint

Possible successors

find_deformable_surface_modelFindDeformableSurfaceModel, refine_deformable_surface_modelRefineDeformableSurfaceModel, write_deformable_surface_modelWriteDeformableSurfaceModel

See also

create_deformable_surface_modelCreateDeformableSurfaceModel

Module🔗

3D Metrology