get_sample_identifier_object_infoT_get_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo (Operator)
Name
get_sample_identifier_object_infoT_get_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo — Retrieve information about an object of a sample identifier.
Signature
Description
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo retrieves information from the
SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier. 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_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo can be retrieved.
For an explanation of the concept of sample-based identification
see the introduction of chapter Identification / Sample-Based.
The parameter ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx defines the index of the object for which
information is retrieved. Note that this parameter is not evaluated if
InfoNameInfoNameInfoNameInfoNameinfoName is set to '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", '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".
InfoNameInfoNameInfoNameInfoNameinfoName defines the kind of information to be returned in
InfoValueInfoValueInfoValueInfoValueinfoValue. The following values for InfoNameInfoNameInfoNameInfoNameinfoName are
possible:
- '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", are counted as one single preparation
object.
- '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", if the object index of at least one preparation
object hast been set to 'unknown'"unknown""unknown""unknown""unknown".
- '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 ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.
- '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
ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.
- '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":
-
The list of indices of all
available training objects.
- '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 ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.
- '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
ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.
- '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_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo for the preparation object
indicated by ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.
- '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_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo
for the training object indicated by ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.
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
SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier (input_control) sample_identifier → HSampleIdentifier, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the sample identifier.
ObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx (input_control) integer(-array) → HTupleHTupleHtuple (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"
InfoNameInfoNameInfoNameInfoNameinfoName (input_control) attribute.name(-array) → HTupleHTupleHtuple (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"
List of values: '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_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", '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_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_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"
InfoValueInfoValueInfoValueInfoValueinfoValue (output_control) attribute.value(-array) → HTupleHTupleHtuple (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_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo returns the value 2 (H_MSG_TRUE). If
necessary an exception is raised.
Possible Predecessors
add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData,
add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData
See also
create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier,
prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifier,
train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifier,
apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier,
set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParam,
get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamGetSampleIdentifierParam,
remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData,
remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData,
write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier,
read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifier,
serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier,
deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier,
clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierClearSampleIdentifier
Module
Matching