remove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData (算子名称)

名称

remove_sample_identifier_preparation_dataT_remove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data — Remove preparation data from a sample identifier.

警告

remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data is obsolete and is only provided for reasons of backward compatibility. New applications should use 该算子s for Deep-Learning-based classification instead, for details see Deep Learning / Classification.

参数签名

remove_sample_identifier_preparation_data( : : SampleIdentifier, ObjectIdx, ObjectSampleIdx : )

描述

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

ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_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""unknown" with add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data, set ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx to 'unknown'"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_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info.

ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_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 ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx, ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_sample_idx can be set to 'all'"all""all""all""all""all".

To remove all preparation samples of all preparation objects from the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier, set both ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx and ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_sample_idx to 'all'"all""all""all""all""all".

运行信息

多线程类型:可重入(与非独占操作符并行运行)。
多线程作用域:全局(可以从任何线程调用)。
未经并行化处理。

参数表

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier (input_control) sample_identifier → (handle)

Handle of the sample identifier.

ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_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""all", 'unknown'"unknown""unknown""unknown""unknown""unknown"

ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_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""all"

结果

如果参数均有效，算子 remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data 返回值 2 ( H_MSG_TRUE) . If necessary an exception is raised.