prepare_direct_variation_modelT_prepare_direct_variation_modelPrepareDirectVariationModelPrepareDirectVariationModel (Operator)

Name

prepare_direct_variation_modelT_prepare_direct_variation_modelPrepareDirectVariationModelPrepareDirectVariationModel — Prepare a variation model for comparison with an image.

Signature

prepare_direct_variation_model(RefImage, VarImage : : ModelID, AbsThreshold, VarThreshold : )

Description

prepare_direct_variation_modelprepare_direct_variation_modelPrepareDirectVariationModelPrepareDirectVariationModelPrepareDirectVariationModel prepares a variation model for the image comparison with compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModel or compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModel. The variation model must have been created with Mode='direct'"direct""direct""direct""direct" with create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelCreateVariationModel. In contrast to prepare_variation_modelprepare_variation_modelPrepareVariationModelPrepareVariationModelPrepareVariationModel, the ideal image of the object and the corresponding variation image are not computed with train_variation_modeltrain_variation_modelTrainVariationModelTrainVariationModelTrainVariationModel, but are specified directly in RefImageRefImageRefImageRefImagerefImage and VarImageVarImageVarImageVarImagevarImage. This is useful if the variation model should be created from a single image, as described with create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelCreateVariationModel. The variation image should typically be created with edge operators like sobel_ampsobel_ampSobelAmpSobelAmpSobelAmp, edges_imageedges_imageEdgesImageEdgesImageEdgesImage, or gray_range_rectgray_range_rectGrayRangeRectGrayRangeRectGrayRangeRect.

prepare_direct_variation_modelprepare_direct_variation_modelPrepareDirectVariationModelPrepareDirectVariationModelPrepareDirectVariationModel converts the ideal image RefImageRefImageRefImageRefImagerefImage and the variation image VarImageVarImageVarImageVarImagevarImage into two threshold images and stores them in the variation model. These threshold images are used in compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModel or compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModel to perform the comparison of the current image to the variation model.

Two thresholds are used to compute the threshold images. The parameter AbsThresholdAbsThresholdAbsThresholdAbsThresholdabsThreshold determines the minimum amount of gray levels by which the image of the current object must differ from the image of the ideal object. The parameter VarThresholdVarThresholdVarThresholdVarThresholdvarThreshold determines a factor relative to the variation image for the minimum difference of the current image and the ideal image. VarThresholdVarThresholdVarThresholdVarThresholdvarThreshold utilizes VarImageVarImageVarImageVarImagevarImage to define regions, in which differences in gray values may occur which should not be counted as errors. This allows variations for specific parts of the object to inspect. AbsThresholdAbsThresholdAbsThresholdAbsThresholdabsThreshold and VarThresholdVarThresholdVarThresholdVarThresholdvarThreshold each can contain one or two values. If two values are specified, different thresholds can be determined for too bright and too dark pixels. In this mode, the first value refers to too bright pixels, while the second value refers to too dark pixels. If one value is specified, this value refers to both the too bright and too dark pixels. Let i(x,y) be the ideal image RefImageRefImageRefImageRefImagerefImage, v(x,y) the variation image VarImageVarImageVarImageVarImagevarImage, , , , and (or , , , and , respectively). Then the two threshold images are computed as follows: If the current image c(x,y) is compared to the variation model using compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModel, the output region contains all points that differ substantially from the model, i.e., that fulfill the following condition: In compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModel, extended comparison modes are available, which return only too bright errors, only too dark errors, or bright and dark errors as separate regions.

After the threshold images have been created they can be read out with get_thresh_images_variation_modelget_thresh_images_variation_modelGetThreshImagesVariationModelGetThreshImagesVariationModelGetThreshImagesVariationModel.

It should be noted that RefImageRefImageRefImageRefImagerefImage and VarImageVarImageVarImageVarImagevarImage are not stored as the ideal and variation images in the model to save memory in the 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:

ModelIDModelIDModelIDModelIDmodelID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

RefImageRefImageRefImageRefImagerefImage (input_object) singlechannelimage → object (byte / int2 / uint2)

Reference image of the object.

VarImageVarImageVarImageVarImagevarImage (input_object) singlechannelimage → object (byte / int2 / uint2)

Variation image of the object.

ModelIDModelIDModelIDModelIDmodelID (input_control, state is modified) variation_model → (handle)

ID of the variation model.

AbsThresholdAbsThresholdAbsThresholdAbsThresholdabsThreshold (input_control) number(-array) → (real / integer)

Absolute minimum threshold for the differences between the image and the variation model.

Default value: 10

Suggested values: 0, 5, 10, 15, 20, 30, 40, 50

Restriction: AbsThreshold >= 0

VarThresholdVarThresholdVarThresholdVarThresholdvarThreshold (input_control) number(-array) → (real / integer)

Threshold for the differences based on the variation of the variation model.

Default value: 2

Suggested values: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5

Restriction: VarThreshold >= 0

Example (HDevelop)

read_image (Image, 'model')
sobel_amp (Image, VarImage, 'sum_abs', 3)
get_image_pointer1 (Image, Pointer, Type, Width, Height)
create_variation_model (Width, Height, Type, 'direct', ModelID)
prepare_direct_variation_model (Image, VarImage, ModelID, 20, 1)
write_variation_model (ModelID, 'model.var')

Result

prepare_direct_variation_modelprepare_direct_variation_modelPrepareDirectVariationModelPrepareDirectVariationModelPrepareDirectVariationModel returns 2 (H_MSG_TRUE) if all parameters are correct.