Operator Reference

HALCON Operator Reference / Legacy / Identification

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

clear_sample_identifierT_clear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier (Operator)

clear_sample_identifierT_clear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier — Free the memory of a sample identifier.

Warning

clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier is obsolete and is only provided for reasons of backward compatibility. New applications should use the operators for Deep-Learning-based classification instead, for details see Deep Learning / Classification.

Signature

clear_sample_identifier( : : SampleIdentifier : )

Herror T_clear_sample_identifier(const Htuple SampleIdentifier)

void ClearSampleIdentifier(const HTuple& SampleIdentifier)

void HSampleIdentifier::ClearSampleIdentifier() const

static void HOperatorSet.ClearSampleIdentifier(HTuple sampleIdentifier)

void HSampleIdentifier.ClearSampleIdentifier()

def clear_sample_identifier(sample_identifier: HHandle) -> None

Description

The operator clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier frees the memory of a sample identifier that was created by create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier, read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier, or deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierdeserialize_sample_identifier. After calling clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier, the sample identifier can no longer be used. The handle SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier becomes invalid.

For an explanation of the concept of sample-based identification see the introduction of chapter Legacy / Identification.

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:

• SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier

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

Parameters

SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier (input_control, state is modified)  sample_identifier → HSampleIdentifier, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the sample identifier.

Result

If the handle of the sample identifier is valid, the operator clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierserialize_sample_identifier

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier, add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifiertrain_sample_identifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamset_sample_identifier_param, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_data, read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierdeserialize_sample_identifier, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info

Module

Matching

---

ClassesClasses | | Operators