prepare_variation_modelPrepareVariationModelPrepareVariationModelprepare_variation_modelT_prepare_variation_model🔗

Short description🔗

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

Signature🔗

prepare_variation_model( variation_model ModelID, number AbsThreshold, number VarThreshold )

Description🔗

prepare_variation_modelPrepareVariationModel prepares a variation model for the image comparison with compare_variation_modelCompareVariationModel or compare_ext_variation_modelCompareExtVariationModel. This is done by converting the ideal image and the variation image that have been trained with train_variation_modelTrainVariationModel into two threshold images and storing them in the variation model. These threshold images are used in compare_variation_modelCompareVariationModel or compare_ext_variation_modelCompareExtVariationModel to speed up the comparison of the current image to the variation model.

Two thresholds are used to compute the threshold images. The parameter AbsThresholdabsThresholdabs_threshold 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 VarThresholdvarThresholdvar_threshold determines a factor relative to the variation image for the minimum difference of the current image and the ideal image. AbsThresholdabsThresholdabs_threshold and VarThresholdvarThresholdvar_threshold 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, v(x,y) the variation image, \(a_{u}=\textrm{AbsThreshold}[0]\), \(a_{l}=\textrm{AbsThreshold}[1]\), \(b_{u}=\textrm{VarThreshold}[0]\), and \(b_{l}=\textrm{VarThreshold}[1]\) (or \(a_{u}=\textrm{AbsThreshold}\), \(a_{l}=\textrm{AbsThreshold}\), \(b_{u}=\textrm{VarThreshold}\), and \(b_{l}=\textrm{VarThreshold}\), respectively). Then the two threshold images \(t_{u,l}\) are computed as follows:

\[\begin{eqnarray*} t_{u}(x,y) = i(x,y) + \max \{ a_{u} , b_{u} v(x,y) \} \qquad t_{l}(x,y) = i(x,y) - \max \{ a_{l} , b_{l} v(x,y) \} \enspace . \end{eqnarray*}\]

If the current image c(x,y) is compared to the variation model using compare_variation_modelCompareVariationModel, the output region contains all points that differ substantially from the model, i.e., that fulfill the following condition:

\[\begin{eqnarray*} c(x,y) > t_{u}(x,y) \lor c(x,y) < t_{l}(x,y) \enspace . \end{eqnarray*}\]

In compare_ext_variation_modelCompareExtVariationModel, 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_modelGetThreshImagesVariationModel. Furthermore, the training data can be deleted with clear_train_data_variation_modelClearTrainDataVariationModel to save memory.

Execution information🔗

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:

ModelIDmodelIDmodel_id

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

Parameters🔗

ModelIDmodelIDmodel_id (input_control, state is modified) variation_model → (handle)HTuple (HHandle)HVariationModel, HTuple (IntPtr)HHandleHtuple (handle)

ID of the variation model.

AbsThresholdabsThresholdabs_threshold (input_control) number(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)

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

Default: 1010
Suggested values: 0, 5, 10, 15, 20, 30, 40, 500, 5, 10, 15, 20, 30, 40, 50
Restriction: AbsThreshold >= 0

VarThresholdvarThresholdvar_threshold (input_control) number(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)

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

Default: 22
Suggested values: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 51, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5
Restriction: VarThreshold >= 0

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

train_variation_modelTrainVariationModel

Possible successors

compare_variation_modelCompareVariationModel, compare_ext_variation_modelCompareExtVariationModel, get_thresh_images_variation_modelGetThreshImagesVariationModel, clear_train_data_variation_modelClearTrainDataVariationModel, write_variation_modelWriteVariationModel

Alternatives

prepare_direct_variation_modelPrepareDirectVariationModel

Module🔗

Matching