Solar
Public Member Functions | List of all members
SolAR::api::features::IDescriptorsExtractorSBPattern Class Referenceabstract

Extracts descriptors from a squared binary pattern or from an image of a squared binary pattern. UUID: 2e2bde18-ce39-11e7-abc4-cec278b6b50a More...

#include <IDescriptorsExtractorSBPattern.h>

Inheritance diagram for SolAR::api::features::IDescriptorsExtractorSBPattern:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::features::IDescriptorsExtractorSBPattern:
Collaboration graph
[legend]

Public Member Functions

 IDescriptorsExtractorSBPattern ()=default
 IDescriptorsExtractorSBPattern default constructor.
 
virtual ~IDescriptorsExtractorSBPattern ()=default
 IDescriptorsExtractorSBPattern default destructor.
 
virtual FrameworkReturnCode extract (const std::vector< SRef< SolAR::datastructure::Image > > &images, const std::vector< SolAR::datastructure::Contour2Df > &inContours, SRef< SolAR::datastructure::DescriptorBuffer > &descriptors, std::vector< SolAR::datastructure::Contour2Df > &outContours)=0
 Extracts the descriptors of a set of images of squared binary patterns. More...
 
virtual FrameworkReturnCode extract (const SolAR::datastructure::SquaredBinaryPattern &pattern, SRef< SolAR::datastructure::DescriptorBuffer > &descriptor)=0
 Extracts the descriptors of a squared binary patterns. More...
 

Detailed Description

Extracts descriptors from a squared binary pattern or from an image of a squared binary pattern. UUID: 2e2bde18-ce39-11e7-abc4-cec278b6b50a

This class provides a method to extract descriptors of a squared binary pattern by simply concatenating pattern rows in a single vector.

Member Function Documentation

◆ extract() [1/2]

virtual FrameworkReturnCode SolAR::api::features::IDescriptorsExtractorSBPattern::extract ( const SolAR::datastructure::SquaredBinaryPattern pattern,
SRef< SolAR::datastructure::DescriptorBuffer > &  descriptor 
)
pure virtual

Extracts the descriptors of a squared binary patterns.

Parameters
[in]patternThe squared binary pattern for which we want to extract its descriptor
[out]descriptorThe descriptor extracted from the squared binary pattern. The descriptor of a squared binary pattern is simply the concatenation of the rows of the pattern matrix.
Returns
FrameworkReturnCode::SUCCESS if the extraction succeed, else FrameworkReturnCode::_ERROR.

◆ extract() [2/2]

virtual FrameworkReturnCode SolAR::api::features::IDescriptorsExtractorSBPattern::extract ( const std::vector< SRef< SolAR::datastructure::Image > > &  images,
const std::vector< SolAR::datastructure::Contour2Df > &  inContours,
SRef< SolAR::datastructure::DescriptorBuffer > &  descriptors,
std::vector< SolAR::datastructure::Contour2Df > &  outContours 
)
pure virtual

Extracts the descriptors of a set of images of squared binary patterns.

Parameters
[in]imagesThe set of images on which we want to extract descriptors. These images have to be exactly aligned on the squared binary patterns including the borders of the marker.
[in]inContoursThe contours in the original image of candidates for squared binary pattern. The nth contour corresponds to the nth image of the first attribute representing a candidate of a squared binary pattern extracted from the original image.
[out]descriptorsThe descriptors of the squared binary pattern recognized in the images.
[out]outContoursThe contours in the original image of recognized squared binary pattern. The nth contour corresponds to the nth descriptors of the third attribute representing a recognized squared binary pattern extracted from the original image.
Returns
FrameworkReturnCode::SUCCESS if the extraction succeed, else FrameworkReturnCode::_ERROR.

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