get_generic_shape_model_paramT_get_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param (Operator)
get_generic_shape_model_paramT_get_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param — Return the parameters of a shape model.
Signature
def get_generic_shape_model_param(model_id: HHandle, gen_param_name: Sequence[str]) -> Sequence[Union[int, float, str]]
Description
The operator get_generic_shape_model_paramget_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param returns the parameters
values GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value of GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name for the shape model
ModelIDModelIDModelIDmodelIDmodel_id.
For an explanation of the settable GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value, see
set_generic_shape_model_paramset_generic_shape_model_paramSetGenericShapeModelParamSetGenericShapeModelParamset_generic_shape_model_param.
Additional parameters whose value can only be retrieved:
The operator get_generic_shape_model_paramget_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param returns the value as it is
used by the shape model.
As certain parameters may be modified after calling
train_generic_shape_modeltrain_generic_shape_modelTrainGenericShapeModelTrainGenericShapeModeltrain_generic_shape_model, their value can differ from the set value.
This applies particularly to parameters whose value is to be determined
automatically, e.g., with values set to 'auto'"auto""auto""auto""auto".
The (unmodified) set value of a GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name can be retrieved by
adding the suffix '_param' to its name.
Example: After calling train_generic_shape_modeltrain_generic_shape_modelTrainGenericShapeModelTrainGenericShapeModeltrain_generic_shape_model,
'num_levels'"num_levels""num_levels""num_levels""num_levels" returns the estimated value
and 'num_levels_param'"num_levels_param""num_levels_param""num_levels_param""num_levels_param" returns the set value, e.g., its value
set by default or the one set by the user.
Exceptions to this rule are:
-
'greediness'"greediness""greediness""greediness""greediness" when 'extended_parameter_estimation'"extended_parameter_estimation""extended_parameter_estimation""extended_parameter_estimation""extended_parameter_estimation" is
set to 'per_level'"per_level""per_level""per_level""per_level".
-
'min_score'"min_score""min_score""min_score""min_score" when 'extended_parameter_estimation'"extended_parameter_estimation""extended_parameter_estimation""extended_parameter_estimation""extended_parameter_estimation" is
set to 'per_level'"per_level""per_level""per_level""per_level".
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 modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
ModelIDModelIDModelIDmodelIDmodel_id (input_control, state is modified) shape_model → HShapeModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the shape model.
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Parameter name.
Default:
'min_score'
"min_score"
"min_score"
"min_score"
"min_score"
List of values:
'angle_end'"angle_end""angle_end""angle_end""angle_end", 'angle_start'"angle_start""angle_start""angle_start""angle_start", 'angle_step'"angle_step""angle_step""angle_step""angle_step", 'border_shape_models'"border_shape_models""border_shape_models""border_shape_models""border_shape_models", 'clutter_border_mode'"clutter_border_mode""clutter_border_mode""clutter_border_mode""clutter_border_mode", 'clutter_contrast'"clutter_contrast""clutter_contrast""clutter_contrast""clutter_contrast", 'clutter_hom_mat_2d'"clutter_hom_mat_2d""clutter_hom_mat_2d""clutter_hom_mat_2d""clutter_hom_mat_2d", 'contrast_high'"contrast_high""contrast_high""contrast_high""contrast_high", 'contrast_low'"contrast_low""contrast_low""contrast_low""contrast_low", 'extended_parameter_estimation'"extended_parameter_estimation""extended_parameter_estimation""extended_parameter_estimation""extended_parameter_estimation", 'greediness'"greediness""greediness""greediness""greediness", 'has_samples'"has_samples""has_samples""has_samples""has_samples", 'iso_scale_max'"iso_scale_max""iso_scale_max""iso_scale_max""iso_scale_max", 'iso_scale_min'"iso_scale_min""iso_scale_min""iso_scale_min""iso_scale_min", 'iso_scale_step'"iso_scale_step""iso_scale_step""iso_scale_step""iso_scale_step", 'max_clutter'"max_clutter""max_clutter""max_clutter""max_clutter", 'max_deformation'"max_deformation""max_deformation""max_deformation""max_deformation", 'max_overlap'"max_overlap""max_overlap""max_overlap""max_overlap", 'max_overlap_global_enable'"max_overlap_global_enable""max_overlap_global_enable""max_overlap_global_enable""max_overlap_global_enable", 'metric'"metric""metric""metric""metric", 'min_contrast'"min_contrast""min_contrast""min_contrast""min_contrast", 'min_score'"min_score""min_score""min_score""min_score", 'min_size'"min_size""min_size""min_size""min_size", 'model_cache'"model_cache""model_cache""model_cache""model_cache", 'model_identifier'"model_identifier""model_identifier""model_identifier""model_identifier", 'needs_training'"needs_training""needs_training""needs_training""needs_training", 'num_levels'"num_levels""num_levels""num_levels""num_levels", 'num_matches'"num_matches""num_matches""num_matches""num_matches", 'optimization'"optimization""optimization""optimization""optimization", 'origin_column'"origin_column""origin_column""origin_column""origin_column", 'origin_row'"origin_row""origin_row""origin_row""origin_row", 'prepare_clutter_region_for_visualization'"prepare_clutter_region_for_visualization""prepare_clutter_region_for_visualization""prepare_clutter_region_for_visualization""prepare_clutter_region_for_visualization", 'prepare_contours_for_visualization'"prepare_contours_for_visualization""prepare_contours_for_visualization""prepare_contours_for_visualization""prepare_contours_for_visualization", 'pyramid_level_highest'"pyramid_level_highest""pyramid_level_highest""pyramid_level_highest""pyramid_level_highest", 'pyramid_level_lowest'"pyramid_level_lowest""pyramid_level_lowest""pyramid_level_lowest""pyramid_level_lowest", 'pyramid_level_robust_tracking'"pyramid_level_robust_tracking""pyramid_level_robust_tracking""pyramid_level_robust_tracking""pyramid_level_robust_tracking", 'restrict_iso_scale_max'"restrict_iso_scale_max""restrict_iso_scale_max""restrict_iso_scale_max""restrict_iso_scale_max", 'restrict_iso_scale_min'"restrict_iso_scale_min""restrict_iso_scale_min""restrict_iso_scale_min""restrict_iso_scale_min", 'restrict_scale_column_max'"restrict_scale_column_max""restrict_scale_column_max""restrict_scale_column_max""restrict_scale_column_max", 'restrict_scale_column_min'"restrict_scale_column_min""restrict_scale_column_min""restrict_scale_column_min""restrict_scale_column_min", 'restrict_scale_row_max'"restrict_scale_row_max""restrict_scale_row_max""restrict_scale_row_max""restrict_scale_row_max", 'restrict_scale_row_min'"restrict_scale_row_min""restrict_scale_row_min""restrict_scale_row_min""restrict_scale_row_min", 'scale_column_max'"scale_column_max""scale_column_max""scale_column_max""scale_column_max", 'scale_column_min'"scale_column_min""scale_column_min""scale_column_min""scale_column_min", 'scale_column_step'"scale_column_step""scale_column_step""scale_column_step""scale_column_step", 'scale_row_max'"scale_row_max""scale_row_max""scale_row_max""scale_row_max", 'scale_row_min'"scale_row_min""scale_row_min""scale_row_min""scale_row_min", 'scale_row_step'"scale_row_step""scale_row_step""scale_row_step""scale_row_step", 'scale_type'"scale_type""scale_type""scale_type""scale_type", 'strict_boundaries'"strict_boundaries""strict_boundaries""strict_boundaries""strict_boundaries", 'subpixel'"subpixel""subpixel""subpixel""subpixel", 'time_measurement'"time_measurement""time_measurement""time_measurement""time_measurement", 'timeout'"timeout""timeout""timeout""timeout", 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter"
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) attribute.value-array → HTupleSequence[Union[int, float, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Parameter value.
Result
If the parameters are valid, the operator
get_generic_shape_model_paramget_generic_shape_model_paramGetGenericShapeModelParamGetGenericShapeModelParamget_generic_shape_model_param returns the value 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
create_generic_shape_modelcreate_generic_shape_modelCreateGenericShapeModelCreateGenericShapeModelcreate_generic_shape_model,
set_generic_shape_model_paramset_generic_shape_model_paramSetGenericShapeModelParamSetGenericShapeModelParamset_generic_shape_model_param,
train_generic_shape_modeltrain_generic_shape_modelTrainGenericShapeModelTrainGenericShapeModeltrain_generic_shape_model
Module
Matching