Making your own linear filters! — OpenCV 2.4.10.0 documentation

### Navigation

- index
- next |
- previous |
- OpenCV 2.4.10.0 documentation »
- OpenCV Tutorials »
- imgproc module. Image Processing »

# Making your own linear filters!

## Goal

In this tutorial you will learn how to:

- Use the OpenCV function filter2D to create your own linear filters.

## Theory

Note

The explanation below belongs to the book Learning OpenCV by Bradski and Kaehler.

### Convolution

In a very general sense, convolution is an operation between every part of an image and an operator (kernel).

### What is a kernel?

A kernel is essentially a fixed size array of numerical coefficeints along with an anchor point in that array, which is tipically located at the center.

### How does convolution with a kernel work?

Assume you want to know the resulting value of a particular location in the image. The value of the convolution is calculated in the following way:

1. Place the kernel anchor on top of a determined pixel, with the rest of the kernel overlaying the corresponding local pixels in the image.
2. Multiply the kernel coefficients by the corresponding image pixel values and sum the result.
3. Place the result to the location of the anchor in the input image.
4. Repeat the process for all pixels by scanning the kernel over the entire image.

Expressing the procedure above in the form of an equation we would have:

System Message: WARNING/2 (`H(x,y) = \sum_{i=0}^{M_{i} - 1} \sum_{j=0}^{M_{j}-1} I(x+i - a_{i}, y + j - a_{j})K(i,j)`)

latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014-OpenBSD_Ports) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2014/05/01> Babel <3.9k> and hyphenation patterns for 78 languages loaded. (/usr/local/share/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/local/share/texmf-dist/tex/latex/base/size12.clo)) (/usr/local/share/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.165 \endinput ^^M No pages of output. Transcript written on math.log.

Fortunately, OpenCV provides you with the function filter2D so you do not have to code all these operations.

## Code

1. What does this program do?

   - Loads an image

   - Performs a normalized box filter. For instance, for a kernel of size

     System Message: WARNING/2 (`size = 3`)

     latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014-OpenBSD_Ports) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2014/05/01> Babel <3.9k> and hyphenation patterns for 78 languages loaded. (/usr/local/share/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/local/share/texmf-dist/tex/latex/base/size12.clo)) (/usr/local/share/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.165 \endinput ^^M No pages of output. Transcript written on math.log.

     , the kernel would be:

     System Message: WARNING/2 (`K = \dfrac{1}{3 \cdot 3} \begin{bmatrix} 1 & 1 & 1 \\ 1 & 1 & 1 \\ 1 & 1 & 1 \end{bmatrix}`)

     latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014-OpenBSD_Ports) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2014/05/01> Babel <3.9k> and hyphenation patterns for 78 languages loaded. (/usr/local/share/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/local/share/texmf-dist/tex/latex/base/size12.clo)) (/usr/local/share/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.165 \endinput ^^M No pages of output. Transcript written on math.log.

     The program will perform the filter operation with kernels of sizes 3, 5, 7, 9 and 11.

   - The filter output (with each kernel) will be shown during 500 milliseconds

2. The tutorial code’s is shown lines below. You can also download it from here

    #include "opencv2/imgproc/imgproc.hpp"
    #include "opencv2/highgui/highgui.hpp"
    #include <stdlib.h>
    #include <stdio.h>

    using namespace cv;

    /** @function main */
    int main ( int argc, char** argv )
    {
      /// Declare variables
      Mat src, dst;

      Mat kernel;
      Point anchor;
      double delta;
      int ddepth;
      int kernel_size;
      char* window_name = "filter2D Demo";

      int c;

      /// Load an image
      src = imread( argv[1] );

      if( !src.data )
      { return -1; }

      /// Create window
      namedWindow( window_name, CV_WINDOW_AUTOSIZE );

      /// Initialize arguments for the filter
      anchor = Point( -1, -1 );
      delta = 0;
      ddepth = -1;

      /// Loop - Will filter the image with different kernel sizes each 0.5 seconds
      int ind = 0;
      while( true )
        {
          c = waitKey(500);
          /// Press 'ESC' to exit the program
          if( (char)c == 27 )
            { break; }

          /// Update kernel size for a normalized box filter
          kernel_size = 3 + 2*( ind%5 );
          kernel = Mat::ones( kernel_size, kernel_size, CV_32F )/ (float)(kernel_size*kernel_size);

          /// Apply filter
          filter2D(src, dst, ddepth , kernel, anchor, delta, BORDER_DEFAULT );
          imshow( window_name, dst );
          ind++;
        }

      return 0;
    }

## Explanation

1. Load an image

       src = imread( argv[1] );

       if( !src.data )
         { return -1; }

2. Create a window to display the result

       namedWindow( window_name, CV_WINDOW_AUTOSIZE );

3. Initialize the arguments for the linear filter

       anchor = Point( -1, -1 );
       delta = 0;
       ddepth = -1;

4. Perform an infinite loop updating the kernel size and applying our linear filter to the input image. Let’s analyze that more in detail:

5. First we define the kernel our filter is going to use. Here it is:

       kernel_size = 3 + 2*( ind%5 );
       kernel = Mat::ones( kernel_size, kernel_size, CV_32F )/ (float)(kernel_size*kernel_size);

   The first line is to update the kernel_size to odd values in the range:

   System Message: WARNING/2 (`[3,11]`)

   latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014-OpenBSD_Ports) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2014/05/01> Babel <3.9k> and hyphenation patterns for 78 languages loaded. (/usr/local/share/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/local/share/texmf-dist/tex/latex/base/size12.clo)) (/usr/local/share/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.165 \endinput ^^M No pages of output. Transcript written on math.log.

   . The second line actually builds the kernel by setting its value to a matrix filled with

   System Message: WARNING/2 (`1's`)

   latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014-OpenBSD_Ports) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2014/05/01> Babel <3.9k> and hyphenation patterns for 78 languages loaded. (/usr/local/share/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/local/share/texmf-dist/tex/latex/base/size12.clo)) (/usr/local/share/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.165 \endinput ^^M No pages of output. Transcript written on math.log.

   and normalizing it by dividing it between the number of elements.

6. After setting the kernel, we can generate the filter by using the function filter2D:

       filter2D(src, dst, ddepth , kernel, anchor, delta, BORDER_DEFAULT );

   The arguments denote:

   1. src: Source image
   2. dst: Destination image
   3. ddepth: The depth of dst. A negative value (such as

      System Message: WARNING/2 (`-1`)

      latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014-OpenBSD_Ports) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2014/05/01> Babel <3.9k> and hyphenation patterns for 78 languages loaded. (/usr/local/share/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/local/share/texmf-dist/tex/latex/base/size12.clo)) (/usr/local/share/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.165 \endinput ^^M No pages of output. Transcript written on math.log.
      ) indicates that the depth is the same as the source.
   4. kernel: The kernel to be scanned through the image
   5. anchor: The position of the anchor relative to its kernel. The location Point(-1, -1) indicates the center by default.
   6. delta: A value to be added to each pixel during the convolution. By default it is

      System Message: WARNING/2 (`0`)

      latex exited with error [stdout] This is pdfTeX, Version 3.14159265-2.6-1.40.15 (TeX Live 2014-OpenBSD_Ports) (preloaded format=latex) restricted \write18 enabled. entering extended mode (./math.tex LaTeX2e <2014/05/01> Babel <3.9k> and hyphenation patterns for 78 languages loaded. (/usr/local/share/texmf-dist/tex/latex/base/article.cls Document Class: article 2007/10/19 v1.4h Standard LaTeX document class (/usr/local/share/texmf-dist/tex/latex/base/size12.clo)) (/usr/local/share/texmf-dist/tex/latex/base/inputenc.sty ! LaTeX Error: File `utf8x.def’ not found. Type X to quit or <RETURN> to proceed, or enter new name. (Default extension: def) Enter file name: ! Emergency stop. <read *> l.165 \endinput ^^M No pages of output. Transcript written on math.log.
   7. BORDER_DEFAULT: We let this value by default (more details in the following tutorial)

7. Our program will effectuate a while loop, each 500 ms the kernel size of our filter will be updated in the range indicated.

## Results

1. After compiling the code above, you can execute it giving as argument the path of an image. The result should be a window that shows an image blurred by a normalized filter. Each 0.5 seconds the kernel size should change, as can be seen in the series of snapshots below:

## Help and Feedback

You did not find what you were looking for?

- Ask a question on the Q&A forum.
- If you think something is missing or wrong in the documentation, please file a bug report.

### Navigation

- index
- next |
- previous |
- OpenCV 2.4.10.0 documentation »
- OpenCV Tutorials »
- imgproc module. Image Processing »