Skip to content

clear_training_componentsClearTrainingComponentsClearTrainingComponentsclear_training_componentsT_clear_training_components🔗

Short description🔗

clear_training_componentsClearTrainingComponentsClearTrainingComponentsclear_training_componentsT_clear_training_components — Free the memory of a component training result.

Warning🔗

clear_training_componentsClearTrainingComponents is obsolete and is only provided for reasons of backward compatibility. The operator will be removed with HALCON 26.11.

Signature🔗

clear_training_components( component_training ComponentTrainingID )void ClearTrainingComponents( const HTuple& ComponentTrainingID )static void HOperatorSet.ClearTrainingComponents( HTuple componentTrainingID )def clear_training_components( component_training_id: HHandle ) -> None

Herror T_clear_training_components( const Htuple ComponentTrainingID )

void HComponentTraining::ClearTrainingComponents( ) const

void HComponentTraining.ClearTrainingComponents( )

Description🔗

The operator clear_training_componentsClearTrainingComponents frees the memory of a training result that was created by train_model_componentsTrainModelComponents. After calling clear_training_componentsClearTrainingComponents, the training result can no longer be used. The handle ComponentTrainingIDcomponentTrainingIDcomponent_training_id becomes invalid.

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🔗

ComponentTrainingIDcomponentTrainingIDcomponent_training_id (input_control, state is modified) component_training → (handle)HTuple (HHandle)HComponentTraining, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the training result.

Result🔗

If the handle of the training result is valid, the operator clear_training_componentsClearTrainingComponents returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Module🔗

Matching