query_data_code_2d_params🔗
Short description🔗
query_data_code_2d_params — Get for a given 2D code model the names of the generic
parameters or objects that can be used in the other 2D code
operators.
Signature🔗
query_data_code_2d_params( datacode_2d DataCodeHandle, attribute.name QueryName, out attribute.value GenParamName )
Description🔗
The operator query_data_code_2d_params returns the names of
the generic parameters that are supported by the 2D code
operators set_data_code_2d_param,
get_data_code_2d_param, find_data_code_2d,
get_data_code_2d_results, and
get_data_code_2d_objects.
For an explanation of the concept of the 2D code reader see the introduction of chapter Identification / Data Code.
The parameter QueryName is used to select the desired
parameter group:
-
'get_model_params':
get_data_code_2d_param- Parameters for querying the 2D code model. -
'set_model_params':
set_data_code_2d_param- Parameters for adjusting the 2D code model. -
'find_params':
find_data_code_2d- Parameters used while searching and reading the 2D code symbols. -
'get_result_params':
get_data_code_2d_results- Parameters for querying the alphanumerical results of the symbol search. -
'get_result_objects':
get_data_code_2d_objects- Parameters for accessing the iconic objects of the symbol search. -
'trained':
set_data_code_2d_param- Parameters whose values were determined by training. The next training will not reset these parameters, but extend the parameter space if necessary.
The returned parameter list depends only on the type of the 2D code and not on the current state of the model or its results.
Execution information🔗
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🔗
DataCodeHandle (input_control) datacode_2d → (handle)
Handle of the 2D code model.
QueryName (input_control) attribute.name → (string)
Name of the parameter group.
Default: 'get_result_params'
List of values: 'find_params', 'get_model_params', 'get_result_objects', 'get_result_params', 'set_model_params', 'trained'
GenParamName (output_control) attribute.value-array → (string)
List containing the names of the supported generic parameters.
Example🔗
(HDevelop)
* This example demonstrates how the names of all available model parameters
* can be queried. This is used to request first the settings of the
* untrained and then the settings of the trained model.
* Create a model for reading Data Matrix ECC 200 codes
create_data_code_2d_model ('Data Matrix ECC 200', [], [], DataCodeHandle)
* Query all the names of the generic parameters that can be passed to the
* operator get_data_code_2d_param to request the model
query_data_code_2d_params (DataCodeHandle, 'get_model_params', GenParamName)
* Request the current settings of the (untrained) model
get_data_code_2d_param(DataCodeHandle, GenParamName, ModelParams)
* Read a training image
read_image (Image, 'datacode/ecc200/ecc200_cpu_007')
* train the model with the symbol in the image
find_data_code_2d (Image, SymbolXLDs, DataCodeHandle, 'train', 'all', \
ResultHandles, DecodedDataStrings)
* Request the current settings of the (now trained) model
get_data_code_2d_param(DataCodeHandle, GenParamName, TrainedModelParams)
* Create a tuple that demonstrates the changings
ModelAdaption := GenParamName + ': ' + ModelParams + ' -> ' + \
TrainedModelParams
* Clear the model
clear_data_code_2d_model (DataCodeHandle)
Result🔗
The operator query_data_code_2d_params returns the value 2 (H_MSG_TRUE)
if the given parameters are correct.
Otherwise, an exception is raised.
Combinations with other operators🔗
Combinations
Possible predecessors
Possible successors
get_data_code_2d_param, get_data_code_2d_results, get_data_code_2d_objects
Module🔗
Data Code