create_sample_identifierT_create_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier (Operator)
create_sample_identifierT_create_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier — Create a new sample identifier.
Warning
create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier 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
The operator create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier creates a new sample
identifier. Alternatively, an already available sample identifier can be
read from file with the operator read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier.
For an explanation of the concept of sample-based identification
see the introduction of chapter Legacy / Identification.
Note that if you want to use color information, you must specify this
explicitly by setting the generic parameter 'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info" to
'true'"true""true""true""true".
The generic parameters can be used to influence the behavior of the sample
identifier. Typically, only 'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info" must be considered.
The parameters and their corresponding values can be specified by using
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value, respectively. The following
values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name are possible:
- 'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info":
-
This parameter determines if color
information is used for the identification. If 'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info"
is set to 'true'"true""true""true""true", color information is used. Note that in this
case, all images used for the preparation and the training of the sample
identifier must be RGB color images. If 'add_color_info'"add_color_info""add_color_info""add_color_info""add_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 if the
illumination can be controlled to some degree. In this case, the use of
color information makes the identification more robust.
List of values:
'true'"true""true""true""true", 'false'"false""false""false""false"
Default:
'false'"false""false""false""false"
- 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info":
-
This parameter determines if texture
information is used for the identification. If 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info"
is set to 'true'"true""true""true""true", texture information is used. If
'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info" is set to 'false'"false""false""false""false", no texture
information is used. Typically, 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_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
'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info" and 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info" must be set to
'true'"true""true""true""true".
List of values:
'true'"true""true""true""true", 'false'"false""false""false""false"
Default:
'true'"true""true""true""true"
- 'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method":
-
To speed up the identification
process, the images are resized internally to a given size or by a given
factor. If 'none'"none""none""none""none" is selected, no resizing will be done. For
'scale_factor'"scale_factor""scale_factor""scale_factor""scale_factor", a constant scale factor can be set and for
'subsampling_step'"subsampling_step""subsampling_step""subsampling_step""subsampling_step", a constant subsampling step, i.e., the
inverse of the scale factor can be set. Finally, for
'image_area'"image_area""image_area""image_area""image_area", a constant size of the resized image can be
specified. The corresponding values can be set with the
'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value" (see below).
To make the identification process faster, choose parameters that lead to
a smaller internal image, i.e., use smaller scale factors or image sizes
or a larger subsampling step. If the objects to be identified show
high-frequency texture, the identification result may become better, if a
larger internal image size is used, because otherwise the texture may be
eliminated in the resized images.
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:
'image_area'"image_area""image_area""image_area""image_area"
- 'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value":
-
With this parameter, the selected
'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method" can be parameterized. If
'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method" is set to 'scale_factor'"scale_factor""scale_factor""scale_factor""scale_factor", the
value of 'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value" defines the scale factor to be
used. If 'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method" is set to
'subsampling_step'"subsampling_step""subsampling_step""subsampling_step""subsampling_step", the value of 'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value"
defines the subsampling step, i.e., the inverse of the scale factor. If
'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method" is set to 'image_area'"image_area""image_area""image_area""image_area", the value
of 'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value" defines the area of the resized image
given in megapixels, i.e., in million pixels.
Suggested values:
0.25, 0.5, 1.0,
2, 3, 4
Default:
The default value depends on the selected
'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method". It is
-
0.5 for 'scale_factor'"scale_factor""scale_factor""scale_factor""scale_factor",
-
2.0 for 'subsampling_step'"subsampling_step""subsampling_step""subsampling_step""subsampling_step", and
-
0.5 for 'image_area'"image_area""image_area""image_area""image_area".
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.
Parameters
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Parameter name.
Default:
[]
List of values:
'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info", 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info", 'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method", 'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value"
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → HTupleSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)
Parameter value.
Default:
[]
Suggested 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", 0.25, 0.5, 0.75, 1.0, 2, 3, 4, 'true'"true""true""true""true", 'false'"false""false""false""false"
SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier (output_control) sample_identifier → HSampleIdentifier, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the sample identifier.
Result
If the parameters are valid, the operator create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier
returns the value 2 (
H_MSG_TRUE)
. If necessary an exception is raised.
Possible Successors
add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data,
set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamset_sample_identifier_param
Alternatives
read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier
See also
prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier,
add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data,
train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifiertrain_sample_identifier,
apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier,
get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param,
get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info,
remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data,
remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_data,
write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier,
serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierserialize_sample_identifier,
deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierdeserialize_sample_identifier,
clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier,
set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info
Module
Matching