clear_train_data_variation_modelT_clear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model (Operator)
Name
clear_train_data_variation_modelT_clear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model
— 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
def clear_train_data_variation_model(model_id: HHandle) -> None
Description
clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model
frees the memory of a
variation model that was created by create_variation_modelcreate_variation_modelCreateVariationModelCreateVariationModelCreateVariationModelcreate_variation_model
.
clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model
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_modelWriteVariationModelWriteVariationModelWriteVariationModelwrite_variation_model
).
clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model
can only be called if the
model has been prepared for comparison with an image with
prepare_variation_modelprepare_variation_modelPrepareVariationModelPrepareVariationModelPrepareVariationModelprepare_variation_model
. After the call to
clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model
the variation model can
only be used for image comparison with
compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModelcompare_variation_model
or
compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModelcompare_ext_variation_model
. 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_modelGetVariationModelGetVariationModelGetVariationModelget_variation_model
. If they are
required, get_variation_modelget_variation_modelGetVariationModelGetVariationModelGetVariationModelget_variation_model
must be called before
clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model
is called.
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
ModelIDModelIDModelIDModelIDmodelIDmodel_id
(input_control, state is modified) variation_model →
HVariationModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
ID of the variation model.
Result
clear_train_data_variation_modelclear_train_data_variation_modelClearTrainDataVariationModelClearTrainDataVariationModelClearTrainDataVariationModelclear_train_data_variation_model
returns 2 (H_MSG_TRUE) if all
parameters are correct.
Possible Predecessors
prepare_variation_modelprepare_variation_modelPrepareVariationModelPrepareVariationModelPrepareVariationModelprepare_variation_model
Possible Successors
compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModelcompare_variation_model
,
compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModelcompare_ext_variation_model
,
write_variation_modelwrite_variation_modelWriteVariationModelWriteVariationModelWriteVariationModelwrite_variation_model
Module
Matching