├── .gitignore ├── CMakeLists.txt ├── LICENSE ├── PyOpenPoseLib ├── CMakeLists.txt ├── OpenPoseWrapper.cpp ├── OpenPoseWrapper.h ├── PyOpenPose.cpp ├── opencv_expose.cpp └── opencv_expose.h ├── README.md ├── doc ├── CMakeLists.txt └── docu.in └── scripts ├── JustFaceNet.py ├── JustHandNet.py ├── OpLoop.py ├── OpLoop_heatmaps_example.py ├── galloping knights.jpg └── optest.ipynb /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Compiled Dynamic libraries 8 | *.so 9 | *.dylib 10 | *.dll 11 | 12 | # Compiled Static libraries 13 | *.lai 14 | *.la 15 | *.a 16 | *.lib 17 | 18 | # Executables 19 | *.exe 20 | *.out 21 | *.app 22 | .idea 23 | cmake-build-* 24 | scripts/.ipynb_checkpoints 25 | *.pyc 26 | build 27 | .vscode 28 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.5) 2 | project(PyOpenPose) 3 | 4 | set_property(GLOBAL PROPERTY USE_FOLDERS ON) 5 | set(CMAKE_CXX_STANDARD 11) 6 | include(FeatureSummary) 7 | 8 | ##### Auto configure install prefix and build mode ##### 9 | if(DEFINED ENV{PYOPENPOSE_ROOT}) 10 | message("PYOPENPOSE_ROOT is defined. Setting CMAKE_INSTALL_PREFIX to: $ENV{PYOPENPOSE_ROOT}") 11 | set(CMAKE_INSTALL_PREFIX $ENV{PYOPENPOSE_ROOT} CACHE PATH "Install path for PyOpenpose" FORCE ) 12 | endif() 13 | message("Install prefix is set to: ${CMAKE_INSTALL_PREFIX}") 14 | 15 | if(CMAKE_BUILD_TYPE STREQUAL "") 16 | set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Build type" FORCE) 17 | endif() 18 | message("Generating with build type: ${CMAKE_BUILD_TYPE}") 19 | 20 | ############### 21 | 22 | # Use at every target to make it default installable 23 | macro(make_installable project) 24 | set_target_properties(${project} PROPERTIES DEBUG_POSTFIX "D") 25 | install(TARGETS ${project} EXPORT ${project} 26 | INCLUDES DESTINATION include 27 | LIBRARY DESTINATION lib 28 | ARCHIVE DESTINATION lib 29 | RUNTIME DESTINATION bin) 30 | install(EXPORT ${project} DESTINATION cmake) 31 | endmacro() 32 | 33 | # Use for every python target to take care of peculiarities 34 | macro(pythonize project) 35 | set_target_properties(${project} PROPERTIES PREFIX "") 36 | if(WIN32) 37 | set_target_properties(${project} PROPERTIES SUFFIX ".pyd" FOLDER "Python") 38 | endif() 39 | make_installable(${project}) 40 | endmacro() 41 | 42 | if(NOT WIN32) # compile with fPIC when building static with gcc 43 | set(CUDA_NVCC_FLAGS "--compiler-options=-fPIC ${CUDA_NVCC_FLAGS}") 44 | set(CMAKE_CXX_FLAGS "-fPIC ${CMAKE_CXX_FLAGS}") 45 | set(CMAKE_C_FLAGS "-fPIC ${CMAKE_C_FLAGS}") 46 | endif() 47 | 48 | 49 | find_package(CUDA REQUIRED) 50 | find_package(OpenCV 3 REQUIRED) 51 | find_package(Doxygen) 52 | 53 | ### for python 3 use this: 54 | set(WITH_PYTHON3 False CACHE BOOL "Use Python3") 55 | set(WITH_SYSTEMBOOST True CACHE BOOL "Boost from deb package") 56 | 57 | if( NOT WITH_SYSTEMBOOST) #boost package syntax 58 | if( WITH_PYTHON3 ) 59 | find_package(Boost COMPONENTS system python3 REQUIRED) 60 | else() 61 | find_package(Boost COMPONENTS system python2 REQUIRED) 62 | endif() 63 | else() 64 | if( WITH_PYTHON3 ) 65 | find_package(Boost COMPONENTS system python-py35 REQUIRED) 66 | else() 67 | find_package(Boost COMPONENTS system python-py27 REQUIRED) 68 | endif() 69 | endif() 70 | 71 | if( WITH_PYTHON3 ) 72 | find_package(PythonLibs 3 EXACT REQUIRED) 73 | else() 74 | find_package(PythonLibs 2.7 EXACT REQUIRED) 75 | endif() 76 | 77 | 78 | 79 | 80 | # USE_CAFFE define needed by openpose headers 81 | if(DEFINED ENV{OPENPOSE_ROOT}) 82 | add_definitions("-DUSE_CAFFE") 83 | 84 | set(OPENPOSE_INCLUDE_DIRS "$ENV{OPENPOSE_ROOT}/include") 85 | set(OPENPOSE_LIBRARIES "$ENV{OPENPOSE_ROOT}/lib") 86 | set(CAFFE_INCLUDE_DIRS "$ENV{OPENPOSE_ROOT}/include") 87 | set(CAFFE_LIBRARIES "$ENV{OPENPOSE_ROOT}/lib") 88 | else() 89 | message(FATAL_ERROR "Environment variable OPENPOSE_ROOT is not set. Please set and point to openpose installation folder") 90 | endif() 91 | 92 | 93 | link_directories(${CAFFE_LIBRARIES} ${OPENPOSE_LIBRARIES}) 94 | include_directories(${OPENPOSE_INCLUDE_DIRS}) 95 | include_directories(${CAFFE_INCLUDE_DIRS}) 96 | 97 | include_directories(${OpenCV_INCLUDE_DIRS}) 98 | include_directories(${CUDA_INCLUDE_DIRS}) 99 | include_directories(${PYTHON_INCLUDE_DIRS}) 100 | 101 | feature_summary(WHAT ALL) 102 | 103 | 104 | add_subdirectory(PyOpenPoseLib) 105 | if(DOXYGEN_FOUND) 106 | add_subdirectory(doc) 107 | endif() 108 | 109 | # custom install target, needed for Clion IDE. 110 | add_custom_target(install_${PROJECT_NAME} $(MAKE) install COMMENT "Installing ${PROJECT_NAME}") 111 | 112 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD 3-Clause License 2 | 3 | Copyright (c) 2017, FORTH Computational Vision and Robotics Laboratory 4 | All rights reserved. 5 | 6 | Redistribution and use in source and binary forms, with or without 7 | modification, are permitted provided that the following conditions are met: 8 | 9 | * Redistributions of source code must retain the above copyright notice, this 10 | list of conditions and the following disclaimer. 11 | 12 | * Redistributions in binary form must reproduce the above copyright notice, 13 | this list of conditions and the following disclaimer in the documentation 14 | and/or other materials provided with the distribution. 15 | 16 | * Neither the name of the copyright holder nor the names of its 17 | contributors may be used to endorse or promote products derived from 18 | this software without specific prior written permission. 19 | 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 | -------------------------------------------------------------------------------- /PyOpenPoseLib/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | set(SOURCE_FILES OpenPoseWrapper.cpp OpenPoseWrapper.h PyOpenPose.cpp opencv_expose.h opencv_expose.cpp) 2 | add_library(PyOpenPose SHARED ${SOURCE_FILES}) 3 | 4 | target_link_libraries(PyOpenPose ${OpenCV_LIBRARIES} ${Boost_LIBRARIES} ${PYTHON_LIBRARIES} openpose caffe) 5 | 6 | pythonize(PyOpenPose) 7 | 8 | -------------------------------------------------------------------------------- /PyOpenPoseLib/OpenPoseWrapper.cpp: -------------------------------------------------------------------------------- 1 | // 2 | // Created by padeler on 21/6/2017. 3 | // 4 | 5 | #include "OpenPoseWrapper.h" 6 | 7 | #include 8 | 9 | #include 10 | #include 11 | #include 12 | 13 | #include 14 | #include 15 | #include 16 | 17 | #include 18 | 19 | #include 20 | 21 | // Detector specific paramters are here: 22 | //#include 23 | //#include 24 | //#include 25 | 26 | struct OpenPoseWrapper::PrivateData 27 | { 28 | PrivateData(const op::Point &netInputSize, const op::Point &netInputSizeFaceAndHands, 29 | const op::Point &outputSize, const op::PoseModel &poseModel, 30 | const std::string &modelFolder, int numScales, float scaleGap, float blendAlpha, 31 | const std::vector &heatMapTypes, const op::ScaleMode &heatMapScale, int gpuId, bool logging): 32 | poseExtractorCaffe{poseModel, modelFolder, gpuId, heatMapTypes, heatMapScale, false, logging}, 33 | poseRenderer{poseModel, nullptr, 0.05, true, blendAlpha}, 34 | scaleAndSizeExtractor{netInputSize, outputSize, numScales, scaleGap}, 35 | 36 | faceExtractor{netInputSizeFaceAndHands, netInputSizeFaceAndHands, modelFolder, gpuId, heatMapTypes, heatMapScale, logging}, 37 | faceRenderer{0.4}, 38 | faceDetector(poseModel), 39 | 40 | handDetector(poseModel), 41 | handRenderer{0.2}, 42 | handExtractor{netInputSizeFaceAndHands, netInputSizeFaceAndHands, modelFolder, gpuId, 1, 0.4, heatMapTypes, heatMapScale, logging} 43 | 44 | {} 45 | 46 | op::CvMatToOpInput cvMatToOpInput; 47 | op::CvMatToOpOutput cvMatToOpOutput; 48 | op::PoseExtractorCaffe poseExtractorCaffe; 49 | 50 | op::PoseGpuRenderer poseRenderer; 51 | 52 | op::FaceExtractorCaffe faceExtractor; 53 | op::FaceDetector faceDetector; 54 | op::FaceGpuRenderer faceRenderer; 55 | 56 | op::HandExtractorCaffe handExtractor; 57 | op::HandDetector handDetector; 58 | op::HandGpuRenderer handRenderer; 59 | 60 | op::OpOutputToCvMat opOutputToCvMat; 61 | op::ScaleAndSizeExtractor scaleAndSizeExtractor; 62 | }; 63 | 64 | OpenPoseWrapper::OpenPoseWrapper(const cv::Size &netPoseSize, const cv::Size &netFaceHandsSize, const cv::Size &outSize, 65 | const std::string &model, const std::string &modelFolder, const int logLevel, 66 | bool downloadHeatmaps, OpenPoseWrapper::ScaleMode scaleMode, bool withFace, bool withHands, int gpuId):withFace(withFace), withHands(withHands) { 67 | // google::InitGoogleLogging("OpenPose Wrapper"); 68 | 69 | // Step 1 - Set logging level 70 | // - 0 will output all the logging messages 71 | // - 255 will output nothing 72 | 73 | op::check(0 <= logLevel && logLevel <= 255, "Wrong logging_level value.", __LINE__, __FUNCTION__, __FILE__); 74 | op::ConfigureLog::setPriorityThreshold((op::Priority)logLevel); 75 | 76 | // Step 2 - Init params 77 | op::Point outputSize(outSize.width,outSize.height); 78 | op::Point netInputSize(netPoseSize.width,netPoseSize.height); 79 | op::Point netInputSizeFaceAndHands(netFaceHandsSize.width,netFaceHandsSize.height); 80 | 81 | op::PoseModel poseModel; 82 | 83 | op::log("", op::Priority::Low, __LINE__, __FUNCTION__, __FILE__); 84 | if (model == "COCO") 85 | poseModel = op::PoseModel::COCO_18; 86 | else if (model == "MPI") 87 | poseModel = op::PoseModel::MPI_15; 88 | else if (model == "MPI_4_layers") 89 | poseModel = op::PoseModel::MPI_15_4; 90 | else if (model == "BODY_25") 91 | poseModel = op::PoseModel::BODY_25; 92 | else 93 | { 94 | op::error("String does not correspond to any model (COCO, MPI, MPI_4_layers)", __LINE__, __FUNCTION__, __FILE__); 95 | poseModel = op::PoseModel::COCO_18; 96 | } 97 | 98 | int numScales = 1; 99 | float scaleGap = 0.3; // not used if numScales==1 100 | float blendAlpha = 0.6; 101 | 102 | //if you need to download bodypart heatmaps, Background or PAFs. They must be enabled here. 103 | std::vector hmt = {}; 104 | if(downloadHeatmaps) 105 | { 106 | hmt = {op::HeatMapType::Parts, op::HeatMapType::Background, op::HeatMapType::PAFs}; 107 | } 108 | 109 | // Step 3 - Initialize all required classes 110 | membersPtr = std::shared_ptr(new PrivateData(netInputSize, netInputSizeFaceAndHands, 111 | outputSize, poseModel, modelFolder, 112 | numScales, scaleGap, blendAlpha, 113 | hmt, (op::ScaleMode)scaleMode, gpuId, logLevel < 255)); 114 | 115 | // Step 4 - Initialize resources on desired thread (in this case single thread, i.e. we init resources here) 116 | membersPtr->poseExtractorCaffe.initializationOnThread(); 117 | membersPtr->poseRenderer.initializationOnThread(); 118 | if(withFace) { 119 | membersPtr->faceExtractor.initializationOnThread(); 120 | membersPtr->faceRenderer.initializationOnThread(); 121 | } 122 | if(withHands) { 123 | membersPtr->handExtractor.initializationOnThread(); 124 | membersPtr->handRenderer.initializationOnThread(); 125 | } 126 | } 127 | 128 | void OpenPoseWrapper::detectPose(const cv::Mat &rgb) { 129 | // Step 2 - Format input image to OpenPose input and output formats 130 | 131 | const op::Point imageSize{rgb.cols, rgb.rows}; 132 | std::vector scaleInputToNetInputs; 133 | std::vector> netInputSizes; 134 | double scaleInputToOutput; 135 | op::Point outputResolution; 136 | std::tie(scaleInputToNetInputs, netInputSizes, scaleInputToOutput, outputResolution) 137 | = membersPtr->scaleAndSizeExtractor.extract(imageSize); 138 | std::vector> netInputArray = membersPtr->cvMatToOpInput.createArray(rgb, scaleInputToNetInputs, netInputSizes); 139 | 140 | // Step 3 - Estimate poseKeypoints 141 | membersPtr->poseExtractorCaffe.forwardPass(netInputArray, imageSize, scaleInputToNetInputs); 142 | } 143 | 144 | void OpenPoseWrapper::detectFace(const cv::Mat &rgb) { 145 | if(!withFace) 146 | { 147 | BOOST_THROW_EXCEPTION(std::runtime_error("Face network was not initialized.")); 148 | } 149 | const auto poseKeypoints = membersPtr->poseExtractorCaffe.getPoseKeypoints(); 150 | const auto faceRectsOP = membersPtr->faceDetector.detectFaces(poseKeypoints); 151 | 152 | this->faceRects = cv::Mat(faceRectsOP.size(), 4, CV_32SC1, cv::Scalar(0)); 153 | cv::Mat fr = this->faceRects.reshape(4,faceRects.rows); // stupid cv::Mat iterator cannot iterate over rows. 154 | std::transform(faceRectsOP.begin(), faceRectsOP.end(), fr.begin(), [](const op::Rectangle &r) -> cv::Vec4i { return cv::Vec4i(r.x, r.y, r.width, r.height);}); 155 | 156 | membersPtr->faceExtractor.forwardPass(faceRectsOP, rgb); 157 | } 158 | 159 | void OpenPoseWrapper::detectFace(const cv::Mat &rgb, const cv::Mat &faceRects) 160 | { 161 | if(!withFace) 162 | { 163 | BOOST_THROW_EXCEPTION(std::runtime_error("Face network was not initialized.")); 164 | } 165 | if(faceRects.cols!=4 or faceRects.type()!=CV_32SC1) 166 | { 167 | BOOST_THROW_EXCEPTION(std::runtime_error("Invalid face rectangles format. Expected Nx4 mat with type CV_32SC1")); 168 | } 169 | 170 | this->faceRects = faceRects; // keep a copy 171 | std::vector > faceRectsOP(faceRects.rows); 172 | cv::Mat fr = faceRects.reshape(4,faceRects.rows); // stupid cv::Mat iterator cannot iterate over rows. 173 | std::transform(fr.begin(), fr.end(), faceRectsOP.begin(), 174 | [](const cv::Vec4i &r) -> op::Rectangle { return op::Rectangle(r[0], r[1], r[2], r[3]);}); 175 | 176 | membersPtr->faceExtractor.forwardPass(faceRectsOP, rgb); 177 | } 178 | 179 | void OpenPoseWrapper::detectHands(const cv::Mat &rgb) { 180 | if(!withHands) 181 | { 182 | BOOST_THROW_EXCEPTION(std::runtime_error("Hand network was not initialized.")); 183 | } 184 | 185 | const auto poseKeypoints = membersPtr->poseExtractorCaffe.getPoseKeypoints(); 186 | const auto handRectsOP = membersPtr->handDetector.detectHands(poseKeypoints); 187 | 188 | this->handRects= cv::Mat(handRectsOP.size(), 8, CV_32SC1, cv::Scalar(0)); 189 | cv::Mat hr = this->handRects.reshape(8,handRects.rows); // stupid cv::Mat iterator cannot iterate over rows. 190 | std::transform(handRectsOP.begin(), handRectsOP.end(), hr.begin(), 191 | [](const std::array, 2> &r) -> cv::Vec8i 192 | { return cv::Vec8i(r[0].x, r[0].y, r[0].width, r[0].height, r[1].x, r[1].y, r[1].width, r[1].height); }); 193 | 194 | membersPtr->handExtractor.forwardPass(handRectsOP, rgb); 195 | } 196 | 197 | void OpenPoseWrapper::detectHands(const cv::Mat &rgb, const cv::Mat &handRects) 198 | { 199 | if(!withHands) 200 | { 201 | BOOST_THROW_EXCEPTION(std::runtime_error("Hand network was not initialized.")); 202 | } 203 | if(handRects.cols!=8 or handRects.type()!=CV_32SC1) 204 | { 205 | BOOST_THROW_EXCEPTION(std::runtime_error("Invalid hand rectangles format. Expected Nx8 mat with type CV_32SC1")); 206 | } 207 | 208 | this->handRects = handRects; 209 | std::vector, 2> > handRectsOP(handRects.rows); 210 | cv::Mat hr = handRects.reshape(8,handRects.rows); // stupid cv::Mat iterator cannot iterate over rows. 211 | std::transform(hr.begin(), hr.end(), handRectsOP.begin(), 212 | [](const cv::Vec8i &r) -> std::array, 2> 213 | { return std::array, 2>{op::Rectangle(r[0], r[1], r[2], r[3]), op::Rectangle(r[4], r[5], r[6], r[7])};}); 214 | 215 | membersPtr->handExtractor.forwardPass(handRectsOP, rgb); 216 | } 217 | 218 | cv::Mat OpenPoseWrapper::render(const cv::Mat &rgb) 219 | { 220 | op::Array outputArray; 221 | 222 | const op::Point imageSize{rgb.cols, rgb.rows}; 223 | std::vector scaleInputToNetInputs; 224 | std::vector> netInputSizes; 225 | double scaleInputToOutput; 226 | op::Point outputResolution; 227 | std::tie(scaleInputToNetInputs, netInputSizes, scaleInputToOutput, outputResolution) 228 | = membersPtr->scaleAndSizeExtractor.extract(imageSize); 229 | 230 | outputArray = membersPtr->cvMatToOpOutput.createArray(rgb, scaleInputToOutput, outputResolution); 231 | 232 | const auto poseKeypoints = membersPtr->poseExtractorCaffe.getPoseKeypoints(); 233 | membersPtr->poseRenderer.renderPose(outputArray, poseKeypoints, scaleInputToOutput); 234 | 235 | if(withFace){ 236 | const auto faceKeypoints = membersPtr->faceExtractor.getFaceKeypoints(); 237 | membersPtr->faceRenderer.renderFace(outputArray, faceKeypoints, 1.0); 238 | } 239 | if(withHands) { 240 | const auto handKeypoints = membersPtr->handExtractor.getHandKeypoints(); 241 | membersPtr->handRenderer.renderHand(outputArray, handKeypoints, 1.0); 242 | } 243 | 244 | auto outputImage = membersPtr->opOutputToCvMat.formatToCvMat(outputArray); 245 | return outputImage; 246 | } 247 | 248 | OpenPoseWrapper::KeypointGroups OpenPoseWrapper::getKeypoints(KeypointType kpt) { 249 | 250 | op::Array faces,persons; 251 | std::array, 2> hands; 252 | 253 | KeypointGroups res; 254 | switch(kpt){ 255 | case FACE: 256 | faces = membersPtr->faceExtractor.getFaceKeypoints(); 257 | res.push_back(faces.getConstCvMat()); // all faces in a cv::Mat at index 0 258 | break; 259 | case HAND: 260 | hands = membersPtr->handExtractor.getHandKeypoints(); 261 | res.push_back(hands[0].getConstCvMat()); // left hands cv::Mat 262 | res.push_back(hands[1].getConstCvMat()); // right hands cv::Mat 263 | break; 264 | default: // POSE 265 | persons = membersPtr->poseExtractorCaffe.getPoseKeypoints(); 266 | res.push_back(persons.getConstCvMat()); // all persons in a cv::Mat at index 0 267 | break; 268 | } 269 | 270 | return res; 271 | } 272 | 273 | cv::Mat OpenPoseWrapper::getHeatmaps() { 274 | op::Array maps = membersPtr->poseExtractorCaffe.getHeatMapsCopy(); 275 | return maps.getConstCvMat().clone(); 276 | } 277 | 278 | 279 | std::vector OpenPoseWrapper::getHandHeatmaps() { 280 | 281 | std::array, 2> maps = membersPtr->handExtractor.getHeatMaps(); 282 | 283 | std::vector res; 284 | res.push_back(maps.at(0).getConstCvMat().clone()); 285 | res.push_back(maps.at(1).getConstCvMat().clone()); 286 | return res; 287 | } 288 | 289 | cv::Mat OpenPoseWrapper::getFaceHeatmaps() { 290 | op::Array maps = membersPtr->faceExtractor.getHeatMaps(); 291 | return maps.getConstCvMat().clone(); 292 | } 293 | -------------------------------------------------------------------------------- /PyOpenPoseLib/OpenPoseWrapper.h: -------------------------------------------------------------------------------- 1 | // 2 | // Created by padeler on 21/6/2017. 3 | // 4 | 5 | #ifndef PYOPENPOSE_OPENPOSEWRAPPER_H 6 | #define PYOPENPOSE_OPENPOSEWRAPPER_H 7 | 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | 14 | 15 | class OpenPoseWrapper { 16 | 17 | 18 | public: 19 | typedef std::shared_ptr Ptr; 20 | typedef std::vector KeypointGroups; 21 | 22 | enum class ScaleMode : unsigned char 23 | { 24 | InputResolution, 25 | NetOutputResolution, 26 | OutputResolution, 27 | ZeroToOne, // [0, 1] 28 | PlusMinusOne, // [-1, 1] 29 | UnsignedChar, // [0, 255] 30 | }; 31 | 32 | enum KeypointType { POSE, FACE, HAND }; 33 | 34 | /** 35 | * Openpose wrapper constructor. 36 | * @param netPoseSize Body pose network input size 37 | * @param netFaceHandsSize Face and Hands networks input size 38 | * @param outputSize The output joint positions is rescaled to this size. 39 | * @param model The model to be used to the body pose estimation 40 | * @param modelFolder Folder containing the models for body pose, hands and faces (open pose models folder) 41 | * @param logLevel Openpose loglevel parameter 42 | * @param downloadHeatmaps If False the heatmaps wont be downloaded from GPU mem. 43 | * @param heatMapScaleMode The scale mode of the output heatmaps @see ScaleMode 44 | * @param withFace Initialize the network for face pose detection 45 | * @param withHands Initialize the network for hand pose detection 46 | */ 47 | OpenPoseWrapper(const cv::Size &netPoseSize = cv::Size(320, 240), const cv::Size &netFaceHandsSize = cv::Size(128,128), 48 | const cv::Size &outputSize = cv::Size(640,480), 49 | const std::string &model="COCO", const std::string &modelFolder="models/", const int logLevel=255, 50 | bool downloadHeatmaps=false, 51 | OpenPoseWrapper::ScaleMode heatMapScaleMode = OpenPoseWrapper::ScaleMode::ZeroToOne, 52 | bool withFace=true, bool withHands=true, int gpuId=0); 53 | 54 | /** 55 | * Detect body poses in given image 56 | * @param rgb input image 57 | */ 58 | void detectPose(const cv::Mat &rgb); 59 | 60 | /** 61 | * Detect faces in given image. 62 | * You need to call the @refitem detectPose with the same image first. 63 | * 64 | * @param rgb input image 65 | */ 66 | void detectFace(const cv::Mat &rgb); 67 | 68 | /** 69 | * Detect faces in given image. 70 | * The network is only run in the supplied rectangles 71 | * You don't have to call the @refitem detectPose first. 72 | * 73 | * @param rgb input image 74 | * @param faceRects bounding boxes with the hand positions in the image. Nx4 cv::Mat with type CV_32SC1. 75 | * One row per person, Each row is a bounding box [x,y,width,height] . 76 | */ 77 | void detectFace(const cv::Mat &rgb, const cv::Mat &faceRects); 78 | 79 | /** 80 | * Detect hands in given image. 81 | * The network is only run in the supplied rectangles 82 | * You don't have to call the @refitem detectPose first. 83 | * 84 | * @param rgb input image 85 | * @param handRects bounding boxes with the hand positions in the image. Nx8 cv::Mat with type CV_32SC1. 86 | * Each row corresponds to a person. Each row represents two bounding rectangles of the form: 87 | * [ leftX, leftY, leftWidth, leftHeight, rightX, rightY, rightWidth, rightHeight] 88 | */ 89 | void detectHands(const cv::Mat &rgb, const cv::Mat &handRects); 90 | 91 | 92 | /** 93 | * Detect hands in given image. 94 | * You need to call the @refitem detectPose with the same image first. 95 | * 96 | * @param rgb input image 97 | */ 98 | void detectHands(const cv::Mat &rgb); 99 | 100 | 101 | /** 102 | * Uses the visualization tools of Openpose to render detected keypoints on the input rgb image 103 | * @param rgb input image 104 | * @return the input image with the keypoints and skeletons rendered on it. 105 | */ 106 | cv::Mat render(const cv::Mat &rgb); 107 | 108 | /** 109 | * Returns the keypoints of a given type. 110 | * @param t the keypointtype @see KeypointType 111 | * @return A vector of cv::Mat. The vector has a single entry for t=POSE and t=FACE and two entries for t==HAND. 112 | * For hands the first entry is a Mat with all left hands, and the second is a Mat with all the right hands. 113 | * The dimensions of each mat is NxKx3. N is the number of item detected (i.e number of FACEs if t=FACE). 114 | * K is the number of keypoitns (i.e 21 if t=HAND). The last dimension is the X,Y coordinates of the keypoint and 115 | * its score. 116 | */ 117 | KeypointGroups getKeypoints(KeypointType t=POSE); 118 | 119 | /** 120 | * Returns the heatmaps and PAFs generated by the POSE network. 121 | * @return a multichannel cv::Mat, each channel corresponds to a different headmap. Each PAF is represented by two 122 | * consecutive channels one for each dimension of the PAF. 123 | */ 124 | cv::Mat getHeatmaps(); 125 | 126 | /** 127 | * Returns the hand rectangles (bouding boxes) used during the the 128 | * last network forward pass (i.e last call to detectHands) 129 | * 130 | * The rectangles are stored in a cv::Mat with N rows by 8 columns. 131 | * Each row corresponds to a person. 132 | * Each row represents two bounding rectangles of the form: 133 | * [ leftX, leftY, leftWidth, leftHeight, rightX, rightY, rightWidth, rightHeight] 134 | * if width or height is zero, the corresponding rectangle is ignored. 135 | * Check the openpose source (handExtractor::forwardPass for more details) 136 | * 137 | * @return a cv::Mat Nx8. Each row holds two rectangles, one for the left and one for the right hand. 138 | */ 139 | const cv::Mat getHandRects() const { 140 | return handRects; 141 | } 142 | 143 | /** 144 | * Returns the face rectangles (bouding boxes) used during the the 145 | * last network forward pass (i.e last call to detectFace) 146 | * The rectangles are stored in a cv::Mat with N rows and 4 columns. 147 | * Each row represents a bounding rectangle of the form: 148 | * [ faceX, faceY, faceWidth, faceHeight] 149 | * Faces with area less than 40 (faceWidth*faceHeight<40) are ignored. 150 | * Check the openpose source (faceExtractor::forwardPass for more details) 151 | * @return a vector of rectangles, one for each face. 152 | */ 153 | const cv::Mat getFaceRects() const { 154 | return faceRects; 155 | } 156 | 157 | 158 | /** 159 | * Returns a vector of length 2. 160 | * Index 0 holds all left hands detected. 161 | * Index 1 holds all right hands detected. 162 | * @return all the hands (left and right) of all persons detected during the last call. 163 | */ 164 | std::vector getHandHeatmaps(); 165 | 166 | /** 167 | * Get all face heatmaps for all persons detected. 168 | * @return a cv::Mat with all heatmaps for all persons. 169 | */ 170 | cv::Mat getFaceHeatmaps(); 171 | 172 | private: 173 | struct PrivateData; 174 | std::shared_ptr membersPtr; 175 | 176 | bool withFace, withHands; 177 | 178 | // N rows by 8 columns. Each row corresponds to a person. 179 | // Each row represents two bounding rectangles of the form: 180 | // [ leftX, leftY, leftWidth, leftHeight, rightX, rightY, rightWidth, rightHeight] 181 | // if width or height is zero, the corresponding rectangle is ignored. 182 | cv::Mat handRects; 183 | 184 | // N rows by 4 columns. Each row corresponds to a person. 185 | // Each row represents a bounding rectangle of the form: 186 | // [ faceX, faceY, faceWidth, faceHeight] 187 | cv::Mat faceRects; 188 | 189 | }; 190 | 191 | 192 | #endif //PYOPENPOSE_OPENPOSEWRAPPER_H 193 | -------------------------------------------------------------------------------- /PyOpenPoseLib/PyOpenPose.cpp: -------------------------------------------------------------------------------- 1 | // 2 | // Created by padeler on 21/6/2017. 3 | // 4 | #include 5 | #include "OpenPoseWrapper.h" 6 | #include "opencv_expose.h" 7 | 8 | 9 | 10 | 11 | #if defined(DEBUG) || defined(_DEBUG) 12 | # define OPENPOSE_MODULE_NAME PyOpenPoseD 13 | # define OPENPOSE_MODULE_NAME_STR "PyOpenPoseD" 14 | #else 15 | # define OPENPOSE_MODULE_NAME PyOpenPose 16 | # define OPENPOSE_MODULE_NAME_STR "PyOpenPose" 17 | #endif 18 | 19 | namespace bpy = boost::python; 20 | 21 | 22 | BOOST_PYTHON_MODULE(OPENPOSE_MODULE_NAME) 23 | { 24 | bpy::return_value_policy ref_existing; 25 | 26 | // expose opencv cv::Mat and cv::Size 27 | expose_opencv(); 28 | 29 | void (OpenPoseWrapper::*detectFace1)(const cv::Mat &rgb) = &OpenPoseWrapper::detectFace; 30 | void (OpenPoseWrapper::*detectFace2)(const cv::Mat &rgb, const cv::Mat &faceRects) = &OpenPoseWrapper::detectFace; 31 | void (OpenPoseWrapper::*detectHands1)(const cv::Mat &rgb) = &OpenPoseWrapper::detectHands; 32 | void (OpenPoseWrapper::*detectHands2)(const cv::Mat &rgb, const cv::Mat &handRects) = &OpenPoseWrapper::detectHands; 33 | 34 | // OpenPose wrapper 35 | bpy::scope s = 36 | bpy::class_("OpenPose") 37 | .def(bpy::init<>()) 38 | .def(bpy::init()) 39 | .def(bpy::init()) 40 | .def(bpy::init()) 41 | .def(bpy::init()) 42 | .def(bpy::init()) 43 | .def(bpy::init()) 44 | .def(bpy::init()) 45 | .def("detectPose", &OpenPoseWrapper::detectPose) 46 | .def("detectFace", detectFace1) 47 | .def("detectFace", detectFace2) 48 | .def("detectHands", detectHands1) 49 | .def("detectHands", detectHands2) 50 | .def("render", &OpenPoseWrapper::render) 51 | .def("getKeypoints", &OpenPoseWrapper::getKeypoints) 52 | .def("getHeatmaps", &OpenPoseWrapper::getHeatmaps) 53 | .def("getHandHeatmaps", &OpenPoseWrapper::getHandHeatmaps) 54 | .def("getFaceHeatmaps", &OpenPoseWrapper::getFaceHeatmaps) 55 | .add_property("handRects", &OpenPoseWrapper::getHandRects) 56 | .add_property("faceRects", &OpenPoseWrapper::getFaceRects) 57 | ; 58 | 59 | s.attr("KeypointType") = bpy::enum_("KeypointType") 60 | .value("POSE", OpenPoseWrapper::POSE) 61 | .value("FACE", OpenPoseWrapper::FACE) 62 | .value("HAND", OpenPoseWrapper::HAND) 63 | ; 64 | 65 | s.attr("ScaleMode") = bpy::enum_("ScaleMode") 66 | .value("InputResolution", OpenPoseWrapper::ScaleMode::InputResolution) 67 | .value("NetOutputResolution", OpenPoseWrapper::ScaleMode::NetOutputResolution) 68 | .value("OutputResolution", OpenPoseWrapper::ScaleMode::OutputResolution) 69 | .value("ZeroToOne", OpenPoseWrapper::ScaleMode::ZeroToOne) 70 | .value("PlusMinusOne", OpenPoseWrapper::ScaleMode::PlusMinusOne) 71 | .value("UnsignedChar", OpenPoseWrapper::ScaleMode::UnsignedChar) 72 | ; 73 | } 74 | -------------------------------------------------------------------------------- /PyOpenPoseLib/opencv_expose.cpp: -------------------------------------------------------------------------------- 1 | // 2 | // Created by padeler on 3/8/2017. 3 | // 4 | /** 5 | * Code adapted for PyOpenPose from opencv cv2.cpp for use with boost::python 6 | */ 7 | 8 | #include "opencv_expose.h" 9 | 10 | #include 11 | 12 | #define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION 13 | #include 14 | 15 | #include 16 | 17 | 18 | namespace bpy = boost::python; 19 | using namespace cv; 20 | 21 | static PyObject* opencv_error = 0; 22 | 23 | 24 | int initialize_array() 25 | { 26 | // XXX This is needed to initialize numpy. Otherwise: Silent segfault 27 | static bool init = false; 28 | if(!init) 29 | { 30 | init = true; 31 | import_array1(0); 32 | #if BOOST_VERSION < 106500 33 | bpy::numeric::array::set_module_and_type("numpy", "ndarray"); 34 | #endif 35 | return 0; 36 | } 37 | return 1; 38 | } 39 | 40 | 41 | static int failmsg(const char *fmt, ...) 42 | { 43 | char str[1000]; 44 | 45 | va_list ap; 46 | va_start(ap, fmt); 47 | vsnprintf(str, sizeof(str), fmt, ap); 48 | va_end(ap); 49 | 50 | PyErr_SetString(PyExc_TypeError, str); 51 | return 0; 52 | } 53 | 54 | class PyAllowThreads 55 | { 56 | public: 57 | PyAllowThreads() : _state(PyEval_SaveThread()) {} 58 | ~PyAllowThreads() 59 | { 60 | PyEval_RestoreThread(_state); 61 | } 62 | private: 63 | PyThreadState* _state; 64 | }; 65 | 66 | 67 | class PyEnsureGIL 68 | { 69 | public: 70 | PyEnsureGIL() : _state(PyGILState_Ensure()) {} 71 | ~PyEnsureGIL() 72 | { 73 | PyGILState_Release(_state); 74 | } 75 | private: 76 | PyGILState_STATE _state; 77 | }; 78 | 79 | #define ERRWRAP2(expr) \ 80 | try \ 81 | { \ 82 | PyAllowThreads allowThreads; \ 83 | expr; \ 84 | } \ 85 | catch (const cv::Exception &e) \ 86 | { \ 87 | PyErr_SetString(opencv_error, e.what()); \ 88 | return 0; \ 89 | } 90 | 91 | 92 | class NumpyAllocator : public MatAllocator 93 | { 94 | public: 95 | NumpyAllocator() { stdAllocator = Mat::getStdAllocator(); } 96 | ~NumpyAllocator() {} 97 | 98 | UMatData* allocate(PyObject* o, int dims, const int* sizes, int type, size_t* step) const 99 | { 100 | UMatData* u = new UMatData(this); 101 | u->data = u->origdata = (uchar*)PyArray_DATA((PyArrayObject*)o); 102 | npy_intp* _strides = PyArray_STRIDES((PyArrayObject*)o); 103 | for (int i = 0; i < dims - 1; i++) 104 | step[i] = (size_t)_strides[i]; 105 | step[dims - 1] = CV_ELEM_SIZE(type); 106 | u->size = sizes[0] * step[0]; 107 | u->userdata = o; 108 | return u; 109 | } 110 | 111 | UMatData* allocate(int dims0, const int* sizes, int type, void* data, size_t* step, int flags, UMatUsageFlags usageFlags) const 112 | { 113 | if (data != 0) 114 | { 115 | CV_Error(Error::StsAssert, "The data should normally be nullptr!"); 116 | // probably this is safe to do in such extreme case 117 | return stdAllocator->allocate(dims0, sizes, type, data, step, flags, usageFlags); 118 | } 119 | PyEnsureGIL gil; 120 | 121 | int depth = CV_MAT_DEPTH(type); 122 | int cn = CV_MAT_CN(type); 123 | const int f = (int)(sizeof(size_t) / 8); 124 | int typenum = depth == CV_8U ? NPY_UBYTE : depth == CV_8S ? NPY_BYTE : 125 | depth == CV_16U ? NPY_USHORT : depth == CV_16S ? NPY_SHORT : 126 | depth == CV_32S ? NPY_INT : depth == CV_32F ? NPY_FLOAT : 127 | depth == CV_64F ? NPY_DOUBLE : f*NPY_ULONGLONG + (f ^ 1)*NPY_UINT; 128 | int i, dims = dims0; 129 | cv::AutoBuffer _sizes(dims + 1); 130 | for (i = 0; i < dims; i++) 131 | _sizes[i] = sizes[i]; 132 | if (cn > 1) 133 | _sizes[dims++] = cn; 134 | PyObject* o = PyArray_SimpleNew(dims, _sizes, typenum); 135 | if (!o) 136 | CV_Error_(Error::StsError, ("The numpy array of typenum=%d, ndims=%d can not be created", typenum, dims)); 137 | return allocate(o, dims0, sizes, type, step); 138 | } 139 | 140 | bool allocate(UMatData* u, int accessFlags, UMatUsageFlags usageFlags) const 141 | { 142 | return stdAllocator->allocate(u, accessFlags, usageFlags); 143 | } 144 | 145 | void deallocate(UMatData* u) const 146 | { 147 | if (!u) 148 | return; 149 | PyEnsureGIL gil; 150 | CV_Assert(u->urefcount >= 0); 151 | CV_Assert(u->refcount >= 0); 152 | if (u->refcount == 0) 153 | { 154 | PyObject* o = (PyObject*)u->userdata; 155 | Py_XDECREF(o); 156 | delete u; 157 | } 158 | } 159 | 160 | const MatAllocator* stdAllocator; 161 | }; 162 | 163 | NumpyAllocator g_numpyAllocator; 164 | 165 | 166 | static PyObject* pyopencv_from(const cv::Mat& m) 167 | { 168 | if (!m.data) 169 | Py_RETURN_NONE; 170 | Mat temp, *p = (Mat*)&m; 171 | if (!p->u || p->allocator != &g_numpyAllocator) 172 | { 173 | temp.allocator = &g_numpyAllocator; 174 | ERRWRAP2(m.copyTo(temp)); 175 | p = &temp; 176 | } 177 | PyObject* o = (PyObject*)p->u->userdata; 178 | Py_INCREF(o); 179 | return o; 180 | } 181 | 182 | static bool pyopencv_to(PyObject* o, Mat& m, const char* name = "") 183 | { 184 | bool allowND = true; 185 | if (!o || o == Py_None) 186 | { 187 | if (!m.data) 188 | m.allocator = &g_numpyAllocator; 189 | return true; 190 | } 191 | 192 | if (PyInt_Check(o)) 193 | { 194 | double v[] = { static_cast(PyInt_AsLong((PyObject*)o)), 0., 0., 0. }; 195 | m = Mat(4, 1, CV_64F, v).clone(); 196 | return true; 197 | } 198 | if (PyFloat_Check(o)) 199 | { 200 | double v[] = { PyFloat_AsDouble((PyObject*)o), 0., 0., 0. }; 201 | m = Mat(4, 1, CV_64F, v).clone(); 202 | return true; 203 | } 204 | if (PyTuple_Check(o)) 205 | { 206 | int i, sz = (int)PyTuple_Size((PyObject*)o); 207 | m = Mat(sz, 1, CV_64F); 208 | for (i = 0; i < sz; i++) 209 | { 210 | PyObject* oi = PyTuple_GET_ITEM(o, i); 211 | if (PyInt_Check(oi)) 212 | m.at(i) = (double)PyInt_AsLong(oi); 213 | else if (PyFloat_Check(oi)) 214 | m.at(i) = (double)PyFloat_AsDouble(oi); 215 | else 216 | { 217 | failmsg("%s is not a numerical tuple", name); 218 | m.release(); 219 | return false; 220 | } 221 | } 222 | return true; 223 | } 224 | 225 | if (!PyArray_Check(o)) 226 | { 227 | failmsg("%s is not a numpy array, neither a scalar", name); 228 | return false; 229 | } 230 | 231 | PyArrayObject* oarr = (PyArrayObject*)o; 232 | 233 | bool needcopy = false, needcast = false; 234 | int typenum = PyArray_TYPE(oarr), new_typenum = typenum; 235 | int type = typenum == NPY_UBYTE ? CV_8U : 236 | typenum == NPY_BYTE ? CV_8S : 237 | typenum == NPY_USHORT ? CV_16U : 238 | typenum == NPY_SHORT ? CV_16S : 239 | typenum == NPY_INT ? CV_32S : 240 | typenum == NPY_INT32 ? CV_32S : 241 | typenum == NPY_FLOAT ? CV_32F : 242 | typenum == NPY_DOUBLE ? CV_64F : -1; 243 | 244 | if (type < 0) 245 | { 246 | if (typenum == NPY_INT64 || typenum == NPY_UINT64 || typenum == NPY_LONG) 247 | { 248 | needcopy = needcast = true; 249 | new_typenum = NPY_INT; 250 | type = CV_32S; 251 | } 252 | else 253 | { 254 | failmsg("%s data type = %d is not supported", name, typenum); 255 | return false; 256 | } 257 | } 258 | 259 | #ifndef CV_MAX_DIM 260 | const int CV_MAX_DIM = 32; 261 | #endif 262 | 263 | int ndims = PyArray_NDIM(oarr); 264 | if (ndims >= CV_MAX_DIM) 265 | { 266 | failmsg("%s dimensionality (=%d) is too high", name, ndims); 267 | return false; 268 | } 269 | 270 | int size[CV_MAX_DIM + 1]; 271 | size_t step[CV_MAX_DIM + 1]; 272 | size_t elemsize = CV_ELEM_SIZE1(type); 273 | const npy_intp* _sizes = PyArray_DIMS(oarr); 274 | const npy_intp* _strides = PyArray_STRIDES(oarr); 275 | bool ismultichannel = ndims == 3 && _sizes[2] <= CV_CN_MAX; 276 | 277 | for (int i = ndims - 1; i >= 0 && !needcopy; i--) 278 | { 279 | // these checks handle cases of 280 | // a) multi-dimensional (ndims > 2) arrays, as well as simpler 1- and 2-dimensional cases 281 | // b) transposed arrays, where _strides[] elements go in non-descending order 282 | // c) flipped arrays, where some of _strides[] elements are negative 283 | // the _sizes[i] > 1 is needed to avoid spurious copies when NPY_RELAXED_STRIDES is set 284 | if ((i == ndims - 1 && _sizes[i] > 1 && (size_t)_strides[i] != elemsize) || 285 | (i < ndims - 1 && _sizes[i] > 1 && _strides[i] < _strides[i + 1])) 286 | needcopy = true; 287 | } 288 | 289 | if (ismultichannel && _strides[1] != (npy_intp)elemsize*_sizes[2]) 290 | needcopy = true; 291 | 292 | if (needcopy) 293 | { 294 | if (needcast) { 295 | o = PyArray_Cast(oarr, new_typenum); 296 | oarr = (PyArrayObject*)o; 297 | } 298 | else { 299 | oarr = PyArray_GETCONTIGUOUS(oarr); 300 | o = (PyObject*)oarr; 301 | } 302 | 303 | _strides = PyArray_STRIDES(oarr); 304 | } 305 | 306 | // Normalize strides in case NPY_RELAXED_STRIDES is set 307 | size_t default_step = elemsize; 308 | for (int i = ndims - 1; i >= 0; --i) 309 | { 310 | size[i] = (int)_sizes[i]; 311 | if (size[i] > 1) 312 | { 313 | step[i] = (size_t)_strides[i]; 314 | default_step = step[i] * size[i]; 315 | } 316 | else 317 | { 318 | step[i] = default_step; 319 | default_step *= size[i]; 320 | } 321 | } 322 | 323 | // handle degenerate case 324 | if (ndims == 0) { 325 | size[ndims] = 1; 326 | step[ndims] = elemsize; 327 | ndims++; 328 | } 329 | 330 | if (ismultichannel) 331 | { 332 | ndims--; 333 | type |= CV_MAKETYPE(0, size[2]); 334 | } 335 | 336 | if (ndims > 2 && !allowND) 337 | { 338 | failmsg("%s has more than 2 dimensions", name); 339 | return false; 340 | } 341 | 342 | m = Mat(ndims, size, type, PyArray_DATA(oarr), step); 343 | m.u = g_numpyAllocator.allocate(o, ndims, size, type, step); 344 | m.addref(); 345 | 346 | if (!needcopy) 347 | { 348 | Py_INCREF(o); 349 | } 350 | m.allocator = &g_numpyAllocator; 351 | 352 | return true; 353 | } 354 | 355 | 356 | struct PythonConverterForSize 357 | { 358 | PythonConverterForSize() 359 | { 360 | bpy::converter::registry::push_back( 361 | &convertible, 362 | &construct, 363 | bpy::type_id()); 364 | bpy::to_python_converter(); 365 | } 366 | 367 | static PyObject* convert(const cv::Size &t) 368 | { 369 | return Py_BuildValue("(ii)", t.width, t.height); 370 | } 371 | 372 | static bool pyopencv_to(PyObject* obj, cv::Size& sz) 373 | { 374 | if (!obj || obj == Py_None) 375 | return true; 376 | return PyArg_ParseTuple(obj, "ii", &sz.width, &sz.height) > 0; 377 | } 378 | 379 | static void* convertible(PyObject *obj) 380 | { 381 | cv::Size tmp; 382 | return pyopencv_to(obj, tmp) ? obj : nullptr; 383 | } 384 | 385 | static void construct(PyObject * obj, bpy::converter::rvalue_from_python_stage1_data* data) 386 | { 387 | cv::Size *t = new cv::Size; 388 | pyopencv_to(obj, *t); 389 | data->convertible = t; 390 | } 391 | }; 392 | 393 | struct PythonConverterForMat 394 | { 395 | PythonConverterForMat() 396 | { 397 | bpy::converter::registry::push_back( 398 | &convertible, 399 | &construct, 400 | bpy::type_id()); 401 | bpy::to_python_converter(); 402 | } 403 | 404 | 405 | 406 | static PyObject* convert(const cv::Mat& m) 407 | { 408 | initialize_array(); 409 | return pyopencv_from(m); 410 | } 411 | 412 | static bool is_convertible(const bpy::object &o) 413 | { 414 | return PyArray_Check(o.ptr()); 415 | } 416 | 417 | // Convert obj_ptr into a QString 418 | static void construct_from(const bpy::object &o, cv::Mat *storage) 419 | { 420 | cv::Mat value; 421 | pyopencv_to(o.ptr(), value); 422 | new (storage) cv::Mat(value); 423 | } 424 | 425 | static void * convertible(PyObject *obj) 426 | { 427 | return is_convertible(bpy::object(bpy::handle<>(bpy::borrowed(obj)))) ? obj : 0; 428 | } 429 | 430 | static void construct(PyObject *obj, bpy::converter::rvalue_from_python_stage1_data *data) 431 | { 432 | void *storage = ((bpy::converter::rvalue_from_python_storage*)data)->storage.bytes; 433 | construct_from(bpy::object(bpy::handle<>(bpy::borrowed(obj))), (cv::Mat*)storage); 434 | data->convertible = storage; 435 | } 436 | }; 437 | 438 | struct MatVectorToPython 439 | { 440 | static PyObject* pyopencv_from_vec(const std::vector& value) 441 | { 442 | int i, n = (int)value.size(); 443 | PyObject* seq = PyList_New(n); 444 | for (i = 0; i < n; i++) 445 | { 446 | PyObject* item = pyopencv_from(value[i]); 447 | if (!item) 448 | break; 449 | PyList_SET_ITEM(seq, i, item); 450 | } 451 | if (i < n) 452 | { 453 | Py_DECREF(seq); 454 | return 0; 455 | } 456 | return seq; 457 | } 458 | 459 | static PyObject* convert(const std::vector &m) 460 | { 461 | return pyopencv_from_vec(m); 462 | } 463 | }; 464 | 465 | void expose_opencv() 466 | { 467 | 468 | initialize_array(); 469 | 470 | PythonConverterForMat(); 471 | PythonConverterForSize(); 472 | 473 | bpy::to_python_converter, MatVectorToPython, false>(); 474 | } -------------------------------------------------------------------------------- /PyOpenPoseLib/opencv_expose.h: -------------------------------------------------------------------------------- 1 | // 2 | // Created by padeler on 3/8/2017. 3 | // 4 | /** 5 | * Code adapted for PyOpenPose from opencv cv2.cpp and pycompat.hpp for use with boost::python 6 | */ 7 | 8 | #ifndef PYOPENPOSE_OPENCV_EXPOSE_H_H 9 | #define PYOPENPOSE_OPENCV_EXPOSE_H_H 10 | 11 | #include 12 | 13 | 14 | // Defines for Python 2/3 compatibility. 15 | #ifndef __PYCOMPAT_HPP__ 16 | #define __PYCOMPAT_HPP__ 17 | 18 | #if PY_MAJOR_VERSION >= 3 19 | // Python3 treats all ints as longs, PyInt_X functions have been removed. 20 | #define PyInt_Check PyLong_Check 21 | #define PyInt_CheckExact PyLong_CheckExact 22 | #define PyInt_AsLong PyLong_AsLong 23 | #define PyInt_AS_LONG PyLong_AS_LONG 24 | #define PyInt_FromLong PyLong_FromLong 25 | #define PyNumber_Int PyNumber_Long 26 | 27 | // Python3 strings are unicode, these defines mimic the Python2 functionality. 28 | #define PyString_Check PyUnicode_Check 29 | #define PyString_FromString PyUnicode_FromString 30 | #define PyString_FromStringAndSize PyUnicode_FromStringAndSize 31 | #define PyString_Size PyUnicode_GET_SIZE 32 | 33 | // PyUnicode_AsUTF8 isn't available until Python 3.3 34 | #if (PY_VERSION_HEX < 0x03030000) 35 | #define PyString_AsString _PyUnicode_AsString 36 | #else 37 | #define PyString_AsString PyUnicode_AsUTF8 38 | #endif 39 | #endif 40 | 41 | #endif // END HEADER GUARD 42 | 43 | 44 | 45 | void expose_opencv(); 46 | 47 | #endif //PYOPENPOSE_OPENCV_EXPOSE_H_H 48 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## PyOpenPose 2 | 3 | Python bindings for the awesome Openpose library. 4 | 5 | Openpose [github page](https://github.com/CMU-Perceptual-Computing-Lab/openpose) 6 | 7 | 8 | ### Building 9 | 10 | Clone and build openpose. If you use cmake then ```make install``` will copy 11 | all necessary headers and libs to an _install_ forder that you specify (default is ```/usr/local```). 12 | 13 | Set an environment variable named OPENPOSE_ROOT pointing to the openpose _install_ folder. 14 | For running the example scripts make sure OPENPOSE_ROOT contains a models folder with the openpose models. 15 | 16 | __Note:__ Openpose lib is under heavy development and the API changes very often. 17 | Some API changes will break PyOpenPose. I try to upgrade as soon as possible but I am usually a few days behind. 18 | Openning an issue helps to speed-up the proccess. 19 | Current PyOpenPose version is built with [openpose commit e382698](https://github.com/CMU-Perceptual-Computing-Lab/openpose/commit/e38269862f05beca9497960eef3d35f9eecc0808) 20 | 21 | __Note:__ PyOpenPose requires __opencv3.x__. You will have to build openpose with opencv3 as well. 22 | 23 | Inside the root folder of PyOpenpose run cmake and build with: 24 | 25 | ```bash 26 | mkdir build 27 | cd build 28 | cmake .. 29 | make 30 | ``` 31 | 32 | Add the folder containing PyOpenPose.so to your PYTHONPATH. 33 | 34 | ### Building the library for python3 or python2 35 | 36 | - Set WITH_PYTHON3 flag in cmake to True (i.e with cmake-gui). 37 | - rebuild project 38 | 39 | ### Testing 40 | 41 | Check the scripts folder for python examples using PyOpenPose. 42 | -------------------------------------------------------------------------------- /doc/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | set(CMAKE_DOC_ROOT ${CMAKE_SOURCE_DIR}/PyOpenPoseLib) 2 | mark_as_advanced(CMAKE_DOC_ROOT) 3 | configure_file(docu.in 4 | ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) 5 | add_custom_target(doc 6 | ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile 7 | WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 8 | COMMENT "Generating SDK documentation with Doxygen" 9 | VERBATIM) 10 | -------------------------------------------------------------------------------- /doc/docu.in: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.11 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 = "PyOpenPose" 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 = "Python bindings for Openpose" 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 = 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 | # If one adds a struct or class to a group and this option is enabled, then also 347 | # any nested class or struct is added to the same group. By default this option 348 | # is disabled and one has to add nested compounds explicitly via \ingroup. 349 | # The default value is: NO. 350 | 351 | GROUP_NESTED_COMPOUNDS = NO 352 | 353 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 354 | # (for instance a group of public functions) to be put as a subgroup of that 355 | # type (e.g. under the Public Functions section). Set it to NO to prevent 356 | # subgrouping. Alternatively, this can be done per class using the 357 | # \nosubgrouping command. 358 | # The default value is: YES. 359 | 360 | SUBGROUPING = YES 361 | 362 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 363 | # are shown inside the group in which they are included (e.g. using \ingroup) 364 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 365 | # and RTF). 366 | # 367 | # Note that this feature does not work in combination with 368 | # SEPARATE_MEMBER_PAGES. 369 | # The default value is: NO. 370 | 371 | INLINE_GROUPED_CLASSES = NO 372 | 373 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 374 | # with only public data fields or simple typedef fields will be shown inline in 375 | # the documentation of the scope in which they are defined (i.e. file, 376 | # namespace, or group documentation), provided this scope is documented. If set 377 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 378 | # Man pages) or section (for LaTeX and RTF). 379 | # The default value is: NO. 380 | 381 | INLINE_SIMPLE_STRUCTS = NO 382 | 383 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 384 | # enum is documented as struct, union, or enum with the name of the typedef. So 385 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 386 | # with name TypeT. When disabled the typedef will appear as a member of a file, 387 | # namespace, or class. And the struct will be named TypeS. This can typically be 388 | # useful for C code in case the coding convention dictates that all compound 389 | # types are typedef'ed and only the typedef is referenced, never the tag name. 390 | # The default value is: NO. 391 | 392 | TYPEDEF_HIDES_STRUCT = NO 393 | 394 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 395 | # cache is used to resolve symbols given their name and scope. Since this can be 396 | # an expensive process and often the same symbol appears multiple times in the 397 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 398 | # doxygen will become slower. If the cache is too large, memory is wasted. The 399 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 400 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 401 | # symbols. At the end of a run doxygen will report the cache usage and suggest 402 | # the optimal cache size from a speed point of view. 403 | # Minimum value: 0, maximum value: 9, default value: 0. 404 | 405 | LOOKUP_CACHE_SIZE = 0 406 | 407 | #--------------------------------------------------------------------------- 408 | # Build related configuration options 409 | #--------------------------------------------------------------------------- 410 | 411 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 412 | # documentation are documented, even if no documentation was available. Private 413 | # class members and static file members will be hidden unless the 414 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 415 | # Note: This will also disable the warnings about undocumented members that are 416 | # normally produced when WARNINGS is set to YES. 417 | # The default value is: NO. 418 | 419 | EXTRACT_ALL = NO 420 | 421 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 422 | # be included in the documentation. 423 | # The default value is: NO. 424 | 425 | EXTRACT_PRIVATE = NO 426 | 427 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 428 | # scope will be included in the documentation. 429 | # The default value is: NO. 430 | 431 | EXTRACT_PACKAGE = NO 432 | 433 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 434 | # included in the documentation. 435 | # The default value is: NO. 436 | 437 | EXTRACT_STATIC = NO 438 | 439 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 440 | # locally in source files will be included in the documentation. If set to NO, 441 | # only classes defined in header files are included. Does not have any effect 442 | # for Java sources. 443 | # The default value is: YES. 444 | 445 | EXTRACT_LOCAL_CLASSES = YES 446 | 447 | # This flag is only useful for Objective-C code. If set to YES, local methods, 448 | # which are defined in the implementation section but not in the interface are 449 | # included in the documentation. If set to NO, only methods in the interface are 450 | # included. 451 | # The default value is: NO. 452 | 453 | EXTRACT_LOCAL_METHODS = NO 454 | 455 | # If this flag is set to YES, the members of anonymous namespaces will be 456 | # extracted and appear in the documentation as a namespace called 457 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 458 | # the file that contains the anonymous namespace. By default anonymous namespace 459 | # are hidden. 460 | # The default value is: NO. 461 | 462 | EXTRACT_ANON_NSPACES = NO 463 | 464 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 465 | # undocumented members inside documented classes or files. If set to NO these 466 | # members will be included in the various overviews, but no documentation 467 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 468 | # The default value is: NO. 469 | 470 | HIDE_UNDOC_MEMBERS = NO 471 | 472 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 473 | # undocumented classes that are normally visible in the class hierarchy. If set 474 | # to NO, these classes will be included in the various overviews. This option 475 | # has no effect if EXTRACT_ALL is enabled. 476 | # The default value is: NO. 477 | 478 | HIDE_UNDOC_CLASSES = NO 479 | 480 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 481 | # (class|struct|union) declarations. If set to NO, these declarations will be 482 | # included in the documentation. 483 | # The default value is: NO. 484 | 485 | HIDE_FRIEND_COMPOUNDS = NO 486 | 487 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 488 | # documentation blocks found inside the body of a function. If set to NO, these 489 | # blocks will be appended to the function's detailed documentation block. 490 | # The default value is: NO. 491 | 492 | HIDE_IN_BODY_DOCS = NO 493 | 494 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 495 | # \internal command is included. If the tag is set to NO then the documentation 496 | # will be excluded. Set it to YES to include the internal documentation. 497 | # The default value is: NO. 498 | 499 | INTERNAL_DOCS = NO 500 | 501 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 502 | # names in lower-case letters. If set to YES, upper-case letters are also 503 | # allowed. This is useful if you have classes or files whose names only differ 504 | # in case and if your file system supports case sensitive file names. Windows 505 | # and Mac users are advised to set this option to NO. 506 | # The default value is: system dependent. 507 | 508 | CASE_SENSE_NAMES = YES 509 | 510 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 511 | # their full class and namespace scopes in the documentation. If set to YES, the 512 | # scope will be hidden. 513 | # The default value is: NO. 514 | 515 | HIDE_SCOPE_NAMES = NO 516 | 517 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 518 | # append additional text to a page's title, such as Class Reference. If set to 519 | # YES the compound reference will be hidden. 520 | # The default value is: NO. 521 | 522 | HIDE_COMPOUND_REFERENCE= NO 523 | 524 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 525 | # the files that are included by a file in the documentation of that file. 526 | # The default value is: YES. 527 | 528 | SHOW_INCLUDE_FILES = YES 529 | 530 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 531 | # grouped member an include statement to the documentation, telling the reader 532 | # which file to include in order to use the member. 533 | # The default value is: NO. 534 | 535 | SHOW_GROUPED_MEMB_INC = NO 536 | 537 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 538 | # files with double quotes in the documentation rather than with sharp brackets. 539 | # The default value is: NO. 540 | 541 | FORCE_LOCAL_INCLUDES = NO 542 | 543 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 544 | # documentation for inline members. 545 | # The default value is: YES. 546 | 547 | INLINE_INFO = YES 548 | 549 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 550 | # (detailed) documentation of file and class members alphabetically by member 551 | # name. If set to NO, the members will appear in declaration order. 552 | # The default value is: YES. 553 | 554 | SORT_MEMBER_DOCS = YES 555 | 556 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 557 | # descriptions of file, namespace and class members alphabetically by member 558 | # name. If set to NO, the members will appear in declaration order. Note that 559 | # this will also influence the order of the classes in the class list. 560 | # The default value is: NO. 561 | 562 | SORT_BRIEF_DOCS = NO 563 | 564 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 565 | # (brief and detailed) documentation of class members so that constructors and 566 | # destructors are listed first. If set to NO the constructors will appear in the 567 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 568 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 569 | # member documentation. 570 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 571 | # detailed member documentation. 572 | # The default value is: NO. 573 | 574 | SORT_MEMBERS_CTORS_1ST = NO 575 | 576 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 577 | # of group names into alphabetical order. If set to NO the group names will 578 | # appear in their defined order. 579 | # The default value is: NO. 580 | 581 | SORT_GROUP_NAMES = NO 582 | 583 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 584 | # fully-qualified names, including namespaces. If set to NO, the class list will 585 | # be sorted only by class name, not including the namespace part. 586 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 587 | # Note: This option applies only to the class list, not to the alphabetical 588 | # list. 589 | # The default value is: NO. 590 | 591 | SORT_BY_SCOPE_NAME = NO 592 | 593 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 594 | # type resolution of all parameters of a function it will reject a match between 595 | # the prototype and the implementation of a member function even if there is 596 | # only one candidate or it is obvious which candidate to choose by doing a 597 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 598 | # accept a match between prototype and implementation in such cases. 599 | # The default value is: NO. 600 | 601 | STRICT_PROTO_MATCHING = NO 602 | 603 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 604 | # list. This list is created by putting \todo commands in the documentation. 605 | # The default value is: YES. 606 | 607 | GENERATE_TODOLIST = YES 608 | 609 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 610 | # list. This list is created by putting \test commands in the documentation. 611 | # The default value is: YES. 612 | 613 | GENERATE_TESTLIST = YES 614 | 615 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 616 | # list. This list is created by putting \bug commands in the documentation. 617 | # The default value is: YES. 618 | 619 | GENERATE_BUGLIST = YES 620 | 621 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 622 | # the deprecated list. This list is created by putting \deprecated commands in 623 | # the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_DEPRECATEDLIST= YES 627 | 628 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 629 | # sections, marked by \if ... \endif and \cond 630 | # ... \endcond blocks. 631 | 632 | ENABLED_SECTIONS = 633 | 634 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 635 | # initial value of a variable or macro / define can have for it to appear in the 636 | # documentation. If the initializer consists of more lines than specified here 637 | # it will be hidden. Use a value of 0 to hide initializers completely. The 638 | # appearance of the value of individual variables and macros / defines can be 639 | # controlled using \showinitializer or \hideinitializer command in the 640 | # documentation regardless of this setting. 641 | # Minimum value: 0, maximum value: 10000, default value: 30. 642 | 643 | MAX_INITIALIZER_LINES = 30 644 | 645 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 646 | # the bottom of the documentation of classes and structs. If set to YES, the 647 | # list will mention the files that were used to generate the documentation. 648 | # The default value is: YES. 649 | 650 | SHOW_USED_FILES = YES 651 | 652 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 653 | # will remove the Files entry from the Quick Index and from the Folder Tree View 654 | # (if specified). 655 | # The default value is: YES. 656 | 657 | SHOW_FILES = YES 658 | 659 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 660 | # page. This will remove the Namespaces entry from the Quick Index and from the 661 | # Folder Tree View (if specified). 662 | # The default value is: YES. 663 | 664 | SHOW_NAMESPACES = YES 665 | 666 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 667 | # doxygen should invoke to get the current version for each file (typically from 668 | # the version control system). Doxygen will invoke the program by executing (via 669 | # popen()) the command command input-file, where command is the value of the 670 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 671 | # by doxygen. Whatever the program writes to standard output is used as the file 672 | # version. For an example see the documentation. 673 | 674 | FILE_VERSION_FILTER = 675 | 676 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 677 | # by doxygen. The layout file controls the global structure of the generated 678 | # output files in an output format independent way. To create the layout file 679 | # that represents doxygen's defaults, run doxygen with the -l option. You can 680 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 681 | # will be used as the name of the layout file. 682 | # 683 | # Note that if you run doxygen from a directory containing a file called 684 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 685 | # tag is left empty. 686 | 687 | LAYOUT_FILE = 688 | 689 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 690 | # the reference definitions. This must be a list of .bib files. The .bib 691 | # extension is automatically appended if omitted. This requires the bibtex tool 692 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 693 | # For LaTeX the style of the bibliography can be controlled using 694 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 695 | # search path. See also \cite for info how to create references. 696 | 697 | CITE_BIB_FILES = 698 | 699 | #--------------------------------------------------------------------------- 700 | # Configuration options related to warning and progress messages 701 | #--------------------------------------------------------------------------- 702 | 703 | # The QUIET tag can be used to turn on/off the messages that are generated to 704 | # standard output by doxygen. If QUIET is set to YES this implies that the 705 | # messages are off. 706 | # The default value is: NO. 707 | 708 | QUIET = NO 709 | 710 | # The WARNINGS tag can be used to turn on/off the warning messages that are 711 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 712 | # this implies that the warnings are on. 713 | # 714 | # Tip: Turn warnings on while writing the documentation. 715 | # The default value is: YES. 716 | 717 | WARNINGS = YES 718 | 719 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 720 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 721 | # will automatically be disabled. 722 | # The default value is: YES. 723 | 724 | WARN_IF_UNDOCUMENTED = YES 725 | 726 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 727 | # potential errors in the documentation, such as not documenting some parameters 728 | # in a documented function, or documenting parameters that don't exist or using 729 | # markup commands wrongly. 730 | # The default value is: YES. 731 | 732 | WARN_IF_DOC_ERROR = YES 733 | 734 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 735 | # are documented, but have no documentation for their parameters or return 736 | # value. If set to NO, doxygen will only warn about wrong or incomplete 737 | # parameter documentation, but not about the absence of documentation. 738 | # The default value is: NO. 739 | 740 | WARN_NO_PARAMDOC = NO 741 | 742 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 743 | # a warning is encountered. 744 | # The default value is: NO. 745 | 746 | WARN_AS_ERROR = NO 747 | 748 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 749 | # can produce. The string should contain the $file, $line, and $text tags, which 750 | # will be replaced by the file and line number from which the warning originated 751 | # and the warning text. Optionally the format may contain $version, which will 752 | # be replaced by the version of the file (if it could be obtained via 753 | # FILE_VERSION_FILTER) 754 | # The default value is: $file:$line: $text. 755 | 756 | WARN_FORMAT = "$file:$line: $text" 757 | 758 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 759 | # messages should be written. If left blank the output is written to standard 760 | # error (stderr). 761 | 762 | WARN_LOGFILE = 763 | 764 | #--------------------------------------------------------------------------- 765 | # Configuration options related to the input files 766 | #--------------------------------------------------------------------------- 767 | 768 | # The INPUT tag is used to specify the files and/or directories that contain 769 | # documented source files. You may enter file names like myfile.cpp or 770 | # directories like /usr/src/myproject. Separate the files or directories with 771 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 772 | # Note: If this tag is empty the current directory is searched. 773 | 774 | INPUT = "@CMAKE_SOURCE_DIR@/PyOpenPoseLib/OpenPoseWrapper.cpp" \ 775 | "@CMAKE_SOURCE_DIR@/PyOpenPoseLib/OpenPoseWrapper.h" 776 | 777 | # This tag can be used to specify the character encoding of the source files 778 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 779 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 780 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 781 | # possible encodings. 782 | # The default value is: UTF-8. 783 | 784 | INPUT_ENCODING = UTF-8 785 | 786 | # If the value of the INPUT tag contains directories, you can use the 787 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 788 | # *.h) to filter out the source-files in the directories. 789 | # 790 | # Note that for custom extensions or not directly supported extensions you also 791 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 792 | # read by doxygen. 793 | # 794 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 795 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 796 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 797 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 798 | # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 799 | 800 | FILE_PATTERNS = 801 | 802 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 803 | # be searched for input files as well. 804 | # The default value is: NO. 805 | 806 | RECURSIVE = NO 807 | 808 | # The EXCLUDE tag can be used to specify files and/or directories that should be 809 | # excluded from the INPUT source files. This way you can easily exclude a 810 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 811 | # 812 | # Note that relative paths are relative to the directory from which doxygen is 813 | # run. 814 | 815 | EXCLUDE = 816 | 817 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 818 | # directories that are symbolic links (a Unix file system feature) are excluded 819 | # from the input. 820 | # The default value is: NO. 821 | 822 | EXCLUDE_SYMLINKS = NO 823 | 824 | # If the value of the INPUT tag contains directories, you can use the 825 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 826 | # certain files from those directories. 827 | # 828 | # Note that the wildcards are matched against the file with absolute path, so to 829 | # exclude all test directories for example use the pattern */test/* 830 | 831 | EXCLUDE_PATTERNS = 832 | 833 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 834 | # (namespaces, classes, functions, etc.) that should be excluded from the 835 | # output. The symbol name can be a fully qualified name, a word, or if the 836 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 837 | # AClass::ANamespace, ANamespace::*Test 838 | # 839 | # Note that the wildcards are matched against the file with absolute path, so to 840 | # exclude all test directories use the pattern */test/* 841 | 842 | EXCLUDE_SYMBOLS = 843 | 844 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 845 | # that contain example code fragments that are included (see the \include 846 | # command). 847 | 848 | EXAMPLE_PATH = 849 | 850 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 851 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 852 | # *.h) to filter out the source-files in the directories. If left blank all 853 | # files are included. 854 | 855 | EXAMPLE_PATTERNS = 856 | 857 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 858 | # searched for input files to be used with the \include or \dontinclude commands 859 | # irrespective of the value of the RECURSIVE tag. 860 | # The default value is: NO. 861 | 862 | EXAMPLE_RECURSIVE = NO 863 | 864 | # The IMAGE_PATH tag can be used to specify one or more files or directories 865 | # that contain images that are to be included in the documentation (see the 866 | # \image command). 867 | 868 | IMAGE_PATH = 869 | 870 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 871 | # invoke to filter for each input file. Doxygen will invoke the filter program 872 | # by executing (via popen()) the command: 873 | # 874 | # 875 | # 876 | # where is the value of the INPUT_FILTER tag, and is the 877 | # name of an input file. Doxygen will then use the output that the filter 878 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 879 | # will be ignored. 880 | # 881 | # Note that the filter must not add or remove lines; it is applied before the 882 | # code is scanned, but not when the output code is generated. If lines are added 883 | # or removed, the anchors will not be placed correctly. 884 | # 885 | # Note that for custom extensions or not directly supported extensions you also 886 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 887 | # properly processed by doxygen. 888 | 889 | INPUT_FILTER = 890 | 891 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 892 | # basis. Doxygen will compare the file name with each pattern and apply the 893 | # filter if there is a match. The filters are a list of the form: pattern=filter 894 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 895 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 896 | # patterns match the file name, INPUT_FILTER is applied. 897 | # 898 | # Note that for custom extensions or not directly supported extensions you also 899 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 900 | # properly processed by doxygen. 901 | 902 | FILTER_PATTERNS = 903 | 904 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 905 | # INPUT_FILTER) will also be used to filter the input files that are used for 906 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 907 | # The default value is: NO. 908 | 909 | FILTER_SOURCE_FILES = NO 910 | 911 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 912 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 913 | # it is also possible to disable source filtering for a specific pattern using 914 | # *.ext= (so without naming a filter). 915 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 916 | 917 | FILTER_SOURCE_PATTERNS = 918 | 919 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 920 | # is part of the input, its contents will be placed on the main page 921 | # (index.html). This can be useful if you have a project on for instance GitHub 922 | # and want to reuse the introduction page also for the doxygen output. 923 | 924 | USE_MDFILE_AS_MAINPAGE = 925 | 926 | #--------------------------------------------------------------------------- 927 | # Configuration options related to source browsing 928 | #--------------------------------------------------------------------------- 929 | 930 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 931 | # generated. Documented entities will be cross-referenced with these sources. 932 | # 933 | # Note: To get rid of all source code in the generated output, make sure that 934 | # also VERBATIM_HEADERS is set to NO. 935 | # The default value is: NO. 936 | 937 | SOURCE_BROWSER = NO 938 | 939 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 940 | # classes and enums directly into the documentation. 941 | # The default value is: NO. 942 | 943 | INLINE_SOURCES = NO 944 | 945 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 946 | # special comment blocks from generated source code fragments. Normal C, C++ and 947 | # Fortran comments will always remain visible. 948 | # The default value is: YES. 949 | 950 | STRIP_CODE_COMMENTS = YES 951 | 952 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 953 | # function all documented functions referencing it will be listed. 954 | # The default value is: NO. 955 | 956 | REFERENCED_BY_RELATION = NO 957 | 958 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 959 | # all documented entities called/used by that function will be listed. 960 | # The default value is: NO. 961 | 962 | REFERENCES_RELATION = NO 963 | 964 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 965 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 966 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 967 | # link to the documentation. 968 | # The default value is: YES. 969 | 970 | REFERENCES_LINK_SOURCE = YES 971 | 972 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 973 | # source code will show a tooltip with additional information such as prototype, 974 | # brief description and links to the definition and documentation. Since this 975 | # will make the HTML file larger and loading of large files a bit slower, you 976 | # can opt to disable this feature. 977 | # The default value is: YES. 978 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 979 | 980 | SOURCE_TOOLTIPS = YES 981 | 982 | # If the USE_HTAGS tag is set to YES then the references to source code will 983 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 984 | # source browser. The htags tool is part of GNU's global source tagging system 985 | # (see http://www.gnu.org/software/global/global.html). You will need version 986 | # 4.8.6 or higher. 987 | # 988 | # To use it do the following: 989 | # - Install the latest version of global 990 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 991 | # - Make sure the INPUT points to the root of the source tree 992 | # - Run doxygen as normal 993 | # 994 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 995 | # tools must be available from the command line (i.e. in the search path). 996 | # 997 | # The result: instead of the source browser generated by doxygen, the links to 998 | # source code will now point to the output of htags. 999 | # The default value is: NO. 1000 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1001 | 1002 | USE_HTAGS = NO 1003 | 1004 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1005 | # verbatim copy of the header file for each class for which an include is 1006 | # specified. Set to NO to disable this. 1007 | # See also: Section \class. 1008 | # The default value is: YES. 1009 | 1010 | VERBATIM_HEADERS = YES 1011 | 1012 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1013 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1014 | # cost of reduced performance. This can be particularly helpful with template 1015 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1016 | # information. 1017 | # Note: The availability of this option depends on whether or not doxygen was 1018 | # generated with the -Duse-libclang=ON option for CMake. 1019 | # The default value is: NO. 1020 | 1021 | CLANG_ASSISTED_PARSING = NO 1022 | 1023 | # If clang assisted parsing is enabled you can provide the compiler with command 1024 | # line options that you would normally use when invoking the compiler. Note that 1025 | # the include paths will already be set by doxygen for the files and directories 1026 | # specified with INPUT and INCLUDE_PATH. 1027 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1028 | 1029 | CLANG_OPTIONS = 1030 | 1031 | #--------------------------------------------------------------------------- 1032 | # Configuration options related to the alphabetical class index 1033 | #--------------------------------------------------------------------------- 1034 | 1035 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1036 | # compounds will be generated. Enable this if the project contains a lot of 1037 | # classes, structs, unions or interfaces. 1038 | # The default value is: YES. 1039 | 1040 | ALPHABETICAL_INDEX = YES 1041 | 1042 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1043 | # which the alphabetical index list will be split. 1044 | # Minimum value: 1, maximum value: 20, default value: 5. 1045 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1046 | 1047 | COLS_IN_ALPHA_INDEX = 5 1048 | 1049 | # In case all classes in a project start with a common prefix, all classes will 1050 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1051 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1052 | # while generating the index headers. 1053 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1054 | 1055 | IGNORE_PREFIX = 1056 | 1057 | #--------------------------------------------------------------------------- 1058 | # Configuration options related to the HTML output 1059 | #--------------------------------------------------------------------------- 1060 | 1061 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1062 | # The default value is: YES. 1063 | 1064 | GENERATE_HTML = YES 1065 | 1066 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1067 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1068 | # it. 1069 | # The default directory is: html. 1070 | # This tag requires that the tag GENERATE_HTML is set to YES. 1071 | 1072 | HTML_OUTPUT = html 1073 | 1074 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1075 | # generated HTML page (for example: .htm, .php, .asp). 1076 | # The default value is: .html. 1077 | # This tag requires that the tag GENERATE_HTML is set to YES. 1078 | 1079 | HTML_FILE_EXTENSION = .html 1080 | 1081 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1082 | # each generated HTML page. If the tag is left blank doxygen will generate a 1083 | # standard header. 1084 | # 1085 | # To get valid HTML the header file that includes any scripts and style sheets 1086 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1087 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1088 | # default header using 1089 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1090 | # YourConfigFile 1091 | # and then modify the file new_header.html. See also section "Doxygen usage" 1092 | # for information on how to generate the default header that doxygen normally 1093 | # uses. 1094 | # Note: The header is subject to change so you typically have to regenerate the 1095 | # default header when upgrading to a newer version of doxygen. For a description 1096 | # of the possible markers and block names see the documentation. 1097 | # This tag requires that the tag GENERATE_HTML is set to YES. 1098 | 1099 | HTML_HEADER = 1100 | 1101 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1102 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1103 | # footer. See HTML_HEADER for more information on how to generate a default 1104 | # footer and what special commands can be used inside the footer. See also 1105 | # section "Doxygen usage" for information on how to generate the default footer 1106 | # that doxygen normally uses. 1107 | # This tag requires that the tag GENERATE_HTML is set to YES. 1108 | 1109 | HTML_FOOTER = 1110 | 1111 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1112 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1113 | # the HTML output. If left blank doxygen will generate a default style sheet. 1114 | # See also section "Doxygen usage" for information on how to generate the style 1115 | # sheet that doxygen normally uses. 1116 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1117 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1118 | # obsolete. 1119 | # This tag requires that the tag GENERATE_HTML is set to YES. 1120 | 1121 | HTML_STYLESHEET = 1122 | 1123 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1124 | # cascading style sheets that are included after the standard style sheets 1125 | # created by doxygen. Using this option one can overrule certain style aspects. 1126 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1127 | # standard style sheet and is therefore more robust against future updates. 1128 | # Doxygen will copy the style sheet files to the output directory. 1129 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1130 | # style sheet in the list overrules the setting of the previous ones in the 1131 | # list). For an example see the documentation. 1132 | # This tag requires that the tag GENERATE_HTML is set to YES. 1133 | 1134 | HTML_EXTRA_STYLESHEET = 1135 | 1136 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1137 | # other source files which should be copied to the HTML output directory. Note 1138 | # that these files will be copied to the base HTML output directory. Use the 1139 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1140 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1141 | # files will be copied as-is; there are no commands or markers available. 1142 | # This tag requires that the tag GENERATE_HTML is set to YES. 1143 | 1144 | HTML_EXTRA_FILES = 1145 | 1146 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1147 | # will adjust the colors in the style sheet and background images according to 1148 | # this color. Hue is specified as an angle on a colorwheel, see 1149 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1150 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1151 | # purple, and 360 is red again. 1152 | # Minimum value: 0, maximum value: 359, default value: 220. 1153 | # This tag requires that the tag GENERATE_HTML is set to YES. 1154 | 1155 | HTML_COLORSTYLE_HUE = 220 1156 | 1157 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1158 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1159 | # value of 255 will produce the most vivid colors. 1160 | # Minimum value: 0, maximum value: 255, default value: 100. 1161 | # This tag requires that the tag GENERATE_HTML is set to YES. 1162 | 1163 | HTML_COLORSTYLE_SAT = 100 1164 | 1165 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1166 | # luminance component of the colors in the HTML output. Values below 100 1167 | # gradually make the output lighter, whereas values above 100 make the output 1168 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1169 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1170 | # change the gamma. 1171 | # Minimum value: 40, maximum value: 240, default value: 80. 1172 | # This tag requires that the tag GENERATE_HTML is set to YES. 1173 | 1174 | HTML_COLORSTYLE_GAMMA = 80 1175 | 1176 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1177 | # page will contain the date and time when the page was generated. Setting this 1178 | # to YES can help to show when doxygen was last run and thus if the 1179 | # documentation is up to date. 1180 | # The default value is: NO. 1181 | # This tag requires that the tag GENERATE_HTML is set to YES. 1182 | 1183 | HTML_TIMESTAMP = NO 1184 | 1185 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1186 | # documentation will contain sections that can be hidden and shown after the 1187 | # page has loaded. 1188 | # The default value is: NO. 1189 | # This tag requires that the tag GENERATE_HTML is set to YES. 1190 | 1191 | HTML_DYNAMIC_SECTIONS = NO 1192 | 1193 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1194 | # shown in the various tree structured indices initially; the user can expand 1195 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1196 | # such a level that at most the specified number of entries are visible (unless 1197 | # a fully collapsed tree already exceeds this amount). So setting the number of 1198 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1199 | # representing an infinite number of entries and will result in a full expanded 1200 | # tree by default. 1201 | # Minimum value: 0, maximum value: 9999, default value: 100. 1202 | # This tag requires that the tag GENERATE_HTML is set to YES. 1203 | 1204 | HTML_INDEX_NUM_ENTRIES = 100 1205 | 1206 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1207 | # generated that can be used as input for Apple's Xcode 3 integrated development 1208 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1209 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1210 | # Makefile in the HTML output directory. Running make will produce the docset in 1211 | # that directory and running make install will install the docset in 1212 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1213 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1214 | # for more information. 1215 | # The default value is: NO. 1216 | # This tag requires that the tag GENERATE_HTML is set to YES. 1217 | 1218 | GENERATE_DOCSET = NO 1219 | 1220 | # This tag determines the name of the docset feed. A documentation feed provides 1221 | # an umbrella under which multiple documentation sets from a single provider 1222 | # (such as a company or product suite) can be grouped. 1223 | # The default value is: Doxygen generated docs. 1224 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1225 | 1226 | DOCSET_FEEDNAME = "Doxygen generated docs" 1227 | 1228 | # This tag specifies a string that should uniquely identify the documentation 1229 | # set bundle. This should be a reverse domain-name style string, e.g. 1230 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1231 | # The default value is: org.doxygen.Project. 1232 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1233 | 1234 | DOCSET_BUNDLE_ID = org.doxygen.Project 1235 | 1236 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1237 | # the documentation publisher. This should be a reverse domain-name style 1238 | # string, e.g. com.mycompany.MyDocSet.documentation. 1239 | # The default value is: org.doxygen.Publisher. 1240 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1241 | 1242 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1243 | 1244 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1245 | # The default value is: Publisher. 1246 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1247 | 1248 | DOCSET_PUBLISHER_NAME = Publisher 1249 | 1250 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1251 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1252 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1253 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1254 | # Windows. 1255 | # 1256 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1257 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1258 | # files are now used as the Windows 98 help format, and will replace the old 1259 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1260 | # HTML files also contain an index, a table of contents, and you can search for 1261 | # words in the documentation. The HTML workshop also contains a viewer for 1262 | # compressed HTML files. 1263 | # The default value is: NO. 1264 | # This tag requires that the tag GENERATE_HTML is set to YES. 1265 | 1266 | GENERATE_HTMLHELP = NO 1267 | 1268 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1269 | # file. You can add a path in front of the file if the result should not be 1270 | # written to the html output directory. 1271 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1272 | 1273 | CHM_FILE = 1274 | 1275 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1276 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1277 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1278 | # The file has to be specified with full path. 1279 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1280 | 1281 | HHC_LOCATION = 1282 | 1283 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1284 | # (YES) or that it should be included in the master .chm file (NO). 1285 | # The default value is: NO. 1286 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1287 | 1288 | GENERATE_CHI = NO 1289 | 1290 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1291 | # and project file content. 1292 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1293 | 1294 | CHM_INDEX_ENCODING = 1295 | 1296 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1297 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1298 | # enables the Previous and Next buttons. 1299 | # The default value is: NO. 1300 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1301 | 1302 | BINARY_TOC = NO 1303 | 1304 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1305 | # the table of contents of the HTML help documentation and to the tree view. 1306 | # The default value is: NO. 1307 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1308 | 1309 | TOC_EXPAND = NO 1310 | 1311 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1312 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1313 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1314 | # (.qch) of the generated HTML documentation. 1315 | # The default value is: NO. 1316 | # This tag requires that the tag GENERATE_HTML is set to YES. 1317 | 1318 | GENERATE_QHP = NO 1319 | 1320 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1321 | # the file name of the resulting .qch file. The path specified is relative to 1322 | # the HTML output folder. 1323 | # This tag requires that the tag GENERATE_QHP is set to YES. 1324 | 1325 | QCH_FILE = 1326 | 1327 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1328 | # Project output. For more information please see Qt Help Project / Namespace 1329 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1330 | # The default value is: org.doxygen.Project. 1331 | # This tag requires that the tag GENERATE_QHP is set to YES. 1332 | 1333 | QHP_NAMESPACE = org.doxygen.Project 1334 | 1335 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1336 | # Help Project output. For more information please see Qt Help Project / Virtual 1337 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1338 | # folders). 1339 | # The default value is: doc. 1340 | # This tag requires that the tag GENERATE_QHP is set to YES. 1341 | 1342 | QHP_VIRTUAL_FOLDER = doc 1343 | 1344 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1345 | # filter to add. For more information please see Qt Help Project / Custom 1346 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1347 | # filters). 1348 | # This tag requires that the tag GENERATE_QHP is set to YES. 1349 | 1350 | QHP_CUST_FILTER_NAME = 1351 | 1352 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1353 | # custom filter to add. For more information please see Qt Help Project / Custom 1354 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1355 | # filters). 1356 | # This tag requires that the tag GENERATE_QHP is set to YES. 1357 | 1358 | QHP_CUST_FILTER_ATTRS = 1359 | 1360 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1361 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1362 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1363 | # This tag requires that the tag GENERATE_QHP is set to YES. 1364 | 1365 | QHP_SECT_FILTER_ATTRS = 1366 | 1367 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1368 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1369 | # generated .qhp file. 1370 | # This tag requires that the tag GENERATE_QHP is set to YES. 1371 | 1372 | QHG_LOCATION = 1373 | 1374 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1375 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1376 | # install this plugin and make it available under the help contents menu in 1377 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1378 | # to be copied into the plugins directory of eclipse. The name of the directory 1379 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1380 | # After copying Eclipse needs to be restarted before the help appears. 1381 | # The default value is: NO. 1382 | # This tag requires that the tag GENERATE_HTML is set to YES. 1383 | 1384 | GENERATE_ECLIPSEHELP = NO 1385 | 1386 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1387 | # the directory name containing the HTML and XML files should also have this 1388 | # name. Each documentation set should have its own identifier. 1389 | # The default value is: org.doxygen.Project. 1390 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1391 | 1392 | ECLIPSE_DOC_ID = org.doxygen.Project 1393 | 1394 | # If you want full control over the layout of the generated HTML pages it might 1395 | # be necessary to disable the index and replace it with your own. The 1396 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1397 | # of each HTML page. A value of NO enables the index and the value YES disables 1398 | # it. Since the tabs in the index contain the same information as the navigation 1399 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1400 | # The default value is: NO. 1401 | # This tag requires that the tag GENERATE_HTML is set to YES. 1402 | 1403 | DISABLE_INDEX = NO 1404 | 1405 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1406 | # structure should be generated to display hierarchical information. If the tag 1407 | # value is set to YES, a side panel will be generated containing a tree-like 1408 | # index structure (just like the one that is generated for HTML Help). For this 1409 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1410 | # (i.e. any modern browser). Windows users are probably better off using the 1411 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1412 | # further fine-tune the look of the index. As an example, the default style 1413 | # sheet generated by doxygen has an example that shows how to put an image at 1414 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1415 | # the same information as the tab index, you could consider setting 1416 | # DISABLE_INDEX to YES when enabling this option. 1417 | # The default value is: NO. 1418 | # This tag requires that the tag GENERATE_HTML is set to YES. 1419 | 1420 | GENERATE_TREEVIEW = NO 1421 | 1422 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1423 | # doxygen will group on one line in the generated HTML documentation. 1424 | # 1425 | # Note that a value of 0 will completely suppress the enum values from appearing 1426 | # in the overview section. 1427 | # Minimum value: 0, maximum value: 20, default value: 4. 1428 | # This tag requires that the tag GENERATE_HTML is set to YES. 1429 | 1430 | ENUM_VALUES_PER_LINE = 4 1431 | 1432 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1433 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1434 | # Minimum value: 0, maximum value: 1500, default value: 250. 1435 | # This tag requires that the tag GENERATE_HTML is set to YES. 1436 | 1437 | TREEVIEW_WIDTH = 250 1438 | 1439 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1440 | # external symbols imported via tag files in a separate window. 1441 | # The default value is: NO. 1442 | # This tag requires that the tag GENERATE_HTML is set to YES. 1443 | 1444 | EXT_LINKS_IN_WINDOW = NO 1445 | 1446 | # Use this tag to change the font size of LaTeX formulas included as images in 1447 | # the HTML documentation. When you change the font size after a successful 1448 | # doxygen run you need to manually remove any form_*.png images from the HTML 1449 | # output directory to force them to be regenerated. 1450 | # Minimum value: 8, maximum value: 50, default value: 10. 1451 | # This tag requires that the tag GENERATE_HTML is set to YES. 1452 | 1453 | FORMULA_FONTSIZE = 10 1454 | 1455 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1456 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1457 | # supported properly for IE 6.0, but are supported on all modern browsers. 1458 | # 1459 | # Note that when changing this option you need to delete any form_*.png files in 1460 | # the HTML output directory before the changes have effect. 1461 | # The default value is: YES. 1462 | # This tag requires that the tag GENERATE_HTML is set to YES. 1463 | 1464 | FORMULA_TRANSPARENT = YES 1465 | 1466 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1467 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1468 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1469 | # installed or if you want to formulas look prettier in the HTML output. When 1470 | # enabled you may also need to install MathJax separately and configure the path 1471 | # to it using the MATHJAX_RELPATH option. 1472 | # The default value is: NO. 1473 | # This tag requires that the tag GENERATE_HTML is set to YES. 1474 | 1475 | USE_MATHJAX = NO 1476 | 1477 | # When MathJax is enabled you can set the default output format to be used for 1478 | # the MathJax output. See the MathJax site (see: 1479 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1480 | # Possible values are: HTML-CSS (which is slower, but has the best 1481 | # compatibility), NativeMML (i.e. MathML) and SVG. 1482 | # The default value is: HTML-CSS. 1483 | # This tag requires that the tag USE_MATHJAX is set to YES. 1484 | 1485 | MATHJAX_FORMAT = HTML-CSS 1486 | 1487 | # When MathJax is enabled you need to specify the location relative to the HTML 1488 | # output directory using the MATHJAX_RELPATH option. The destination directory 1489 | # should contain the MathJax.js script. For instance, if the mathjax directory 1490 | # is located at the same level as the HTML output directory, then 1491 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1492 | # Content Delivery Network so you can quickly see the result without installing 1493 | # MathJax. However, it is strongly recommended to install a local copy of 1494 | # MathJax from http://www.mathjax.org before deployment. 1495 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1496 | # This tag requires that the tag USE_MATHJAX is set to YES. 1497 | 1498 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1499 | 1500 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1501 | # extension names that should be enabled during MathJax rendering. For example 1502 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1503 | # This tag requires that the tag USE_MATHJAX is set to YES. 1504 | 1505 | MATHJAX_EXTENSIONS = 1506 | 1507 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1508 | # of code that will be used on startup of the MathJax code. See the MathJax site 1509 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1510 | # example see the documentation. 1511 | # This tag requires that the tag USE_MATHJAX is set to YES. 1512 | 1513 | MATHJAX_CODEFILE = 1514 | 1515 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1516 | # the HTML output. The underlying search engine uses javascript and DHTML and 1517 | # should work on any modern browser. Note that when using HTML help 1518 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1519 | # there is already a search function so this one should typically be disabled. 1520 | # For large projects the javascript based search engine can be slow, then 1521 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1522 | # search using the keyboard; to jump to the search box use + S 1523 | # (what the is depends on the OS and browser, but it is typically 1524 | # , /