get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo (Operator)

Name

get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo — Retrieve information about an object of a sample identifier.

Signature

Description

get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo retrieves information from the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier. 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_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo can be retrieved.

See create_sample_identifiercreate_sample_identifierCreateSampleIdentifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifier for an explanation of the concept of sample-based identification.

The parameter ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx defines the index of the object for which information is retrieved. Note that this parameter is not evaluated if InfoNameInfoNameInfoNameInfoNameInfoNameinfoName 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".

InfoNameInfoNameInfoNameInfoNameInfoNameinfoName defines the kind of information to be returned in InfoValueInfoValueInfoValueInfoValueInfoValueinfoValue. The following values for InfoNameInfoNameInfoNameInfoNameInfoNameinfoName 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 ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.

'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 ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.

'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 ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.

'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 ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.

'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_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo for the preparation object indicated by ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.

'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_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo for the training object indicated by ObjectIdxObjectIdxObjectIdxObjectIdxObjectIdxobjectIdx.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

If the parameters are valid, the operator get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Possible Predecessors

add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifier, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifier, train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifier, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParam, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParam, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifier, read_sample_identifierread_sample_identifierReadSampleIdentifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifier, clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiers

Module

Matching