Operator Reference

prepare_variation_modelT_prepare_variation_modelPrepareVariationModelPrepareVariationModelprepare_variation_model (Operator)

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

Signature

prepare_variation_model( : : ModelID, AbsThreshold, VarThreshold : )

Herror T_prepare_variation_model(const Htuple ModelID, const Htuple AbsThreshold, const Htuple VarThreshold)

void PrepareVariationModel(const HTuple& ModelID, const HTuple& AbsThreshold, const HTuple& VarThreshold)

void HVariationModel::PrepareVariationModel(const HTuple& AbsThreshold, const HTuple& VarThreshold) const

void HVariationModel::PrepareVariationModel(double AbsThreshold, double VarThreshold) const

static void HOperatorSet.PrepareVariationModel(HTuple modelID, HTuple absThreshold, HTuple varThreshold)

void HVariationModel.PrepareVariationModel(HTuple absThreshold, HTuple varThreshold)

void HVariationModel.PrepareVariationModel(double absThreshold, double varThreshold)

def prepare_variation_model(model_id: HHandle, abs_threshold: MaybeSequence[Union[float, int]], var_threshold: MaybeSequence[Union[float, int]]) -> None

Description

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

Two thresholds are used to compute the threshold images. The parameter AbsThresholdAbsThresholdAbsThresholdabsThresholdabs_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 VarThresholdVarThresholdVarThresholdvarThresholdvar_threshold determines a factor relative to the variation image for the minimum difference of the current image and the ideal image. AbsThresholdAbsThresholdAbsThresholdabsThresholdabs_threshold and VarThresholdVarThresholdVarThresholdvarThresholdvar_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, , , , 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_modelCompareVariationModelCompareVariationModelcompare_variation_model, 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_modelCompareExtVariationModelCompareExtVariationModelcompare_ext_variation_model, 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_modelGetThreshImagesVariationModelGetThreshImagesVariationModelget_thresh_images_variation_model. Furthermore, the training data can be deleted with clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model to save memory.

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

ModelIDModelIDModelIDmodelIDmodel_id (input_control, state is modified)  variation_model HVariationModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

ID of the variation model.

AbsThresholdAbsThresholdAbsThresholdabsThresholdabs_threshold (input_control)  number(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

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

Default: 10

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

Restriction: AbsThreshold >= 0

VarThresholdVarThresholdVarThresholdvarThresholdvar_threshold (input_control)  number(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

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

Default: 2

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

Restriction: VarThreshold >= 0

Result

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

Possible Predecessors

train_variation_modeltrain_variation_modelTrainVariationModelTrainVariationModeltrain_variation_model

Possible Successors

compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelcompare_variation_model, compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelcompare_ext_variation_model, get_thresh_images_variation_modelget_thresh_images_variation_modelGetThreshImagesVariationModelGetThreshImagesVariationModelget_thresh_images_variation_model, clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model, write_variation_modelwrite_variation_modelWriteVariationModelWriteVariationModelwrite_variation_model

Alternatives

prepare_direct_variation_modelprepare_direct_variation_modelPrepareDirectVariationModelPrepareDirectVariationModelprepare_direct_variation_model

See also

create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelcreate_variation_model

Module

Matching