HALCON Website / HALCON Operator Reference / Identification / Sample-Based
ClassesClassesClassesClasses | | | | Operators

read_sample_identifierread_sample_identifierReadSampleIdentifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier (Operator)

Name

read_sample_identifierread_sample_identifierReadSampleIdentifierread_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)

Herror read_sample_identifier(const HTuple& FileName, Hlong* SampleIdentifier)

void HSampleIdentifier::ReadSampleIdentifier(const HTuple& FileName)

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)

void HOperatorSetX.ReadSampleIdentifier(
[in] VARIANT FileName, [out] VARIANT* SampleIdentifier)

void HSampleIdentifierX.ReadSampleIdentifier([in] BSTR 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_identifierReadSampleIdentifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier reads a sample identifier, which has been written with write_sample_identifierwrite_sample_identifierWriteSampleIdentifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifier, from the file FileNameFileNameFileNameFileNameFileNamefileName. The default HALCON file extension for the sample identifier is 'sid'.

Parallelization

Parameters

FileNameFileNameFileNameFileNameFileNamefileName (input_control)  filename.read → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

File name.

File extension: .sid

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier (output_control)  sample_identifier → HSampleIdentifier, HTupleHTupleHSampleIdentifier, HTupleHSampleIdentifierX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the sample identifier.

Result

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

Possible Successors

apply_sample_identifierapply_sample_identifierApplySampleIdentifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifier, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData

Alternatives

deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifier

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifier, add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifier, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParam, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParam, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifier, clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiers, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo

Module

Matching

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 11.0.5 Copyright © 1996-2015 MVTec Software GmbH