get_sample_identifier_object_info — Retrieve information about an object of a sample identifier.
get_sample_identifier_object_info retrieves information from the SampleIdentifier. This information comprises the number of objects and object samples as well as their indices. Furthermore, the information set with set_sample_identifier_object_info can be retrieved.
See create_sample_identifier for an explanation of the concept of sample-based identification.
The parameter ObjectIdx defines the index of the object for which information is retrieved. Note that this parameter is not evaluated if InfoName is set to 'num_preparation_objects', 'preparation_object_idx', 'num_training_objects', or 'training_object_idx'.
InfoName defines the kind of information to be returned in InfoValue. The following values for InfoName are possible:
The number of preparation objects. Note that all preparation objects for which the object index has been set to 'unknown', are counted as one single preparation object.
The list of indices of all available preparation objects. Note that this list will contain the string 'unknown', if the object index of at least one preparation object hast been set to 'unknown'.
The number of preparation samples for the preparation object indicated by ObjectIdx.
The list of indices of all available preparation samples for the preparation object indicated by ObjectIdx.
The number of training objects.
The list of indices of all available training objects.
The number of training samples for the training object indicated by ObjectIdx.
The list of indices of all available training samples for the training object indicated by ObjectIdx.
The information of the preparation object that has been set with set_sample_identifier_object_info for the preparation object indicated by ObjectIdx.
The information of the training object that has been set with set_sample_identifier_object_info for the training object indicated by ObjectIdx.
Handle of the sample identifier.
Index of the object for which information is retrieved.
List of values: 0, 1, 2, 3, 4, 5, 'unknown'
Define, for which kind of object information is retrieved.
Default value: 'num_training_objects'
List of values: 'num_preparation_objects', 'num_preparation_samples', 'num_training_objects', 'num_training_samples', 'preparation_object_idx', 'preparation_object_name', 'preparation_sample_idx', 'training_object_idx', 'training_object_name', 'training_sample_idx'
Information about the object.
If the parameters are valid, the operator get_sample_identifier_object_info returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.
create_sample_identifier, prepare_sample_identifier, train_sample_identifier, apply_sample_identifier, set_sample_identifier_param, get_sample_identifier_param, remove_sample_identifier_preparation_data, remove_sample_identifier_training_data, write_sample_identifier, read_sample_identifier, serialize_sample_identifier, deserialize_sample_identifier, clear_sample_identifier, clear_all_sample_identifiers