Visual Servoing Platform  version 3.5.1 under development (2023-03-14)
Static Public Member Functions | List of all members
vpImageFilter Class Reference
core: Core module » Image manipulation

#include <visp3/core/vpImageFilter.h>

Static Public Member Functions

static void canny (const vpImage< unsigned char > &I, vpImage< unsigned char > &Ic, unsigned int gaussianFilterSize, double thresholdCanny, unsigned int apertureSobel)
 
template<class T >
static double derivativeFilterX (const vpImage< T > &I, unsigned int r, unsigned int c)
 
template<class T >
static double derivativeFilterY (const vpImage< T > &I, unsigned int r, unsigned int c)
 
template<class T >
static double derivativeFilterX (const vpImage< T > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
template<class T >
static double derivativeFilterY (const vpImage< T > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static void filter (const vpImage< double > &I, vpImage< double > &Iu, vpImage< double > &Iv, const vpMatrix &M, bool convolve=false)
 
static void filter (const vpImage< unsigned char > &I, vpImage< double > &If, const vpMatrix &M, bool convolve=false)
 
static void sepFilter (const vpImage< unsigned char > &I, vpImage< double > &If, const vpColVector &kernelH, const vpColVector &kernelV)
 
static void filter (const vpImage< unsigned char > &I, vpImage< double > &GI, const double *filter, unsigned int size)
 
static void filter (const vpImage< double > &I, vpImage< double > &GI, const double *filter, unsigned int size)
 
static unsigned char filterGaussXPyramidal (const vpImage< unsigned char > &I, unsigned int i, unsigned int j)
 
static unsigned char filterGaussYPyramidal (const vpImage< unsigned char > &I, unsigned int i, unsigned int j)
 
static void filterX (const vpImage< unsigned char > &I, vpImage< double > &dIx, const double *filter, unsigned int size)
 
static void filterX (const vpImage< double > &I, vpImage< double > &dIx, const double *filter, unsigned int size)
 
static void filterX (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static void filterXR (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static void filterXG (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static void filterXB (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static double filterX (const vpImage< unsigned char > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXR (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXG (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXB (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXLeftBorder (const vpImage< unsigned char > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXLeftBorderR (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXLeftBorderG (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXLeftBorderB (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXRightBorder (const vpImage< unsigned char > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXRightBorderR (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXRightBorderG (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXRightBorderB (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterX (const vpImage< double > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXLeftBorder (const vpImage< double > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterXRightBorder (const vpImage< double > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static void filterY (const vpImage< unsigned char > &I, vpImage< double > &dIx, const double *filter, unsigned int size)
 
static void filterY (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static void filterYR (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static void filterYG (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static void filterYB (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &dIx, const double *filter, unsigned int size)
 
static void filterY (const vpImage< double > &I, vpImage< double > &dIx, const double *filter, unsigned int size)
 
static double filterY (const vpImage< unsigned char > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYR (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYG (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYB (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYTopBorder (const vpImage< unsigned char > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYTopBorderR (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYTopBorderG (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYTopBorderB (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYBottomBorder (const vpImage< unsigned char > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYBottomBorderR (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYBottomBorderG (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYBottomBorderB (const vpImage< vpRGBa > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYTopBorder (const vpImage< double > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterYBottomBorder (const vpImage< double > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static double filterY (const vpImage< double > &I, unsigned int r, unsigned int c, const double *filter, unsigned int size)
 
static void gaussianBlur (const vpImage< unsigned char > &I, vpImage< double > &GI, unsigned int size=7, double sigma=0., bool normalize=true)
 
static void gaussianBlur (const vpImage< vpRGBa > &I, vpImage< vpRGBa > &GI, unsigned int size=7, double sigma=0., bool normalize=true)
 
static void gaussianBlur (const vpImage< double > &I, vpImage< double > &GI, unsigned int size=7, double sigma=0., bool normalize=true)
 
template<class T >
static double gaussianFilter (const vpImage< T > &fr, unsigned int r, unsigned int c)
 
static void getGaussPyramidal (const vpImage< unsigned char > &I, vpImage< unsigned char > &GI)
 
static void getGaussXPyramidal (const vpImage< unsigned char > &I, vpImage< unsigned char > &GI)
 
static void getGaussYPyramidal (const vpImage< unsigned char > &I, vpImage< unsigned char > &GI)
 
static void getGaussianKernel (double *filter, unsigned int size, double sigma=0., bool normalize=true)
 
static void getGaussianDerivativeKernel (double *filter, unsigned int size, double sigma=0., bool normalize=true)
 
static void getGradX (const vpImage< unsigned char > &I, vpImage< double > &dIx)
 
static void getGradX (const vpImage< unsigned char > &I, vpImage< double > &dIx, const double *filter, unsigned int size)
 
static void getGradX (const vpImage< double > &I, vpImage< double > &dIx, const double *filter, unsigned int size)
 
static void getGradXGauss2D (const vpImage< unsigned char > &I, vpImage< double > &dIx, const double *gaussianKernel, const double *gaussianDerivativeKernel, unsigned int size)
 
static void getGradY (const vpImage< unsigned char > &I, vpImage< double > &dIy)
 
static void getGradY (const vpImage< unsigned char > &I, vpImage< double > &dIy, const double *filter, unsigned int size)
 
static void getGradY (const vpImage< double > &I, vpImage< double > &dIy, const double *filter, unsigned int size)
 
static void getGradYGauss2D (const vpImage< unsigned char > &I, vpImage< double > &dIy, const double *gaussianKernel, const double *gaussianDerivativeKernel, unsigned int size)
 
static double getSobelKernelX (double *filter, unsigned int size)
 
static double getSobelKernelY (double *filter, unsigned int size)
 

Detailed Description

Various image filter, convolution, etc...

Definition at line 67 of file vpImageFilter.h.

Member Function Documentation

◆ canny()

void vpImageFilter::canny ( const vpImage< unsigned char > &  Isrc,
vpImage< unsigned char > &  Ires,
unsigned int  gaussianFilterSize,
double  thresholdCanny,
unsigned int  apertureSobel 
)
static

Apply the Canny edge operator on the image Isrc and return the resulting image Ires.

The following example shows how to use the method:

#include <visp3/core/vpConfig.h>
#include <visp3/core/vpImage.h>
#include <visp3/core/vpImageFilter.h>
int main()
{
#if VISP_HAVE_OPENCV_VERSION >= 0x020100 // Canny uses OpenCV >=2.1.0
// Constants for the Canny operator.
const unsigned int gaussianFilterSize = 5;
const double thresholdCanny = 15;
const unsigned int apertureSobel = 3;
// Image for the Canny edge operator
vpImage<unsigned char> Isrc;
vpImage<unsigned char> Icanny;
//First grab the source image Isrc.
//Apply the Canny edge operator and set the Icanny image.
vpImageFilter::canny(Isrc, Icanny, gaussianFilterSize, thresholdCanny, apertureSobel);
#endif
return (0);
}
vpImageFilter::canny
static void canny(const vpImage< unsigned char > &I, vpImage< unsigned char > &Ic, unsigned int gaussianFilterSize, double thresholdCanny, unsigned int apertureSobel)
Definition: vpImageFilter.cpp:298
Parameters
Isrc: Image to apply the Canny edge detector to.
Ires: Filtered image (255 means an edge, 0 otherwise).
gaussianFilterSize: The size of the mask of the Gaussian filter to apply (an odd number).
thresholdCanny: The threshold for the Canny operator. Only value greater than this value are marked as an edge).
apertureSobel: Size of the mask for the Sobel operator (odd number).
Examples
tutorial-image-filter.cpp.

Definition at line 298 of file vpImageFilter.cpp.

References vpImageConvert::convert().

Referenced by vpMeNurbs::seekExtremitiesCanny().

◆ derivativeFilterX() [1/2]

template<class T >
static double vpImageFilter::derivativeFilterX ( const vpImage< T > &  I,
unsigned int  r,
unsigned int  c 
)
inlinestatic

Apply a 1x3 derivative filter to an image pixel.

Parameters
I: Image to filter
r: coordinates (row) of the pixel
c: coordinates (column) of the pixel

Definition at line 82 of file vpImageFilter.h.

Referenced by vpFeatureLuminance::buildFrom(), and getGradX().

◆ derivativeFilterX() [2/2]

template<class T >
static double vpImageFilter::derivativeFilterX ( const vpImage< T > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Apply a 1 x size Derivative Filter in X to an image pixel.

Parameters
I: Image to filter
r: coordinates (row) of the pixel
c: coordinates (column) of the pixel
filter: coefficients of the filter to be initialized using vpImageFilter::getGaussianDerivativeKernel().
size: size of the filter
See also
vpImageFilter::getGaussianDerivativeKernel()

Definition at line 117 of file vpImageFilter.h.

◆ derivativeFilterY() [1/2]

template<class T >
static double vpImageFilter::derivativeFilterY ( const vpImage< T > &  I,
unsigned int  r,
unsigned int  c 
)
inlinestatic

Apply a 3x1 derivative filter to an image pixel.

Parameters
I: Image to filter
r: coordinates (row) of the pixel
c: coordinates (column) of the pixel

Definition at line 96 of file vpImageFilter.h.

Referenced by vpFeatureLuminance::buildFrom(), and getGradY().

◆ derivativeFilterY() [2/2]

template<class T >
static double vpImageFilter::derivativeFilterY ( const vpImage< T > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Apply a size x 1 Derivative Filter in Y to an image pixel.

Parameters
I: Image to filter
r: coordinates (row) of the pixel
c: coordinates (column) of the pixel
filter: coefficients of the filter to be initialized using vpImageFilter::getGaussianDerivativeKernel().
size: size of the filter
See also
vpImageFilter::getGaussianDerivativeKernel()

Definition at line 144 of file vpImageFilter.h.

◆ filter() [1/4]

void vpImageFilter::filter ( const vpImage< double > &  I,
vpImage< double > &  GI,
const double *  filter,
unsigned int  size 
)
static

Apply a separable filter.

Definition at line 338 of file vpImageFilter.cpp.

References vpImage< Type >::destroy(), filter(), filterX(), and filterY().

◆ filter() [2/4]

void vpImageFilter::filter ( const vpImage< double > &  I,
vpImage< double > &  Iu,
vpImage< double > &  Iv,
const vpMatrix &  M,
bool  convolve = false 
)
static

Apply a filter to an image:

\[ \textbf{I}_u = \textbf{M} \ast \textbf{I} \textbf{ and } \textbf{I}_v = \textbf{M}^t \ast \textbf{I} \]

Parameters
I: Image to filter
Iu: Filtered image along the horizontal axis (u = columns).
Iv: Filtered image along the vertical axis (v = rows).
M: Filter kernel.
convolve: If true, perform a convolution otherwise a correlation.
Examples
testImageFilter.cpp, and tutorial-image-filter.cpp.

Definition at line 127 of file vpImageFilter.cpp.

References vpImage< Type >::getHeight(), vpArray2D< Type >::getRows(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

Referenced by filter(), filterX(), filterY(), vpTemplateTracker::getGaussianBluredImage(), getGaussianDerivativeKernel(), getGaussianKernel(), getGradX(), getGradY(), vpTemplateTrackerMI::getMI(), vpTemplateTrackerMI::getMI256(), getSobelKernelX(), getSobelKernelY(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpTemplateTrackerMIESM::initHessienDesired(), vpTemplateTrackerMIForwardAdditional::initHessienDesired(), vpTemplateTrackerMIForwardCompositional::initHessienDesired(), vpTemplateTrackerMIInverseCompositional::initHessienDesired(), vpTemplateTracker::initTracking(), vpTemplateTrackerSSDESM::trackNoPyr(), vpTemplateTrackerSSDForwardAdditional::trackNoPyr(), vpTemplateTrackerSSDForwardCompositional::trackNoPyr(), vpTemplateTrackerSSDInverseCompositional::trackNoPyr(), vpTemplateTrackerZNCCForwardAdditional::trackNoPyr(), vpTemplateTrackerZNCCInverseCompositional::trackNoPyr(), vpTemplateTrackerMIESM::trackNoPyr(), vpTemplateTrackerMIForwardAdditional::trackNoPyr(), vpTemplateTrackerMIForwardCompositional::trackNoPyr(), and vpTemplateTrackerMIInverseCompositional::trackNoPyr().

◆ filter() [3/4]

void vpImageFilter::filter ( const vpImage< unsigned char > &  I,
vpImage< double > &  GI,
const double *  filter,
unsigned int  size 
)
static

Apply a separable filter.

Definition at line 326 of file vpImageFilter.cpp.

References vpImage< Type >::destroy(), filter(), filterX(), and filterY().

◆ filter() [4/4]

void vpImageFilter::filter ( const vpImage< unsigned char > &  I,
vpImage< double > &  If,
const vpMatrix &  M,
bool  convolve = false 
)
static

Apply a filter to an image.

Parameters
I: Image to filter
If: Filtered image.
M: Filter kernel.
convolve: If true, perform a convolution otherwise a correlation.
Note
By default it performs a correlation:

\[ \textbf{I\_filtered} \left( u,v \right) = \sum_{y=0}^{\textbf{kernel\_h}} \sum_{x=0}^{\textbf{kernel\_w}} \textbf{M} \left( x,y \right ) \times \textbf{I} \left( u-\frac{\textbf{kernel\_w}}{2}+x,v-\frac{\textbf{kernel\_h}}{2}+y \right) \]

The convolution is almost the same operation:

\[ \textbf{I\_filtered} \left( u,v \right) = \sum_{y=0}^{\textbf{kernel\_h}} \sum_{x=0}^{\textbf{kernel\_w}} \textbf{M} \left( x,y \right ) \times \textbf{I} \left( u+\frac{\textbf{kernel\_w}}{2}-x,v+\frac{\textbf{kernel\_h}}{2}-y \right) \]

Only pixels in the input image fully covered by the kernel are considered.

Definition at line 77 of file vpImageFilter.cpp.

References vpArray2D< Type >::getCols(), vpImage< Type >::getHeight(), vpArray2D< Type >::getRows(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ filterGaussXPyramidal()

static unsigned char vpImageFilter::filterGaussXPyramidal ( const vpImage< unsigned char > &  I,
unsigned int  i,
unsigned int  j 
)
inlinestatic

Definition at line 169 of file vpImageFilter.h.

Referenced by getGaussXPyramidal().

◆ filterGaussYPyramidal()

static unsigned char vpImageFilter::filterGaussYPyramidal ( const vpImage< unsigned char > &  I,
unsigned int  i,
unsigned int  j 
)
inlinestatic

Definition at line 174 of file vpImageFilter.h.

Referenced by getGaussYPyramidal().

◆ filterX() [1/5]

static double vpImageFilter::filterX ( const vpImage< double > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 367 of file vpImageFilter.h.

◆ filterX() [2/5]

void vpImageFilter::filterX ( const vpImage< double > &  I,
vpImage< double > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 385 of file vpImageFilter.cpp.

References filter(), filterX(), filterXLeftBorder(), filterXRightBorder(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ filterX() [3/5]

static double vpImageFilter::filterX ( const vpImage< unsigned char > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 187 of file vpImageFilter.h.

◆ filterX() [4/5]

void vpImageFilter::filterX ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 346 of file vpImageFilter.cpp.

References filter(), filterXLeftBorder(), filterXRightBorder(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

Referenced by filter(), filterX(), gaussianBlur(), and getGradYGauss2D().

◆ filterX() [5/5]

void vpImageFilter::filterX ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 364 of file vpImageFilter.cpp.

References filter(), filterXB(), filterXG(), filterXLeftBorderB(), filterXLeftBorderG(), filterXLeftBorderR(), filterXR(), filterXRightBorderB(), filterXRightBorderG(), filterXRightBorderR(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ filterXB() [1/2]

static double vpImageFilter::filterXB ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 226 of file vpImageFilter.h.

◆ filterXB() [2/2]

static void vpImageFilter::filterXB ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Referenced by filterX().

◆ filterXG() [1/2]

static double vpImageFilter::filterXG ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 213 of file vpImageFilter.h.

◆ filterXG() [2/2]

static void vpImageFilter::filterXG ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Referenced by filterX().

◆ filterXLeftBorder() [1/2]

static double vpImageFilter::filterXLeftBorder ( const vpImage< double > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 380 of file vpImageFilter.h.

◆ filterXLeftBorder() [2/2]

static double vpImageFilter::filterXLeftBorder ( const vpImage< unsigned char > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 239 of file vpImageFilter.h.

Referenced by filterX().

◆ filterXLeftBorderB()

static double vpImageFilter::filterXLeftBorderB ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 287 of file vpImageFilter.h.

Referenced by filterX().

◆ filterXLeftBorderG()

static double vpImageFilter::filterXLeftBorderG ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 271 of file vpImageFilter.h.

Referenced by filterX().

◆ filterXLeftBorderR()

static double vpImageFilter::filterXLeftBorderR ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 255 of file vpImageFilter.h.

Referenced by filterX().

◆ filterXR() [1/2]

static double vpImageFilter::filterXR ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 200 of file vpImageFilter.h.

◆ filterXR() [2/2]

static void vpImageFilter::filterXR ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Referenced by filterX().

◆ filterXRightBorder() [1/2]

static double vpImageFilter::filterXRightBorder ( const vpImage< double > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 396 of file vpImageFilter.h.

References vpImage< Type >::getWidth().

◆ filterXRightBorder() [2/2]

static double vpImageFilter::filterXRightBorder ( const vpImage< unsigned char > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 303 of file vpImageFilter.h.

References vpImage< Type >::getWidth().

Referenced by filterX().

◆ filterXRightBorderB()

static double vpImageFilter::filterXRightBorderB ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 351 of file vpImageFilter.h.

References vpImage< Type >::getWidth().

Referenced by filterX().

◆ filterXRightBorderG()

static double vpImageFilter::filterXRightBorderG ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 335 of file vpImageFilter.h.

References vpImage< Type >::getWidth().

Referenced by filterX().

◆ filterXRightBorderR()

static double vpImageFilter::filterXRightBorderR ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 319 of file vpImageFilter.h.

References vpImage< Type >::getWidth().

Referenced by filterX().

◆ filterY() [1/5]

static double vpImageFilter::filterY ( const vpImage< double > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 628 of file vpImageFilter.h.

◆ filterY() [2/5]

void vpImageFilter::filterY ( const vpImage< double > &  I,
vpImage< double > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 447 of file vpImageFilter.cpp.

References filter(), filterY(), filterYBottomBorder(), filterYTopBorder(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ filterY() [3/5]

static double vpImageFilter::filterY ( const vpImage< unsigned char > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 418 of file vpImageFilter.h.

◆ filterY() [4/5]

void vpImageFilter::filterY ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 402 of file vpImageFilter.cpp.

References filter(), filterYBottomBorder(), filterYTopBorder(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

Referenced by filter(), filterY(), gaussianBlur(), and getGradXGauss2D().

◆ filterY() [5/5]

void vpImageFilter::filterY ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 422 of file vpImageFilter.cpp.

References filter(), filterYB(), filterYBottomBorderB(), filterYBottomBorderG(), filterYBottomBorderR(), filterYG(), filterYR(), filterYTopBorderB(), filterYTopBorderG(), filterYTopBorderR(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ filterYB() [1/2]

static double vpImageFilter::filterYB ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 455 of file vpImageFilter.h.

◆ filterYB() [2/2]

static void vpImageFilter::filterYB ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Referenced by filterY().

◆ filterYBottomBorder() [1/2]

static double vpImageFilter::filterYBottomBorder ( const vpImage< double > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 612 of file vpImageFilter.h.

References vpImage< Type >::getHeight().

◆ filterYBottomBorder() [2/2]

static double vpImageFilter::filterYBottomBorder ( const vpImage< unsigned char > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 532 of file vpImageFilter.h.

References vpImage< Type >::getHeight().

Referenced by filterY().

◆ filterYBottomBorderB()

static double vpImageFilter::filterYBottomBorderB ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 580 of file vpImageFilter.h.

References vpImage< Type >::getHeight().

Referenced by filterY().

◆ filterYBottomBorderG()

static double vpImageFilter::filterYBottomBorderG ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 564 of file vpImageFilter.h.

References vpImage< Type >::getHeight().

Referenced by filterY().

◆ filterYBottomBorderR()

static double vpImageFilter::filterYBottomBorderR ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 548 of file vpImageFilter.h.

References vpImage< Type >::getHeight().

Referenced by filterY().

◆ filterYG() [1/2]

static double vpImageFilter::filterYG ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 443 of file vpImageFilter.h.

◆ filterYG() [2/2]

static void vpImageFilter::filterYG ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Referenced by filterY().

◆ filterYR() [1/2]

static double vpImageFilter::filterYR ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 431 of file vpImageFilter.h.

◆ filterYR() [2/2]

static void vpImageFilter::filterYR ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Referenced by filterY().

◆ filterYTopBorder() [1/2]

static double vpImageFilter::filterYTopBorder ( const vpImage< double > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 596 of file vpImageFilter.h.

◆ filterYTopBorder() [2/2]

static double vpImageFilter::filterYTopBorder ( const vpImage< unsigned char > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 468 of file vpImageFilter.h.

Referenced by filterY().

◆ filterYTopBorderB()

static double vpImageFilter::filterYTopBorderB ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 516 of file vpImageFilter.h.

Referenced by filterY().

◆ filterYTopBorderG()

static double vpImageFilter::filterYTopBorderG ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 500 of file vpImageFilter.h.

Referenced by filterY().

◆ filterYTopBorderR()

static double vpImageFilter::filterYTopBorderR ( const vpImage< vpRGBa > &  I,
unsigned int  r,
unsigned int  c,
const double *  filter,
unsigned int  size 
)
inlinestatic

Definition at line 484 of file vpImageFilter.h.

Referenced by filterY().

◆ gaussianBlur() [1/3]

void vpImageFilter::gaussianBlur ( const vpImage< double > &  I,
vpImage< double > &  GI,
unsigned int  size = 7,
double  sigma = 0.,
bool  normalize = true 
)
static

Apply a Gaussian blur to a double image.

Parameters
I: Input double image.
GI: Filtered image.
size: Filter size. This value should be odd.
sigma: Gaussian standard deviation. If it is equal to zero or negative, it is computed from filter size as sigma = (size-1)/6.
normalize: Flag indicating whether to normalize the filter coefficients or not.
See also
getGaussianKernel() to know which kernel is used.

Definition at line 525 of file vpImageFilter.cpp.

References vpImage< Type >::destroy(), filterX(), filterY(), and getGaussianKernel().

◆ gaussianBlur() [2/3]

void vpImageFilter::gaussianBlur ( const vpImage< unsigned char > &  I,
vpImage< double > &  GI,
unsigned int  size = 7,
double  sigma = 0.,
bool  normalize = true 
)
static

Apply a Gaussian blur to an image.

Parameters
I: Input image.
GI: Filtered image.
size: Filter size. This value should be odd.
sigma: Gaussian standard deviation. If it is equal to zero or negative, it is computed from filter size as sigma = (size-1)/6.
normalize: Flag indicating whether to normalize the filter coefficients or not.
See also
getGaussianKernel() to know which kernel is used.
Examples
grabV4l2MultiCpp11Thread.cpp, testImageFilter.cpp, and tutorial-image-filter.cpp.

Definition at line 479 of file vpImageFilter.cpp.

References vpImage< Type >::destroy(), filterX(), filterY(), and getGaussianKernel().

Referenced by vp::unsharpMask().

◆ gaussianBlur() [3/3]

void vpImageFilter::gaussianBlur ( const vpImage< vpRGBa > &  I,
vpImage< vpRGBa > &  GI,
unsigned int  size = 7,
double  sigma = 0.,
bool  normalize = true 
)
static

Apply a Gaussian blur to RGB color image.

Parameters
I: Input image.
GI: Filtered image.
size: Filter size. This value should be odd.
sigma: Gaussian standard deviation. If it is equal to zero or negative, it is computed from filter size as sigma = (size-1)/6.
normalize: Flag indicating whether to normalize the filter coefficients or not.
See also
getGaussianKernel() to know which kernel is used.

Definition at line 502 of file vpImageFilter.cpp.

References vpImage< Type >::destroy(), filterX(), filterY(), and getGaussianKernel().

◆ gaussianFilter()

template<class T >
static double vpImageFilter::gaussianFilter ( const vpImage< T > &  fr,
unsigned int  r,
unsigned int  c 
)
inlinestatic

Apply a 5x5 Gaussian filter to an image pixel.

Parameters
fr: Image to filter
r: coordinates (row) of the pixel
c: coordinates (column) of the pixel

Definition at line 654 of file vpImageFilter.h.

◆ getGaussianDerivativeKernel()

void vpImageFilter::getGaussianDerivativeKernel ( double *  filter,
unsigned int  size,
double  sigma = 0.,
bool  normalize = true 
)
static

Return the coefficients of a Gaussian derivative filter that may be used to compute spatial image derivatives after applying a Gaussian blur.

Parameters
filter: Pointer to the filter kernel that should refer to a (size+1)/2 array. The first value refers to the central coefficient, the next one to the right coefficients. Left coefficients could be deduced by symmetry.
size: Filter size. This value should be odd.
sigma: Gaussian standard deviation. If it is equal to zero or negative, it is computed from filter size as sigma = (size-1)/6.
normalize: Flag indicating whether to normalize the filter coefficients or not.

Definition at line 593 of file vpImageFilter.cpp.

References filter(), vpImageException::incorrectInitializationError, and vpMath::sqr().

Referenced by vpTemplateTracker::setGaussianFilterSize(), and vpTemplateTracker::vpTemplateTracker().

◆ getGaussianKernel()

void vpImageFilter::getGaussianKernel ( double *  filter,
unsigned int  size,
double  sigma = 0.,
bool  normalize = true 
)
static

Return the coefficients $G_i$ of a Gaussian filter.

Parameters
[out]filter: Pointer to the half size filter kernel that should refer to a (size+1)/2 array. The first value refers to the central coefficient, the next one to the right coefficients. Left coefficients could be deduced by symmetry.
[in]size: Filter size. This value should be odd and positive.
[in]sigma: Gaussian standard deviation $ \sigma $. If it is equal to zero or negative, it is computed from filter size as sigma = (size-1)/6.
[in]normalize: Flag indicating whether to normalize the filter coefficients or not. In that case $\Sigma G_i = 1 $.

The function computes the (size+1)/2 values of the Gaussian filter cooefficients $ G_i $ as:

\[ G_i = \frac{1}{\sigma \sqrt{2 \pi}} \exp{(-i^2 / (2. * \sigma^2))}\]

Definition at line 553 of file vpImageFilter.cpp.

References filter(), vpImageException::incorrectInitializationError, and vpMath::sqr().

Referenced by gaussianBlur(), vpTemplateTracker::setGaussianFilterSize(), and vpTemplateTracker::vpTemplateTracker().

◆ getGaussPyramidal()

void vpImageFilter::getGaussPyramidal ( const vpImage< unsigned char > &  I,
vpImage< unsigned char > &  GI 
)
static
Examples
tutorial-image-filter.cpp.

Definition at line 774 of file vpImageFilter.cpp.

References vpImageConvert::convert(), getGaussXPyramidal(), getGaussYPyramidal(), vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().

Referenced by vpTemplateTracker::initHessienDesiredPyr(), vpTemplateTracker::initTrackingPyr(), and vpTemplateTracker::trackPyr().

◆ getGaussXPyramidal()

void vpImageFilter::getGaussXPyramidal ( const vpImage< unsigned char > &  I,
vpImage< unsigned char > &  GI 
)
static

Definition at line 806 of file vpImageFilter.cpp.

References filterGaussXPyramidal(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

Referenced by getGaussPyramidal().

◆ getGaussYPyramidal()

void vpImageFilter::getGaussYPyramidal ( const vpImage< unsigned char > &  I,
vpImage< unsigned char > &  GI 
)
static

Definition at line 833 of file vpImageFilter.cpp.

References filterGaussYPyramidal(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

Referenced by getGaussPyramidal().

◆ getGradX() [1/3]

void vpImageFilter::getGradX ( const vpImage< double > &  I,
vpImage< double > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 677 of file vpImageFilter.cpp.

References derivativeFilterX(), filter(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ getGradX() [2/3]

void vpImageFilter::getGradX ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIx 
)
static
Examples
tutorial-image-filter.cpp.

Definition at line 622 of file vpImageFilter.cpp.

References derivativeFilterX(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

Referenced by getGradXGauss2D(), vpTemplateTrackerMIInverseCompositional::initCompInverse(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), and vpTemplateTrackerMIESM::initHessienDesired().

◆ getGradX() [3/3]

void vpImageFilter::getGradX ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIx,
const double *  filter,
unsigned int  size 
)
static

Definition at line 660 of file vpImageFilter.cpp.

References derivativeFilterX(), filter(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ getGradXGauss2D()

void vpImageFilter::getGradXGauss2D ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIx,
const double *  gaussianKernel,
const double *  gaussianDerivativeKernel,
unsigned int  size 
)
static

Compute the gradient along X after applying a gaussian filter along Y.

Parameters
I: Input image
dIx: Gradient along X.
gaussianKernel: Gaussian kernel which values should be computed using vpImageFilter::getGaussianKernel().
gaussianDerivativeKernel: Gaussian derivative kernel which values should be computed using vpImageFilter::getGaussianDerivativeKernel().
size: Size of the Gaussian and Gaussian derivative kernels.

Definition at line 748 of file vpImageFilter.cpp.

References filterY(), and getGradX().

Referenced by vpTemplateTrackerZNCCInverseCompositional::initCompInverse(), vpTemplateTrackerMIInverseCompositional::initCompInverse(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpTemplateTrackerMIESM::initHessienDesired(), vpTemplateTrackerMIForwardAdditional::initHessienDesired(), vpTemplateTrackerMIForwardCompositional::initHessienDesired(), vpTemplateTracker::initTracking(), vpTemplateTrackerSSDESM::trackNoPyr(), vpTemplateTrackerSSDForwardAdditional::trackNoPyr(), vpTemplateTrackerSSDForwardCompositional::trackNoPyr(), vpTemplateTrackerZNCCForwardAdditional::trackNoPyr(), vpTemplateTrackerMIESM::trackNoPyr(), vpTemplateTrackerMIForwardAdditional::trackNoPyr(), and vpTemplateTrackerMIForwardCompositional::trackNoPyr().

◆ getGradY() [1/3]

void vpImageFilter::getGradY ( const vpImage< double > &  I,
vpImage< double > &  dIy,
const double *  filter,
unsigned int  size 
)
static

Definition at line 718 of file vpImageFilter.cpp.

References derivativeFilterY(), filter(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ getGradY() [2/3]

void vpImageFilter::getGradY ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIy 
)
static
Examples
tutorial-image-filter.cpp.

Definition at line 639 of file vpImageFilter.cpp.

References derivativeFilterY(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

Referenced by getGradYGauss2D(), vpTemplateTrackerMIInverseCompositional::initCompInverse(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), and vpTemplateTrackerMIESM::initHessienDesired().

◆ getGradY() [3/3]

void vpImageFilter::getGradY ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIy,
const double *  filter,
unsigned int  size 
)
static

Definition at line 694 of file vpImageFilter.cpp.

References derivativeFilterY(), filter(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and vpImage< Type >::resize().

◆ getGradYGauss2D()

void vpImageFilter::getGradYGauss2D ( const vpImage< unsigned char > &  I,
vpImage< double > &  dIy,
const double *  gaussianKernel,
const double *  gaussianDerivativeKernel,
unsigned int  size 
)
static

Compute the gradient along Y after applying a gaussian filter along X.

Parameters
I: Input image
dIy: Gradient along Y.
gaussianKernel: Gaussian kernel which values should be computed using vpImageFilter::getGaussianKernel().
gaussianDerivativeKernel: Gaussian derivative kernel which values should be computed using vpImageFilter::getGaussianDerivativeKernel().
size: Size of the Gaussian and Gaussian derivative kernels.

Definition at line 765 of file vpImageFilter.cpp.

References filterX(), and getGradY().

Referenced by vpTemplateTrackerZNCCInverseCompositional::initCompInverse(), vpTemplateTrackerMIInverseCompositional::initCompInverse(), vpTemplateTrackerZNCCForwardAdditional::initHessienDesired(), vpTemplateTrackerZNCCInverseCompositional::initHessienDesired(), vpTemplateTrackerMIESM::initHessienDesired(), vpTemplateTrackerMIForwardAdditional::initHessienDesired(), vpTemplateTrackerMIForwardCompositional::initHessienDesired(), vpTemplateTracker::initTracking(), vpTemplateTrackerSSDESM::trackNoPyr(), vpTemplateTrackerSSDForwardAdditional::trackNoPyr(), vpTemplateTrackerSSDForwardCompositional::trackNoPyr(), vpTemplateTrackerZNCCForwardAdditional::trackNoPyr(), vpTemplateTrackerMIESM::trackNoPyr(), vpTemplateTrackerMIForwardAdditional::trackNoPyr(), and vpTemplateTrackerMIForwardCompositional::trackNoPyr().

◆ getSobelKernelX()

double vpImageFilter::getSobelKernelX ( double *  filter,
unsigned int  size 
)
static

Get Sobel kernel for X-direction.

Parameters
filter: Pointer to a double array already allocated.
size: Kernel size computed as: kernel_size = size*2 + 1 (max size is 20).
Returns
Scaling factor.
Examples
testImageFilter.cpp.

Definition at line 867 of file vpImageFilter.cpp.

References vpArray2D< Type >::data, vpException::dimensionError, filter(), vpArray2D< Type >::getCols(), vpArray2D< Type >::getRows(), getSobelKernelY(), and vpMatrix::t().

Referenced by vpMbTracker::setProjectionErrorKernelSize(), and vpMbTracker::vpMbTracker().

◆ getSobelKernelY()

double vpImageFilter::getSobelKernelY ( double *  filter,
unsigned int  size 
)
static

Get Sobel kernel for Y-direction.

Parameters
filter: Pointer to a double array already allocated.
size: Kernel size computed as: kernel_size = size*2 + 1 (max size is 20).
Returns
Scaling factor.

Definition at line 887 of file vpImageFilter.cpp.

References vpMatrix::conv2(), vpArray2D< Type >::data, vpException::dimensionError, filter(), vpArray2D< Type >::getCols(), and vpArray2D< Type >::getRows().

Referenced by getSobelKernelX(), vpMbTracker::setProjectionErrorKernelSize(), and vpMbTracker::vpMbTracker().

◆ sepFilter()

void vpImageFilter::sepFilter ( const vpImage< unsigned char > &  I,
vpImage< double > &  If,
const vpColVector &  kernelH,
const vpColVector &  kernelV 
)
static

Apply a filter to an image using two separable kernels. For instance, the Sobel kernel can be decomposed to:

\[ \left [ \begin{matrix} 1 & 0 & -1 \\ 2 & 0 & -2 \\ 1 & 0 & -1 \end{matrix} \right ] = \left [ \begin{matrix} 1 \\ 2 \\ 1 \end{matrix} \right ] \ast \left [ \begin{matrix} 1 && 0 && -1 \end{matrix} \right ] \]

Thus, the convolution operation can be performed as:

\[ G_x = \left [ \begin{matrix} 1 \\ 2 \\ 1 \end{matrix} \right ] \ast \left ( \left [ \begin{matrix} 1 && 0 && -1 \end{matrix} \right ] \ast I \right ) \]

Using two separable kernels reduce the number of operations and can be faster for large kernels.

Parameters
I: Image to filter
If: Filtered image.
kernelH: Separable kernel (performed first).
kernelV: Separable kernel (performed last).
Note
Only pixels in the input image fully covered by the kernel are considered.
Examples
testImageFilter.cpp.

Definition at line 225 of file vpImageFilter.cpp.

References vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpImage< Type >::resize(), and vpArray2D< Type >::size().