Operator Reference
find_generic_shape_model (Operator)
find_generic_shape_model — Find the best matches of one or multiple shape models in an image.
Signature
find_generic_shape_model(SearchImage : : ModelID : MatchResultID, NumMatchResult)
Description
The operator find_generic_shape_model finds the best instances of
one or multiple shape models passed in ModelID in the input image
SearchImage. The found matches are returned in
MatchResultID and can be queried using
get_generic_shape_model_result and
get_generic_shape_model_result_object. The number of found matches
is returned in NumMatchResult. The model can be parameterized using
set_generic_shape_model_param and
set_generic_shape_model_object, through which one can control
the search.
The input image SearchImage may be a multichannel image.
Which channels of a multichannel image are used depends on the
model parameter 'metric' (see
set_generic_shape_model_param).
The domain of SearchImage sets the ROI for the
search. It limits the search space as it is considered as boundary for the
center of gravity of ModelID in order to accelerate the matching
process. For information on passing a tuple of images to
SearchImage see below.
Furthermore, the search space is limited by the size of SearchImage.
By default, ModelID is only searched within those points of the
domain, in which ModelID fits completely. Hence, ModelID
will not be found if it exceeds the border of the image. This holds
for all levels of the used image pyramid.
In rare cases which typically occur for artificial images, instances of
ModelID cannot be found in an image, if they touch the border of the
domain on any level of the image pyramid.
As a rule of thumb, ModelID might not be found if its distance to
an image border is smaller than
pixels (where is the number of pyramid levels).
This behavior can be changed with 'border_shape_models', see
set_generic_shape_model_param.
When searching multiple models 'border_shape_models' is treated
as 'true' for all models even if 'border_shape_models'
only evaluates to 'true' for one of the models in a search.
| ( 1) | ( 2) | ( 3) |
When searching multiple models, the search space can be restricted for all
models simultaneously by passing a single image with reduced domain in
SearchImage.
Alternatively, the search space can be restricted for each model
individually by passing an object containing multiple image objects, one for
each model in ModelID.
The search space is determined by the domain of the corresponding image.
Except the domain, the images have to be identical, i.e.,
the pointers of the image objects need to refer to the same
image (thus they need to be identical).
The pointers can be checked using get_image_pointer1.
When applying multiple models, different identifiers ('model_identifier') have to be set for each model, so that each instance can be assigned to the shape model it has been found with. Otherwise an exception is raised.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Automatically parallelized on internal data level.
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.
This operator supports canceling timeouts and interrupts.
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
SearchImage (input_object) (multichannel-)object(-array) → object
Image in which the model is searched.
ModelID (input_control, state is modified) shape_model(-array) → (handle)
Handle of the shape model.
MatchResultID (output_control) generic_shape_model_result → (handle)
Handle with the found matches.
NumMatchResult (output_control) integer → (integer)
Number of found matches.
Result
If the parameters are valid, the operator
find_generic_shape_model returns the value 2 (
H_MSG_TRUE)
.
If necessary an exception is raised.
Possible Predecessors
train_generic_shape_model,
set_generic_shape_model_param
Module
Matching