Operator Reference

HALCON Operator Reference / Legacy / Identification

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

ClassesClasses | | Operators

write_sample_identifierT_write_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier (Operator)

write_sample_identifierT_write_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier — Write a sample identifier to a file.

Warning

write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_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

write_sample_identifier( : : SampleIdentifier, FileName : )

Herror T_write_sample_identifier(const Htuple SampleIdentifier, const Htuple FileName)

void WriteSampleIdentifier(const HTuple& SampleIdentifier, const HTuple& FileName)

void HSampleIdentifier::WriteSampleIdentifier(const HString& FileName) const

void HSampleIdentifier::WriteSampleIdentifier(const char* FileName) const

void HSampleIdentifier::WriteSampleIdentifier(const wchar_t* FileName) const   ( Windows only)

static void HOperatorSet.WriteSampleIdentifier(HTuple sampleIdentifier, HTuple fileName)

void HSampleIdentifier.WriteSampleIdentifier(string fileName)

def write_sample_identifier(sample_identifier: HHandle, file_name: str) -> None

Description

The operator write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier writes a sample identifier to the file FileNameFileNameFileNamefileNamefile_name. The sample identifier can be read again with read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier. The default HALCON file extension for the sample identifier is 'sid'.

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.

Parameters

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

Handle of the sample identifier.

FileNameFileNameFileNamefileNamefile_name (input_control)  filename.write → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

File name.

File extension: .sid

Result

If the file name is valid (write permission), the operator write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifiertrain_sample_identifier, add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamset_sample_identifier_param

Possible Successors

clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier

Alternatives

serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierserialize_sample_identifier

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifiertrain_sample_identifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier, 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