ClassesClassesClassesClasses | | | | Operators

remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData (Operator)

Name

remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData — Remove training data from a sample identifier.

Signature

remove_sample_identifier_training_data( : : SampleIdentifier, ObjectIdx, ObjectSampleIdx : )

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

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

Herror remove_sample_identifier_training_data(const HTuple& SampleIdentifier, const HTuple& ObjectIdx, const HTuple& ObjectSampleIdx)

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

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

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

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

void HOperatorSetX.RemoveSampleIdentifierTrainingData(
[in] VARIANT SampleIdentifier, [in] VARIANT ObjectIdx, [in] VARIANT ObjectSampleIdx)

void HSampleIdentifierX.RemoveSampleIdentifierTrainingData(
[in] VARIANT ObjectIdx, [in] VARIANT ObjectSampleIdx)

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

void HSampleIdentifier.RemoveSampleIdentifierTrainingData(HTuple objectIdx, HTuple objectSampleIdx)

void HSampleIdentifier.RemoveSampleIdentifierTrainingData(int objectIdx, int objectSampleIdx)

Description

remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData removes training data from a sample identifier.

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

ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx defines the index of the training object, of which samples should be removed.

ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx defines the index of the training sample that should be removed. To remove all training samples of the training object defined by ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx, ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx can be set to 'all'"all""all""all""all""all". This will remove also the corresponding training object itself from the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier.

To remove all training samples of all training objects from the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier, set both ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx and ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx to 'all'"all""all""all""all""all".

Parallelization

Parameters

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

Handle of the sample identifier.

ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx (input_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*) (Hlong / BSTR) (Hlong / char*)

Index of the training object, from which samples should be removed.

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

ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdx (input_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*) (Hlong / BSTR) (Hlong / char*)

Index of the training sample that should be removed.

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

Result

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

Possible Predecessors

add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData

Possible Successors

train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier

Alternatives

read_sample_identifierread_sample_identifierReadSampleIdentifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier

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, 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, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifier, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo

Module

Matching


ClassesClassesClassesClasses | | | | Operators