Solar
Public Member Functions | List of all members
SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv Class Reference

Draws 2D features (circles, lines, etc.) on an image. UUID: cc51d685-9797-4ffd-a9dd-cec4f367fa6a More...

#include <SolAR2DOverlayOpencv.h>

Inheritance diagram for SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv:
Inheritance graph
[legend]
Collaboration diagram for SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv:
Collaboration graph
[legend]

Public Member Functions

void drawCircle (const datastructure::Point2Df &point, SRef< datastructure::Image > displayImage) override
 Draw one Circle. Draws a circle on the image displayImage center on the point with specified radius and thickness. More...
 
void drawCircles (const std::vector< datastructure::Point2Df > &points, SRef< datastructure::Image > displayImage) override
 Draw Circles. Draws all the circles stored in the vector std::vector <Point2Df> & points on image displayImage with specified radius, thickness and colors (defined in the configuration file). More...
 
void drawCircles (const std::vector< datastructure::Keypoint > &keypoints, SRef< datastructure::Image > displayImage) override
 Draw Circles. Draws all the circles stored in the vector std::vector <Keypoint> & keypoints on image displayImage with specified radius, thickness and colors (defined in the configuration file). More...
 
void drawContour (const datastructure::Contour2Df &contour, SRef< datastructure::Image > displayImage)
 Draw a Contour. Draws a contour on image displayImage. More...
 
void drawContours (const std::vector< datastructure::Contour2Df > &contours, SRef< datastructure::Image > displayImage) override
 Draw Contours. Draws all the contours stored in the vector std::vector <Contour2Df> & contours on image displayImage. More...
 
void drawSBPattern (const datastructure::SquaredBinaryPattern &pattern, SRef< datastructure::Image > displayImage) override
 Draws a Squared Binary Pattern. More...
 
void unloadComponent () override final
 

Detailed Description

Draws 2D features (circles, lines, etc.) on an image. UUID: cc51d685-9797-4ffd-a9dd-cec4f367fa6a

Properties
thickness the thickness of the displayed features (not used for SBPattern)
type: uint; range : [0..MAX UINT]; default: 1
radius the radius of a circle (not used for contours and SBPattern)
type: uint; range : [0..MAX UINT]; default: 5
color The color in BGR format of the displayed features
size: 3, elem type: uint; range : [0..255]; default: { 0, 255, 0 }
randomColor if not 0, the color will be randomized for each elements
type: int; range : [0, 1]; default: 0

Member Function Documentation

◆ drawCircle()

void SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv::drawCircle ( const datastructure::Point2Df &  point,
SRef< datastructure::Image >  displayImage 
)
override

Draw one Circle. Draws a circle on the image displayImage center on the point with specified radius and thickness.

Parameters
[in]pointThe position of the circle to draw
[in,out]displayImageThe image on which the the circles will be drawn.

◆ drawCircles() [1/2]

void SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv::drawCircles ( const std::vector< datastructure::Keypoint > &  keypoints,
SRef< datastructure::Image >  displayImage 
)
override

Draw Circles. Draws all the circles stored in the vector std::vector <Keypoint> & keypoints on image displayImage with specified radius, thickness and colors (defined in the configuration file).

Parameters
[in]keypointThe positions of the circles to draw
[in,out]displayImageThe image on which the circles will be drawn.

◆ drawCircles() [2/2]

void SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv::drawCircles ( const std::vector< datastructure::Point2Df > &  points,
SRef< datastructure::Image >  displayImage 
)
override

Draw Circles. Draws all the circles stored in the vector std::vector <Point2Df> & points on image displayImage with specified radius, thickness and colors (defined in the configuration file).

Parameters
[in]pointThe positions of the circles to draw
[in,out]displayImageThe image on which the circles will be drawn.

◆ drawContour()

void SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv::drawContour ( const datastructure::Contour2Df &  contour,
SRef< datastructure::Image >  displayImage 
)

Draw a Contour. Draws a contour on image displayImage.

Parameters
[in]contourThe contour in 2D to draw with specified radius, thickness and colors (defined in the configuration file).
[in,out]displayImageThe image on which the contours will be drawn.

◆ drawContours()

void SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv::drawContours ( const std::vector< datastructure::Contour2Df > &  contours,
SRef< datastructure::Image >  displayImage 
)
override

Draw Contours. Draws all the contours stored in the vector std::vector <Contour2Df> & contours on image displayImage.

Parameters
[in]contoursThe vector of contours in 2D to draw with specified radius, thickness and colors (defined in the configuration file).
[in,out]displayImageThe image on which the contours will be drawn.

◆ drawSBPattern()

void SolAR::MODULES::OPENCV::SolAR2DOverlayOpencv::drawSBPattern ( const datastructure::SquaredBinaryPattern &  pattern,
SRef< datastructure::Image >  displayImage 
)
override

Draws a Squared Binary Pattern.

Parameters
[in]patternThe squared binary pattern to display.
[in,out]displayImageThe image on which the squared binary pattern will be drawn (on the whole image).

The documentation for this class was generated from the following file: