clear_samples_class_gmmT_clear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmm (Operator)

Name

clear_samples_class_gmmT_clear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmm — Clear the training data of a Gaussian Mixture Model.

Signature

Description

clear_samples_class_gmmclear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmmClearSamplesClassGmm clears all training samples that have been stored in the Gaussian Mixture Model (GMM) GMMHandleGMMHandleGMMHandleGMMHandleGMMHandle. clear_samples_class_gmmclear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmmClearSamplesClassGmm should only be used if the GMM is trained in the same process that uses the GMM for evaluation with evaluate_class_gmmevaluate_class_gmmEvaluateClassGmmEvaluateClassGmmEvaluateClassGmm or for classification with classify_class_gmmclassify_class_gmmClassifyClassGmmClassifyClassGmmClassifyClassGmm. In this case, the memory required for the training samples can be freed with clear_samples_class_gmmclear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmmClearSamplesClassGmm, and hence memory can be saved. In the normal usage, in which the GMM is trained offline and written to a file with write_class_gmmwrite_class_gmmWriteClassGmmWriteClassGmmWriteClassGmm, it is typically unnecessary to call clear_samples_class_gmmclear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmmClearSamplesClassGmm because write_class_gmmwrite_class_gmmWriteClassGmmWriteClassGmmWriteClassGmm does not save the training samples, and hence the online process, which reads the GMM with read_class_gmmread_class_gmmReadClassGmmReadClassGmmReadClassGmm, requires no memory for the training samples.

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:

• GMMHandleGMMHandleGMMHandleGMMHandleGMMHandle

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

Parameters

Result

If the parameters are valid, the operator clear_samples_class_gmmclear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmmClearSamplesClassGmm returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

train_class_gmmtrain_class_gmmTrainClassGmmTrainClassGmmTrainClassGmm, write_samples_class_gmmwrite_samples_class_gmmWriteSamplesClassGmmWriteSamplesClassGmmWriteSamplesClassGmm

See also

create_class_gmmcreate_class_gmmCreateClassGmmCreateClassGmmCreateClassGmm, clear_class_gmmclear_class_gmmClearClassGmmClearClassGmmClearClassGmm, add_sample_class_gmmadd_sample_class_gmmAddSampleClassGmmAddSampleClassGmmAddSampleClassGmm, read_samples_class_gmmread_samples_class_gmmReadSamplesClassGmmReadSamplesClassGmmReadSamplesClassGmm

Module

Foundation