LBSP Class Reference

#include <LBSP.h>

Inheritance diagram for LBSP:

Public Member Functions
	LBSP (size_t nThreshold)
	constructor 1, threshold = absolute intensity 'similarity' threshold used when computing comparisons
	LBSP (float fRelThreshold, size_t nThresholdOffset=0)
	constructor 2, threshold = relative intensity 'similarity' threshold used when computing comparisons
virtual	~LBSP ()
	default destructor
virtual void	read (const cv::FileNode &)
	loads extractor params from the specified file node @@ not impl
virtual void	write (cv::FileStorage &) const
	writes extractor params to the specified file storage @@ not impl
virtual void	setReference (const cv::Mat &)
	sets the 'reference' image to be used for inter-frame comparisons (note: if no image is set or if the image is empty, the algorithm will default back to intra-frame comparisons)
virtual int	descriptorSize () const
	returns the current descriptor size, in bytes
virtual int	descriptorType () const
	returns the current descriptor data type
virtual bool	isUsingRelThreshold () const
	returns whether this extractor is using a relative threshold or not
virtual float	getRelThreshold () const
	returns the current relative threshold used for comparisons (-1 = invalid/not used)
virtual size_t	getAbsThreshold () const
	returns the current absolute threshold used for comparisons (-1 = invalid/not used)
void	compute2 (const cv::Mat &oImage, std::vector< cv::KeyPoint > &voKeypoints, cv::Mat &oDescriptors) const
	similar to DescriptorExtractor::compute(const cv::Mat& image, ...), but in this case, the descriptors matrix has the same shape as the input matrix (possibly slower, but the result can be displayed)
void	compute2 (const std::vector< cv::Mat > &voImageCollection, std::vector< std::vector< cv::KeyPoint > > &vvoPointCollection, std::vector< cv::Mat > &voDescCollection) const
	batch version of LBSP::compute2(const cv::Mat& image, ...), also similar to DescriptorExtractor::compute(const std::vector<cv::Mat>& imageCollection, ...)

Static Public Member Functions
static void	computeGrayscaleDescriptor (const cv::Mat &oInputImg, const uchar _ref, const int _x, const int _y, const size_t _t, ushort &_res)
	utility function, shortcut/lightweight/direct single-point LBSP computation function for extra flexibility (1-channel version)
static void	computeRGBDescriptor (const cv::Mat &oInputImg, const uchar *const _ref, const int _x, const int _y, const size_t *const _t, ushort *_res)
	utility function, shortcut/lightweight/direct single-point LBSP computation function for extra flexibility (3-channels version)
static void	computeRGBDescriptor (const cv::Mat &oInputImg, const uchar *const _ref, const int _x, const int _y, const size_t _t, ushort *_res)
	utility function, shortcut/lightweight/direct single-point LBSP computation function for extra flexibility (3-channels version)
static void	computeSingleRGBDescriptor (const cv::Mat &oInputImg, const uchar _ref, const int _x, const int _y, const size_t _c, const size_t _t, ushort &_res)
	utility function, shortcut/lightweight/direct single-point LBSP computation function for extra flexibility (1-channel-RGB version)
static void	reshapeDesc (cv::Size oSize, const std::vector< cv::KeyPoint > &voKeypoints, const cv::Mat &oDescriptors, cv::Mat &oOutput)
	utility function, used to reshape a descriptors matrix to its input image size via their keypoint locations
static void	calcDescImgDiff (const cv::Mat &oDesc1, const cv::Mat &oDesc2, cv::Mat &oOutput, bool bForceMergeChannels=false)
	utility function, used to illustrate the difference between two descriptor images
static void	validateKeyPoints (std::vector< cv::KeyPoint > &voKeypoints, cv::Size oImgSize)
	utility function, used to filter out bad keypoints that would trigger out of bounds error because they're too close to the image border
static void	validateROI (cv::Mat &oROI)
	utility function, used to filter out bad pixels in a ROI that would trigger out of bounds error because they're too close to the image border

Static Public Attributes
static const size_t	PATCH_SIZE = 5
	utility, specifies the pixel size of the pattern used (width and height)
static const size_t	DESC_SIZE = 2
	utility, specifies the number of bytes per descriptor (should be the same as calling 'descriptorSize()')

Protected Member Functions
virtual void	computeImpl (const cv::Mat &oImage, std::vector< cv::KeyPoint > &voKeypoints, cv::Mat &oDescriptors) const
	classic 'compute' implementation, based on the regular DescriptorExtractor::computeImpl arguments & expected output

Protected Attributes
const bool	m_bOnlyUsingAbsThreshold
const float	m_fRelThreshold
const size_t	m_nThreshold
cv::Mat	m_oRefImage

Detailed Description

Local Binary Similarity Pattern (LBSP) feature extractor

Note 1: both grayscale and RGB/BGR images may be used with this extractor. Note 2: using LBSP::compute2(...) is logically equivalent to using LBSP::compute(...) followed by LBSP::reshapeDesc(...).

For more details on the different parameters, see G.-A. Bilodeau et al, "Change Detection in Feature Space Using Local Binary Similarity Patterns", in CRV 2013.

This algorithm is currently NOT thread-safe.

---

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

• custom_utils/LBSP.h
• custom_utils/LBSP.cpp