HALCON 17.12 / HALCON Operator Reference / Identification / Sample-Based
ClassesClasses | | Operators

read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier (Operator)

Name

read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier — Read a sample identifier from a file.

Signature

read_sample_identifier( : : FileName : SampleIdentifier)

Herror read_sample_identifier(const char* FileName, Hlong* 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::ReadSampleIdentifier(const HString& FileName)

void HSampleIdentifier::ReadSampleIdentifier(const char* FileName)

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

public HSampleIdentifier(string fileName)

void HSampleIdentifier.ReadSampleIdentifier(string fileName)

Description

The operator read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifier reads a sample identifier, which has been written with write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier, from the file FileNameFileNameFileNameFileNamefileName. 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 Identification / Sample-Based.

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

FileNameFileNameFileNameFileNamefileName (input_control)  filename.read → HTupleHTupleHtuple (string) (string) (HString) (char*)

File name.

File extension: .sid

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier (output_control)  sample_identifier → HSampleIdentifier, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the sample identifier.

Result

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

Possible Successors

apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData

Alternatives

deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier, add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParam, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamGetSampleIdentifierParam, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierClearSampleIdentifier, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo

Module

Matching

ClassesClasses | | Operators
HALCON Operator Reference 17.12 Copyright © 1996-2017 MVTec Software GmbH