get_sample_identifier_object_infoT_get_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info (Operator)
Name
get_sample_identifier_object_infoT_get_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info — Retrieve information about an object of a sample identifier.
Warning
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info 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
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info retrieves information from the
SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier. This information comprises the number of objects
and object samples as well as their indices. Furthermore, the information
set with set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info can be retrieved.
For an explanation of the concept of sample-based identification
see the introduction of chapter Legacy / Identification.
The parameter ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx defines the index of the object for which
information is retrieved. Note that this parameter is not evaluated if
InfoNameInfoNameInfoNameInfoNameinfoNameinfo_name is set to 'num_preparation_objects'"num_preparation_objects""num_preparation_objects""num_preparation_objects""num_preparation_objects""num_preparation_objects",
'preparation_object_idx'"preparation_object_idx""preparation_object_idx""preparation_object_idx""preparation_object_idx""preparation_object_idx", 'num_training_objects'"num_training_objects""num_training_objects""num_training_objects""num_training_objects""num_training_objects", or
'training_object_idx'"training_object_idx""training_object_idx""training_object_idx""training_object_idx""training_object_idx".
InfoNameInfoNameInfoNameInfoNameinfoNameinfo_name defines the kind of information to be returned in
InfoValueInfoValueInfoValueInfoValueinfoValueinfo_value. The following values for InfoNameInfoNameInfoNameInfoNameinfoNameinfo_name are
possible:
- 'num_preparation_objects'"num_preparation_objects""num_preparation_objects""num_preparation_objects""num_preparation_objects""num_preparation_objects":
-
The number of preparation
objects. Note that all preparation objects for which the object index has
been set to 'unknown'"unknown""unknown""unknown""unknown""unknown", are counted as one single preparation
object.
- 'preparation_object_idx'"preparation_object_idx""preparation_object_idx""preparation_object_idx""preparation_object_idx""preparation_object_idx":
-
The list of indices of all
available preparation objects. Note that this list will contain the
string 'unknown'"unknown""unknown""unknown""unknown""unknown", if the object index of at least one preparation
object hast been set to 'unknown'"unknown""unknown""unknown""unknown""unknown".
- 'num_preparation_samples'"num_preparation_samples""num_preparation_samples""num_preparation_samples""num_preparation_samples""num_preparation_samples":
-
The number of preparation
samples for the preparation object indicated by ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx.
- 'preparation_sample_idx'"preparation_sample_idx""preparation_sample_idx""preparation_sample_idx""preparation_sample_idx""preparation_sample_idx":
-
The list of indices of all
available preparation samples for the preparation object indicated by
ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx.
- 'num_training_objects'"num_training_objects""num_training_objects""num_training_objects""num_training_objects""num_training_objects":
-
The number of training objects.
- 'training_object_idx'"training_object_idx""training_object_idx""training_object_idx""training_object_idx""training_object_idx":
-
The list of indices of all
available training objects.
- 'num_training_samples'"num_training_samples""num_training_samples""num_training_samples""num_training_samples""num_training_samples":
-
The number of training samples for
the training object indicated by ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx.
- 'training_sample_idx'"training_sample_idx""training_sample_idx""training_sample_idx""training_sample_idx""training_sample_idx":
-
The list of indices of all
available training samples for the training object indicated by
ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx.
- 'preparation_object_name'"preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name":
-
The information of the
preparation object that has been set with
set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info for the preparation object
indicated by ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx.
- 'training_object_name'"training_object_name""training_object_name""training_object_name""training_object_name""training_object_name":
-
The information of the training
object that has been set with set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info
for the training object indicated by ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdxobject_idx.
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(-array) → HTupleMaybeSequence[Union[int, str]]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Index of the object for which information is retrieved.
Suggested values: 0, 1, 2, 3, 4, 5, 'unknown'"unknown""unknown""unknown""unknown""unknown"
InfoNameInfoNameInfoNameInfoNameinfoNameinfo_name (input_control) attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Define, for which kind of object information is
retrieved.
Default value:
'num_training_objects'
"num_training_objects"
"num_training_objects"
"num_training_objects"
"num_training_objects"
"num_training_objects"
List of values: 'num_preparation_objects'"num_preparation_objects""num_preparation_objects""num_preparation_objects""num_preparation_objects""num_preparation_objects", 'num_preparation_samples'"num_preparation_samples""num_preparation_samples""num_preparation_samples""num_preparation_samples""num_preparation_samples", 'num_training_objects'"num_training_objects""num_training_objects""num_training_objects""num_training_objects""num_training_objects", 'num_training_samples'"num_training_samples""num_training_samples""num_training_samples""num_training_samples""num_training_samples", 'preparation_object_idx'"preparation_object_idx""preparation_object_idx""preparation_object_idx""preparation_object_idx""preparation_object_idx", 'preparation_object_name'"preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name""preparation_object_name", 'preparation_sample_idx'"preparation_sample_idx""preparation_sample_idx""preparation_sample_idx""preparation_sample_idx""preparation_sample_idx", 'training_object_idx'"training_object_idx""training_object_idx""training_object_idx""training_object_idx""training_object_idx", 'training_object_name'"training_object_name""training_object_name""training_object_name""training_object_name""training_object_name", 'training_sample_idx'"training_sample_idx""training_sample_idx""training_sample_idx""training_sample_idx""training_sample_idx"
InfoValueInfoValueInfoValueInfoValueinfoValueinfo_value (output_control) attribute.value(-array) → HTupleSequence[Union[int, str]]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Information about the object.
Result
If the parameters are valid, the operator
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info 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,
add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data
See also
create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier,
prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier,
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,
remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data,
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
Module
Matching