Operator Reference
get_deformable_model_contours (Operator)
get_deformable_model_contours
— Return the contour representation of a deformable model.
Signature
get_deformable_model_contours( : ModelContours : ModelID, Level : )
Description
The operator get_deformable_model_contours
returns a
representation of the deformable model ModelID
as XLD contours
in ModelContours
. The parameter Level
determines
for which pyramid level of the model the contour representation
should be returned. The contours can be used, for example, to
visualize the found instances of the model in an image.
In case that the model was generated by
create_planar_calib_deformable_model_xld
, the contours by default
are returned in the world coordinate system in metric units. Here, the
contours must be transformed by the returned pose for visualizing a match.
In all other cases, the contours of the model by default are returned in the
image coordinate system in pixel units. In the calibrated case this
system corresponds to the rectified image coordinate system. The
rectified image coordinate system is the coordinate system of an image
one would obtain by change_radial_distortion_image
when
using the rectified camera parameters. The rectified camera parameters
can be queried by get_deformable_model_params
.
It should
be noted that the position of ModelContours
is normalized
such that the reference point of the model (see
set_deformable_model_origin
) lies at the pixel position (0,0).
Hence, the contours simply need to be transformed by the found
homography in the image.
The default behavior for the calibrated case can be changed with the
generic parameter 'get_deformable_model_contours_coord_system'
of the operator set_deformable_model_param
.
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
ModelContours
(output_object) xld_cont-array →
object
Contour representation of the deformable model.
ModelID
(input_control) deformable_model →
(handle)
Handle of the model.
Level
(input_control) integer →
(integer)
Pyramid level for which the contour representation should be returned.
Default: 1
Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
Restriction:
Level >= 1
Result
If the handle of the model is valid, the operator
get_deformable_model_contours
returns the value 2 (
H_MSG_TRUE)
. If
necessary an exception is raised.
Possible Predecessors
create_planar_uncalib_deformable_model
,
create_planar_uncalib_deformable_model_xld
,
read_deformable_model
,
create_planar_calib_deformable_model
,
create_planar_calib_deformable_model_xld
,
create_local_deformable_model
,
create_local_deformable_model_xld
See also
set_deformable_model_param
,
find_planar_uncalib_deformable_model
,
find_planar_calib_deformable_model
Module
Matching