Operator Reference

apply_bead_inspection_modelT_apply_bead_inspection_modelApplyBeadInspectionModelApplyBeadInspectionModelapply_bead_inspection_model (Operator)

apply_bead_inspection_modelT_apply_bead_inspection_modelApplyBeadInspectionModelApplyBeadInspectionModelapply_bead_inspection_model — Inspect beads in an image, as defined by the bead inspection model.

Signature

Herror T_apply_bead_inspection_model(const Hobject Image, Hobject* LeftContour, Hobject* RightContour, Hobject* ErrorSegment, const Htuple BeadInspectionModel, Htuple* ErrorType)

void ApplyBeadInspectionModel(const HObject& Image, HObject* LeftContour, HObject* RightContour, HObject* ErrorSegment, const HTuple& BeadInspectionModel, HTuple* ErrorType)

HXLD HBeadInspectionModel::ApplyBeadInspectionModel(const HImage& Image, HXLD* RightContour, HXLD* ErrorSegment, HTuple* ErrorType) const

static void HOperatorSet.ApplyBeadInspectionModel(HObject image, out HObject leftContour, out HObject rightContour, out HObject errorSegment, HTuple beadInspectionModel, out HTuple errorType)

HXLD HBeadInspectionModel.ApplyBeadInspectionModel(HImage image, out HXLD rightContour, out HXLD errorSegment, out HTuple errorType)

def apply_bead_inspection_model(image: HObject, bead_inspection_model: HHandle) -> Tuple[HObject, HObject, HObject, Sequence[str]]

Description

The operator apply_bead_inspection_modelapply_bead_inspection_modelApplyBeadInspectionModelApplyBeadInspectionModelapply_bead_inspection_model applies the bead inspection model BeadInspectionModelBeadInspectionModelBeadInspectionModelbeadInspectionModelbead_inspection_model to the input ImageImageImageimageimage. The output parameter ErrorSegmentErrorSegmentErrorSegmenterrorSegmenterror_segment indicates the positions of detected errors. The parameter ErrorTypeErrorTypeErrorTypeerrorTypeerror_type indicates the type of the detected errors for each segment. For more details on the possible errors, refer to the parameters' description and figures in create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model. The value of ErrorTypeErrorTypeErrorTypeerrorTypeerror_type can be:

'no bead'"no bead""no bead""no bead""no bead":

No bead could be detected at this position.

'incorrect position'"incorrect position""incorrect position""incorrect position""incorrect position":

The center of the bead found at this position is further away from the contour than allowed by PositionTolerancePositionTolerancePositionTolerancepositionToleranceposition_tolerance.

'too thin'"too thin""too thin""too thin""too thin":

The bead is thinner than allowed by TargetThicknessTargetThicknessTargetThicknesstargetThicknesstarget_thickness and ThicknessToleranceThicknessToleranceThicknessTolerancethicknessTolerancethickness_tolerance.

'too thick'"too thick""too thick""too thick""too thick":

The bead is thicker than allowed by TargetThicknessTargetThicknessTargetThicknesstargetThicknesstarget_thickness and ThicknessToleranceThicknessToleranceThicknessTolerancethicknessTolerancethickness_tolerance.

Values of the generic parameters set through create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model or set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param highly affect the inspection results of the same model. For more details on those parameters, please refer to create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model.

Note that the operator ignores the image domain and applies the model to the full image

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

ImageImageImageimageimage (input_object)  singlechannelimage objectHImageHObjectHObjectHobject (byte / uint2)

Image to apply bead inspection on.

LeftContourLeftContourLeftContourleftContourleft_contour (output_object)  xld-array objectHXLDHObjectHObjectHobject *

The detected left contour of the beads.

RightContourRightContourRightContourrightContourright_contour (output_object)  xld-array objectHXLDHObjectHObjectHobject *

The detected right contour of the beads.

ErrorSegmentErrorSegmentErrorSegmenterrorSegmenterror_segment (output_object)  xld-array objectHXLDHObjectHObjectHobject *

Detected error segments

BeadInspectionModelBeadInspectionModelBeadInspectionModelbeadInspectionModelbead_inspection_model (input_control, state is modified)  bead_inspection_model HBeadInspectionModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the bead inspection model to be used.

ErrorTypeErrorTypeErrorTypeerrorTypeerror_type (output_control)  string-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Types of detected errors.

Result

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

set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param, clear_bead_inspection_modelclear_bead_inspection_modelClearBeadInspectionModelClearBeadInspectionModelclear_bead_inspection_model

See also

get_bead_inspection_paramget_bead_inspection_paramGetBeadInspectionParamGetBeadInspectionParamget_bead_inspection_param, create_bead_inspection_modelcreate_bead_inspection_modelCreateBeadInspectionModelCreateBeadInspectionModelcreate_bead_inspection_model, set_bead_inspection_paramset_bead_inspection_paramSetBeadInspectionParamSetBeadInspectionParamset_bead_inspection_param

Module

2D Metrology