remove_sample_identifier_preparation_dataT_remove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data (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_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_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
Description
remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data removes preparation data
from a sample identifier.
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".
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
SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier (input_control) sample_identifier → HSampleIdentifier, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the sample identifier.
ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx (input_control) integer → HTupleUnion[int, str]HTupleHtuple (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""all", 'unknown'"unknown""unknown""unknown""unknown""unknown"
ObjectSampleIdxObjectSampleIdxObjectSampleIdxObjectSampleIdxobjectSampleIdxobject_sample_idx (input_control) integer → HTupleUnion[int, str]HTupleHtuple (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""all"
Result
If the parameters are valid, the operator
remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data returns the value 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data
Possible Successors
prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier
Alternatives
create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier
See also
add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data,
train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifiertrain_sample_identifier,
apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier,
set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParamset_sample_identifier_param,
get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param,
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info,
remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_data,
write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier,
read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier,
serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifierserialize_sample_identifier,
deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifierdeserialize_sample_identifier,
clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier,
set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info
Module
Matching