Solar
Public Member Functions | List of all members
SolAR::api::display::IMaskOverlay Class Referenceabstract

Draws masks on top of an image. UUID: 35a2454a-cb09-44ac-b2ce-0b0732175f94 More...

#include <IMaskOverlay.h>

Inheritance diagram for SolAR::api::display::IMaskOverlay:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::display::IMaskOverlay:
Collaboration graph
[legend]

Public Member Functions

 IMaskOverlay ()=default
 IMaskOverlay default constructor.
 
virtual ~IMaskOverlay ()=default
 IMaskOverlay default destructor.
 
virtual FrameworkReturnCode draw (SRef< SolAR::datastructure::Image > image, const std::vector< SolAR::datastructure::Rectanglei > &boxes, const std::vector< SRef< SolAR::datastructure::Image > > &masks, const std::vector< uint32_t > &classIds, const std::vector< float > &scores)=0
 Draw masks on an image. More...
 
virtual FrameworkReturnCode draw (SRef< SolAR::datastructure::Image > image, const SRef< SolAR::datastructure::Image > mask)=0
 Draw masks on an image. More...
 

Detailed Description

Draws masks on top of an image. UUID: 35a2454a-cb09-44ac-b2ce-0b0732175f94

Member Function Documentation

◆ draw() [1/2]

virtual FrameworkReturnCode SolAR::api::display::IMaskOverlay::draw ( SRef< SolAR::datastructure::Image image,
const SRef< SolAR::datastructure::Image mask 
)
pure virtual

Draw masks on an image.

Parameters
[in,out]imageThe image on which the masks will be drawn.
[in]maskThe mask has same size as the input image, in which the value of each pixel is corresponding to the class id.
Returns
FrameworkReturnCode::SUCCESS if the draw succeed, else FrameworkReturnCode::_ERROR

◆ draw() [2/2]

virtual FrameworkReturnCode SolAR::api::display::IMaskOverlay::draw ( SRef< SolAR::datastructure::Image image,
const std::vector< SolAR::datastructure::Rectanglei > &  boxes,
const std::vector< SRef< SolAR::datastructure::Image > > &  masks,
const std::vector< uint32_t > &  classIds,
const std::vector< float > &  scores 
)
pure virtual

Draw masks on an image.

Parameters
[in,out]imageThe image on which the masks will be drawn.
[in]boxesThe bounding boxes of each detected object.
[in]masksThe binary masks corresponding to the bounding boxes. For each mask, regions with a value of 1 correspond to the object, otherwise the background.
[in]classIdsThe id of each object in the bounding box.
[in]scoresThe corresponding confidence scores.
Returns
FrameworkReturnCode::SUCCESS if the draw succeed, else FrameworkReturnCode::_ERROR

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