Operator Reference

HALCON Operator Reference / Inspection / Structured Light
ClassesClasses | | Operators

get_structured_light_model_paramT_get_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamget_structured_light_model_param (Operator)

get_structured_light_model_paramT_get_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamget_structured_light_model_param — Query parameters of a structured light model.

Signature

get_structured_light_model_param( : : StructuredLightModel, GenParamName : GenParamValue)

Herror T_get_structured_light_model_param(const Htuple StructuredLightModel, const Htuple GenParamName, Htuple* GenParamValue)

void GetStructuredLightModelParam(const HTuple& StructuredLightModel, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HStructuredLightModel::GetStructuredLightModelParam(const HTuple& GenParamName) const

HTuple HStructuredLightModel::GetStructuredLightModelParam(const HString& GenParamName) const

HTuple HStructuredLightModel::GetStructuredLightModelParam(const char* GenParamName) const

HTuple HStructuredLightModel::GetStructuredLightModelParam(const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetStructuredLightModelParam(HTuple structuredLightModel, HTuple genParamName, out HTuple genParamValue)

HTuple HStructuredLightModel.GetStructuredLightModelParam(HTuple genParamName)

HTuple HStructuredLightModel.GetStructuredLightModelParam(string genParamName)

def get_structured_light_model_param(structured_light_model: HHandle, gen_param_name: MaybeSequence[str]) -> Sequence[Union[int, float, str]]

def get_structured_light_model_param_s(structured_light_model: HHandle, gen_param_name: MaybeSequence[str]) -> Union[int, float, str]

Description

The operator get_structured_light_model_paramget_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamget_structured_light_model_param is used to query the values of the different parameters of a structured light model (StructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModelstructured_light_model). The names of the desired parameters are passed in the parameter GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are returned in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. It is possible to query multiple parameters with a single call to get_structured_light_model_paramget_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamget_structured_light_model_param.

All parameters which can be manipulated by set_structured_light_model_paramset_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamset_structured_light_model_param can be queried. Please refer to the documentation of set_structured_light_model_paramset_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamset_structured_light_model_param for an explanation of the individual parameters.

The following additional parameter can be queried:

'type'"type""type""type""type":

Type of the structured light model (currently either 'deflectometry'"deflectometry""deflectometry""deflectometry""deflectometry" or '3d_reconstruction'"3d_reconstruction""3d_reconstruction""3d_reconstruction""3d_reconstruction", as set in create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelcreate_structured_light_model).

For an explanation of the concept of structured light and its supported applications, see the introduction of chapter Inspection / Structured Light.

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

StructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModelstructured_light_model (input_control)  structured_light_model → HStructuredLightModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the structured light model.

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

Name of the queried model parameter.

Default: 'min_stripe_width' "min_stripe_width" "min_stripe_width" "min_stripe_width" "min_stripe_width"

List of values: 'camera_setup_model'"camera_setup_model""camera_setup_model""camera_setup_model""camera_setup_model", 'derivative_sigma'"derivative_sigma""derivative_sigma""derivative_sigma""derivative_sigma", 'min_gray_difference'"min_gray_difference""min_gray_difference""min_gray_difference""min_gray_difference", 'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width", 'normalization'"normalization""normalization""normalization""normalization", 'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height", 'pattern_orientation'"pattern_orientation""pattern_orientation""pattern_orientation""pattern_orientation", 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type", 'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width", 'persistence'"persistence""persistence""persistence""persistence", 'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width", 'type'"type""type""type""type"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  attribute.value(-array) → HTupleSequence[Union[int, float, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Value of the queried model parameter.

Example (HDevelop)

* Create the model
create_structured_light_model ('deflectometry', StructuredLightModel)
* Get the default value
get_structured_light_model_param (StructuredLightModel, \
                                  'min_stripe_width', Default)
* Set the value
set_structured_light_model_param (StructuredLightModel, \
                                  'min_stripe_width', 64)
* Get the value
get_structured_light_model_param (StructuredLightModel, 'min_stripe_width', \
                                  MinStripeWidth)
* Generate the patterns to project
gen_structured_light_pattern (PatternImages, StructuredLightModel)
* Decode the camera images
decode_structured_light_pattern (CameraImages, StructuredLightModel)

Result

The operator get_structured_light_model_paramget_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamget_structured_light_model_param returns the value 2 ( H_MSG_TRUE) if the given parameters are valid. Otherwise, an exception will be raised.

Possible Predecessors

create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelcreate_structured_light_model

See also

set_structured_light_model_paramset_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamset_structured_light_model_param

Module

3D Metrology

ClassesClasses | | Operators