Operator Reference

HALCON Operator Reference / Inspection / Bead Inspection
ClassesClasses | | Operators

get_bead_inspection_paramT_get_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param (Operator)

get_bead_inspection_paramT_get_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param — Get the value of a parameter in a specific bead inspection model.

Signature

get_bead_inspection_param( : : BeadInspectionModel, GenParamName : GenParamValue)

Herror T_get_bead_inspection_param(const Htuple BeadInspectionModel, const Htuple GenParamName, Htuple* GenParamValue)

void GetBeadInspectionParam(const HTuple& BeadInspectionModel, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HBeadInspectionModel::GetBeadInspectionParam(const HTuple& GenParamName) const

HTuple HBeadInspectionModel::GetBeadInspectionParam(const HString& GenParamName) const

HTuple HBeadInspectionModel::GetBeadInspectionParam(const char* GenParamName) const

HTuple HBeadInspectionModel::GetBeadInspectionParam(const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetBeadInspectionParam(HTuple beadInspectionModel, HTuple genParamName, out HTuple genParamValue)

HTuple HBeadInspectionModel.GetBeadInspectionParam(HTuple genParamName)

HTuple HBeadInspectionModel.GetBeadInspectionParam(string genParamName)

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

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

Description

The operator get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param is used to query the values of the different parameters of a bead inspection model. The names of the desired parameters are passed in the parameter GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the corresponding values are returned in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. All these parameters can be set and changed at any time with the operator set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param. Multiple parameters can be queried with a single call to get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param.

The parameters that can be queried are 'target_thickness'"target_thickness""target_thickness""target_thickness""target_thickness", 'thickness_tolerance'"thickness_tolerance""thickness_tolerance""thickness_tolerance""thickness_tolerance", 'position_tolerance'"position_tolerance""position_tolerance""position_tolerance""position_tolerance", 'polarity'"polarity""polarity""polarity""polarity", 'sigma'"sigma""sigma""sigma""sigma" and 'threshold'"threshold""threshold""threshold""threshold". Only the model's contour cannot be queried. Refer to set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param and create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model for a detailed description of all supported parameters.

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

BeadInspectionModelBeadInspectionModelBeadInspectionModelbeadInspectionModelbead_inspection_model (input_control)  bead_inspection_model → HBeadInspectionModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the bead inspection model.

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

Name of the model parameter that is queried.

Default: 'target_thickness' "target_thickness" "target_thickness" "target_thickness" "target_thickness"

List of values: 'polarity'"polarity""polarity""polarity""polarity", 'position_tolerance'"position_tolerance""position_tolerance""position_tolerance""position_tolerance", 'sigma'"sigma""sigma""sigma""sigma", 'target_thickness'"target_thickness""target_thickness""target_thickness""target_thickness", 'thickness_tolerance'"thickness_tolerance""thickness_tolerance""thickness_tolerance""thickness_tolerance", 'threshold'"threshold""threshold""threshold""threshold"

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.

Result

The operator get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param returns the value 2 ( H_MSG_TRUE) if the given parameters are valid and within acceptable range. Otherwise, an exception will be raised.

Possible Predecessors

create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model, set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param

Possible Successors

apply_bead_inspection_modelapply_bead_inspection_modelApplyBeadInspectionModelApplyBeadInspectionModelapply_bead_inspection_model, set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param

See also

create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model, set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param

Module

2D Metrology

ClassesClasses | | Operators