Skip to content

clear_samples_class_gmmClearSamplesClassGmmClearSamplesClassGmmclear_samples_class_gmmT_clear_samples_class_gmm🔗

Short description🔗

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

Signature🔗

clear_samples_class_gmm( class_gmm GMMHandle )void ClearSamplesClassGmm( const HTuple& GMMHandle )static void HOperatorSet.ClearSamplesClassGmm( HTuple GMMHandle )def clear_samples_class_gmm( gmmhandle: MaybeSequence[HHandle] ) -> None

Herror T_clear_samples_class_gmm( const Htuple GMMHandle )

static void HClassGmm::ClearSamplesClassGmm( const HClassGmmArray& GMMHandle )

void HClassGmm::ClearSamplesClassGmm( ) const

static void HClassGmm.ClearSamplesClassGmm( HClassGmm[] GMMHandle )

void HClassGmm.ClearSamplesClassGmm( )

Description🔗

clear_samples_class_gmmClearSamplesClassGmm clears all training samples that have been stored in the Gaussian Mixture Model (GMM) GMMHandleGMMHandlegmmhandle. clear_samples_class_gmmClearSamplesClassGmm should only be used if the GMM is trained in the same process that uses the GMM for evaluation with evaluate_class_gmmEvaluateClassGmm or for classification with classify_class_gmmClassifyClassGmm. In this case, the memory required for the training samples can be freed with clear_samples_class_gmmClearSamplesClassGmm, 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_gmmWriteClassGmm, it is typically unnecessary to call clear_samples_class_gmmClearSamplesClassGmm because write_class_gmmWriteClassGmm does not save the training samples, and hence the online process, which reads the GMM with read_class_gmmReadClassGmm, requires no memory for the training samples.

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:

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

Parameters🔗

GMMHandleGMMHandlegmmhandle (input_control, state is modified) class_gmm(-array) → (handle)HTuple (HHandle)HClassGmm, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

GMM handle.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

train_class_gmmTrainClassGmm, write_samples_class_gmmWriteSamplesClassGmm

See also

create_class_gmmCreateClassGmm, clear_class_gmmClearClassGmm, add_sample_class_gmmAddSampleClassGmm, read_samples_class_gmmReadSamplesClassGmm

Module🔗

Foundation