set_sample_identifier_paramT_set_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParam (Operator)

Name

set_sample_identifier_paramT_set_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParam — Set selected parameters of a sample identifier.

Signature

Description

The operator set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamSetSampleIdentifierParam is used to set or change the different parameters of the given SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier.

For an explanation of the concept of sample-based identification see the introduction of chapter Identification / Sample-Based.

The following parameters can be used to influence the behavior of the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier. These parameters and their corresponding values can be specified by using GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue, respectively. The following values for GenParamNameGenParamNameGenParamNameGenParamNamegenParamName are possible:

'use_color_info'"use_color_info""use_color_info""use_color_info""use_color_info":

This parameter determines if color information is used for the identification. If 'use_color_info'"use_color_info""use_color_info""use_color_info""use_color_info" is set to 'true'"true""true""true""true", color information is used. Note that in this case, the images used for apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier must be RGB color images. If 'use_color_info'"use_color_info""use_color_info""use_color_info""use_color_info" is set to 'false'"false""false""false""false", no color information is used. Use color information if the objects to be identified have different colors and the illumination can be controlled to some degree. In this case, the use of color information makes the identification more robust.

Note that in contrast to the generic parameter 'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info", which can only be set in create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier, this parameter affects only the operator apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier. With this, it is, e.g., possible to train the sample identifier using texture and color and to identify selected objects only based on the texture information.

List of values: 'true'"true""true""true""true", 'false'"false""false""false""false"

Default value: As long as 'use_color_info'"use_color_info""use_color_info""use_color_info""use_color_info" has not been set, the value set with 'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info" in create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier is used.

'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info":

This parameter determines if texture information is used for the identification. If 'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info" is set to 'true'"true""true""true""true", texture information is used. If 'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info" is set to 'false'"false""false""false""false", no texture information is used. Typically, 'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info" should be set to 'true'"true""true""true""true", because sample-based identification requires textured objects. Note that at least one of the two generic parameters 'use_color_info'"use_color_info""use_color_info""use_color_info""use_color_info" and 'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info" must be set to 'true'"true""true""true""true".

Note that in contrast to the generic parameter 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info", which can only be set in create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier, this parameter affects only the operator apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier.

List of values: 'true'"true""true""true""true", 'false'"false""false""false""false"

Default value: As long as 'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info" has not been set, the value set with 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info" in create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier is used.

'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method":

See create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier for a description of this parameter.

List of values: 'none'"none""none""none""none", 'scale_factor'"scale_factor""scale_factor""scale_factor""scale_factor", 'subsampling_step'"subsampling_step""subsampling_step""subsampling_step""subsampling_step", 'image_area'"image_area""image_area""image_area""image_area"

Default value: If the 'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method" is not set explicitly by this operator, the value that has been set with create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier will be used.

'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value":

See create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier for a description of this parameter.

Suggested values: 0.25, 0.5, 1.0, 2, 3, 4

Default value: If the 'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value" is not set explicitly by this operator, the value that has been set with create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier will be used.

'rating_method'"rating_method""rating_method""rating_method""rating_method":

See apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier for a description of this parameter that is used only by apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier.

List of values: 'distance'"distance""distance""distance""distance", 'score'"score""score""score""score", 'score_single'"score_single""score_single""score_single""score_single"

Default value: 'score'"score""score""score""score"

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

Result

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

Possible Predecessors

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier, read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierReadSampleIdentifier

Alternatives

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifierCreateSampleIdentifier

See also

add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierPrepareSampleIdentifier, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifierTrainSampleIdentifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierApplySampleIdentifier, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamGetSampleIdentifierParam, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierWriteSampleIdentifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierSerializeSampleIdentifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierDeserializeSampleIdentifier, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo

Module

Matching