Operator Reference
get_generic_shape_model_result_object (Operator)
get_generic_shape_model_result_object — Get objects from a shape matching result.
Signature
get_generic_shape_model_result_object( : Objects : MatchResultID, MatchSelector, GenParamName : )
Description
get_generic_shape_model_result_object returns iconic results of
shape-based matching in Objects.
The results are contained in MatchResultID.
The parameter MatchSelector is used
to select from which matches the result values shall be returned. For more
information and the list of supported values for MatchSelector
see get_generic_shape_model_result.
GenParamName specifies which object result value will
be returned. The following values are possible:
- 'contours':
Model contours transformed according to the matching result.
- 'clutter_region':
Region where no clutter should occur.
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
Objects (output_object) (multichannel-)object(-array) → object
Objects of the queried result.
MatchResultID (input_control) generic_shape_model_result → (handle)
Handle of the shape model matches.
MatchSelector (input_control) string-array → (string / integer)
Selector for the matching results to be queried.
Default: 'all'
List of values: 'all', 'best'
GenParamName (input_control) string → (string)
Name of the queried result object.
Default: 'contours'
List of values: 'clutter_region', 'contours'
Result
If the parameters are valid, the operator
get_generic_shape_model_result_object returns the value 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
Module
Matching