Operator Reference

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

set_bead_inspection_paramT_set_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param (Operator)

set_bead_inspection_paramT_set_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param — Set parameters of the bead inspection model.

Signature

set_bead_inspection_param( : : BeadInspectionModel, GenParamName, GenParamValue : )

Herror T_set_bead_inspection_param(const Htuple BeadInspectionModel, const Htuple GenParamName, const Htuple GenParamValue)

void SetBeadInspectionParam(const HTuple& BeadInspectionModel, const HTuple& GenParamName, const HTuple& GenParamValue)

void HBeadInspectionModel::SetBeadInspectionParam(const HTuple& GenParamName, const HTuple& GenParamValue) const

void HBeadInspectionModel::SetBeadInspectionParam(const HString& GenParamName, const HString& GenParamValue) const

void HBeadInspectionModel::SetBeadInspectionParam(const char* GenParamName, const char* GenParamValue) const

void HBeadInspectionModel::SetBeadInspectionParam(const wchar_t* GenParamName, const wchar_t* GenParamValue) const   ( Windows only)

static void HOperatorSet.SetBeadInspectionParam(HTuple beadInspectionModel, HTuple genParamName, HTuple genParamValue)

void HBeadInspectionModel.SetBeadInspectionParam(HTuple genParamName, HTuple genParamValue)

void HBeadInspectionModel.SetBeadInspectionParam(string genParamName, string genParamValue)

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

Description

The operator set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param is used to set parameters of a bead inspection model in order to adapt it to a particular inspection task. All parameters except for the model's contour can be set with this operator. A new bead inspection model should be used when a new contour is introduced. The current values of all parameters can be queried with the operator get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param.

Parameters that can be set

The following parameters are essential and inspection model specific. It is vital for the inspection's success to identify accurate values for those parameters:

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

sets the TargetThicknessTargetThicknessTargetThicknesstargetThicknesstarget_thickness.

'thickness_tolerance'"thickness_tolerance""thickness_tolerance""thickness_tolerance""thickness_tolerance":

sets the ThicknessToleranceThicknessToleranceThicknessTolerancethicknessTolerancethickness_tolerance.

'position_tolerance'"position_tolerance""position_tolerance""position_tolerance""position_tolerance":

sets the PositionTolerancePositionTolerancePositionTolerancepositionToleranceposition_tolerance.

'polarity'"polarity""polarity""polarity""polarity":

sets the bead's PolarityPolarityPolaritypolaritypolarity.

'sigma'"sigma""sigma""sigma""sigma"
'threshold'"threshold""threshold""threshold""threshold"

For more details, refer to the parameters' description in create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

BeadInspectionModelBeadInspectionModelBeadInspectionModelbeadInspectionModelbead_inspection_model (input_control, state is modified)  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 shall be adjusted for the specified bead inspection model.

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 (input_control)  attribute.value(-array) → HTupleMaybeSequence[Union[int, float, str]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Value of the model parameter that shall be adjusted for the specified bead inspection model.

Default: 40

Suggested values: 40, 10, 15, 0.6, 1.0, 4.0, 5.0, 'light'"light""light""light""light", 'dark'"dark""dark""dark""dark"

Result

The operator set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_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

Possible Successors

apply_bead_inspection_modelapply_bead_inspection_modelApplyBeadInspectionModelApplyBeadInspectionModelapply_bead_inspection_model, get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param

Alternatives

create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model

See also

create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model, clear_bead_inspection_modelclear_bead_inspection_modelClearBeadInspectionModelClearBeadInspectionModelclear_bead_inspection_model

Module

2D Metrology

ClassesClasses | | Operators