Commit abd7d63b authored by Alexander Alekhin's avatar Alexander Alekhin

Merge pull request #15424 from mshabunin:add-cmake-docs

parents 048ddbf9 f3aab47f
...@@ -132,7 +132,7 @@ if(DOXYGEN_FOUND) ...@@ -132,7 +132,7 @@ if(DOXYGEN_FOUND)
# set export variables # set export variables
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_INPUT_LIST "${rootfile} ; ${faqfile} ; ${paths_include} ; ${paths_hal_interface} ; ${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial} ; ${tutorial_contrib_root}") string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_INPUT_LIST "${rootfile} ; ${faqfile} ; ${paths_include} ; ${paths_hal_interface} ; ${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial} ; ${tutorial_contrib_root}")
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial}") string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_IMAGE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/images ; ${paths_doc} ; ${tutorial_path} ; ${tutorial_py_path} ; ${tutorial_js_path} ; ${paths_tutorial}")
string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_EXCLUDE_LIST "${CMAKE_DOXYGEN_EXCLUDE_LIST}") string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_EXCLUDE_LIST "${CMAKE_DOXYGEN_EXCLUDE_LIST}")
string(REPLACE ";" " " CMAKE_DOXYGEN_ENABLED_SECTIONS "${CMAKE_DOXYGEN_ENABLED_SECTIONS}") string(REPLACE ";" " " CMAKE_DOXYGEN_ENABLED_SECTIONS "${CMAKE_DOXYGEN_ENABLED_SECTIONS}")
# TODO: remove paths_doc from EXAMPLE_PATH after face module tutorials/samples moved to separate folders # TODO: remove paths_doc from EXAMPLE_PATH after face module tutorials/samples moved to separate folders
......
...@@ -261,9 +261,7 @@ GENERATE_TAGFILE = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag ...@@ -261,9 +261,7 @@ GENERATE_TAGFILE = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag
ALLEXTERNALS = NO ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES EXTERNAL_PAGES = YES
PERL_PATH = /usr/bin/perl
CLASS_DIAGRAMS = YES CLASS_DIAGRAMS = YES
MSCGEN_PATH =
DIA_PATH = DIA_PATH =
HIDE_UNDOC_RELATIONS = NO HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = NO HAVE_DOT = NO
......
...@@ -50,7 +50,7 @@ Now we will learn how to write a simple Hello World Application in Xcode using O ...@@ -50,7 +50,7 @@ Now we will learn how to write a simple Hello World Application in Xcode using O
Output Output
------ ------
![](images/output.png) ![](images/ios_hello_output.png)
Changes for XCode5+ and iOS8+ Changes for XCode5+ and iOS8+
----------------------------- -----------------------------
......
...@@ -205,4 +205,4 @@ The code opens an image, finds the orientation of the detected objects of intere ...@@ -205,4 +205,4 @@ The code opens an image, finds the orientation of the detected objects of intere
![](images/pca_test1.jpg) ![](images/pca_test1.jpg)
![](images/output.png) ![](images/pca_output.png)
...@@ -73,8 +73,10 @@ ...@@ -73,8 +73,10 @@
@defgroup core_cluster Clustering @defgroup core_cluster Clustering
@defgroup core_utils Utility and system functions and macros @defgroup core_utils Utility and system functions and macros
@{ @{
@defgroup core_logging Logging facilities
@defgroup core_utils_sse SSE utilities @defgroup core_utils_sse SSE utilities
@defgroup core_utils_neon NEON utilities @defgroup core_utils_neon NEON utilities
@defgroup core_utils_vsx VSX utilities
@defgroup core_utils_softfloat Softfloat support @defgroup core_utils_softfloat Softfloat support
@defgroup core_utils_samples Utility functions for OpenCV samples @defgroup core_utils_samples Utility functions for OpenCV samples
@} @}
......
...@@ -507,8 +507,8 @@ Special cases: ...@@ -507,8 +507,8 @@ Special cases:
*/ */
CV_EXPORTS softdouble cos( const softdouble& a ); CV_EXPORTS softdouble cos( const softdouble& a );
} //! @} core_utils_softfloat
//! @} } // cv::
#endif #endif
...@@ -11,15 +11,13 @@ ...@@ -11,15 +11,13 @@
#include "logger.defines.hpp" #include "logger.defines.hpp"
//! @addtogroup core_logging
// This section describes OpenCV logging utilities.
//
//! @{
namespace cv { namespace cv {
namespace utils { namespace utils {
namespace logging { namespace logging {
//! @addtogroup core_logging
//! @{
//! Supported logging levels and their semantic //! Supported logging levels and their semantic
enum LogLevel { enum LogLevel {
LOG_LEVEL_SILENT = 0, //!< for using in setLogVevel() call LOG_LEVEL_SILENT = 0, //!< for using in setLogVevel() call
...@@ -79,9 +77,8 @@ CV_EXPORTS void writeLogMessage(LogLevel logLevel, const char* message); ...@@ -79,9 +77,8 @@ CV_EXPORTS void writeLogMessage(LogLevel logLevel, const char* message);
#define CV_LOG_VERBOSE(tag, v, ...) for(;;) { if (cv::utils::logging::getLogLevel() < cv::utils::logging::LOG_LEVEL_VERBOSE) break; std::stringstream ss; ss << "[VERB" << v << ":" << cv::utils::getThreadID() << "] " << __VA_ARGS__; cv::utils::logging::internal::writeLogMessage(cv::utils::logging::LOG_LEVEL_VERBOSE, ss.str().c_str()); break; } #define CV_LOG_VERBOSE(tag, v, ...) for(;;) { if (cv::utils::logging::getLogLevel() < cv::utils::logging::LOG_LEVEL_VERBOSE) break; std::stringstream ss; ss << "[VERB" << v << ":" << cv::utils::getThreadID() << "] " << __VA_ARGS__; cv::utils::logging::internal::writeLogMessage(cv::utils::logging::LOG_LEVEL_VERBOSE, ss.str().c_str()); break; }
#endif #endif
//! @}
}}} // namespace }}} // namespace
//! @}
#endif // OPENCV_LOGGER_HPP #endif // OPENCV_LOGGER_HPP
...@@ -7,15 +7,13 @@ ...@@ -7,15 +7,13 @@
#include <opencv2/core/cvdef.h> #include <opencv2/core/cvdef.h>
//! @addtogroup core_logging
// This section describes OpenCV tracing utilities.
//
//! @{
namespace cv { namespace cv {
namespace utils { namespace utils {
namespace trace { namespace trace {
//! @addtogroup core_logging
//! @{
//! Macro to trace function //! Macro to trace function
#define CV_TRACE_FUNCTION() #define CV_TRACE_FUNCTION()
...@@ -247,8 +245,8 @@ CV_EXPORTS void traceArg(const TraceArg& arg, double value); ...@@ -247,8 +245,8 @@ CV_EXPORTS void traceArg(const TraceArg& arg, double value);
//! @endcond //! @endcond
}}} // namespace
//! @} //! @}
}}} // namespace
#endif // OPENCV_TRACE_HPP #endif // OPENCV_TRACE_HPP
...@@ -72,7 +72,7 @@ CV_EXPORTS ...@@ -72,7 +72,7 @@ CV_EXPORTS
cudaStream_t nppStSetActiveCUDAstream(cudaStream_t cudaStream); cudaStream_t nppStSetActiveCUDAstream(cudaStream_t cudaStream);
/*@}*/ /** @} */
/** \defgroup nppi NPPST Image Processing /** \defgroup nppi NPPST Image Processing
...@@ -787,7 +787,7 @@ NCVStatus nppiStSqrIntegral_8u64u_C1R_host(Ncv8u *h_src, Ncv32u srcStep, ...@@ -787,7 +787,7 @@ NCVStatus nppiStSqrIntegral_8u64u_C1R_host(Ncv8u *h_src, Ncv32u srcStep,
Ncv64u *h_dst, Ncv32u dstStep, NcvSize32u roiSize); Ncv64u *h_dst, Ncv32u dstStep, NcvSize32u roiSize);
/*@}*/ /** @} */
/** \defgroup npps NPPST Signal Processing /** \defgroup npps NPPST Signal Processing
...@@ -899,8 +899,8 @@ NCVStatus nppsStCompact_32f_host(Ncv32f *h_src, Ncv32u srcLen, ...@@ -899,8 +899,8 @@ NCVStatus nppsStCompact_32f_host(Ncv32f *h_src, Ncv32u srcLen,
Ncv32f *h_dst, Ncv32u *dstLen, Ncv32f elemRemove); Ncv32f *h_dst, Ncv32u *dstLen, Ncv32f elemRemove);
/*@}*/ /** @} */
//! @} //! @} cudalegacy
#endif // _npp_staging_hpp_ #endif // _npp_staging_hpp_
...@@ -80,6 +80,10 @@ This section describes approaches based on local 2D features and used to categor ...@@ -80,6 +80,10 @@ This section describes approaches based on local 2D features and used to categor
- (Python) An example using the features2D framework to perform object categorization can be - (Python) An example using the features2D framework to perform object categorization can be
found at opencv_source_code/samples/python/find_obj.py found at opencv_source_code/samples/python/find_obj.py
@defgroup feature2d_hal Hardware Acceleration Layer
@{
@defgroup features2d_hal_interface Interface
@}
@} @}
*/ */
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
#define OPENCV_FEATURE2D_HAL_INTERFACE_H #define OPENCV_FEATURE2D_HAL_INTERFACE_H
#include "opencv2/core/cvdef.h" #include "opencv2/core/cvdef.h"
//! @addtogroup featrure2d_hal_interface //! @addtogroup features2d_hal_interface
//! @{ //! @{
//! @name Fast feature detector types //! @name Fast feature detector types
......
...@@ -107,38 +107,38 @@ the index is built. ...@@ -107,38 +107,38 @@ the index is built.
`Distance` functor specifies the metric to be used to calculate the distance between two points. `Distance` functor specifies the metric to be used to calculate the distance between two points.
There are several `Distance` functors that are readily available: There are several `Distance` functors that are readily available:
@link cvflann::L2_Simple cv::flann::L2_Simple @endlink- Squared Euclidean distance functor. cv::cvflann::L2_Simple - Squared Euclidean distance functor.
This is the simpler, unrolled version. This is preferable for very low dimensionality data (eg 3D points) This is the simpler, unrolled version. This is preferable for very low dimensionality data (eg 3D points)
@link cvflann::L2 cv::flann::L2 @endlink- Squared Euclidean distance functor, optimized version. cv::flann::L2 - Squared Euclidean distance functor, optimized version.
@link cvflann::L1 cv::flann::L1 @endlink - Manhattan distance functor, optimized version. cv::flann::L1 - Manhattan distance functor, optimized version.
@link cvflann::MinkowskiDistance cv::flann::MinkowskiDistance @endlink - The Minkowsky distance functor. cv::flann::MinkowskiDistance - The Minkowsky distance functor.
This is highly optimised with loop unrolling. This is highly optimised with loop unrolling.
The computation of squared root at the end is omitted for efficiency. The computation of squared root at the end is omitted for efficiency.
@link cvflann::MaxDistance cv::flann::MaxDistance @endlink - The max distance functor. It computes the cv::flann::MaxDistance - The max distance functor. It computes the
maximum distance between two vectors. This distance is not a valid kdtree distance, it's not maximum distance between two vectors. This distance is not a valid kdtree distance, it's not
dimensionwise additive. dimensionwise additive.
@link cvflann::HammingLUT cv::flann::HammingLUT @endlink - %Hamming distance functor. It counts the bit cv::flann::HammingLUT - %Hamming distance functor. It counts the bit
differences between two strings using a lookup table implementation. differences between two strings using a lookup table implementation.
@link cvflann::Hamming cv::flann::Hamming @endlink - %Hamming distance functor. Population count is cv::flann::Hamming - %Hamming distance functor. Population count is
performed using library calls, if available. Lookup table implementation is used as a fallback. performed using library calls, if available. Lookup table implementation is used as a fallback.
@link cvflann::Hamming2 cv::flann::Hamming2 @endlink- %Hamming distance functor. Population count is cv::flann::Hamming2 - %Hamming distance functor. Population count is
implemented in 12 arithmetic operations (one of which is multiplication). implemented in 12 arithmetic operations (one of which is multiplication).
@link cvflann::HistIntersectionDistance cv::flann::HistIntersectionDistance @endlink - The histogram cv::flann::HistIntersectionDistance - The histogram
intersection distance functor. intersection distance functor.
@link cvflann::HellingerDistance cv::flann::HellingerDistance @endlink - The Hellinger distance functor. cv::flann::HellingerDistance - The Hellinger distance functor.
@link cvflann::ChiSquareDistance cv::flann::ChiSquareDistance @endlink - The chi-square distance functor. cv::flann::ChiSquareDistance - The chi-square distance functor.
@link cvflann::KL_Divergence cv::flann::KL_Divergence @endlink - The Kullback-Leibler divergence functor. cv::flann::KL_Divergence - The Kullback-Leibler divergence functor.
Although the provided implementations cover a vast range of cases, it is also possible to use Although the provided implementations cover a vast range of cases, it is also possible to use
a custom implementation. The distance functor is a class whose `operator()` computes the distance a custom implementation. The distance functor is a class whose `operator()` computes the distance
...@@ -397,8 +397,6 @@ int GenericIndex<Distance>::radiusSearch(const Mat& query, Mat& indices, Mat& di ...@@ -397,8 +397,6 @@ int GenericIndex<Distance>::radiusSearch(const Mat& query, Mat& indices, Mat& di
return nnIndex->radiusSearch(m_query,m_indices,m_dists,radius,searchParams); return nnIndex->radiusSearch(m_query,m_indices,m_dists,radius,searchParams);
} }
//! @endcond
/** /**
* @deprecated Use GenericIndex class instead * @deprecated Use GenericIndex class instead
*/ */
...@@ -531,6 +529,7 @@ private: ...@@ -531,6 +529,7 @@ private:
::cvflann::Index< L1<ElementType> >* nnIndex_L1; ::cvflann::Index< L1<ElementType> >* nnIndex_L1;
}; };
//! @endcond
/** @brief Clusters features using hierarchical k-means algorithm. /** @brief Clusters features using hierarchical k-means algorithm.
...@@ -567,8 +566,8 @@ int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::K ...@@ -567,8 +566,8 @@ int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::K
return ::cvflann::hierarchicalClustering<Distance>(m_features, m_centers, params, d); return ::cvflann::hierarchicalClustering<Distance>(m_features, m_centers, params, d);
} }
/** @deprecated //! @cond IGNORED
*/
template <typename ELEM_TYPE, typename DIST_TYPE> template <typename ELEM_TYPE, typename DIST_TYPE>
CV_DEPRECATED int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::KMeansIndexParams& params) CV_DEPRECATED int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::KMeansIndexParams& params)
{ {
...@@ -589,6 +588,8 @@ CV_DEPRECATED int hierarchicalClustering(const Mat& features, Mat& centers, cons ...@@ -589,6 +588,8 @@ CV_DEPRECATED int hierarchicalClustering(const Mat& features, Mat& centers, cons
} }
} }
//! @endcond
//! @} flann //! @} flann
} } // namespace cv::flann } } // namespace cv::flann
......
...@@ -30,6 +30,8 @@ ...@@ -30,6 +30,8 @@
#ifndef OPENCV_FLANN_ALL_INDICES_H_ #ifndef OPENCV_FLANN_ALL_INDICES_H_
#define OPENCV_FLANN_ALL_INDICES_H_ #define OPENCV_FLANN_ALL_INDICES_H_
//! @cond IGNORED
#include "general.h" #include "general.h"
#include "nn_index.h" #include "nn_index.h"
...@@ -152,4 +154,6 @@ NNIndex<Distance>* create_index_by_type(const Matrix<typename Distance::ElementT ...@@ -152,4 +154,6 @@ NNIndex<Distance>* create_index_by_type(const Matrix<typename Distance::ElementT
} }
//! @endcond
#endif /* OPENCV_FLANN_ALL_INDICES_H_ */ #endif /* OPENCV_FLANN_ALL_INDICES_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_ALLOCATOR_H_ #ifndef OPENCV_FLANN_ALLOCATOR_H_
#define OPENCV_FLANN_ALLOCATOR_H_ #define OPENCV_FLANN_ALLOCATOR_H_
//! @cond IGNORED
#include <stdlib.h> #include <stdlib.h>
#include <stdio.h> #include <stdio.h>
...@@ -189,4 +191,6 @@ private: ...@@ -189,4 +191,6 @@ private:
} }
//! @endcond
#endif //OPENCV_FLANN_ALLOCATOR_H_ #endif //OPENCV_FLANN_ALLOCATOR_H_
...@@ -12,6 +12,8 @@ ...@@ -12,6 +12,8 @@
* Adapted for FLANN by Marius Muja * Adapted for FLANN by Marius Muja
*/ */
//! @cond IGNORED
#include "defines.h" #include "defines.h"
#include <stdexcept> #include <stdexcept>
#include <ostream> #include <ostream>
...@@ -327,4 +329,6 @@ inline std::ostream& operator <<(std::ostream& out, const any& any_val) ...@@ -327,4 +329,6 @@ inline std::ostream& operator <<(std::ostream& out, const any& any_val)
} }
//! @endcond
#endif // OPENCV_FLANN_ANY_H_ #endif // OPENCV_FLANN_ANY_H_
...@@ -30,6 +30,8 @@ ...@@ -30,6 +30,8 @@
#ifndef OPENCV_FLANN_AUTOTUNED_INDEX_H_ #ifndef OPENCV_FLANN_AUTOTUNED_INDEX_H_
#define OPENCV_FLANN_AUTOTUNED_INDEX_H_ #define OPENCV_FLANN_AUTOTUNED_INDEX_H_
//! @cond IGNORED
#include <sstream> #include <sstream>
#include "general.h" #include "general.h"
...@@ -588,4 +590,6 @@ private: ...@@ -588,4 +590,6 @@ private:
}; };
} }
//! @endcond
#endif /* OPENCV_FLANN_AUTOTUNED_INDEX_H_ */ #endif /* OPENCV_FLANN_AUTOTUNED_INDEX_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_COMPOSITE_INDEX_H_ #ifndef OPENCV_FLANN_COMPOSITE_INDEX_H_
#define OPENCV_FLANN_COMPOSITE_INDEX_H_ #define OPENCV_FLANN_COMPOSITE_INDEX_H_
//! @cond IGNORED
#include "general.h" #include "general.h"
#include "nn_index.h" #include "nn_index.h"
#include "kdtree_index.h" #include "kdtree_index.h"
...@@ -191,4 +193,6 @@ private: ...@@ -191,4 +193,6 @@ private:
} }
//! @endcond
#endif //OPENCV_FLANN_COMPOSITE_INDEX_H_ #endif //OPENCV_FLANN_COMPOSITE_INDEX_H_
...@@ -30,9 +30,13 @@ ...@@ -30,9 +30,13 @@
#ifndef OPENCV_FLANN_CONFIG_H_ #ifndef OPENCV_FLANN_CONFIG_H_
#define OPENCV_FLANN_CONFIG_H_ #define OPENCV_FLANN_CONFIG_H_
//! @cond IGNORED
#ifdef FLANN_VERSION_ #ifdef FLANN_VERSION_
#undef FLANN_VERSION_ #undef FLANN_VERSION_
#endif #endif
#define FLANN_VERSION_ "1.6.10" #define FLANN_VERSION_ "1.6.10"
//! @endcond
#endif /* OPENCV_FLANN_CONFIG_H_ */ #endif /* OPENCV_FLANN_CONFIG_H_ */
...@@ -30,6 +30,8 @@ ...@@ -30,6 +30,8 @@
#ifndef OPENCV_FLANN_DEFINES_H_ #ifndef OPENCV_FLANN_DEFINES_H_
#define OPENCV_FLANN_DEFINES_H_ #define OPENCV_FLANN_DEFINES_H_
//! @cond IGNORED
#include "config.h" #include "config.h"
#ifdef FLANN_EXPORT #ifdef FLANN_EXPORT
...@@ -161,4 +163,6 @@ enum ...@@ -161,4 +163,6 @@ enum
} }
//! @endcond
#endif /* OPENCV_FLANN_DEFINES_H_ */ #endif /* OPENCV_FLANN_DEFINES_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_DIST_H_ #ifndef OPENCV_FLANN_DIST_H_
#define OPENCV_FLANN_DIST_H_ #define OPENCV_FLANN_DIST_H_
//! @cond IGNORED
#include <cmath> #include <cmath>
#include <cstdlib> #include <cstdlib>
#include <string.h> #include <string.h>
...@@ -901,4 +903,6 @@ typename Distance::ResultType ensureSimpleDistance( typename Distance::ResultTyp ...@@ -901,4 +903,6 @@ typename Distance::ResultType ensureSimpleDistance( typename Distance::ResultTyp
} }
//! @endcond
#endif //OPENCV_FLANN_DIST_H_ #endif //OPENCV_FLANN_DIST_H_
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
#ifndef OPENCV_FLANN_DUMMY_H_ #ifndef OPENCV_FLANN_DUMMY_H_
#define OPENCV_FLANN_DUMMY_H_ #define OPENCV_FLANN_DUMMY_H_
//! @cond IGNORED
namespace cvflann namespace cvflann
{ {
...@@ -9,5 +11,6 @@ CV_DEPRECATED inline void dummyfunc() {} ...@@ -9,5 +11,6 @@ CV_DEPRECATED inline void dummyfunc() {}
} }
//! @endcond
#endif /* OPENCV_FLANN_DUMMY_H_ */ #endif /* OPENCV_FLANN_DUMMY_H_ */
...@@ -35,6 +35,8 @@ ...@@ -35,6 +35,8 @@
#ifndef OPENCV_FLANN_DYNAMIC_BITSET_H_ #ifndef OPENCV_FLANN_DYNAMIC_BITSET_H_
#define OPENCV_FLANN_DYNAMIC_BITSET_H_ #define OPENCV_FLANN_DYNAMIC_BITSET_H_
//! @cond IGNORED
#ifndef FLANN_USE_BOOST #ifndef FLANN_USE_BOOST
# define FLANN_USE_BOOST 0 # define FLANN_USE_BOOST 0
#endif #endif
...@@ -156,4 +158,6 @@ private: ...@@ -156,4 +158,6 @@ private:
#endif #endif
//! @endcond
#endif // OPENCV_FLANN_DYNAMIC_BITSET_H_ #endif // OPENCV_FLANN_DYNAMIC_BITSET_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_BASE_HPP_ #ifndef OPENCV_FLANN_BASE_HPP_
#define OPENCV_FLANN_BASE_HPP_ #define OPENCV_FLANN_BASE_HPP_
//! @cond IGNORED
#include <vector> #include <vector>
#include <cassert> #include <cassert>
#include <cstdio> #include <cstdio>
...@@ -292,4 +294,7 @@ int hierarchicalClustering(const Matrix<typename Distance::ElementType>& points, ...@@ -292,4 +294,7 @@ int hierarchicalClustering(const Matrix<typename Distance::ElementType>& points,
} }
} }
//! @endcond
#endif /* OPENCV_FLANN_BASE_HPP_ */ #endif /* OPENCV_FLANN_BASE_HPP_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_GENERAL_H_ #ifndef OPENCV_FLANN_GENERAL_H_
#define OPENCV_FLANN_GENERAL_H_ #define OPENCV_FLANN_GENERAL_H_
//! @cond IGNORED
#include "opencv2/core.hpp" #include "opencv2/core.hpp"
namespace cvflann namespace cvflann
...@@ -46,5 +48,6 @@ public: ...@@ -46,5 +48,6 @@ public:
} }
//! @endcond
#endif /* OPENCV_FLANN_GENERAL_H_ */ #endif /* OPENCV_FLANN_GENERAL_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_GROUND_TRUTH_H_ #ifndef OPENCV_FLANN_GROUND_TRUTH_H_
#define OPENCV_FLANN_GROUND_TRUTH_H_ #define OPENCV_FLANN_GROUND_TRUTH_H_
//! @cond IGNORED
#include "dist.h" #include "dist.h"
#include "matrix.h" #include "matrix.h"
...@@ -91,4 +93,6 @@ void compute_ground_truth(const Matrix<typename Distance::ElementType>& dataset, ...@@ -91,4 +93,6 @@ void compute_ground_truth(const Matrix<typename Distance::ElementType>& dataset,
} }
//! @endcond
#endif //OPENCV_FLANN_GROUND_TRUTH_H_ #endif //OPENCV_FLANN_GROUND_TRUTH_H_
...@@ -30,6 +30,8 @@ ...@@ -30,6 +30,8 @@
#ifndef OPENCV_FLANN_HDF5_H_ #ifndef OPENCV_FLANN_HDF5_H_
#define OPENCV_FLANN_HDF5_H_ #define OPENCV_FLANN_HDF5_H_
//! @cond IGNORED
#include <hdf5.h> #include <hdf5.h>
#include "matrix.h" #include "matrix.h"
...@@ -228,4 +230,6 @@ void load_from_file(cvflann::Matrix<T>& dataset, const String& filename, const S ...@@ -228,4 +230,6 @@ void load_from_file(cvflann::Matrix<T>& dataset, const String& filename, const S
#endif // HAVE_MPI #endif // HAVE_MPI
} // namespace cvflann::mpi } // namespace cvflann::mpi
//! @endcond
#endif /* OPENCV_FLANN_HDF5_H_ */ #endif /* OPENCV_FLANN_HDF5_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_HEAP_H_ #ifndef OPENCV_FLANN_HEAP_H_
#define OPENCV_FLANN_HEAP_H_ #define OPENCV_FLANN_HEAP_H_
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <vector> #include <vector>
...@@ -162,4 +164,6 @@ public: ...@@ -162,4 +164,6 @@ public:
} }
//! @endcond
#endif //OPENCV_FLANN_HEAP_H_ #endif //OPENCV_FLANN_HEAP_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_ #ifndef OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_
#define OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_ #define OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <map> #include <map>
#include <cassert> #include <cassert>
...@@ -845,4 +847,6 @@ private: ...@@ -845,4 +847,6 @@ private:
} }
//! @endcond
#endif /* OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_ */ #endif /* OPENCV_FLANN_HIERARCHICAL_CLUSTERING_INDEX_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_INDEX_TESTING_H_ #ifndef OPENCV_FLANN_INDEX_TESTING_H_
#define OPENCV_FLANN_INDEX_TESTING_H_ #define OPENCV_FLANN_INDEX_TESTING_H_
//! @cond IGNORED
#include <cstring> #include <cstring>
#include <cassert> #include <cassert>
#include <cmath> #include <cmath>
...@@ -315,4 +317,6 @@ void test_index_precisions(NNIndex<Distance>& index, const Matrix<typename Dista ...@@ -315,4 +317,6 @@ void test_index_precisions(NNIndex<Distance>& index, const Matrix<typename Dista
} }
//! @endcond
#endif //OPENCV_FLANN_INDEX_TESTING_H_ #endif //OPENCV_FLANN_INDEX_TESTING_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_KDTREE_INDEX_H_ #ifndef OPENCV_FLANN_KDTREE_INDEX_H_
#define OPENCV_FLANN_KDTREE_INDEX_H_ #define OPENCV_FLANN_KDTREE_INDEX_H_
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <map> #include <map>
#include <cassert> #include <cassert>
...@@ -623,4 +625,6 @@ private: ...@@ -623,4 +625,6 @@ private:
} }
//! @endcond
#endif //OPENCV_FLANN_KDTREE_INDEX_H_ #endif //OPENCV_FLANN_KDTREE_INDEX_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_ #ifndef OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_
#define OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_ #define OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <map> #include <map>
#include <cassert> #include <cassert>
...@@ -632,4 +634,6 @@ private: ...@@ -632,4 +634,6 @@ private:
} }
//! @endcond
#endif //OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_ #endif //OPENCV_FLANN_KDTREE_SINGLE_INDEX_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_KMEANS_INDEX_H_ #ifndef OPENCV_FLANN_KMEANS_INDEX_H_
#define OPENCV_FLANN_KMEANS_INDEX_H_ #define OPENCV_FLANN_KMEANS_INDEX_H_
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <map> #include <map>
#include <cassert> #include <cassert>
...@@ -1169,4 +1171,6 @@ private: ...@@ -1169,4 +1171,6 @@ private:
} }
//! @endcond
#endif //OPENCV_FLANN_KMEANS_INDEX_H_ #endif //OPENCV_FLANN_KMEANS_INDEX_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_LINEAR_INDEX_H_ #ifndef OPENCV_FLANN_LINEAR_INDEX_H_
#define OPENCV_FLANN_LINEAR_INDEX_H_ #define OPENCV_FLANN_LINEAR_INDEX_H_
//! @cond IGNORED
#include "general.h" #include "general.h"
#include "nn_index.h" #include "nn_index.h"
...@@ -129,4 +131,6 @@ private: ...@@ -129,4 +131,6 @@ private:
} }
//! @endcond
#endif // OPENCV_FLANN_LINEAR_INDEX_H_ #endif // OPENCV_FLANN_LINEAR_INDEX_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_LOGGER_H #ifndef OPENCV_FLANN_LOGGER_H
#define OPENCV_FLANN_LOGGER_H #define OPENCV_FLANN_LOGGER_H
//! @cond IGNORED
#include <stdio.h> #include <stdio.h>
#include <stdarg.h> #include <stdarg.h>
...@@ -132,4 +134,6 @@ private: ...@@ -132,4 +134,6 @@ private:
} }
//! @endcond
#endif //OPENCV_FLANN_LOGGER_H #endif //OPENCV_FLANN_LOGGER_H
...@@ -35,6 +35,8 @@ ...@@ -35,6 +35,8 @@
#ifndef OPENCV_FLANN_LSH_INDEX_H_ #ifndef OPENCV_FLANN_LSH_INDEX_H_
#define OPENCV_FLANN_LSH_INDEX_H_ #define OPENCV_FLANN_LSH_INDEX_H_
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <cassert> #include <cassert>
#include <cstring> #include <cstring>
...@@ -389,4 +391,6 @@ private: ...@@ -389,4 +391,6 @@ private:
}; };
} }
//! @endcond
#endif //OPENCV_FLANN_LSH_INDEX_H_ #endif //OPENCV_FLANN_LSH_INDEX_H_
...@@ -35,6 +35,8 @@ ...@@ -35,6 +35,8 @@
#ifndef OPENCV_FLANN_LSH_TABLE_H_ #ifndef OPENCV_FLANN_LSH_TABLE_H_
#define OPENCV_FLANN_LSH_TABLE_H_ #define OPENCV_FLANN_LSH_TABLE_H_
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <iostream> #include <iostream>
#include <iomanip> #include <iomanip>
...@@ -510,4 +512,6 @@ inline LshStats LshTable<unsigned char>::getStats() const ...@@ -510,4 +512,6 @@ inline LshStats LshTable<unsigned char>::getStats() const
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//! @endcond
#endif /* OPENCV_FLANN_LSH_TABLE_H_ */ #endif /* OPENCV_FLANN_LSH_TABLE_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_DATASET_H_ #ifndef OPENCV_FLANN_DATASET_H_
#define OPENCV_FLANN_DATASET_H_ #define OPENCV_FLANN_DATASET_H_
//! @cond IGNORED
#include <stdio.h> #include <stdio.h>
#include "general.h" #include "general.h"
...@@ -113,4 +115,6 @@ public: ...@@ -113,4 +115,6 @@ public:
} }
//! @endcond
#endif //OPENCV_FLANN_DATASET_H_ #endif //OPENCV_FLANN_DATASET_H_
...@@ -43,6 +43,8 @@ ...@@ -43,6 +43,8 @@
#ifndef OPENCV_MINIFLANN_HPP #ifndef OPENCV_MINIFLANN_HPP
#define OPENCV_MINIFLANN_HPP #define OPENCV_MINIFLANN_HPP
//! @cond IGNORED
#include "opencv2/core.hpp" #include "opencv2/core.hpp"
#include "opencv2/flann/defines.h" #include "opencv2/flann/defines.h"
...@@ -159,4 +161,6 @@ protected: ...@@ -159,4 +161,6 @@ protected:
} } // namespace cv::flann } } // namespace cv::flann
//! @endcond
#endif #endif
...@@ -36,6 +36,8 @@ ...@@ -36,6 +36,8 @@
#include "result_set.h" #include "result_set.h"
#include "params.h" #include "params.h"
//! @cond IGNORED
namespace cvflann namespace cvflann
{ {
...@@ -174,4 +176,6 @@ public: ...@@ -174,4 +176,6 @@ public:
} }
//! @endcond
#endif //OPENCV_FLANN_NNINDEX_H #endif //OPENCV_FLANN_NNINDEX_H
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_OBJECT_FACTORY_H_ #ifndef OPENCV_FLANN_OBJECT_FACTORY_H_
#define OPENCV_FLANN_OBJECT_FACTORY_H_ #define OPENCV_FLANN_OBJECT_FACTORY_H_
//! @cond IGNORED
#include <map> #include <map>
namespace cvflann namespace cvflann
...@@ -88,4 +90,6 @@ private: ...@@ -88,4 +90,6 @@ private:
} }
//! @endcond
#endif /* OPENCV_FLANN_OBJECT_FACTORY_H_ */ #endif /* OPENCV_FLANN_OBJECT_FACTORY_H_ */
...@@ -30,6 +30,8 @@ ...@@ -30,6 +30,8 @@
#ifndef OPENCV_FLANN_PARAMS_H_ #ifndef OPENCV_FLANN_PARAMS_H_
#define OPENCV_FLANN_PARAMS_H_ #define OPENCV_FLANN_PARAMS_H_
//! @cond IGNORED
#include "any.h" #include "any.h"
#include "general.h" #include "general.h"
#include <iostream> #include <iostream>
...@@ -95,5 +97,6 @@ inline void print_params(const IndexParams& params) ...@@ -95,5 +97,6 @@ inline void print_params(const IndexParams& params)
} }
//! @endcond
#endif /* OPENCV_FLANN_PARAMS_H_ */ #endif /* OPENCV_FLANN_PARAMS_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_RANDOM_H #ifndef OPENCV_FLANN_RANDOM_H
#define OPENCV_FLANN_RANDOM_H #define OPENCV_FLANN_RANDOM_H
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <cstdlib> #include <cstdlib>
#include <vector> #include <vector>
...@@ -152,4 +154,6 @@ public: ...@@ -152,4 +154,6 @@ public:
} }
//! @endcond
#endif //OPENCV_FLANN_RANDOM_H #endif //OPENCV_FLANN_RANDOM_H
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_RESULTSET_H #ifndef OPENCV_FLANN_RESULTSET_H
#define OPENCV_FLANN_RESULTSET_H #define OPENCV_FLANN_RESULTSET_H
//! @cond IGNORED
#include <algorithm> #include <algorithm>
#include <cstring> #include <cstring>
#include <iostream> #include <iostream>
...@@ -540,4 +542,6 @@ private: ...@@ -540,4 +542,6 @@ private:
}; };
} }
//! @endcond
#endif //OPENCV_FLANN_RESULTSET_H #endif //OPENCV_FLANN_RESULTSET_H
...@@ -30,6 +30,8 @@ ...@@ -30,6 +30,8 @@
#ifndef OPENCV_FLANN_SAMPLING_H_ #ifndef OPENCV_FLANN_SAMPLING_H_
#define OPENCV_FLANN_SAMPLING_H_ #define OPENCV_FLANN_SAMPLING_H_
//! @cond IGNORED
#include "matrix.h" #include "matrix.h"
#include "random.h" #include "random.h"
...@@ -77,5 +79,6 @@ Matrix<T> random_sample(const Matrix<T>& srcMatrix, size_t size) ...@@ -77,5 +79,6 @@ Matrix<T> random_sample(const Matrix<T>& srcMatrix, size_t size)
} // namespace } // namespace
//! @endcond
#endif /* OPENCV_FLANN_SAMPLING_H_ */ #endif /* OPENCV_FLANN_SAMPLING_H_ */
...@@ -29,6 +29,8 @@ ...@@ -29,6 +29,8 @@
#ifndef OPENCV_FLANN_SAVING_H_ #ifndef OPENCV_FLANN_SAVING_H_
#define OPENCV_FLANN_SAVING_H_ #define OPENCV_FLANN_SAVING_H_
//! @cond IGNORED
#include <cstring> #include <cstring>
#include <vector> #include <vector>
...@@ -184,4 +186,6 @@ void load_value(FILE* stream, std::vector<T>& value) ...@@ -184,4 +186,6 @@ void load_value(FILE* stream, std::vector<T>& value)
} }
//! @endcond
#endif /* OPENCV_FLANN_SAVING_H_ */ #endif /* OPENCV_FLANN_SAVING_H_ */
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_SIMPLEX_DOWNHILL_H_ #ifndef OPENCV_FLANN_SIMPLEX_DOWNHILL_H_
#define OPENCV_FLANN_SIMPLEX_DOWNHILL_H_ #define OPENCV_FLANN_SIMPLEX_DOWNHILL_H_
//! @cond IGNORED
namespace cvflann namespace cvflann
{ {
...@@ -183,4 +185,6 @@ float optimizeSimplexDownhill(T* points, int n, F func, float* vals = NULL ) ...@@ -183,4 +185,6 @@ float optimizeSimplexDownhill(T* points, int n, F func, float* vals = NULL )
} }
//! @endcond
#endif //OPENCV_FLANN_SIMPLEX_DOWNHILL_H_ #endif //OPENCV_FLANN_SIMPLEX_DOWNHILL_H_
...@@ -31,6 +31,8 @@ ...@@ -31,6 +31,8 @@
#ifndef OPENCV_FLANN_TIMER_H #ifndef OPENCV_FLANN_TIMER_H
#define OPENCV_FLANN_TIMER_H #define OPENCV_FLANN_TIMER_H
//! @cond IGNORED
#include <time.h> #include <time.h>
#include "opencv2/core.hpp" #include "opencv2/core.hpp"
#include "opencv2/core/utility.hpp" #include "opencv2/core/utility.hpp"
...@@ -91,4 +93,6 @@ public: ...@@ -91,4 +93,6 @@ public:
} }
//! @endcond
#endif // FLANN_TIMER_H #endif // FLANN_TIMER_H
...@@ -77,6 +77,8 @@ Useful links: ...@@ -77,6 +77,8 @@ Useful links:
http://www.inf.ufrgs.br/~eslgastal/DomainTransform http://www.inf.ufrgs.br/~eslgastal/DomainTransform
https://www.learnopencv.com/non-photorealistic-rendering-using-opencv-python-c/ https://www.learnopencv.com/non-photorealistic-rendering-using-opencv-python-c/
@defgroup photo_c C API
@} @}
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment