HALCON 24.05.0.0 / HALCON Operator Reference / Legacy / Identification
ClassesClasses | | Operators

read_sample_identifierT_read_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier (Operator)

Name

read_sample_identifierT_read_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier — Read a sample identifier from a file.

Warning

read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_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

read_sample_identifier( : : FileName : SampleIdentifier)

Herror T_read_sample_identifier(const Htuple FileName, Htuple* SampleIdentifier)

void ReadSampleIdentifier(const HTuple& FileName, HTuple* SampleIdentifier)

void HSampleIdentifier::HSampleIdentifier(const HString& FileName)

void HSampleIdentifier::HSampleIdentifier(const char* FileName)

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

void HSampleIdentifier::ReadSampleIdentifier(const HString& FileName)

void HSampleIdentifier::ReadSampleIdentifier(const char* FileName)

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

static void HOperatorSet.ReadSampleIdentifier(HTuple fileName, out HTuple sampleIdentifier)

public HSampleIdentifier(string fileName)

void HSampleIdentifier.ReadSampleIdentifier(string fileName)

def read_sample_identifier(file_name: str) -> HHandle

Description

The operator read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier reads a sample identifier, which has been written with write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier, from the file FileNameFileNameFileNamefileNamefile_name. 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

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

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

File name.

File extension: .sid

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

Handle of the sample identifier.

Result

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

Possible Successors

apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data

Alternatives

deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierdeserialize_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, 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, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierserialize_sample_identifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info

Module

Matching

ClassesClasses | | Operators
HALCON Operator Reference 24.05.0.0 Copyright © 1996-2024 MVTec Software GmbH