remove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData (Operator)

Name

remove_sample_identifier_preparation_dataT_remove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data — Remove preparation data from a sample identifier.

Warning

remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data 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

remove_sample_identifier_preparation_data( : : SampleIdentifier, ObjectIdx, ObjectSampleIdx : )

Description

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

ObjectIdxObjectIdxObjectIdxobjectIdxobject_idx 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_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data, set ObjectIdxObjectIdxObjectIdxobjectIdxobject_idx 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_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info.

ObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_sample_idx 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 ObjectIdxObjectIdxObjectIdxobjectIdxobject_idx, ObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_sample_idx can be set to 'all'"all""all""all""all".

To remove all preparation samples of all preparation objects from the SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier, set both ObjectIdxObjectIdxObjectIdxobjectIdxobject_idx and ObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_sample_idx to 'all'"all""all""all""all".

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier (input_control) sample_identifier → (handle)

Handle of the sample identifier.

ObjectIdxObjectIdxObjectIdxobjectIdxobject_idx (input_control) integer → (integer / string)

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"

ObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_sample_idx (input_control) integer → (integer / string)

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_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.