├── cmd.lnk ├── README.pdf ├── bin ├── arch_x64 │ └── sift └── windows_x86 │ └── sift.exe ├── example ├── parrot.jpg └── parrot_orientation.png ├── types.hpp ├── .gitignore ├── CMakeLists.txt ├── point.hpp ├── octaveelem.hpp ├── LICENSE ├── interestpoint.hpp ├── matrix.hpp ├── main.cpp ├── README.md ├── sift.hpp ├── algorithms.hpp ├── algorithms.cpp ├── sift.cpp └── Doxyfile /cmd.lnk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowiow/SIFT/HEAD/cmd.lnk -------------------------------------------------------------------------------- /README.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowiow/SIFT/HEAD/README.pdf -------------------------------------------------------------------------------- /bin/arch_x64/sift: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowiow/SIFT/HEAD/bin/arch_x64/sift -------------------------------------------------------------------------------- /example/parrot.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowiow/SIFT/HEAD/example/parrot.jpg -------------------------------------------------------------------------------- /bin/windows_x86/sift.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowiow/SIFT/HEAD/bin/windows_x86/sift.exe -------------------------------------------------------------------------------- /example/parrot_orientation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowiow/SIFT/HEAD/example/parrot_orientation.png -------------------------------------------------------------------------------- /types.hpp: -------------------------------------------------------------------------------- 1 | #ifndef TYPES_HPP 2 | #define TYPES_HPP 3 | 4 | using u8_t = unsigned char; 5 | using i8_t = char; 6 | using u16_t = unsigned short int; 7 | using i16_t = short int; 8 | using u32_t = unsigned long int; 9 | using i32_t = long int; 10 | using u64_t = unsigned long long int; 11 | using i64_t = long long int; 12 | 13 | using f32_t = float; 14 | using f64_t = double; 15 | using f80_t = long double; 16 | 17 | #endif 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Precompiled Headers 8 | *.gch 9 | *.pch 10 | 11 | # Compiled Dynamic libraries 12 | *.so 13 | *.dylib 14 | *.dll 15 | 16 | # Fortran module files 17 | *.mod 18 | 19 | # Compiled Static libraries 20 | *.lai 21 | *.la 22 | *.a 23 | *.lib 24 | 25 | # Executables 26 | *.out 27 | *.app 28 | 29 | #build directory 30 | build/ 31 | 32 | #documentation directory 33 | doc/ 34 | #tags 35 | tags 36 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.2) 2 | project(sift) 3 | 4 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x -O3") 5 | 6 | FIND_PACKAGE(Vigra) 7 | FIND_PACKAGE(OpenCV REQUIRED) 8 | FIND_PACKAGE(Boost COMPONENTS program_options REQUIRED) 9 | 10 | set(HEADER_FILES sift.hpp types.hpp point.hpp matrix.hpp algorithms.hpp octaveelem.hpp interestpoint.hpp) 11 | set(SOURCE_FILES algorithms.cpp sift.cpp main.cpp ) 12 | add_executable(sift ${SOURCE_FILES}) 13 | TARGET_INCLUDE_DIRECTORIES(sift PUBLIC ${Vigra_INCLUDE_DIRS} ) 14 | INCLUDE_DIRECTORIES(${Boost_INCLUDE_DIRS}) 15 | LINK_DIRECTORIES(${Boost_LIBRARY_DIRS}) 16 | TARGET_LINK_LIBRARIES(sift vigraimpex ${OpenCV_LIBS} ${Boost_LIBRARIES}) 17 | -------------------------------------------------------------------------------- /point.hpp: -------------------------------------------------------------------------------- 1 | #ifndef POINT_HPP 2 | #define POINT_HPP 3 | 4 | #include "types.hpp" 5 | 6 | namespace sift { 7 | template 8 | /** 9 | * A simple Point class which can have two different types for the two coordinates. 10 | */ 11 | class Point { 12 | public: 13 | /** 14 | * The horizontal coordinate 15 | */ 16 | T x; 17 | 18 | /** 19 | * The vertical coordinate 20 | */ 21 | U y; 22 | 23 | Point() = default; 24 | Point(T x, U y) : x(x), y(y) { 25 | 26 | } 27 | }; 28 | } 29 | #endif //POINT_HPP 30 | -------------------------------------------------------------------------------- /octaveelem.hpp: -------------------------------------------------------------------------------- 1 | #ifndef OCTAVEELEM_HPP 2 | #define OCTAVEELEM_HPP 3 | 4 | #include "vigra/multi_array.hxx" 5 | #include "types.hpp" 6 | 7 | namespace sift { 8 | /** 9 | * A Class which saves the needed data of the elements in an octave. These are the Gaussians and 10 | * DoGs. 11 | */ 12 | class OctaveElem { 13 | public: 14 | /** 15 | * The scale of the current element. 16 | */ 17 | f32_t scale; 18 | 19 | /** 20 | * The actual DoG or Gaussian image data. 21 | */ 22 | vigra::MultiArray<2, f32_t> img; 23 | 24 | OctaveElem() = default; 25 | }; 26 | } 27 | #endif //OCTAVEELEM_HPP 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 Marcel Patzwahl, Randy Schütt 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /interestpoint.hpp: -------------------------------------------------------------------------------- 1 | #ifndef INTERESTPOINT_HPP 2 | #define INTERESTPOINT_HPP 3 | 4 | #include 5 | 6 | #include "types.hpp" 7 | #include "point.hpp" 8 | 9 | namespace sift { 10 | /** 11 | * A class, which holds all the necessary information about the collected interest points 12 | */ 13 | class InterestPoint { 14 | public: 15 | /** 16 | * the scale of the interestpoint 17 | */ 18 | f32_t scale; 19 | 20 | /** 21 | * The octave of the interestpoint, because scale alone doesn't identify clearly 22 | */ 23 | u16_t octave; 24 | 25 | /** 26 | * This is needed because of the fact, the corresponding DoG must not be searched 27 | * again. And we get a linear access to the corresponding DoG element. 28 | */ 29 | u16_t index; 30 | 31 | /** 32 | * A flag, which shows if the interestpoint was filtered out by sift 33 | */ 34 | bool filtered = false; 35 | 36 | /** 37 | * the x and y coordinates of the interest point 38 | */ 39 | Point loc; 40 | 41 | /** 42 | * The orientations of the interest point 43 | */ 44 | f32_t orientation; 45 | 46 | std::vector descriptors; 47 | 48 | InterestPoint() = default; 49 | explicit InterestPoint(Point loc, f32_t scale, u16_t octave, u16_t index) 50 | : scale(scale), octave(octave), index(index), loc(loc) { 51 | } 52 | 53 | /** 54 | * Orders interest points by the fact if they are filtered or not. So the filtered can 55 | * be deleted from the end of a vector 56 | */ 57 | static bool cmpByFilter(const InterestPoint &a, const InterestPoint &b) { 58 | if (!a.filtered && b.filtered) { 59 | return true; 60 | } 61 | return false; 62 | } 63 | }; 64 | 65 | } 66 | #endif //INTERESTPOINT_HPP 67 | -------------------------------------------------------------------------------- /matrix.hpp: -------------------------------------------------------------------------------- 1 | #ifndef MATRIX_HPP 2 | #define MATRIX_HPP 3 | 4 | #ifdef _MSC_VER 5 | #pragma warning(disable: 4018) 6 | #endif 7 | 8 | #include 9 | #include 10 | #include 11 | 12 | #include "types.hpp" 13 | #include "point.hpp" 14 | 15 | namespace sift { 16 | template 17 | 18 | /** 19 | * A class which allows 2-dimensional access, but saves the data in an one-dimensional data 20 | * structure 21 | */ 22 | class Matrix { 23 | private: 24 | u16_t _width; 25 | u16_t _height; 26 | 27 | std::shared_ptr _data; 28 | 29 | public: 30 | Matrix() = default; 31 | 32 | /** 33 | * allocates a data structure with the given dimensions and sets everything to a 34 | * default value 35 | */ 36 | explicit Matrix(u16_t width, u16_t height, const T& def = T()) : _height(height), _width(width) { 37 | assert(width > 0 && height > 0); 38 | 39 | const u32_t size = _width * _height; 40 | 41 | _data = std::shared_ptr(new T[size], std::default_delete()); 42 | for (u32_t i = 0; i < size; i++) { 43 | _data.get()[i] = def; 44 | } 45 | } 46 | 47 | u16_t width() const { 48 | return _width; 49 | } 50 | 51 | u16_t height() const { 52 | return _height; 53 | } 54 | 55 | T& operator [](const Point& vec) { 56 | assert(vec.x < _width && vec.y < _height); 57 | 58 | const u32_t index = vec.x * _height + vec.y; 59 | assert(index < (_width * _height)); 60 | 61 | return _data.get()[index]; 62 | } 63 | 64 | const T& operator [](const Point& vec) const { 65 | assert(vec.x < _width && vec.y < _height); 66 | 67 | const u32_t index = vec.x * _height + vec.y; 68 | assert(index < (_width * _height)); 69 | 70 | return _data.get()[index]; 71 | } 72 | 73 | T& operator()(u16_t x, u16_t y) { 74 | return (*this)[Point(x, y)]; 75 | } 76 | 77 | const T& operator()(u16_t x, u16_t y) const { 78 | return (*this)[Point(x, y)]; 79 | } 80 | 81 | T* begin() { 82 | return &_data.get()[0]; 83 | } 84 | 85 | T* end() { 86 | return &_data.get()[_width * _height]; 87 | } 88 | 89 | friend std::ostream& operator <<(std::ostream& out, Matrix& m) { 90 | const u32_t size = m._width * m._height; 91 | 92 | for (u32_t i = 0, x = 1; i < size; i++, x++) { 93 | out << m._data.get()[i] << ','; 94 | if (x >= m._width) { 95 | x = 0; 96 | out << std::endl; 97 | } else { 98 | out << "\t"; 99 | } 100 | } 101 | return out; 102 | } 103 | }; 104 | } 105 | #endif 106 | -------------------------------------------------------------------------------- /main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | #include 7 | #include 8 | 9 | #include 10 | 11 | #include 12 | 13 | #include "sift.hpp" 14 | #include "interestpoint.hpp" 15 | 16 | namespace po = boost::program_options; 17 | 18 | /* 19 | * Main Function takes a greyvalue image as input 20 | */ 21 | int main(int argc, char** argv) { 22 | std::string img_file; 23 | f32_t sigma, k; 24 | u16_t octaves, dogsPerEpoch; 25 | bool subpixel; 26 | bool result; 27 | 28 | po::options_description desc("Options"); 29 | 30 | desc.add_options() 31 | ("help", "Print help messages") 32 | ("img,i", po::value(&img_file), "The image on which sift will be executed") 33 | ("sigma,s", po::value(&sigma)->default_value(1.6), "The sigma value of the Gaussian calculations") 34 | ("k,k", po::value(&k)->default_value(std::sqrt(2)), "The constant which is calculated on sigma for the DoGs") 35 | ("octaves,o", po::value(&octaves)->default_value(4), "How many octaves should be calculated") 36 | ("dogsPerEpoch,d", po::value(&dogsPerEpoch)->default_value(3), "How many DoGs should be created per epoch") 37 | ("subpixel,p", po::value(&subpixel)->default_value(false), "Starts with the doubled size of initial image") 38 | ("result,r", po::value(&result)->default_value(false), "Print the resulting InterestPoints in a file") 39 | ; 40 | po::positional_options_description p; 41 | p.add("img", 1); 42 | po::variables_map vm; 43 | try { 44 | po::store(po::command_line_parser(argc, argv).options(desc).positional(p).run(), vm); 45 | po::notify(vm); 46 | 47 | if (vm.count("help")) { 48 | std::cout << desc << "\n"; 49 | return 1; 50 | } 51 | 52 | vigra::ImageImportInfo info(img_file.c_str()); 53 | vigra::MultiArray<2, f32_t> img(vigra::Shape2(info.shape())); 54 | vigra::importImage(info, img); 55 | 56 | sift::Sift sift(dogsPerEpoch, octaves, sigma, k, subpixel); 57 | std::vector interestPoints = sift.calculate(img); 58 | 59 | auto image = cv::imread(img_file.c_str(), CV_LOAD_IMAGE_COLOR); 60 | u16_t subpixel_divisor = sift.subpixel ? 2 : 1; 61 | for (const sift::InterestPoint& p : interestPoints) { 62 | u16_t x = (p.loc.x * std::pow(2, p.octave)) / subpixel_divisor; 63 | u16_t y = (p.loc.y * std::pow(2, p.octave)) / subpixel_divisor; 64 | cv::RotatedRect r(cv::Point2f(x, y), 65 | cv::Size(p.scale * 10, p.scale * 10), 66 | p.orientation); 67 | 68 | cv::Point2f points[4]; 69 | r.points( points ); 70 | cv::line(image, points[0], points[1], cv::Scalar(255, 0, 0)); 71 | cv::line(image, points[0], points[3], cv::Scalar(255, 0, 0)); 72 | cv::line(image, points[2], points[3], cv::Scalar(255, 0, 0)); 73 | cv::line(image, points[1], points[2], cv::Scalar(255, 0, 0)); 74 | } 75 | 76 | cv::imwrite(img_file + "_orientation.png", image); 77 | 78 | if (result) { 79 | std::ofstream out("interstpoints.txt"); 80 | out << "Location\tscale\torientation\tdescriptors\n"; 81 | for (const sift::InterestPoint& p : interestPoints) { 82 | out << "[" << p.loc.x << ", " << p.loc.y << "]\t" << p.scale << "\t" << p.orientation << "\t" << "["; 83 | for (f32_t d : p.descriptors) { 84 | out << d << ", "; 85 | } 86 | out << "]\n"; 87 | } 88 | out.close(); 89 | } 90 | } catch (std::exception& ex) { 91 | std::cerr << ex.what() << std::endl; 92 | } 93 | 94 | return 0; 95 | } 96 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SIFT Algorithm in C++ 2 | - [Showcase](#showcase) 3 | - [Intro](#intro) 4 | - [Installation](#installation) 5 | - [User Guide](#user-guide) 6 | - [API](#api) 7 | 8 | # Showcase 9 | ![parrot](https://github.com/snowiow/sift/blob/master/example/parrot.jpg) 10 | 11 | ![parrot_features](https://github.com/snowiow/sift/blob/master/example/parrot_orientation.png) 12 | 13 | # Intro 14 | This is a C++ implementation of the SIFT algorithm, which was originally presented by David G. Lowe 15 | in the International Journal of Computer Vision 60 in January 2004. This algorithm is mostly implemented 16 | after the principles described in Lowe's paper. Also some elements were taken from the lecture of Dr. 17 | Mubarak Shah, which was held at the University of Central Florida. 18 | 19 | # Installation 20 | ## Requirements 21 | - Vigra: A generic C++ library for image analysis(used for most of the calculations and image transformations) 22 | - OpenCV: Open Source Computer Vision library(used for visualisation of the found sift features) 23 | - Boost program_options: An easy to use layer for handling program arguments. Part of the Boost Library. 24 | - CMake: A cross-platform open-source make system. 25 | 26 | ## Installation Process 27 | With the needed libraries installed and the help of CMake, the installation is as easy as three commands. 28 | First download this repository by cloning or whatever way you prefer. Switch into the directory afterwards. 29 | Now make an extra directory for your buildfiles. For Example: 30 | `mkdir build` 31 | Switch into the created directory 32 | `cd build` 33 | Then create your preferred make files with CMake. On all Unix like systems this will be 34 | GNU Makefiles. 35 | `cmake -G "Unix Makefiles" ..` 36 | For other supported build systems check the official documentation of CMake. 37 | The final step is to build the executable from the Makefiles 38 | `make` 39 | There should now be an executable named sift in the build directory. Please refer to the next section 40 | to check how it is used and which possibilities you have, by executing it. 41 | 42 | # User Guide 43 | The easiest way to start of is just giving an image and get a new image back, with the sift features drawn on it. The file is called 44 | `[file]_features.png` 45 | and can be found in the same directory as the original file. The command to produce this file is 46 | `./sift path/to/file.type` 47 | But there are many possible parameters on which you can screw the values. The following list shows the possibilities 48 | ```Options: 49 | --help Print help messages 50 | -i [ --img ] arg The image on which sift will be executed 51 | -s [ --sigma ] arg (=1.60000002) The sigma value of the Gaussian calculations 52 | -k [ --k ] arg (=1.41421354) The constant which is calculated on sigma 53 | for the DoGs 54 | -o [ --octaves ] arg (=4) How many octaves should be calculated 55 | -d [ --dogsPerEpoch ] arg (=3) How many DoGs should be created per epoch 56 | -p [ --subpixel ] arg (=0) Starts with the doubled size of initial 57 | image 58 | -r [ --result ] arg (=0) Print the resulting InterestPoints in a file 59 | ``` 60 | This overview can also be called by 61 | `./sift --help` 62 | The first flag is the shorthand and can generally be written by 63 | `./sift path/to/file.jpg -[shorthand] [value]` 64 | The second value inside the square brackets is the longhand and may be more readable, but it's also more typing. The general theme looks like this: 65 | `./sift path/to/file.jpg --[longhand]=[value]` 66 | The following argument is the default value, which is set, if no argument is given by the user. These default values are based on the studies of David Lowe's paper and seem to give the most stable results overall. The following chapters cover every flag in detail. 67 | ## -i [ --img ] arg 68 | The flag is the only non-optional as seen in the first example of the user guide. This is also the only possible option which can be handled without a flag. It takes an image file(tested: jpg, png) in RGB or Greyscale. Currently the algorithm gets slower by the size of the image dramatically. A small list with different image sizes shows the calculation time on my PC(i7 vPro) 69 | - ~300x300 px: ~0.7 seconds 70 | - ~600x600 px: ~15 seconds 71 | - ~1500x1500 px: ~11 minutes 72 | 73 | ## -s [ --sigma ] arg (=1.60000002) 74 | sigma is the standard deviation of the Gaussian curve. It is used extensively throughout the algorithm. For example when creating the Difference of Gaussian(DoG) pyramid. 75 | 76 | ## -k [ --k ] arg (=1.41421354) 77 | k is the constant, which is calculated onto sigma in each step of the Gaussian creation process. For example the process in the first octave of the algorithm looks like the following: 78 | ``` 79 | image 1: sigma 80 | image 2: sigma * k ^ 1 = sigma * k 81 | image 3: sigma * k ^ 2 = ... 82 | ``` 83 | 84 | ## -o [ --octaves ] arg (=4) 85 | The count of octaves to be calculated for the DoG pyramid. 86 | 87 | ## -d [ --dogsPerEpoch ] arg (=3) 88 | The count of DoGs created per epoch. 89 | The minimum is 3, because we need at least one DoG with an upper and lower neighbour to do further 90 | calculation steps of the algorithm. 91 | 92 | ## -p [ --subpixel ] arg (=0) 93 | Sets the subpixel flag to on(1) or off(0). If it is set to on, the algorithm works on subpixel 94 | accuracy. This is accomplished through doubling the size of the initial image and blur it with a Gaussian window 95 | with sigma=1.0 afterwards. Like mentioned in the paper, a base sigma of 0.5 is assumed in the original 96 | image. Every further calculation is based on the doubled version. If this flag is set to off, the 97 | algorithm starts with the initial image. 98 | 99 | ## -r [ --result ] arg (=0) 100 | Writes a sift.txt with a table like listing of all found interest points. The listed data are: positions, 101 | scale, orientation and their descriptors. 102 | 103 | # API 104 | A full Class and Namespace Reference can be found [here]( 105 | https://snowiow.github.io/SIFT/) 106 | -------------------------------------------------------------------------------- /sift.hpp: -------------------------------------------------------------------------------- 1 | #ifndef SIFT_HPP 2 | #define SIFT_HPP 3 | 4 | #include 5 | #include 6 | #include 7 | 8 | #include 9 | #include 10 | 11 | #include "types.hpp" 12 | #include "matrix.hpp" 13 | #include "octaveelem.hpp" 14 | #include "interestpoint.hpp" 15 | 16 | namespace sift { 17 | class Sift { 18 | public: 19 | /** 20 | * Wether to process the algorithm based on subpixel basis or not 21 | */ 22 | const bool subpixel; 23 | private: 24 | /** 25 | * The sigma value is used for the standard derivation of the Gaussian calculations. 26 | */ 27 | const f32_t _sigma; 28 | /** 29 | * The constant which is multiplied with sigma to get the Gaussians and DoGs. 30 | */ 31 | const f32_t _k; 32 | 33 | /** 34 | * How many DoGs will be calculated per epoch. Minimum is 3. 35 | */ 36 | const u16_t _dogsPerEpoch; 37 | 38 | /** 39 | * How many octaves of DoGs will be calculated. 40 | */ 41 | const u16_t _octaves; 42 | 43 | /** 44 | * The Gaussians calculated during the algorithm. 45 | */ 46 | Matrix _gaussians; 47 | 48 | /** 49 | * The magnitudes of the gaussians 50 | */ 51 | Matrix> _magnitudes; 52 | 53 | /** 54 | * The orientations of the gaussians 55 | */ 56 | Matrix> _orientations; 57 | 58 | public: 59 | /** 60 | * @param sigma standard value 1.6 61 | * @param k standard value square root of 2 62 | * @param dogsPerEpoch How many DOGs should be created per octave 63 | * @param octaves how many octaves should be calculated 64 | * @param subpixel wether the calculation is based on subpixel basis or not 65 | */ 66 | explicit 67 | Sift(u16_t dogsPerEpoch = 3, u16_t octaves = 3, f32_t sigma = 1.6, 68 | f32_t k = std::sqrt(2), bool subpixel = false) : 69 | subpixel(subpixel), _sigma(sigma), _k(k), _dogsPerEpoch(dogsPerEpoch), 70 | _octaves(octaves) { 71 | } 72 | 73 | /** 74 | * Processes the whole Sift calculation 75 | * @param img the given image 76 | * @return a vector containing the filtered sift features 77 | */ 78 | std::vector calculate(vigra::MultiArray<2, f32_t>&); 79 | 80 | private: 81 | /** 82 | * Creates the local image desciptors. 83 | * @param interestpoints the vector with interestpoints 84 | */ 85 | void _createDecriptors(std::vector&); 86 | 87 | /** 88 | * Eliminates all values above the threshold of 0.2 and performs a new 89 | * vector normalization as long as there are no more values above 0.2 90 | * @param vec The given vector 91 | */ 92 | std::vector _eliminateVectorThreshold(std::vector&) const; 93 | 94 | /** 95 | * Creates magnitude versions of all the gaussian images. 96 | */ 97 | void _createMagnitudePyramid(); 98 | 99 | /** 100 | * Create orientation versions of all the gaussian images. 101 | */ 102 | void _createOrientationPyramid(); 103 | 104 | /** 105 | * Keypoint Location using Taylor expansion to filter the weak interest points. Those 106 | * interest points, which get filtered get their filtered flag set to true 107 | * @param interestpoints the vector with interestpoints 108 | * @param dogs the dogs which were calculated in an earlier step 109 | */ 110 | void _eliminateEdgeResponses(std::vector&, const Matrix&) const; 111 | 112 | /** 113 | * Searches for the highest Element in the orientation histogram and searches for other 114 | * orientations within a 80% range. Everything outside the range will be set to -1. 115 | * @param histo The given histogram on which the peak calculation finds place 116 | * @return an array with 36 elements, standing for the 36 bins of orientation possibilities 117 | */ 118 | const std::set _findPeaks(const std::array&) const; 119 | 120 | /** 121 | * Calculates the orientation assignments for the interestPoints 122 | * @param interestPoints the found interestPoints for whom the orientation should be 123 | * calulated 124 | */ 125 | void _orientationAssignment(std::vector&); 126 | 127 | /** 128 | * Finds the nearest gaussian, based on the scale given 129 | * @param scale the scale 130 | * @return the point where the Gaussian is lying in the pyramid 131 | */ 132 | const Point _findNearestGaussian(f32_t); 133 | 134 | /** 135 | * Finds the Scale space extrema aka InterestPoints 136 | * @param dogs a matrix of DOGs 137 | * @param interestPoints a vector which holds interestPoints. Will be filled with the 138 | * found interest points 139 | */ 140 | void _findScaleSpaceExtrema(const Matrix&, std::vector&) const; 141 | 142 | /** 143 | * Creates the Difference of Gaussians for the count of octaves. 144 | * @param img the given img 145 | * @return a matrix with the octaves as width and octave elements as height, which contain the DoGs 146 | */ 147 | const Matrix _createDOGs(vigra::MultiArray<2, f32_t>&); 148 | }; 149 | } 150 | #endif //SIFT_HPP 151 | -------------------------------------------------------------------------------- /algorithms.hpp: -------------------------------------------------------------------------------- 1 | #ifndef ALGORITHMS_HPP 2 | #define ALGORITHMS_HPP 3 | 4 | #include 5 | #include 6 | 7 | #include "point.hpp" 8 | #include "types.hpp" 9 | 10 | namespace sift { 11 | namespace alg { 12 | /** 13 | * Convolves a given image with gaussian with a given sigma 14 | * @param input the input image which will be convolved 15 | * @param sigma the standard deviation for the gaussian 16 | * @return blured image 17 | */ 18 | const vigra::MultiArray<2, f32_t> convolveWithGauss(const vigra::MultiArray<2, f32_t>&, 19 | f32_t); 20 | 21 | /** 22 | * Resamples an image by 0.5 23 | * @param img the input image 24 | * @return the output image 25 | */ 26 | const vigra::MultiArray<2, f32_t> reduceToNextLevel(const vigra::MultiArray<2, f32_t>&, 27 | f32_t); 28 | 29 | /** 30 | * Resamples an image by 2 31 | * @param in the input image 32 | * @return the output image 33 | */ 34 | const vigra::MultiArray<2, f32_t> increaseToNextLevel(const vigra::MultiArray<2, f32_t>&, 35 | f32_t); 36 | 37 | /** 38 | * Calculates the Difference of Gaussian, which is the differnce between 2 39 | * images which were convolved with gaussian under usage of a constant K 40 | * @param lower the image which lies lower in an octave 41 | * @param higher the image which lies higher in an octave 42 | * @return the difference of gaussian image, which contains our interest points 43 | */ 44 | const vigra::MultiArray<2, f32_t> dog(const vigra::MultiArray<2, f32_t>&, 45 | const vigra::MultiArray<2, f32_t>&); 46 | 47 | /** 48 | * Calculates the first order derivative of the image, at the coordinates 49 | * @param img the image of which the first derivative is taken. 50 | * @param p the point at which the derivative is taken 51 | * @return the derivative as a vector (dx, dy, ds) 52 | */ 53 | const vigra::Matrix foDerivative(const std::array, 3>&, const Point&); 54 | 55 | /** 56 | * Calculates the second order derivative of the image, at the coordinates 57 | * @param img the image of which the second derivative is taken. 58 | * @param p the point at which the derivative is taken 59 | * @return the derivative as a matrix 60 | * (dxx, dxy, dxs) 61 | * (dyx, dyy, dys) 62 | * (dsx, dsy, dss) 63 | */ 64 | const vigra::Matrix soDerivative(const std::array, 3>&, const Point&); 65 | 66 | /** 67 | * Calculates the gradient magnitude of the given image at the given position 68 | * @param img the given img 69 | * @param p the current point 70 | * @return the gradient magnitude value 71 | */ 72 | f32_t gradientMagnitude(const vigra::MultiArray<2, f32_t>&, const Point&); 73 | 74 | /** 75 | * Calculates the gradient orientation of the given image at the given position 76 | * @param img the given img 77 | * @param p the current point 78 | * @return the gradient orientation value 79 | */ 80 | f32_t gradientOrientation(const vigra::MultiArray<2, f32_t>&, const Point&); 81 | 82 | /** 83 | * Creates an orientation Histogram of a given img and his corresponding orientations and 84 | * magnitudes. Places values in bins of size 10. So the resulting histogram has 36 elements. 85 | * @param orientations The img of which the histogram is taken from. Needs to be computed by gradient 86 | * orientations before 87 | * @param magnitudes The img of which the bins of the histogram will be weighted. Need to be 88 | * precomputed by gradient magnitude 89 | * @param img the given img 90 | * @return histogram with 36 bins which are weighted by magnitudes and gaussian 91 | */ 92 | const std::array orientationHistogram36(const vigra::MultiArray<2, f32_t>&, 93 | const vigra::MultiArray<2, f32_t>& , const vigra::MultiArray<2, f32_t>&); 94 | 95 | /** 96 | * Creates an orientation Histogram of a given img and his corresponding orientations and 97 | * magnitudes. Places values in bins of size 45. So the resulting histogram has 8 elements. 98 | * @param orientations The img of which the histogram is taken from. Needs to be computed by gradient 99 | * orientations before 100 | * @param magnitudes The img of which the bins of the histogram will be weighted. Need to be 101 | * precomputed by gradient magnitude 102 | * @param img the given img 103 | * @return histogram with 8 bins which are weighted by magnitudes and gaussian 104 | */ 105 | const std::vector orientationHistogram8(const vigra::MultiArray<2, f32_t>&, 106 | const vigra::MultiArray<2, f32_t>&, const vigra::MultiArray<2, f32_t>&); 107 | 108 | /** 109 | * Calculates the vertex of a parabola, by taking a max value and its 2 neigbours 110 | * @param ln the left neighbor of the peak 111 | * @param peak the peak value 112 | * @param rn the right neighbor of the peak 113 | * @return the vertex value 114 | */ 115 | f32_t vertexParabola(const Point&, const Point&, 116 | const Point&); 117 | 118 | /** 119 | * Rotates a given shape by a given degree clockwise 120 | * @param center the center point of the shape 121 | * @param angle by which angle the shape should be rotated 122 | * @param width the width of the shape 123 | * @param height the height of the shape 124 | * @return array with 2 elements. First element represents upper left corner of the shape and 125 | * bottom right is represented by the second argument 126 | */ 127 | std::array, 4> rotateShape(const Point&, f32_t, const u16_t, const u16_t); 128 | 129 | /** 130 | * Normalizes a vector 131 | * @param vec the vector to be normalized 132 | */ 133 | void normalizeVector(std::vector&); 134 | } 135 | } 136 | #endif //ALGORITHMS_HPP 137 | -------------------------------------------------------------------------------- /algorithms.cpp: -------------------------------------------------------------------------------- 1 | #include "algorithms.hpp" 2 | 3 | #include 4 | #include 5 | 6 | using namespace vigra::linalg; 7 | 8 | namespace sift { 9 | namespace alg { 10 | const vigra::MultiArray<2, f32_t> convolveWithGauss(const vigra::MultiArray<2, f32_t>& img, 11 | f32_t sigma) { 12 | 13 | vigra::Kernel1D filter; 14 | filter.initGaussian(sigma); 15 | vigra::MultiArray<2, f32_t> tmp(img.shape()); 16 | vigra::MultiArray<2, f32_t> result(img.shape()); 17 | 18 | separableConvolveX(img, tmp, filter); 19 | separableConvolveY(tmp, result, filter); 20 | 21 | return result; 22 | } 23 | 24 | const vigra::MultiArray<2, f32_t> reduceToNextLevel(const vigra::MultiArray<2, f32_t>& img, 25 | f32_t sigma) { 26 | 27 | // image size at current level 28 | const vigra::Shape2 s((img.width()+ 1) / 2, (img.height() + 1) / 2); 29 | 30 | // resize result image to appropriate size 31 | vigra::MultiArray<2, f32_t> out(s); 32 | // downsample smoothed image 33 | resizeImageNoInterpolation(convolveWithGauss(img, sigma), out); 34 | 35 | return out; 36 | } 37 | 38 | const vigra::MultiArray<2, f32_t> increaseToNextLevel(const vigra::MultiArray<2, f32_t>& img, 39 | f32_t sigma) { 40 | // image size at current level 41 | const vigra::Shape2 s(img.width() * 2, img.height() * 2); 42 | 43 | // resize result image to appropriate size 44 | vigra::MultiArray<2, f32_t> out(s); 45 | // downsample smoothed image 46 | resizeImageNoInterpolation(convolveWithGauss(img, sigma), out); 47 | 48 | return out; 49 | } 50 | 51 | 52 | const vigra::MultiArray<2, f32_t> dog(const vigra::MultiArray<2, f32_t>& lower, 53 | const vigra::MultiArray<2, f32_t>& higher) { 54 | 55 | vigra::MultiArray<2, f32_t> result(vigra::Shape2(lower.shape())); 56 | for (u16_t x = 0; x < lower.shape(0); x++) { 57 | for (u16_t y = 0; y < lower.shape(1); y++) { 58 | const f32_t dif = higher(x, y) - lower(x, y); 59 | // don't get negative values 60 | result(x, y) = 128 + dif; 61 | } 62 | } 63 | return result; 64 | } 65 | 66 | const vigra::Matrix foDerivative(const std::array, 3>& img, 67 | const Point& p) { 68 | 69 | const f32_t dx = (img[1](p.x - 1, p.y) - img[1](p.x + 1, p.y)) / 2; 70 | const f32_t dy = (img[1](p.x, p.y - 1) - img[1](p.x, p.y + 1)) / 2; 71 | const f32_t ds = (img[0](p.x, p.y) - img[2](p.x, p.y)) / 2; 72 | vigra::Matrix result(vigra::Shape2(3, 1)); 73 | result(0, 0) = dx; 74 | result(1, 0) = dy; 75 | result(2, 0) = ds; 76 | return result; 77 | } 78 | 79 | const vigra::Matrix soDerivative(const std::array, 3>& img, 80 | const Point& p) { 81 | 82 | const f32_t dxx = img[1](p.x + 1, p.y) + img[1](p.x - 1, p.y) - 2 * img[1](p.x, p.y); 83 | const f32_t dyy = img[1](p.x, p.y + 1) + img[1](p.x, p.y - 1) - 2 * img[1](p.x, p.y); 84 | const f32_t dss = img[2](p.x, p.y) + img[0](p.x, p.y) - 2 * img[1](p.x, p.y); 85 | const f32_t dxy = (img[1](p.x + 1, p.y + 1) - img[1](p.x - 1, p.y + 1) - img[1](p.x + 1, p.y - 1) 86 | + img[1](p.x - 1, p.y - 1)) / 2; 87 | 88 | const f32_t dxs = (img[2](p.x + 1, p.y) - img[2](p.x - 1, p.y) 89 | - img[0](p.x + 1, p.y) + img[0](p.x - 1, p.y)) / 2; 90 | 91 | f32_t dys = (img[2](p.x, p.y + 1) - img[2](p.x, p.y + 1) 92 | - img[0](p.x, p.y + 1) + img[0](p.x, p.y - 1)) / 2; 93 | vigra::MultiArray<2, f32_t> sec_deriv(vigra::Shape2(3, 3)); 94 | 95 | sec_deriv(0, 0) = dxx; 96 | sec_deriv(1, 0) = dxy; 97 | sec_deriv(2, 0) = dxs; 98 | sec_deriv(0, 1) = dxy; 99 | sec_deriv(1, 1) = dyy; 100 | sec_deriv(2, 1) = dys; 101 | sec_deriv(0, 2) = dxs; 102 | sec_deriv(1, 2) = dys; 103 | sec_deriv(2, 2) = dss; 104 | 105 | return sec_deriv; 106 | } 107 | 108 | f32_t gradientMagnitude(const vigra::MultiArray<2, f32_t>& img, const Point& p) { 109 | return std::sqrt(std::pow(img(p.x + 1, p.y) - img(p.x - 1, p.y), 2) + 110 | std::pow(img(p.x, p.y + 1) - img(p.x, p.y - 1), 2)); 111 | } 112 | 113 | f32_t gradientOrientation(const vigra::MultiArray<2, f32_t>& img, const Point& p) { 114 | const f32_t result = std::atan2(img(p.x, p.y + 1) - img(p.x, p.y - 1), img(p.x + 1, p.y) - img(p.x - 1, p.y)); 115 | return std::fmod(result + 360, 360); 116 | } 117 | 118 | const std::array orientationHistogram36( 119 | const vigra::MultiArray<2, f32_t>& orientations, 120 | const vigra::MultiArray<2, f32_t>& magnitudes, 121 | const vigra::MultiArray<2, f32_t>& current_gauss) { 122 | 123 | std::array bins = {{0}}; 124 | for (u16_t x = 0; x < orientations.width(); x++) { 125 | for (u16_t y = 0; y < orientations.height(); y++) { 126 | const f32_t sum = magnitudes(x, y) * current_gauss(x, y); 127 | u16_t i = std::floor(orientations(x, y) / 10); 128 | i = i % 35; 129 | bins[i] += sum; 130 | } 131 | } 132 | return bins; 133 | } 134 | 135 | const std::vector orientationHistogram8( 136 | const vigra::MultiArray<2, f32_t>& orientations, 137 | const vigra::MultiArray<2, f32_t>& magnitudes, 138 | const vigra::MultiArray<2, f32_t>& current_gauss) { 139 | 140 | std::vector bins(8, 0); 141 | for (u16_t x = 0; x < orientations.width(); x++) { 142 | for (u16_t y = 0; y < orientations.height(); y++) { 143 | const f32_t sum = magnitudes(x, y) * current_gauss(x, y); 144 | u16_t i = std::floor(orientations(x, y) / 45); 145 | i = i % 7; 146 | bins[i] += sum; 147 | } 148 | } 149 | return bins; 150 | } 151 | 152 | 153 | f32_t vertexParabola(const Point& ln, const Point& peak, 154 | const Point& rn) { 155 | 156 | vigra::MultiArray<2, f32_t> a(vigra::Shape2(3, 3)); 157 | a(0, 0) = std::pow(ln.x, 2); 158 | a(1, 0) = std::pow(peak.x, 2); 159 | a(2, 0) = std::pow(rn.x, 2); 160 | 161 | a(0, 1) = ln.x; 162 | a(1, 1) = peak.x; 163 | a(2, 1) = rn.x; 164 | 165 | a(0, 2) = 0; 166 | a(1, 2) = 0; 167 | a(2, 2) = 0; 168 | 169 | vigra::MultiArray<2, f32_t> b(vigra::Shape2(3, 1)); 170 | b(0, 0) = ln.y; 171 | b(1, 0) = peak.y; 172 | b(2, 0) = rn.y; 173 | 174 | vigra::MultiArray<2, f32_t> res(vigra::Shape2(3, 1)); 175 | linearSolve(a, b, res); 176 | 177 | return -res(1, 0) / (2 * res(0, 0)); 178 | } 179 | 180 | std::array, 4> rotateShape(const Point& center, f32_t angle, 181 | const u16_t width, const u16_t height) { 182 | 183 | //Determine upper left and bottom right point 184 | auto ul = Point(center.x - width / 2, center.y - height / 2); 185 | auto ur = Point(center.x - width / 2, center.y + height / 2); 186 | auto bl = Point(center.x + width / 2, center.y - height / 2); 187 | auto br = Point(center.x + width / 2, center.y + height / 2); 188 | 189 | std::array, 4> shape{{ul, ur, bl, br}}; 190 | 191 | //Perform clockwise rotation 192 | angle *= -1; 193 | 194 | for (Point& p : shape) { 195 | //Transform center to 0, 0 196 | p.x -= center.x; 197 | p.y -= center.y; 198 | 199 | //Perform rotation based on rotation matrix for both points 200 | p.x = ul.x * std::cos(angle) - p.y * std::sin(angle); 201 | p.y = ul.x * std::sin(angle) + p.y * std::cos(angle); 202 | 203 | //Transform center back to original position 204 | ul.x += center.x; 205 | ul.y += center.y; 206 | } 207 | return shape; 208 | } 209 | 210 | void normalizeVector(std::vector& vec) { 211 | //Get length of vector 212 | f32_t length = 0; 213 | std::for_each(vec.begin(), vec.end(), [&](f32_t& n) { 214 | length += n; 215 | }); 216 | 217 | if (length == 0) { 218 | return; 219 | } 220 | std::for_each(vec.begin(), vec.end(), [&](f32_t& n) { 221 | n /= length; 222 | }); 223 | } 224 | } 225 | } 226 | -------------------------------------------------------------------------------- /sift.cpp: -------------------------------------------------------------------------------- 1 | #include "sift.hpp" 2 | 3 | #include 4 | #include 5 | 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | 12 | #include "point.hpp" 13 | #include "algorithms.hpp" 14 | 15 | using namespace vigra::multi_math; 16 | using namespace vigra::linalg; 17 | 18 | namespace sift { 19 | std::vector Sift::calculate(vigra::MultiArray<2, f32_t>& img) { 20 | if (subpixel) 21 | img = alg::increaseToNextLevel(img, 1.0); 22 | 23 | auto dogs = _createDOGs(img); 24 | //Save DoGs for Demonstration purposes 25 | //for (u16_t i = 0; i < dogs.width(); i++) { 26 | //for (u16_t j = 0; j < dogs.height(); j++) { 27 | //const std::string fnStr = "images/dog" + std::to_string(i) + std::to_string(j) + ".png"; 28 | //exportImage(dogs(i, j).img, vigra::ImageExportInfo(fnStr.c_str())); 29 | //} 30 | //} 31 | 32 | std::vector interestPoints; 33 | _findScaleSpaceExtrema(dogs, interestPoints); 34 | _eliminateEdgeResponses(interestPoints, dogs); 35 | 36 | //Cleanup 37 | std::sort(interestPoints.begin(), interestPoints.end(), InterestPoint::cmpByFilter); 38 | auto result = std::find_if(interestPoints.begin(), interestPoints.end(), 39 | [](const InterestPoint& p) { return p.filtered; }); 40 | 41 | u16_t size = std::distance(interestPoints.begin(), result); 42 | interestPoints.resize(size); 43 | 44 | _createMagnitudePyramid(); 45 | _createOrientationPyramid(); 46 | _orientationAssignment(interestPoints); 47 | 48 | //Cleanup 49 | std::sort(interestPoints.begin(), interestPoints.end(), InterestPoint::cmpByFilter); 50 | result = std::find_if(interestPoints.begin(), interestPoints.end(), 51 | [](const InterestPoint& p) { return p.filtered; }); 52 | 53 | size = std::distance(interestPoints.begin(), result); 54 | interestPoints.resize(size); 55 | _createDecriptors(interestPoints); 56 | return interestPoints; 57 | } 58 | 59 | 60 | void Sift::_createDecriptors(std::vector& interestPoints) { 61 | const u16_t region = 8; 62 | for (InterestPoint& p: interestPoints) { 63 | Point current_point = _findNearestGaussian(p.scale); 64 | const vigra::MultiArray<2, f32_t>& current = _gaussians(current_point.x, current_point.y).img; 65 | if (p.loc.x < region || p.loc.x > current.width() - region || 66 | p.loc.y < region || p.loc.y > current.height() - region) { 67 | 68 | p.filtered = true; 69 | continue; 70 | } 71 | 72 | auto leftUpCorner = vigra::Shape2(p.loc.x - region, p.loc.y - region); 73 | auto rightDownCorner = vigra::Shape2(p.loc.x + region, p.loc.y + region); 74 | auto orientations = _orientations(current_point.x, current_point.y).subarray(leftUpCorner, rightDownCorner); 75 | auto magnitudes = _magnitudes(current_point.x, current_point.y).subarray(leftUpCorner, rightDownCorner); 76 | auto gauss = _gaussians(current_point.x, current_point.y).img.subarray(leftUpCorner, rightDownCorner); 77 | 78 | 79 | //Rotate orientations relative to keypoint orientation 80 | for (u16_t x = 0; x < orientations.width(); x++) { 81 | for (u16_t y = 0; y < orientations.height(); y++) { 82 | orientations(x, y) += p.orientation; 83 | } 84 | } 85 | 86 | //weight magnitudes by a gauss which is half the descriptor window size 87 | auto weighting = alg::convolveWithGauss(current, 1.6); 88 | for (u16_t x = 0; x < magnitudes.width(); x++) { 89 | for (u16_t y = 0; y < magnitudes.height(); y++) { 90 | magnitudes(x, y) += weighting(x, y); 91 | } 92 | } 93 | std::vector descriptors; 94 | //Create histograms of the 4x4 regions of the descriptor window 95 | for (u16_t x = 0; x < gauss.width(); x += 4) { 96 | for (u16_t y = 0; y < gauss.height(); y += 4) { 97 | auto lu = vigra::Shape2(x, y); 98 | auto rb = vigra::Shape2(x + 4, y + 4); 99 | auto cur_orientations = orientations.subarray(lu, rb); 100 | auto cur_magnitudes = magnitudes.subarray(lu, rb); 101 | auto cur_gauss = gauss.subarray(lu, rb); 102 | std::vector result = alg::orientationHistogram8(cur_orientations, cur_magnitudes, cur_gauss); 103 | _eliminateVectorThreshold(result); 104 | 105 | descriptors.insert(descriptors.end(), result.begin(), result.end()); 106 | } 107 | } 108 | p.descriptors = descriptors; 109 | } 110 | } 111 | 112 | 113 | std::vector Sift::_eliminateVectorThreshold(std::vector& vec) const { 114 | alg::normalizeVector(vec); 115 | std::vector result; 116 | result.reserve(vec.size()); 117 | bool threshold = false; 118 | for (auto& elem : vec) { 119 | if (elem <= 0.2) { 120 | result.emplace_back(elem); 121 | } else { 122 | threshold = true; 123 | } 124 | } 125 | if (threshold) 126 | alg::normalizeVector(result); 127 | return result; 128 | } 129 | 130 | void Sift::_createMagnitudePyramid() { 131 | _magnitudes = Matrix>(_gaussians.width(), _gaussians.height()); 132 | for (u16_t o = 0; o < _gaussians.width(); o++) { 133 | for (u16_t i = 0; i < _gaussians.height(); i++) { 134 | const vigra::MultiArray<2, f32_t>& current_gauss = _gaussians(o, i).img; 135 | _magnitudes(o, i) = vigra::MultiArray<2, f32_t>(current_gauss.shape()); 136 | vigra::MultiArray<2, f32_t>& current_mag = _magnitudes(o, i); 137 | for (u16_t x = 1; x < _gaussians(o, i).img.width() - 1; x++) { 138 | for (u16_t y = 1; y < _gaussians(o, i).img.height() - 1; y++) { 139 | current_mag(x, y) = alg::gradientMagnitude(current_gauss, Point(x, y)); 140 | } 141 | } 142 | } 143 | } 144 | } 145 | 146 | void Sift::_createOrientationPyramid() { 147 | _orientations = Matrix>(_gaussians.width(), _gaussians.height()); 148 | for (u16_t o = 0; o < _gaussians.width(); o++) { 149 | for (u16_t i = 0; i < _gaussians.height(); i++) { 150 | const vigra::MultiArray<2, f32_t>& current_gauss = _gaussians(o, i).img; 151 | _orientations(o, i) = vigra::MultiArray<2, f32_t>(current_gauss.shape()); 152 | vigra::MultiArray<2, f32_t>& current_orientation = _orientations(o, i); 153 | for (u16_t x = 1; x < _gaussians(o, i).img.width() - 1; x++) { 154 | for (u16_t y = 1; y < _gaussians(o, i).img.height() - 1; y++) { 155 | current_orientation(x, y) = alg::gradientOrientation(current_gauss, Point(x, y)); 156 | } 157 | } 158 | } 159 | } 160 | } 161 | 162 | 163 | void Sift::_orientationAssignment(std::vector& interestPoints) { 164 | const u16_t region = 8; 165 | //In case an interest point has more than one orientation, the additional will be saved here 166 | //and appended at the end of the function 167 | std::vector additional; 168 | for (InterestPoint& p : interestPoints) { 169 | const Point closest_point = _findNearestGaussian(p.scale); 170 | const vigra::MultiArray<2, f32_t>& closest = _gaussians(closest_point.x, closest_point.y).img; 171 | 172 | //Is Keypoint inside image boundaries of gaussian 173 | if ((p.loc.x < region || p.loc.x >= closest.width() - region) || 174 | (p.loc.y < region || p.loc.y >= closest.height() - region)) { 175 | 176 | p.filtered = true; 177 | continue; 178 | } 179 | const auto topLeftCorner = vigra::Shape2(p.loc.x - region, p.loc.y - region); 180 | const auto bottomRightCorner = vigra::Shape2(p.loc.x + region, p.loc.y + region); 181 | const auto gauss_region = closest.subarray(topLeftCorner, bottomRightCorner); 182 | 183 | 184 | const vigra::MultiArray<2, f32_t> gauss_convolved = alg::convolveWithGauss(gauss_region, 1.5 * p.scale); 185 | const vigra::MultiArray<2, f32_t> orientation = _orientations(closest_point.x, closest_point.y). 186 | subarray(topLeftCorner, bottomRightCorner); 187 | 188 | const vigra::MultiArray<2,f32_t> magnitude = _magnitudes(closest_point.x, closest_point.y). 189 | subarray(topLeftCorner, bottomRightCorner); 190 | 191 | const std::array histogram = alg::orientationHistogram36(orientation, magnitude, gauss_region); 192 | const std::set peaks = _findPeaks(histogram); 193 | p.orientation = *(peaks.begin()); 194 | if (peaks.size() > 1) { 195 | for (auto iter = peaks.begin()++; iter != peaks.end(); iter++) { 196 | InterestPoint temp = p; 197 | temp.orientation = *iter; 198 | additional.emplace_back(temp); 199 | } 200 | } 201 | } 202 | interestPoints.insert(interestPoints.end(), additional.begin(), additional.end()); 203 | } 204 | 205 | const PointSift::_findNearestGaussian(f32_t scale) { 206 | f32_t lowest_diff = 100; 207 | Point nearest_gauss = Point(0, 0); 208 | for (u16_t o = 0; o < _gaussians.width(); o++) { 209 | for (u16_t i = 0; i < _gaussians.height(); i++) { 210 | const f32_t cur_scale = std::abs(_gaussians(o, i).scale - scale); 211 | if (cur_scale < lowest_diff) { 212 | lowest_diff = cur_scale; 213 | nearest_gauss = Point(o, i); 214 | } 215 | } 216 | } 217 | return nearest_gauss; 218 | } 219 | 220 | const std::set Sift::_findPeaks(const std::array& histo) const { 221 | std::set result; 222 | auto peaks_only = histo; 223 | 224 | auto result_iter = std::max_element(peaks_only.begin(), peaks_only.end()); 225 | const u16_t max_index = std::distance(peaks_only.begin(), result_iter); 226 | 227 | //filter all values which are under the allowed range(80% of max) 228 | const f32_t range = histo[max_index] * 0.8; 229 | 230 | std::for_each(peaks_only.begin(), peaks_only.end(), [&](f32_t& elem) { if (elem < range) elem = -1; }); 231 | 232 | //filter every value which isn't a local maximum 233 | for (u16_t i = 1; i < peaks_only.size() - 1; i++) { 234 | if (peaks_only[i] < peaks_only[i - 1] || peaks_only[i] < peaks_only[i + 1]) 235 | peaks_only[i] = -1; 236 | } 237 | 238 | //aproximate peak with vertex parabola. Here we need the 360° space. +5 Because we just have 239 | //10° bins, so we take the middle of the bin. 240 | Point ln; 241 | Point rn; 242 | Point peak(max_index * 10 + 5, histo[max_index]); 243 | 244 | if (max_index == 0) { 245 | ln.x = (histo.size() - 1) * 10 + 5; 246 | ln.y = histo[histo.size() - 1]; 247 | } else { 248 | ln.x = (max_index - 1) * 10 + 5; 249 | ln.y = histo[max_index - 1]; 250 | } 251 | 252 | if (max_index == histo.size() - 1) { 253 | rn.x = 5; 254 | rn.y = histo[0]; 255 | } else { 256 | rn.x = (max_index + 1) * 10 + 5; 257 | rn.y = histo[max_index + 1]; 258 | } 259 | 260 | result.emplace(alg::vertexParabola(ln, peak, rn)); 261 | 262 | for (u16_t i = 0; i < peaks_only.size(); i++) { 263 | if (peaks_only[i] > - 1 && i != max_index) { 264 | Point ln; 265 | Point rn; 266 | Point peak(i * 10 + 5, histo[i]); 267 | if (i == 0) { 268 | ln.x = (histo.size() - 1) * 10 + 5; 269 | ln.y = histo[histo.size() - 1]; 270 | } else { 271 | ln.x = (i - 1) * 10 + 5; 272 | ln.y = histo[i - 1]; 273 | } 274 | 275 | if (i == histo.size() - 1) { 276 | rn.x = 5; 277 | rn.y = histo[0]; 278 | } else { 279 | rn.x = (i + 1) * 10 + 5; 280 | rn.y = histo[i + 1]; 281 | } 282 | result.emplace(alg::vertexParabola(ln, peak, rn)); 283 | } 284 | } 285 | return result; 286 | } 287 | 288 | void Sift::_eliminateEdgeResponses(std::vector& interestPoints, 289 | const Matrix& dogs) const { 290 | 291 | vigra::MultiArray<2, f32_t> extremum(vigra::Shape2(3, 1)); 292 | vigra::MultiArray<2, f32_t> inverse_matrix(vigra::Shape2(3, 3)); 293 | 294 | const f32_t t = std::pow(10 + 1, 2) / 10; 295 | for (InterestPoint& p : interestPoints) { 296 | auto& d = dogs(p.octave, p.index); 297 | const std::array, 3>& param = 298 | {{dogs(p.octave, p.index - 1).img, dogs(p.octave, p.index).img, dogs(p.octave, p.index + 1).img}}; 299 | 300 | const vigra::Matrix deriv = alg::foDerivative(param, p.loc); 301 | const vigra::Matrix sec_deriv = alg::soDerivative(param, p.loc); 302 | 303 | vigra::Matrix neg_sec_deriv = sec_deriv ; 304 | neg_sec_deriv *= -1; 305 | 306 | if (!inverse(neg_sec_deriv, inverse_matrix)) { 307 | p.filtered = true; 308 | continue; 309 | } 310 | 311 | if (!linearSolve(inverse_matrix, deriv, extremum)) { 312 | p.filtered = true; 313 | continue; 314 | } 315 | 316 | //Calculated up from 0.5 of paper to own image values [0,255] 317 | if (extremum(0, 0) > 127.5 || extremum(1, 0) > 127.5 || extremum(2, 0) > 127.5) { 318 | p.filtered = true; 319 | continue; 320 | } 321 | const vigra::Matrix deriv_transpose = deriv.transpose(); 322 | f32_t func_val_extremum = dot(deriv_transpose, extremum); 323 | func_val_extremum *= 0.5 + d.img(p.loc.x, p.loc.y); 324 | 325 | //Calculated up from 0.03 of paper to own image values[0, 255] 326 | if (func_val_extremum < 7.65) { 327 | p.filtered = true; 328 | continue; 329 | } 330 | 331 | const auto dxx = sec_deriv(0, 0); 332 | const auto dyy = sec_deriv(1, 1); 333 | //dxx + dyy 334 | const f32_t hessian_tr = dxx + dyy; 335 | //dxx * dyy - dxy^2 336 | const f32_t hessian_det = dxx * dyy - std::pow(sec_deriv(0, 1), 2); 337 | 338 | if (hessian_det < 0) { 339 | p.filtered = true; 340 | continue; 341 | } 342 | 343 | if (std::pow(hessian_tr, 2) / hessian_det > t) 344 | p.filtered = true; 345 | } 346 | } 347 | 348 | void Sift::_findScaleSpaceExtrema(const Matrix& dogs, 349 | std::vector& interestPoints) const { 350 | 351 | //A matrix of matrix. Outer dogs will be ignored, because we need a upper and lower neighbor 352 | for (u16_t e = 0; e < dogs.width(); e++) { 353 | for (u16_t i = 1; i < dogs.height() - 1; i++) { 354 | for (i16_t x = 1; x < dogs(e, i).img.width() - 1; x++) { 355 | for (i16_t y = 1; y < dogs(e, i).img.height() - 1; y++) { 356 | auto leftUpCorner = vigra::Shape2(x - 1, y - 1); 357 | auto rightDownCorner = vigra::Shape2(x + 1, y + 1); 358 | 359 | //Get the neighborhood of the current pixel 360 | auto current = dogs(e, i).img.subarray(leftUpCorner, rightDownCorner); 361 | //Get neighborhood of adjacent DOGs 362 | auto under = dogs(e, i - 1).img.subarray(leftUpCorner, rightDownCorner); 363 | auto above = dogs(e, i + 1).img.subarray(leftUpCorner, rightDownCorner); 364 | //Check all neighborhood pixels of current and adjacent DOGs. If there isn't any 365 | //pixel bigger or smaller than the current, we found an extremum. 366 | if ((!any(current > dogs(e, i).img(x, y)) && 367 | !any(under > dogs(e, i).img(x, y)) && 368 | !any(above > dogs(e, i).img(x, y))) || 369 | (!any(current < dogs(e, i).img(x, y)) && 370 | !any(under < dogs(e, i).img(x, y)) && 371 | !any(above < dogs(e, i).img(x, y)))) 372 | { 373 | interestPoints.emplace_back(InterestPoint(Point(x, y), dogs(e, i).scale, e, i)); 374 | } 375 | } 376 | } 377 | } 378 | } 379 | } 380 | 381 | const Matrix Sift::_createDOGs(vigra::MultiArray<2, f32_t>& img) { 382 | assert(_octaves > 0); // pre condition 383 | assert(_dogsPerEpoch >= 3); // pre condition 384 | 385 | Matrix gaussians(_octaves, _dogsPerEpoch + 1); 386 | Matrix dogs(_octaves, _dogsPerEpoch); 387 | 388 | gaussians(0, 0).scale = _sigma; 389 | gaussians(0, 0).img = alg::convolveWithGauss(img, _sigma); 390 | 391 | //TODO: More elegant way? 392 | u16_t exp = 0; 393 | for (i16_t i = 0; i < _octaves; i++) { 394 | for (i16_t j = 1; j < _dogsPerEpoch + 1; j++) { 395 | f32_t scale = std::pow(_k, exp) * _sigma; 396 | gaussians(i, j).scale = scale; 397 | gaussians(i, j).img = alg::convolveWithGauss(gaussians(i, j - 1).img, scale); 398 | 399 | dogs(i, j - 1).scale = gaussians(i, j).scale - gaussians(i, j - 1).scale; 400 | dogs(i, j - 1).img = alg::dog(gaussians(i, j - 1).img, gaussians(i, j).img); 401 | exp++; 402 | } 403 | // If we aren't in the last octave populate the next level with the second 404 | // last element, scaled by a half, of the image size of current octave. 405 | if (i < (_octaves - 1)) { 406 | auto scaledElem = alg::reduceToNextLevel(gaussians(i, _dogsPerEpoch - 1).img, 407 | gaussians(i, _dogsPerEpoch - 1).scale); 408 | gaussians(i + 1, 0).scale = gaussians(i, _dogsPerEpoch - 1).scale; 409 | gaussians(i + 1, 0).img = scaledElem; 410 | 411 | exp -= 2; 412 | } 413 | } 414 | 415 | _gaussians = gaussians; 416 | return dogs; // TODO: by ref entgegen nehmen um copy zu vermeiden? 417 | } 418 | } 419 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.9.1 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "SIFT" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = doc 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = 122 | 123 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 124 | # doxygen will generate a detailed section even if there is only a brief 125 | # description. 126 | # The default value is: NO. 127 | 128 | ALWAYS_DETAILED_SEC = NO 129 | 130 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 131 | # inherited members of a class in the documentation of that class as if those 132 | # members were ordinary class members. Constructors, destructors and assignment 133 | # operators of the base classes will not be shown. 134 | # The default value is: NO. 135 | 136 | INLINE_INHERITED_MEMB = NO 137 | 138 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 139 | # before files name in the file list and in the header files. If set to NO the 140 | # shortest path that makes the file name unique will be used 141 | # The default value is: YES. 142 | 143 | FULL_PATH_NAMES = YES 144 | 145 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 146 | # Stripping is only done if one of the specified strings matches the left-hand 147 | # part of the path. The tag can be used to show relative paths in the file list. 148 | # If left blank the directory from which doxygen is run is used as the path to 149 | # strip. 150 | # 151 | # Note that you can specify absolute paths here, but also relative paths, which 152 | # will be relative from the directory where doxygen is started. 153 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 154 | 155 | STRIP_FROM_PATH = 156 | 157 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 158 | # path mentioned in the documentation of a class, which tells the reader which 159 | # header file to include in order to use a class. If left blank only the name of 160 | # the header file containing the class definition is used. Otherwise one should 161 | # specify the list of include paths that are normally passed to the compiler 162 | # using the -I flag. 163 | 164 | STRIP_FROM_INC_PATH = 165 | 166 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 167 | # less readable) file names. This can be useful is your file systems doesn't 168 | # support long names like on DOS, Mac, or CD-ROM. 169 | # The default value is: NO. 170 | 171 | SHORT_NAMES = NO 172 | 173 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 174 | # first line (until the first dot) of a Javadoc-style comment as the brief 175 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 176 | # style comments (thus requiring an explicit @brief command for a brief 177 | # description.) 178 | # The default value is: NO. 179 | 180 | JAVADOC_AUTOBRIEF = NO 181 | 182 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 183 | # line (until the first dot) of a Qt-style comment as the brief description. If 184 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 185 | # requiring an explicit \brief command for a brief description.) 186 | # The default value is: NO. 187 | 188 | QT_AUTOBRIEF = NO 189 | 190 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 191 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 192 | # a brief description. This used to be the default behavior. The new default is 193 | # to treat a multi-line C++ comment block as a detailed description. Set this 194 | # tag to YES if you prefer the old behavior instead. 195 | # 196 | # Note that setting this tag to YES also means that rational rose comments are 197 | # not recognized any more. 198 | # The default value is: NO. 199 | 200 | MULTILINE_CPP_IS_BRIEF = NO 201 | 202 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 203 | # documentation from any documented member that it re-implements. 204 | # The default value is: YES. 205 | 206 | INHERIT_DOCS = YES 207 | 208 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 209 | # page for each member. If set to NO, the documentation of a member will be part 210 | # of the file/class/namespace that contains it. 211 | # The default value is: NO. 212 | 213 | SEPARATE_MEMBER_PAGES = NO 214 | 215 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 216 | # uses this value to replace tabs by spaces in code fragments. 217 | # Minimum value: 1, maximum value: 16, default value: 4. 218 | 219 | TAB_SIZE = 4 220 | 221 | # This tag can be used to specify a number of aliases that act as commands in 222 | # the documentation. An alias has the form: 223 | # name=value 224 | # For example adding 225 | # "sideeffect=@par Side Effects:\n" 226 | # will allow you to put the command \sideeffect (or @sideeffect) in the 227 | # documentation, which will result in a user-defined paragraph with heading 228 | # "Side Effects:". You can put \n's in the value part of an alias to insert 229 | # newlines. 230 | 231 | ALIASES = 232 | 233 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 234 | # A mapping has the form "name=value". For example adding "class=itcl::class" 235 | # will allow you to use the command class in the itcl::class meaning. 236 | 237 | TCL_SUBST = 238 | 239 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 240 | # only. Doxygen will then generate output that is more tailored for C. For 241 | # instance, some of the names that are used will be different. The list of all 242 | # members will be omitted, etc. 243 | # The default value is: NO. 244 | 245 | OPTIMIZE_OUTPUT_FOR_C = NO 246 | 247 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 248 | # Python sources only. Doxygen will then generate output that is more tailored 249 | # for that language. For instance, namespaces will be presented as packages, 250 | # qualified scopes will look different, etc. 251 | # The default value is: NO. 252 | 253 | OPTIMIZE_OUTPUT_JAVA = NO 254 | 255 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 256 | # sources. Doxygen will then generate output that is tailored for Fortran. 257 | # The default value is: NO. 258 | 259 | OPTIMIZE_FOR_FORTRAN = NO 260 | 261 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 262 | # sources. Doxygen will then generate output that is tailored for VHDL. 263 | # The default value is: NO. 264 | 265 | OPTIMIZE_OUTPUT_VHDL = NO 266 | 267 | # Doxygen selects the parser to use depending on the extension of the files it 268 | # parses. With this tag you can assign which parser to use for a given 269 | # extension. Doxygen has a built-in mapping, but you can override or extend it 270 | # using this tag. The format is ext=language, where ext is a file extension, and 271 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 272 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 273 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 274 | # Fortran. In the later case the parser tries to guess whether the code is fixed 275 | # or free formatted code, this is the default for Fortran type files), VHDL. For 276 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 277 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 278 | # 279 | # Note: For files without extension you can use no_extension as a placeholder. 280 | # 281 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 282 | # the files are not read by doxygen. 283 | 284 | EXTENSION_MAPPING = 285 | 286 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 287 | # according to the Markdown format, which allows for more readable 288 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 289 | # The output of markdown processing is further processed by doxygen, so you can 290 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 291 | # case of backward compatibilities issues. 292 | # The default value is: YES. 293 | 294 | MARKDOWN_SUPPORT = YES 295 | 296 | # When enabled doxygen tries to link words that correspond to documented 297 | # classes, or namespaces to their corresponding documentation. Such a link can 298 | # be prevented in individual cases by putting a % sign in front of the word or 299 | # globally by setting AUTOLINK_SUPPORT to NO. 300 | # The default value is: YES. 301 | 302 | AUTOLINK_SUPPORT = YES 303 | 304 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 305 | # to include (a tag file for) the STL sources as input, then you should set this 306 | # tag to YES in order to let doxygen match functions declarations and 307 | # definitions whose arguments contain STL classes (e.g. func(std::string); 308 | # versus func(std::string) {}). This also make the inheritance and collaboration 309 | # diagrams that involve STL classes more complete and accurate. 310 | # The default value is: NO. 311 | 312 | BUILTIN_STL_SUPPORT = NO 313 | 314 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 315 | # enable parsing support. 316 | # The default value is: NO. 317 | 318 | CPP_CLI_SUPPORT = NO 319 | 320 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 321 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 322 | # will parse them like normal C++ but will assume all classes use public instead 323 | # of private inheritance when no explicit protection keyword is present. 324 | # The default value is: NO. 325 | 326 | SIP_SUPPORT = NO 327 | 328 | # For Microsoft's IDL there are propget and propput attributes to indicate 329 | # getter and setter methods for a property. Setting this option to YES will make 330 | # doxygen to replace the get and set methods by a property in the documentation. 331 | # This will only work if the methods are indeed getting or setting a simple 332 | # type. If this is not the case, or you want to show the methods anyway, you 333 | # should set this option to NO. 334 | # The default value is: YES. 335 | 336 | IDL_PROPERTY_SUPPORT = YES 337 | 338 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 339 | # tag is set to YES then doxygen will reuse the documentation of the first 340 | # member in the group (if any) for the other members of the group. By default 341 | # all members of a group must be documented explicitly. 342 | # The default value is: NO. 343 | 344 | DISTRIBUTE_GROUP_DOC = NO 345 | 346 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 347 | # (for instance a group of public functions) to be put as a subgroup of that 348 | # type (e.g. under the Public Functions section). Set it to NO to prevent 349 | # subgrouping. Alternatively, this can be done per class using the 350 | # \nosubgrouping command. 351 | # The default value is: YES. 352 | 353 | SUBGROUPING = YES 354 | 355 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 356 | # are shown inside the group in which they are included (e.g. using \ingroup) 357 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 358 | # and RTF). 359 | # 360 | # Note that this feature does not work in combination with 361 | # SEPARATE_MEMBER_PAGES. 362 | # The default value is: NO. 363 | 364 | INLINE_GROUPED_CLASSES = NO 365 | 366 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 367 | # with only public data fields or simple typedef fields will be shown inline in 368 | # the documentation of the scope in which they are defined (i.e. file, 369 | # namespace, or group documentation), provided this scope is documented. If set 370 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 371 | # Man pages) or section (for LaTeX and RTF). 372 | # The default value is: NO. 373 | 374 | INLINE_SIMPLE_STRUCTS = NO 375 | 376 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 377 | # enum is documented as struct, union, or enum with the name of the typedef. So 378 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 379 | # with name TypeT. When disabled the typedef will appear as a member of a file, 380 | # namespace, or class. And the struct will be named TypeS. This can typically be 381 | # useful for C code in case the coding convention dictates that all compound 382 | # types are typedef'ed and only the typedef is referenced, never the tag name. 383 | # The default value is: NO. 384 | 385 | TYPEDEF_HIDES_STRUCT = NO 386 | 387 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 388 | # cache is used to resolve symbols given their name and scope. Since this can be 389 | # an expensive process and often the same symbol appears multiple times in the 390 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 391 | # doxygen will become slower. If the cache is too large, memory is wasted. The 392 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 393 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 394 | # symbols. At the end of a run doxygen will report the cache usage and suggest 395 | # the optimal cache size from a speed point of view. 396 | # Minimum value: 0, maximum value: 9, default value: 0. 397 | 398 | LOOKUP_CACHE_SIZE = 0 399 | 400 | #--------------------------------------------------------------------------- 401 | # Build related configuration options 402 | #--------------------------------------------------------------------------- 403 | 404 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 405 | # documentation are documented, even if no documentation was available. Private 406 | # class members and static file members will be hidden unless the 407 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 408 | # Note: This will also disable the warnings about undocumented members that are 409 | # normally produced when WARNINGS is set to YES. 410 | # The default value is: NO. 411 | 412 | EXTRACT_ALL = YES 413 | 414 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 415 | # be included in the documentation. 416 | # The default value is: NO. 417 | 418 | EXTRACT_PRIVATE = YES 419 | 420 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 421 | # scope will be included in the documentation. 422 | # The default value is: NO. 423 | 424 | EXTRACT_PACKAGE = NO 425 | 426 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 427 | # included in the documentation. 428 | # The default value is: NO. 429 | 430 | EXTRACT_STATIC = YES 431 | 432 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 433 | # locally in source files will be included in the documentation. If set to NO, 434 | # only classes defined in header files are included. Does not have any effect 435 | # for Java sources. 436 | # The default value is: YES. 437 | 438 | EXTRACT_LOCAL_CLASSES = YES 439 | 440 | # This flag is only useful for Objective-C code. If set to YES, local methods, 441 | # which are defined in the implementation section but not in the interface are 442 | # included in the documentation. If set to NO, only methods in the interface are 443 | # included. 444 | # The default value is: NO. 445 | 446 | EXTRACT_LOCAL_METHODS = YES 447 | 448 | # If this flag is set to YES, the members of anonymous namespaces will be 449 | # extracted and appear in the documentation as a namespace called 450 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 451 | # the file that contains the anonymous namespace. By default anonymous namespace 452 | # are hidden. 453 | # The default value is: NO. 454 | 455 | EXTRACT_ANON_NSPACES = NO 456 | 457 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 458 | # undocumented members inside documented classes or files. If set to NO these 459 | # members will be included in the various overviews, but no documentation 460 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 461 | # The default value is: NO. 462 | 463 | HIDE_UNDOC_MEMBERS = NO 464 | 465 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 466 | # undocumented classes that are normally visible in the class hierarchy. If set 467 | # to NO, these classes will be included in the various overviews. This option 468 | # has no effect if EXTRACT_ALL is enabled. 469 | # The default value is: NO. 470 | 471 | HIDE_UNDOC_CLASSES = NO 472 | 473 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 474 | # (class|struct|union) declarations. If set to NO, these declarations will be 475 | # included in the documentation. 476 | # The default value is: NO. 477 | 478 | HIDE_FRIEND_COMPOUNDS = NO 479 | 480 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 481 | # documentation blocks found inside the body of a function. If set to NO, these 482 | # blocks will be appended to the function's detailed documentation block. 483 | # The default value is: NO. 484 | 485 | HIDE_IN_BODY_DOCS = NO 486 | 487 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 488 | # \internal command is included. If the tag is set to NO then the documentation 489 | # will be excluded. Set it to YES to include the internal documentation. 490 | # The default value is: NO. 491 | 492 | INTERNAL_DOCS = NO 493 | 494 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 495 | # names in lower-case letters. If set to YES, upper-case letters are also 496 | # allowed. This is useful if you have classes or files whose names only differ 497 | # in case and if your file system supports case sensitive file names. Windows 498 | # and Mac users are advised to set this option to NO. 499 | # The default value is: system dependent. 500 | 501 | CASE_SENSE_NAMES = YES 502 | 503 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 504 | # their full class and namespace scopes in the documentation. If set to YES, the 505 | # scope will be hidden. 506 | # The default value is: NO. 507 | 508 | HIDE_SCOPE_NAMES = NO 509 | 510 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 511 | # append additional text to a page's title, such as Class Reference. If set to 512 | # YES the compound reference will be hidden. 513 | # The default value is: NO. 514 | 515 | HIDE_COMPOUND_REFERENCE= NO 516 | 517 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 518 | # the files that are included by a file in the documentation of that file. 519 | # The default value is: YES. 520 | 521 | SHOW_INCLUDE_FILES = YES 522 | 523 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 524 | # grouped member an include statement to the documentation, telling the reader 525 | # which file to include in order to use the member. 526 | # The default value is: NO. 527 | 528 | SHOW_GROUPED_MEMB_INC = NO 529 | 530 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 531 | # files with double quotes in the documentation rather than with sharp brackets. 532 | # The default value is: NO. 533 | 534 | FORCE_LOCAL_INCLUDES = NO 535 | 536 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 537 | # documentation for inline members. 538 | # The default value is: YES. 539 | 540 | INLINE_INFO = YES 541 | 542 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 543 | # (detailed) documentation of file and class members alphabetically by member 544 | # name. If set to NO, the members will appear in declaration order. 545 | # The default value is: YES. 546 | 547 | SORT_MEMBER_DOCS = YES 548 | 549 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 550 | # descriptions of file, namespace and class members alphabetically by member 551 | # name. If set to NO, the members will appear in declaration order. Note that 552 | # this will also influence the order of the classes in the class list. 553 | # The default value is: NO. 554 | 555 | SORT_BRIEF_DOCS = NO 556 | 557 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 558 | # (brief and detailed) documentation of class members so that constructors and 559 | # destructors are listed first. If set to NO the constructors will appear in the 560 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 561 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 562 | # member documentation. 563 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 564 | # detailed member documentation. 565 | # The default value is: NO. 566 | 567 | SORT_MEMBERS_CTORS_1ST = NO 568 | 569 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 570 | # of group names into alphabetical order. If set to NO the group names will 571 | # appear in their defined order. 572 | # The default value is: NO. 573 | 574 | SORT_GROUP_NAMES = NO 575 | 576 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 577 | # fully-qualified names, including namespaces. If set to NO, the class list will 578 | # be sorted only by class name, not including the namespace part. 579 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 580 | # Note: This option applies only to the class list, not to the alphabetical 581 | # list. 582 | # The default value is: NO. 583 | 584 | SORT_BY_SCOPE_NAME = NO 585 | 586 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 587 | # type resolution of all parameters of a function it will reject a match between 588 | # the prototype and the implementation of a member function even if there is 589 | # only one candidate or it is obvious which candidate to choose by doing a 590 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 591 | # accept a match between prototype and implementation in such cases. 592 | # The default value is: NO. 593 | 594 | STRICT_PROTO_MATCHING = NO 595 | 596 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 597 | # list. This list is created by putting \todo commands in the documentation. 598 | # The default value is: YES. 599 | 600 | GENERATE_TODOLIST = YES 601 | 602 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 603 | # list. This list is created by putting \test commands in the documentation. 604 | # The default value is: YES. 605 | 606 | GENERATE_TESTLIST = YES 607 | 608 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 609 | # list. This list is created by putting \bug commands in the documentation. 610 | # The default value is: YES. 611 | 612 | GENERATE_BUGLIST = YES 613 | 614 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 615 | # the deprecated list. This list is created by putting \deprecated commands in 616 | # the documentation. 617 | # The default value is: YES. 618 | 619 | GENERATE_DEPRECATEDLIST= YES 620 | 621 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 622 | # sections, marked by \if ... \endif and \cond 623 | # ... \endcond blocks. 624 | 625 | ENABLED_SECTIONS = 626 | 627 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 628 | # initial value of a variable or macro / define can have for it to appear in the 629 | # documentation. If the initializer consists of more lines than specified here 630 | # it will be hidden. Use a value of 0 to hide initializers completely. The 631 | # appearance of the value of individual variables and macros / defines can be 632 | # controlled using \showinitializer or \hideinitializer command in the 633 | # documentation regardless of this setting. 634 | # Minimum value: 0, maximum value: 10000, default value: 30. 635 | 636 | MAX_INITIALIZER_LINES = 30 637 | 638 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 639 | # the bottom of the documentation of classes and structs. If set to YES, the 640 | # list will mention the files that were used to generate the documentation. 641 | # The default value is: YES. 642 | 643 | SHOW_USED_FILES = YES 644 | 645 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 646 | # will remove the Files entry from the Quick Index and from the Folder Tree View 647 | # (if specified). 648 | # The default value is: YES. 649 | 650 | SHOW_FILES = YES 651 | 652 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 653 | # page. This will remove the Namespaces entry from the Quick Index and from the 654 | # Folder Tree View (if specified). 655 | # The default value is: YES. 656 | 657 | SHOW_NAMESPACES = YES 658 | 659 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 660 | # doxygen should invoke to get the current version for each file (typically from 661 | # the version control system). Doxygen will invoke the program by executing (via 662 | # popen()) the command command input-file, where command is the value of the 663 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 664 | # by doxygen. Whatever the program writes to standard output is used as the file 665 | # version. For an example see the documentation. 666 | 667 | FILE_VERSION_FILTER = 668 | 669 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 670 | # by doxygen. The layout file controls the global structure of the generated 671 | # output files in an output format independent way. To create the layout file 672 | # that represents doxygen's defaults, run doxygen with the -l option. You can 673 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 674 | # will be used as the name of the layout file. 675 | # 676 | # Note that if you run doxygen from a directory containing a file called 677 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 678 | # tag is left empty. 679 | 680 | LAYOUT_FILE = 681 | 682 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 683 | # the reference definitions. This must be a list of .bib files. The .bib 684 | # extension is automatically appended if omitted. This requires the bibtex tool 685 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 686 | # For LaTeX the style of the bibliography can be controlled using 687 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 688 | # search path. See also \cite for info how to create references. 689 | 690 | CITE_BIB_FILES = 691 | 692 | #--------------------------------------------------------------------------- 693 | # Configuration options related to warning and progress messages 694 | #--------------------------------------------------------------------------- 695 | 696 | # The QUIET tag can be used to turn on/off the messages that are generated to 697 | # standard output by doxygen. If QUIET is set to YES this implies that the 698 | # messages are off. 699 | # The default value is: NO. 700 | 701 | QUIET = NO 702 | 703 | # The WARNINGS tag can be used to turn on/off the warning messages that are 704 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 705 | # this implies that the warnings are on. 706 | # 707 | # Tip: Turn warnings on while writing the documentation. 708 | # The default value is: YES. 709 | 710 | WARNINGS = YES 711 | 712 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 713 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 714 | # will automatically be disabled. 715 | # The default value is: YES. 716 | 717 | WARN_IF_UNDOCUMENTED = YES 718 | 719 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 720 | # potential errors in the documentation, such as not documenting some parameters 721 | # in a documented function, or documenting parameters that don't exist or using 722 | # markup commands wrongly. 723 | # The default value is: YES. 724 | 725 | WARN_IF_DOC_ERROR = YES 726 | 727 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 728 | # are documented, but have no documentation for their parameters or return 729 | # value. If set to NO, doxygen will only warn about wrong or incomplete 730 | # parameter documentation, but not about the absence of documentation. 731 | # The default value is: NO. 732 | 733 | WARN_NO_PARAMDOC = NO 734 | 735 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 736 | # can produce. The string should contain the $file, $line, and $text tags, which 737 | # will be replaced by the file and line number from which the warning originated 738 | # and the warning text. Optionally the format may contain $version, which will 739 | # be replaced by the version of the file (if it could be obtained via 740 | # FILE_VERSION_FILTER) 741 | # The default value is: $file:$line: $text. 742 | 743 | WARN_FORMAT = "$file:$line: $text" 744 | 745 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 746 | # messages should be written. If left blank the output is written to standard 747 | # error (stderr). 748 | 749 | WARN_LOGFILE = 750 | 751 | #--------------------------------------------------------------------------- 752 | # Configuration options related to the input files 753 | #--------------------------------------------------------------------------- 754 | 755 | # The INPUT tag is used to specify the files and/or directories that contain 756 | # documented source files. You may enter file names like myfile.cpp or 757 | # directories like /usr/src/myproject. Separate the files or directories with 758 | # spaces. 759 | # Note: If this tag is empty the current directory is searched. 760 | 761 | INPUT = 762 | 763 | # This tag can be used to specify the character encoding of the source files 764 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 765 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 766 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 767 | # possible encodings. 768 | # The default value is: UTF-8. 769 | 770 | INPUT_ENCODING = UTF-8 771 | 772 | # If the value of the INPUT tag contains directories, you can use the 773 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 774 | # *.h) to filter out the source-files in the directories. If left blank the 775 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 776 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 777 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 778 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 779 | # *.qsf, *.as and *.js. 780 | 781 | FILE_PATTERNS = 782 | 783 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 784 | # be searched for input files as well. 785 | # The default value is: NO. 786 | 787 | RECURSIVE = NO 788 | 789 | # The EXCLUDE tag can be used to specify files and/or directories that should be 790 | # excluded from the INPUT source files. This way you can easily exclude a 791 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 792 | # 793 | # Note that relative paths are relative to the directory from which doxygen is 794 | # run. 795 | 796 | EXCLUDE = build 797 | 798 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 799 | # directories that are symbolic links (a Unix file system feature) are excluded 800 | # from the input. 801 | # The default value is: NO. 802 | 803 | EXCLUDE_SYMLINKS = NO 804 | 805 | # If the value of the INPUT tag contains directories, you can use the 806 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 807 | # certain files from those directories. 808 | # 809 | # Note that the wildcards are matched against the file with absolute path, so to 810 | # exclude all test directories for example use the pattern */test/* 811 | 812 | EXCLUDE_PATTERNS = 813 | 814 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 815 | # (namespaces, classes, functions, etc.) that should be excluded from the 816 | # output. The symbol name can be a fully qualified name, a word, or if the 817 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 818 | # AClass::ANamespace, ANamespace::*Test 819 | # 820 | # Note that the wildcards are matched against the file with absolute path, so to 821 | # exclude all test directories use the pattern */test/* 822 | 823 | EXCLUDE_SYMBOLS = 824 | 825 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 826 | # that contain example code fragments that are included (see the \include 827 | # command). 828 | 829 | EXAMPLE_PATH = 830 | 831 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 832 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 833 | # *.h) to filter out the source-files in the directories. If left blank all 834 | # files are included. 835 | 836 | EXAMPLE_PATTERNS = 837 | 838 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 839 | # searched for input files to be used with the \include or \dontinclude commands 840 | # irrespective of the value of the RECURSIVE tag. 841 | # The default value is: NO. 842 | 843 | EXAMPLE_RECURSIVE = NO 844 | 845 | # The IMAGE_PATH tag can be used to specify one or more files or directories 846 | # that contain images that are to be included in the documentation (see the 847 | # \image command). 848 | 849 | IMAGE_PATH = 850 | 851 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 852 | # invoke to filter for each input file. Doxygen will invoke the filter program 853 | # by executing (via popen()) the command: 854 | # 855 | # 856 | # 857 | # where is the value of the INPUT_FILTER tag, and is the 858 | # name of an input file. Doxygen will then use the output that the filter 859 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 860 | # will be ignored. 861 | # 862 | # Note that the filter must not add or remove lines; it is applied before the 863 | # code is scanned, but not when the output code is generated. If lines are added 864 | # or removed, the anchors will not be placed correctly. 865 | 866 | INPUT_FILTER = 867 | 868 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 869 | # basis. Doxygen will compare the file name with each pattern and apply the 870 | # filter if there is a match. The filters are a list of the form: pattern=filter 871 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 872 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 873 | # patterns match the file name, INPUT_FILTER is applied. 874 | 875 | FILTER_PATTERNS = 876 | 877 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 878 | # INPUT_FILTER) will also be used to filter the input files that are used for 879 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 880 | # The default value is: NO. 881 | 882 | FILTER_SOURCE_FILES = NO 883 | 884 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 885 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 886 | # it is also possible to disable source filtering for a specific pattern using 887 | # *.ext= (so without naming a filter). 888 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 889 | 890 | FILTER_SOURCE_PATTERNS = 891 | 892 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 893 | # is part of the input, its contents will be placed on the main page 894 | # (index.html). This can be useful if you have a project on for instance GitHub 895 | # and want to reuse the introduction page also for the doxygen output. 896 | 897 | USE_MDFILE_AS_MAINPAGE = 898 | 899 | #--------------------------------------------------------------------------- 900 | # Configuration options related to source browsing 901 | #--------------------------------------------------------------------------- 902 | 903 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 904 | # generated. Documented entities will be cross-referenced with these sources. 905 | # 906 | # Note: To get rid of all source code in the generated output, make sure that 907 | # also VERBATIM_HEADERS is set to NO. 908 | # The default value is: NO. 909 | 910 | SOURCE_BROWSER = NO 911 | 912 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 913 | # classes and enums directly into the documentation. 914 | # The default value is: NO. 915 | 916 | INLINE_SOURCES = NO 917 | 918 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 919 | # special comment blocks from generated source code fragments. Normal C, C++ and 920 | # Fortran comments will always remain visible. 921 | # The default value is: YES. 922 | 923 | STRIP_CODE_COMMENTS = YES 924 | 925 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 926 | # function all documented functions referencing it will be listed. 927 | # The default value is: NO. 928 | 929 | REFERENCED_BY_RELATION = NO 930 | 931 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 932 | # all documented entities called/used by that function will be listed. 933 | # The default value is: NO. 934 | 935 | REFERENCES_RELATION = NO 936 | 937 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 938 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 939 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 940 | # link to the documentation. 941 | # The default value is: YES. 942 | 943 | REFERENCES_LINK_SOURCE = YES 944 | 945 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 946 | # source code will show a tooltip with additional information such as prototype, 947 | # brief description and links to the definition and documentation. Since this 948 | # will make the HTML file larger and loading of large files a bit slower, you 949 | # can opt to disable this feature. 950 | # The default value is: YES. 951 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 952 | 953 | SOURCE_TOOLTIPS = YES 954 | 955 | # If the USE_HTAGS tag is set to YES then the references to source code will 956 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 957 | # source browser. The htags tool is part of GNU's global source tagging system 958 | # (see http://www.gnu.org/software/global/global.html). You will need version 959 | # 4.8.6 or higher. 960 | # 961 | # To use it do the following: 962 | # - Install the latest version of global 963 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 964 | # - Make sure the INPUT points to the root of the source tree 965 | # - Run doxygen as normal 966 | # 967 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 968 | # tools must be available from the command line (i.e. in the search path). 969 | # 970 | # The result: instead of the source browser generated by doxygen, the links to 971 | # source code will now point to the output of htags. 972 | # The default value is: NO. 973 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 974 | 975 | USE_HTAGS = NO 976 | 977 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 978 | # verbatim copy of the header file for each class for which an include is 979 | # specified. Set to NO to disable this. 980 | # See also: Section \class. 981 | # The default value is: YES. 982 | 983 | VERBATIM_HEADERS = YES 984 | 985 | #--------------------------------------------------------------------------- 986 | # Configuration options related to the alphabetical class index 987 | #--------------------------------------------------------------------------- 988 | 989 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 990 | # compounds will be generated. Enable this if the project contains a lot of 991 | # classes, structs, unions or interfaces. 992 | # The default value is: YES. 993 | 994 | ALPHABETICAL_INDEX = YES 995 | 996 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 997 | # which the alphabetical index list will be split. 998 | # Minimum value: 1, maximum value: 20, default value: 5. 999 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1000 | 1001 | COLS_IN_ALPHA_INDEX = 5 1002 | 1003 | # In case all classes in a project start with a common prefix, all classes will 1004 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1005 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1006 | # while generating the index headers. 1007 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1008 | 1009 | IGNORE_PREFIX = 1010 | 1011 | #--------------------------------------------------------------------------- 1012 | # Configuration options related to the HTML output 1013 | #--------------------------------------------------------------------------- 1014 | 1015 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1016 | # The default value is: YES. 1017 | 1018 | GENERATE_HTML = YES 1019 | 1020 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1021 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1022 | # it. 1023 | # The default directory is: html. 1024 | # This tag requires that the tag GENERATE_HTML is set to YES. 1025 | 1026 | HTML_OUTPUT = html 1027 | 1028 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1029 | # generated HTML page (for example: .htm, .php, .asp). 1030 | # The default value is: .html. 1031 | # This tag requires that the tag GENERATE_HTML is set to YES. 1032 | 1033 | HTML_FILE_EXTENSION = .html 1034 | 1035 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1036 | # each generated HTML page. If the tag is left blank doxygen will generate a 1037 | # standard header. 1038 | # 1039 | # To get valid HTML the header file that includes any scripts and style sheets 1040 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1041 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1042 | # default header using 1043 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1044 | # YourConfigFile 1045 | # and then modify the file new_header.html. See also section "Doxygen usage" 1046 | # for information on how to generate the default header that doxygen normally 1047 | # uses. 1048 | # Note: The header is subject to change so you typically have to regenerate the 1049 | # default header when upgrading to a newer version of doxygen. For a description 1050 | # of the possible markers and block names see the documentation. 1051 | # This tag requires that the tag GENERATE_HTML is set to YES. 1052 | 1053 | HTML_HEADER = 1054 | 1055 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1056 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1057 | # footer. See HTML_HEADER for more information on how to generate a default 1058 | # footer and what special commands can be used inside the footer. See also 1059 | # section "Doxygen usage" for information on how to generate the default footer 1060 | # that doxygen normally uses. 1061 | # This tag requires that the tag GENERATE_HTML is set to YES. 1062 | 1063 | HTML_FOOTER = 1064 | 1065 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1066 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1067 | # the HTML output. If left blank doxygen will generate a default style sheet. 1068 | # See also section "Doxygen usage" for information on how to generate the style 1069 | # sheet that doxygen normally uses. 1070 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1071 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1072 | # obsolete. 1073 | # This tag requires that the tag GENERATE_HTML is set to YES. 1074 | 1075 | HTML_STYLESHEET = 1076 | 1077 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1078 | # cascading style sheets that are included after the standard style sheets 1079 | # created by doxygen. Using this option one can overrule certain style aspects. 1080 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1081 | # standard style sheet and is therefore more robust against future updates. 1082 | # Doxygen will copy the style sheet files to the output directory. 1083 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1084 | # style sheet in the list overrules the setting of the previous ones in the 1085 | # list). For an example see the documentation. 1086 | # This tag requires that the tag GENERATE_HTML is set to YES. 1087 | 1088 | HTML_EXTRA_STYLESHEET = 1089 | 1090 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1091 | # other source files which should be copied to the HTML output directory. Note 1092 | # that these files will be copied to the base HTML output directory. Use the 1093 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1094 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1095 | # files will be copied as-is; there are no commands or markers available. 1096 | # This tag requires that the tag GENERATE_HTML is set to YES. 1097 | 1098 | HTML_EXTRA_FILES = 1099 | 1100 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1101 | # will adjust the colors in the style sheet and background images according to 1102 | # this color. Hue is specified as an angle on a colorwheel, see 1103 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1104 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1105 | # purple, and 360 is red again. 1106 | # Minimum value: 0, maximum value: 359, default value: 220. 1107 | # This tag requires that the tag GENERATE_HTML is set to YES. 1108 | 1109 | HTML_COLORSTYLE_HUE = 220 1110 | 1111 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1112 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1113 | # value of 255 will produce the most vivid colors. 1114 | # Minimum value: 0, maximum value: 255, default value: 100. 1115 | # This tag requires that the tag GENERATE_HTML is set to YES. 1116 | 1117 | HTML_COLORSTYLE_SAT = 100 1118 | 1119 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1120 | # luminance component of the colors in the HTML output. Values below 100 1121 | # gradually make the output lighter, whereas values above 100 make the output 1122 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1123 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1124 | # change the gamma. 1125 | # Minimum value: 40, maximum value: 240, default value: 80. 1126 | # This tag requires that the tag GENERATE_HTML is set to YES. 1127 | 1128 | HTML_COLORSTYLE_GAMMA = 80 1129 | 1130 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1131 | # page will contain the date and time when the page was generated. Setting this 1132 | # to NO can help when comparing the output of multiple runs. 1133 | # The default value is: YES. 1134 | # This tag requires that the tag GENERATE_HTML is set to YES. 1135 | 1136 | HTML_TIMESTAMP = YES 1137 | 1138 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1139 | # documentation will contain sections that can be hidden and shown after the 1140 | # page has loaded. 1141 | # The default value is: NO. 1142 | # This tag requires that the tag GENERATE_HTML is set to YES. 1143 | 1144 | HTML_DYNAMIC_SECTIONS = NO 1145 | 1146 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1147 | # shown in the various tree structured indices initially; the user can expand 1148 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1149 | # such a level that at most the specified number of entries are visible (unless 1150 | # a fully collapsed tree already exceeds this amount). So setting the number of 1151 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1152 | # representing an infinite number of entries and will result in a full expanded 1153 | # tree by default. 1154 | # Minimum value: 0, maximum value: 9999, default value: 100. 1155 | # This tag requires that the tag GENERATE_HTML is set to YES. 1156 | 1157 | HTML_INDEX_NUM_ENTRIES = 100 1158 | 1159 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1160 | # generated that can be used as input for Apple's Xcode 3 integrated development 1161 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1162 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1163 | # Makefile in the HTML output directory. Running make will produce the docset in 1164 | # that directory and running make install will install the docset in 1165 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1166 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1167 | # for more information. 1168 | # The default value is: NO. 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. 1170 | 1171 | GENERATE_DOCSET = NO 1172 | 1173 | # This tag determines the name of the docset feed. A documentation feed provides 1174 | # an umbrella under which multiple documentation sets from a single provider 1175 | # (such as a company or product suite) can be grouped. 1176 | # The default value is: Doxygen generated docs. 1177 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1178 | 1179 | DOCSET_FEEDNAME = "Doxygen generated docs" 1180 | 1181 | # This tag specifies a string that should uniquely identify the documentation 1182 | # set bundle. This should be a reverse domain-name style string, e.g. 1183 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1184 | # The default value is: org.doxygen.Project. 1185 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1186 | 1187 | DOCSET_BUNDLE_ID = org.doxygen.Project 1188 | 1189 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1190 | # the documentation publisher. This should be a reverse domain-name style 1191 | # string, e.g. com.mycompany.MyDocSet.documentation. 1192 | # The default value is: org.doxygen.Publisher. 1193 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1194 | 1195 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1196 | 1197 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1198 | # The default value is: Publisher. 1199 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1200 | 1201 | DOCSET_PUBLISHER_NAME = Publisher 1202 | 1203 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1204 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1205 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1206 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1207 | # Windows. 1208 | # 1209 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1210 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1211 | # files are now used as the Windows 98 help format, and will replace the old 1212 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1213 | # HTML files also contain an index, a table of contents, and you can search for 1214 | # words in the documentation. The HTML workshop also contains a viewer for 1215 | # compressed HTML files. 1216 | # The default value is: NO. 1217 | # This tag requires that the tag GENERATE_HTML is set to YES. 1218 | 1219 | GENERATE_HTMLHELP = NO 1220 | 1221 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1222 | # file. You can add a path in front of the file if the result should not be 1223 | # written to the html output directory. 1224 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1225 | 1226 | CHM_FILE = 1227 | 1228 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1229 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1230 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1231 | # The file has to be specified with full path. 1232 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1233 | 1234 | HHC_LOCATION = 1235 | 1236 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1237 | # (YES) or that it should be included in the master .chm file (NO). 1238 | # The default value is: NO. 1239 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1240 | 1241 | GENERATE_CHI = NO 1242 | 1243 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1244 | # and project file content. 1245 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1246 | 1247 | CHM_INDEX_ENCODING = 1248 | 1249 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1250 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1251 | # enables the Previous and Next buttons. 1252 | # The default value is: NO. 1253 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1254 | 1255 | BINARY_TOC = NO 1256 | 1257 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1258 | # the table of contents of the HTML help documentation and to the tree view. 1259 | # The default value is: NO. 1260 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1261 | 1262 | TOC_EXPAND = NO 1263 | 1264 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1265 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1266 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1267 | # (.qch) of the generated HTML documentation. 1268 | # The default value is: NO. 1269 | # This tag requires that the tag GENERATE_HTML is set to YES. 1270 | 1271 | GENERATE_QHP = NO 1272 | 1273 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1274 | # the file name of the resulting .qch file. The path specified is relative to 1275 | # the HTML output folder. 1276 | # This tag requires that the tag GENERATE_QHP is set to YES. 1277 | 1278 | QCH_FILE = 1279 | 1280 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1281 | # Project output. For more information please see Qt Help Project / Namespace 1282 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1283 | # The default value is: org.doxygen.Project. 1284 | # This tag requires that the tag GENERATE_QHP is set to YES. 1285 | 1286 | QHP_NAMESPACE = org.doxygen.Project 1287 | 1288 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1289 | # Help Project output. For more information please see Qt Help Project / Virtual 1290 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1291 | # folders). 1292 | # The default value is: doc. 1293 | # This tag requires that the tag GENERATE_QHP is set to YES. 1294 | 1295 | QHP_VIRTUAL_FOLDER = doc 1296 | 1297 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1298 | # filter to add. For more information please see Qt Help Project / Custom 1299 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1300 | # filters). 1301 | # This tag requires that the tag GENERATE_QHP is set to YES. 1302 | 1303 | QHP_CUST_FILTER_NAME = 1304 | 1305 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1306 | # custom filter to add. For more information please see Qt Help Project / Custom 1307 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1308 | # filters). 1309 | # This tag requires that the tag GENERATE_QHP is set to YES. 1310 | 1311 | QHP_CUST_FILTER_ATTRS = 1312 | 1313 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1314 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1315 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1316 | # This tag requires that the tag GENERATE_QHP is set to YES. 1317 | 1318 | QHP_SECT_FILTER_ATTRS = 1319 | 1320 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1321 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1322 | # generated .qhp file. 1323 | # This tag requires that the tag GENERATE_QHP is set to YES. 1324 | 1325 | QHG_LOCATION = 1326 | 1327 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1328 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1329 | # install this plugin and make it available under the help contents menu in 1330 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1331 | # to be copied into the plugins directory of eclipse. The name of the directory 1332 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1333 | # After copying Eclipse needs to be restarted before the help appears. 1334 | # The default value is: NO. 1335 | # This tag requires that the tag GENERATE_HTML is set to YES. 1336 | 1337 | GENERATE_ECLIPSEHELP = NO 1338 | 1339 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1340 | # the directory name containing the HTML and XML files should also have this 1341 | # name. Each documentation set should have its own identifier. 1342 | # The default value is: org.doxygen.Project. 1343 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1344 | 1345 | ECLIPSE_DOC_ID = org.doxygen.Project 1346 | 1347 | # If you want full control over the layout of the generated HTML pages it might 1348 | # be necessary to disable the index and replace it with your own. The 1349 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1350 | # of each HTML page. A value of NO enables the index and the value YES disables 1351 | # it. Since the tabs in the index contain the same information as the navigation 1352 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1353 | # The default value is: NO. 1354 | # This tag requires that the tag GENERATE_HTML is set to YES. 1355 | 1356 | DISABLE_INDEX = NO 1357 | 1358 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1359 | # structure should be generated to display hierarchical information. If the tag 1360 | # value is set to YES, a side panel will be generated containing a tree-like 1361 | # index structure (just like the one that is generated for HTML Help). For this 1362 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1363 | # (i.e. any modern browser). Windows users are probably better off using the 1364 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1365 | # further fine-tune the look of the index. As an example, the default style 1366 | # sheet generated by doxygen has an example that shows how to put an image at 1367 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1368 | # the same information as the tab index, you could consider setting 1369 | # DISABLE_INDEX to YES when enabling this option. 1370 | # The default value is: NO. 1371 | # This tag requires that the tag GENERATE_HTML is set to YES. 1372 | 1373 | GENERATE_TREEVIEW = NO 1374 | 1375 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1376 | # doxygen will group on one line in the generated HTML documentation. 1377 | # 1378 | # Note that a value of 0 will completely suppress the enum values from appearing 1379 | # in the overview section. 1380 | # Minimum value: 0, maximum value: 20, default value: 4. 1381 | # This tag requires that the tag GENERATE_HTML is set to YES. 1382 | 1383 | ENUM_VALUES_PER_LINE = 4 1384 | 1385 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1386 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1387 | # Minimum value: 0, maximum value: 1500, default value: 250. 1388 | # This tag requires that the tag GENERATE_HTML is set to YES. 1389 | 1390 | TREEVIEW_WIDTH = 250 1391 | 1392 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1393 | # external symbols imported via tag files in a separate window. 1394 | # The default value is: NO. 1395 | # This tag requires that the tag GENERATE_HTML is set to YES. 1396 | 1397 | EXT_LINKS_IN_WINDOW = NO 1398 | 1399 | # Use this tag to change the font size of LaTeX formulas included as images in 1400 | # the HTML documentation. When you change the font size after a successful 1401 | # doxygen run you need to manually remove any form_*.png images from the HTML 1402 | # output directory to force them to be regenerated. 1403 | # Minimum value: 8, maximum value: 50, default value: 10. 1404 | # This tag requires that the tag GENERATE_HTML is set to YES. 1405 | 1406 | FORMULA_FONTSIZE = 10 1407 | 1408 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1409 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1410 | # supported properly for IE 6.0, but are supported on all modern browsers. 1411 | # 1412 | # Note that when changing this option you need to delete any form_*.png files in 1413 | # the HTML output directory before the changes have effect. 1414 | # The default value is: YES. 1415 | # This tag requires that the tag GENERATE_HTML is set to YES. 1416 | 1417 | FORMULA_TRANSPARENT = YES 1418 | 1419 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1420 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1421 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1422 | # installed or if you want to formulas look prettier in the HTML output. When 1423 | # enabled you may also need to install MathJax separately and configure the path 1424 | # to it using the MATHJAX_RELPATH option. 1425 | # The default value is: NO. 1426 | # This tag requires that the tag GENERATE_HTML is set to YES. 1427 | 1428 | USE_MATHJAX = NO 1429 | 1430 | # When MathJax is enabled you can set the default output format to be used for 1431 | # the MathJax output. See the MathJax site (see: 1432 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1433 | # Possible values are: HTML-CSS (which is slower, but has the best 1434 | # compatibility), NativeMML (i.e. MathML) and SVG. 1435 | # The default value is: HTML-CSS. 1436 | # This tag requires that the tag USE_MATHJAX is set to YES. 1437 | 1438 | MATHJAX_FORMAT = HTML-CSS 1439 | 1440 | # When MathJax is enabled you need to specify the location relative to the HTML 1441 | # output directory using the MATHJAX_RELPATH option. The destination directory 1442 | # should contain the MathJax.js script. For instance, if the mathjax directory 1443 | # is located at the same level as the HTML output directory, then 1444 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1445 | # Content Delivery Network so you can quickly see the result without installing 1446 | # MathJax. However, it is strongly recommended to install a local copy of 1447 | # MathJax from http://www.mathjax.org before deployment. 1448 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1449 | # This tag requires that the tag USE_MATHJAX is set to YES. 1450 | 1451 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1452 | 1453 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1454 | # extension names that should be enabled during MathJax rendering. For example 1455 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1456 | # This tag requires that the tag USE_MATHJAX is set to YES. 1457 | 1458 | MATHJAX_EXTENSIONS = 1459 | 1460 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1461 | # of code that will be used on startup of the MathJax code. See the MathJax site 1462 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1463 | # example see the documentation. 1464 | # This tag requires that the tag USE_MATHJAX is set to YES. 1465 | 1466 | MATHJAX_CODEFILE = 1467 | 1468 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1469 | # the HTML output. The underlying search engine uses javascript and DHTML and 1470 | # should work on any modern browser. Note that when using HTML help 1471 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1472 | # there is already a search function so this one should typically be disabled. 1473 | # For large projects the javascript based search engine can be slow, then 1474 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1475 | # search using the keyboard; to jump to the search box use + S 1476 | # (what the is depends on the OS and browser, but it is typically 1477 | # , /