clear_train_data_variation_modelT_clear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModel (Operator)

Name

clear_train_data_variation_modelT_clear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModel — Free the memory of the training data of a variation model.

Signature

clear_train_data_variation_model( : : ModelID : )

Herror T_clear_train_data_variation_model(const Htuple ModelID)

void ClearTrainDataVariationModel(const HTuple& ModelID)

void HVariationModel::ClearTrainDataVariationModel() const

static void HOperatorSet.ClearTrainDataVariationModel(HTuple modelID)

void HVariationModel.ClearTrainDataVariationModel()

Description

clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModel frees the memory of a variation model that was created by create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelCreateVariationModel. clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModel can be used to reduce the amount of memory required for the variation model (in main memory as well as when writing the model to file with write_variation_modelwrite_variation_modelWriteVariationModelWriteVariationModelWriteVariationModel). clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModel can only be called if the model has been prepared for comparison with an image with prepare_variation_modelprepare_variation_modelPrepareVariationModelPrepareVariationModelPrepareVariationModel. After the call to clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModel the variation model can only be used for image comparision with compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModel or compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModel. The model cannot be trained any further. Furthermore, the images used for the image comparison can no longer be read with get_variation_modelget_variation_modelGetVariationModelGetVariationModelGetVariationModel. If they are required, get_variation_modelget_variation_modelGetVariationModelGetVariationModelGetVariationModel must be called before clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModel is called.

Execution Information

This operator modifies the state of the following input parameter:

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

Parameters

ModelIDModelIDModelIDModelIDmodelID (input_control, state is modified)  variation_model HVariationModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

ID of the variation model.

Result

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

Possible Predecessors

prepare_variation_modelprepare_variation_modelPrepareVariationModelPrepareVariationModelPrepareVariationModel

Possible Successors

compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModel, compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModel, write_variation_modelwrite_variation_modelWriteVariationModelWriteVariationModelWriteVariationModel

Module

Matching