Merge pull request #3 from valentina-kustikova/master

Median filter sample.

Author: Kirill Kornyakov

CMakeLists.txt

@@ -3,8 +3,6 @@ CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
 set(PROJECT_NAME practice2)
 project(${PROJECT_NAME})
 
-option(WITH_CODE_COVERAGE "Enable code coverage analysis" OFF)
-
 set(CMAKE_CONFIGURATION_TYPES "Debug;Release" CACHE STRING "Configs" FORCE)
 if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE Release)
@@ -17,24 +15,14 @@ set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG ${CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEAS
 
 set(PRACTICE2_LIBRARY ${PROJECT_NAME})
 set(PRACTICE2_TESTS "${PROJECT_NAME}_test")
-
-find_package(OpenCV REQUIRED)
-
 set(PRACTICE2_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/include")
+
 include_directories("${PRACTICE2_INCLUDE}")
 include_directories("${CMAKE_CURRENT_SOURCE_DIR}/3rdparty")
 
+find_package(OpenCV REQUIRED)
 set(LIBRARY_DEPS ${OpenCV_LIBS})
 
-if (WITH_CODE_COVERAGE)
-  if (CMAKE_COMPILER_IS_GNUCXX)
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
-  else()
-    message(WARNING "Code coverage can be estimated only when g++ compiler is used. Code coverage analysis is disabled.")
-    set(WITH_CODE_COVERAGE OFF)
-  endif()
-endif()
-
 # BUILD
 add_subdirectory(3rdparty)
 add_subdirectory(src)
@@ -48,5 +36,4 @@ message( STATUS "======================================")
 message( STATUS "")
 message( STATUS "   Configuration:        ${CMAKE_BUILD_TYPE}")
 message( STATUS "   OpenCV build path:    ${OpenCV_DIR}")
-message( STATUS "   Enable code coverage: ${WITH_CODE_COVERAGE}")
 message( STATUS "")

README.md

@@ -1,64 +1,94 @@
-# Инфраструктура для проведения практики по основам библиотеки компьютерного зрения OpenCV
+# Практика 2. Базовые примитивы и основные операции обработки изображений в библиотеке OpenCV
 
 [![Build Status](https://travis-ci.org/Itseez-NNSU-SummerSchool2015/practice2-opencv-intro.svg)](https://travis-ci.org/Itseez-NNSU-SummerSchool2015/practice2-opencv-intro)
 
 
-Проект представляет собой инфраструктуру для освоения основ работы с библиотекой OpenCV:
-  - Загрузка/сохранение изображений (базовые примитивы и операции модуля ```opencv_core```).
-  - Обработка изображений с помощью простеших фильтров библиотеки (операции модуля ```opencv_imgproc```).
-  - Разработка простейшего интерфейса средствами библиотеки (базовые операции модуля ```opencv_highgui```).
+Проект представляет собой инфраструктуру для освоения основ работы 
+с библиотекой OpenCV:
+  - Загрузка/сохранение изображений (базовые примитивы и операции 
+    модуля ```opencv_core```).
+  - Обработка изображений с помощью простеших фильтров библиотеки 
+    (операции модуля ```opencv_imgproc```).
+  - Разработка простейшего интерфейса средствами библиотеки (базовые 
+    операции модуля ```opencv_highgui```).
 
 ## Общая структура проекта
 
 Структура проекта:
-  - ```3rdparty``` - библиотека gtest.
-  - ```include``` - директория для размещения заголовочных файлов.
-  - ```samples``` - директория для размещения примеров использования.
-  - ```src``` - директория с исходными кодами.
-  - ```test``` - директория с тестами.
-  - ```.gitignore``` - перечень расширений файлов, которые не выкладываются в проект.
-  - ```.travis.yml``` - конфигурационный файл для системы автоматического тестирования Travis-CI.
-  - ```CMakeLists.txt``` - общий файл для сборки проекта с помощью CMake.
-  - ```README.md``` - информация о проекте, которую вы сейчас читаете.
+  - `3rdparty` - библиотека gtest.
+  - `include` - директория для размещения заголовочных файлов.
+  - `samples` - директория для размещения примеров использования.
+  - `src` - директория с исходными кодами.
+  - `test` - директория с тестами.
+  - `testdata``` - директория с данными для тестов.
+  - `.gitignore` - перечень расширений файлов, которые не выкладываются 
+    в проект.
+  - `.travis.yml` - конфигурационный файл для системы автоматического 
+    тестирования Travis-CI.
+  - `CMakeLists.txt` - общий файл для сборки проекта с помощью CMake.
+  - `README.md` - информация о проекте, которую вы сейчас читаете.
 
 В шаблонном проекте имеются следующие модули:
-  - Модуль вспомогательных функций (```./include/auxiliaries.hpp```, ```./src/auxiliaries.hpp```), в частности, функция обработки аргументов командной строки.
-  - Модуль, содержащий объявление и реализацию функций загрузки, обработки и отображения изображений (```./include/img_proc.hpp```, ```./src/img_proc.hpp```).
-  - Примеры тестов (```aux_test.cpp```).
-  - Пример приложения, полностью решающего задачу (```sample_template.cpp```).
+  - Модуль вспомогательных функций (`./include/auxiliaries.hpp`, 
+    `./src/auxiliaries.hpp`), в частности, функция обработки аргументов 
+	командной строки.
+  - Модуль, содержащий объявление и реализацию функций загрузки, обработки 
+    и отображения изображений (`./include/img_proc.hpp`, `./src/img_proc.hpp`).
+  - Примеры тестов (`aux_test.cpp`).
+  - Пример приложения, демонстрирующего применение медианного фильтра 
+    (`sample_template.cpp`).
 
 ## Цели и задачи
 
-**_Цель данной работы_** - изучить базовые примитивы модуля ```opencv_core``` и простейшие операции обработки изображений модуля ```opencv_imgproc```, научиться разрабатывать интерфейс средствами модуля ```opencv_highgui``` на примере задачи определения ребер на изображении.
+__Цель данной работы__ - изучить базовые примитивы модуля `opencv_core` 
+и простейшие операции обработки изображений модуля `opencv_imgproc`, научиться 
+разрабатывать интерфейс средствами модуля `opencv_highgui` на примере задачи 
+определения ребер на изображении.
 
-Для этого необходимо решить следующие **_задачи_**:
-  1. Изучить базовые методы класса ```Mat``` (модуль ```opencv_core```), который применяется для представления изображений.
+Для этого необходимо решить следующие __задачи__:
+  1. Изучить базовые методы класса `Mat` (модуль `opencv_core`), который 
+     применяется для представления изображений.
   2. Рассмотреть основные операции работы с изображениями:
-     1. Создание изображения (с помощью конструкторов или метода ```create``` класса ```Mat```).
-	 2. Загрузка изображения (функция ```imread```).
-	 3. Сохранение изображения (функция ```imwrite```).
-	 4. Отображение изображения (функции ```imshow```, ```waitKey```).
-	 5. Копирование изображения (метод ```copyTo``` класса ```Mat```).
+     1. Создание изображения (с помощью конструкторов или метода `create` 
+	    класса `Mat`).
+	 2. Загрузка изображения (функция `imread`).
+	 3. Сохранение изображения (функция `imwrite`).
+	 4. Отображение изображения (функции `imshow`, `waitKey`).
+	 5. Копирование изображения (метод `copyTo` класса `Mat`).
 	 6. Методы фильтрации (размытие, сглаживание и др.).
-	 7. Преобразование изображения в различные цветовые пространства (функция ```cvtColor```).
-  3. Изучить и реализовать с использованием OpenCV различные способы выделения контуров на изображении:
-     1. Бинаризация изображения (функция ```threshold```) + поиск контуров (функция ```findContours```). Примечание: для отображения контуров следует использовать функцию ```drawContours```.
-	 2. Морфологический градиент (функция ```morphologyEx```).
-	 3. Оператор Собеля (функция ```Sobel```).
-	 4. Оператор Лапласа (функция ```Laplacian```).
-	 5. Детектор ребер Канни (функция ```Canny```). Примечание: перед применением фильтра Канни потребуется выполнить фильтрацию и преобразование изображеня в оттенки серого.
+	 7. Преобразование изображения в различные цветовые пространства 
+	    (функция `cvtColor`).
+  3. Изучить и реализовать с использованием OpenCV различные способы 
+     выделения контуров на изображении:
+     1. Бинаризация изображения (функция `threshold`) + поиск контуров 
+	    (функция `findContours`). Примечание: для отображения контуров 
+		следует использовать функцию `drawContours`.
+	 2. Морфологический градиент (функция `morphologyEx`).
+	 3. Оператор Собеля (функция `Sobel`).
+	 4. Оператор Лапласа (функция `Laplacian`).
+	 5. Детектор ребер Канни (функция `Canny`). Примечание: перед применением 
+	    фильтра Канни потребуется выполнить фильтрацию и преобразование 
+		изображения в оттенки серого.
   4. Разработать графический интерфейс, удовлетворяющий следующим требованиям:
      1. Отображение исходного изображения.
 	 2. Отображение изображения, на котором отображены контуры.
-	 3. Наличие набора переключателей (кнопок) для применения различных методов выделения контуров.
+	 3. Наличие набора переключателей (кнопок) для применения различных 
+	    методов выделения контуров.
 
 ## Инструкция по выполнению работы
 
-  1. Создать аккаунт на [github.com](https://github.com), если такой отсутствует. Для определенности обозначим аккаунт ```github-account```.
+  1. Создать аккаунт на [github.com](https://github.com), если такой 
+     отсутствует. Для определенности обозначим аккаунт `github-account`.
 
-  2. Сделать fork репозитория ```https://github.com/Itseez-NNSU-SummerSchool2015/practice2-opencv-intro``` (в терминологии Git upstream-репозиторий) к себе в организацию с названием github-account. В результате будет создана копию репозитория с названием ```https://github.com/github-account/practice2-opencv-intro``` (origin-репозиторий).
+  2. Сделать fork репозитория 
+     <https://github.com/Itseez-NNSU-SummerSchool2015/practice2-opencv-intro> 
+	 (в терминологии Git upstream-репозиторий) к себе в организацию с названием 
+	 `github-account`. В результате будет создана копию репозитория с названием 
+	 <https://github.com/github-account/practice2-opencv-intro> 
+	 (origin-репозиторий).
 
-  3. Клонировать репозиторий ```https://github.com/github-account/practice2-opencv-intro```, воспользовавшись следующей командой:
+  3. Клонировать репозиторий [origin][origin] к себе на локальный компьютер, 
+     воспользовавшись следующей командой:
 
   ```
   $ git clone https://github.com/github-account/practice2-opencv-intro
@@ -70,42 +100,105 @@
   $ git remote add upstream https://github.com/Itseez-NNSU-SummerSchool2015/practice2-opencv-intro
   ```
 
-  5. Настроить имя пользователя, из под которого будут выполняться все операции с репозиторией Git:
+  5. Настроить имя пользователя, из под которого будут выполняться 
+     все операции с репозиторией Git:
 
   ```
   $ git config --global user.name "github-account"
   ```
 
-  6. Создать ветку find-contours-implementation и перейти в нее:
+  6. Создать ветку `find-contours-implementation` и перейти в нее:
 
   ```
   $ git checkout -b find-contours-implementation
   ```
 
-  7. В ветку ```find-contours-implementation``` поместить реализации различных методов поиска контуров, снабдив весь разработанный код необходимым набором тестов.
+  7. В ветку `find-contours-implementation` поместить реализации различных 
+     методов поиска контуров, снабдив весь разработанный код необходимым 
+	 набором тестов. В качестве шаблона необходимо использовать модуль 
+	 `img_proc`. Модуль должен быть расширен различными реализациями методов
+	 поиска контуров на изображении средствами OpenCV. Для начала имеет смысл 
+	 сосредоточиться на реализации одного метода из перечисленных ниже.
+	 
+	 1. Бинаризация изображения (функция `threshold`) + поиск контуров 
+	    (функция `findContours`). Примечание: для отображения контуров 
+		следует использовать функцию `drawContours`.
+	 2. Морфологический градиент (функция `morphologyEx`).
+	 3. Оператор Собеля (функция `Sobel`).
+	 4. Оператор Лапласа (функция `Laplacian`).
+	 5. Детектор ребер Канни (функция `Canny`). Примечание: перед применением 
+	    фильтра Канни потребуется выполнить фильтрацию и преобразование 
+		изображения в оттенки серого.
 
-  8. Создать ветку gui-implementation и перейти в нее:
+  8. Создать ветку `gui-implementation` и перейти в нее:
 
   ```
   $ git checkout -b gui-implementation
   ```
 
-  9. В ветку ```gui-implementation``` поместить разработанную интерфейсную часть. Примечание: по существу необходимо разработать пример использования библиотеки поиска контуров.
-  
-  10. После получения каждой стабильной версии не забывайте проверять работоспособность тестов и выкладывать изменения в ветку.
+  9. В ветку `gui-implementation` поместить разработанную интерфейсную часть. 
+     Примечание: по существу необходимо разработать пример использования 
+	 реализованного метода поиска контуров. Далее приведены возможные
+	 варианты реализации интерфейса в порядке их усложнения с точки зрения 
+	 программной реализации.
+	 
+	 1. Отобразите одновременно в одном окне исходное изображение и изображение
+	    с выделенными контурами. 
+		
+		*Указание:* воспользуйтесь имеющимся примером отображения результата 
+		медианной фильтрации.
+		
+	 2. Добавьте внизу окна виртуальные кнопки (на самом деле одноцветные 
+	    изображения), каждая из которых соответствует вызову определенного 
+		метода выделения контуров изображении. Не забудьте на них добавить 
+		соответствующие надписи. Обеспечьте возможность обновления результата
+		выделения контуров при нажатии на каждую из кнопок. 
+		
+		*Указание:* следует использовать возможность создания обработчика 
+		события нажатия на кнопку, отслеживая положение курсора в каждый 
+		текущий момент времени, чтобы определить, какой метод поиска контуров 
+		необходимо вызвать.
+	 
+	 **Примечание:** примеров использования библиотеки может быть в проекте много. 
+	 Когда разработан какой-то метод стоит его снабдить простым примером
+	 использования. Если задача выделения контуров решена уже несколькими
+	 способами, то можно подумать над усложненными вариантом интерфеса, который
+	 объединяет возможности использования различных способов выделения контуров.
+  
+  10. После получения каждой стабильной версии не забывайте проверять 
+      работоспособность тестов и выкладывать изменения в ветку.  
 
   ```
+  $ git status # Получить список текущих изменений
+  
+  $ git add [<file_name>] # Добавить файл в репозиторий
+  # <file_name> - название файла для добавления в commit
+    если вместо имени указан символ *, то будут добавлены все новые файлы, 
+    расширение которых не указано в .gitignore
+  
   $ git commit [-m "<message_to_commit>"] [-a]
-  [-a] - автоматически добавляет изменения для существующих на сервере файлов без выполнения команды git add
-  [--amend] - перезаписывает последний коммит (используется, если не забыты изменения)
-  ```
+  # [-a] - автоматически добавляет изменения для существующих на сервере файлов
+    без выполнения команды git add
+  # [--amend] - перезаписывает последний коммит (используется, если не забыты
+    изменения)
   
+  $ git push origin find-contours-implementation # или gui-implementation
   ```
-  git push origin <branch-name>
-  ```
 
-  11. Не забудьте сделать Pull Request, чтобы проверить работоспособность тестов на Travis-CI и позволить преподавателям сделать ревью Вашего кода.
+  11. Не забудьте сделать Pull Request, чтобы проверить работоспособность 
+      тестов на Travis-CI и позволить преподавателям сделать ревью Вашего кода.
+  
+  **Примечание:** подробная инструкция по сборке проекта, запуска тестов была 
+  описана в [практической работе по освоению инструментов разработки]
+  (https://github.com/Itseez-NNSU-SummerSchool2015/practice1-devtools).
+  При сборке проекта в командной строке `cmake` необходимо указать 
+  опцию `-DOpenCV_DIR="path-to-OpenCVConfig.cmake"`, чтобы подключить 
+  библиотеку OpenCV.
 
-  **Примечание:** подробная инструкция по сборке проекта, запуска тестов была описана 
-  в [практической работе по освоению инструментов разработки](https://github.com/Itseez-NNSU-SummerSchool2015/practice1-devtools).
-  При сборке проекта в командной строке `cmake` необходимо указать опцию `-DOpenCV_DIR="path-to-OpenCVConfig.cmake"`
+  12. При наличии времени можно организовать обработку видео и вместо одного 
+      изображения обрабатывать и отображать последовательно идущие кадры 
+	  потока.
+  
+<!-- LINKS -->
+
+[origin]: https://github.com/github-account/practice2-opencv-intro

include/auxiliaries.hpp

@@ -1,3 +1,10 @@
 #pragma once
 
-int parseArguments(int argc, char **argv);
+#include <string>
+
+struct Parameters
+{
+    std::string imgFileName;
+};
+
+int parseArguments(int argc, char **argv, Parameters &params);

include/img_proc.hpp

@@ -6,8 +6,8 @@
 
 using namespace cv;
 
-int getFrame(Mat& src);
+int getFrame(const std::string &fileName, Mat& src);
 
 int processFrame(const Mat& src, Mat& dst);
 
-int show(const Mat& src, const Mat& dst);
+int show(const std::string &caption, const Mat& src, const Mat& dst);

samples/sample_template.cpp

@@ -9,23 +9,30 @@ using namespace cv;
 
 int main(int argc, char **argv)
 {
-	if (parseArguments(argc, argv) != 0)
+    const std::string caption = "Median filter";
+    Parameters params;
+	if (parseArguments(argc, argv, params) != 0)
     {
-        cout << "Incorrect input parameters!" << endl;
+        cout << "practice2 <img_name>" << endl;
+        cout << "<img_name> - image name for filtering" << endl;
         return 1;
     }
 
     Mat src, dst;
 
-    if (getFrame(src) != 0)
+    if (getFrame(params.imgFileName, src) != 0)
     {
         cout << "Error: \'src\' image is null or empty!" << endl;
         return 2;
     }
 
-    processFrame(src, dst);
+    if (processFrame(src, dst) != 0)
+    {
+        cout << "Error: Filtering failed!" << endl;
+        return 3;
+    }
 
-    show(src, dst);
+    show(caption, src, dst);
 
 	return 0;
 }

src/auxiliaries.cpp

@@ -1,6 +1,11 @@
 #include "auxiliaries.hpp"
 
-int parseArguments(int argc, char **argv)
+int parseArguments(int argc, char **argv, Parameters &params)
 {
+    if (argc < 2)
+    {
+        return 1;
+    }
+    params.imgFileName = std::string(argv[1]);
     return 0;
 }