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

remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData (Operator)

Name

remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData — Remove preparation data from a sample identifier.

Signature

remove_sample_identifier_preparation_data( : : SampleIdentifier, ObjectIdx, ObjectSampleIdx : )

Herror remove_sample_identifier_preparation_data(const Hlong SampleIdentifier, const Hlong ObjectIdx, const Hlong ObjectSampleIdx)

Herror T_remove_sample_identifier_preparation_data(const Htuple SampleIdentifier, const Htuple ObjectIdx, const Htuple ObjectSampleIdx)

void RemoveSampleIdentifierPreparationData(const HTuple& SampleIdentifier, const HTuple& ObjectIdx, const HTuple& ObjectSampleIdx)

void HSampleIdentifier::RemoveSampleIdentifierPreparationData(const HTuple& ObjectIdx, const HTuple& ObjectSampleIdx) const

void HSampleIdentifier::RemoveSampleIdentifierPreparationData(Hlong ObjectIdx, Hlong ObjectSampleIdx) const

static void HOperatorSet.RemoveSampleIdentifierPreparationData(HTuple sampleIdentifier, HTuple objectIdx, HTuple objectSampleIdx)

void HSampleIdentifier.RemoveSampleIdentifierPreparationData(HTuple objectIdx, HTuple objectSampleIdx)

void HSampleIdentifier.RemoveSampleIdentifierPreparationData(int objectIdx, int objectSampleIdx)

Description

remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData removes preparation data from a sample identifier.

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

ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx defines the index of the preparation object, of which samples should be removed. To remove preparation samples of preparation objects for which the object index has been set to 'unknown'"unknown""unknown""unknown""unknown" with add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, set ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx to 'unknown'"unknown""unknown""unknown""unknown". The indices of all currently available preparation objects can be queried using get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo.

ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx defines the index of the preparation sample that should be removed. Removing the last preparation sample of a preparation object will remove also the corresponding preparation object itself from the SampleIdentifier. To remove all preparation samples of the preparation object defined by ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx, ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx can be set to 'all'"all""all""all""all".

To remove all preparation samples of all preparation objects from the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier, set both ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx and ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx to 'all'"all""all""all""all".

Execution Information

Parameters

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

Handle of the sample identifier.

ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx (input_control)  integer → HTupleHTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Index of the preparation object, of which samples should be removed.

Suggested values: 0, 1, 2, 3, 4, 5, 'all'"all""all""all""all", 'unknown'"unknown""unknown""unknown""unknown"

ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx (input_control)  integer → HTupleHTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Index of the preparation sample that should be removed.

Suggested values: 0, 1, 2, 3, 4, 5, 'all'"all""all""all""all"

Result

If the parameters are valid, the operator remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData

Possible Successors

prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifier

Alternatives

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier

See also

add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData, 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_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier, read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier, 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