Operator Reference

clear_sampsetT_clear_sampsetClearSampsetClearSampsetclear_sampset (Operator)

clear_sampsetT_clear_sampsetClearSampsetClearSampsetclear_sampset — Free memory of a data set.

Warning

clear_sampsetclear_sampsetClearSampsetClearSampsetclear_sampset is obsolete and is only provided for reasons of backward compatibility. New applications should use the MLP, SVM, KNN or GMM operators instead. The operator will be removed with HALCON 25.11.

Signature

clear_sampset( : : SampKey : )

Herror T_clear_sampset(const Htuple SampKey)

void ClearSampset(const HTuple& SampKey)

void HFeatureSet::ClearSampset() const

static void HOperatorSet.ClearSampset(HTuple sampKey)

void HFeatureSet.ClearSampset()

def clear_sampset(samp_key: HHandle) -> None

Description

clear_sampsetclear_sampsetClearSampsetClearSampsetclear_sampset frees the memory which was used for training data set having read by read_sampsetread_sampsetReadSampsetReadSampsetread_sampset. This memory is only reusable in combination with read_sampsetread_sampsetReadSampsetReadSampsetread_sampset.

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

SampKeySampKeySampKeysampKeysamp_key (input_control, state is modified)  feature_set HFeatureSet, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Number of the data set.

Result

clear_sampsetclear_sampsetClearSampsetClearSampsetclear_sampset returns 2 ( H_MSG_TRUE) . An exception is raised if the key SampKeySampKeySampKeysampKeysamp_key does not exist.

Possible Predecessors

create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxcreate_class_box, enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box, learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box, write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box

See also

test_sampset_boxtest_sampset_boxTestSampsetBoxTestSampsetBoxtest_sampset_box, learn_sampset_boxlearn_sampset_boxLearnSampsetBoxLearnSampsetBoxlearn_sampset_box, read_sampsetread_sampsetReadSampsetReadSampsetread_sampset

Module

Foundation