Improved doc for CMake and Python

doc/installation.md

@@ -421,13 +421,13 @@ cd build
 
 The next step is to generate the Makefiles. Now there can be multiple scenarios based on what the user already has e.x. Caffe might be already installed and the user might be interested in building OpenPose against that version of Caffe instead of requiring OpenPose to build Caffe from scratch.
 
-##### SCENARIO 1 -- Caffe not installed and OpenCV installed using `apt-get`
+##### Scenario 1 - Caffe not installed and OpenCV installed using `apt-get`
 In the build directory, run the below command --
 ```bash
 cmake ..
 ```
 
-##### SCENARIO 2 -- Caffe installed and OpenCV build from source
+##### Scenario 2 - Caffe installed and OpenCV build from source
 In this example, we assume that Caffe and OpenCV are already present. The user needs to supply the paths of the libraries and the include directories to CMake. For OpenCV, specify the include directories and the libraries directory using `OpenCV_INCLUDE_DIRS` and `OpenCV_LIBS_DIR` variables respectively. Alternatively, the user can also specify the path to the `OpenCVConfig.cmake` file by setting the `OpenCV_CONFIG_FILE` variable. For Caffe, specify the include directory and library using the `Caffe_INCLUDE_DIRS` and `Caffe_LIBS` variables. This will be where you installed Caffe. Below is an example of the same.
 ```bash
 cmake -DOpenCV_INCLUDE_DIRS=/home/"${USER}"/softwares/opencv/build/install/include \
@@ -442,7 +442,7 @@ cmake -DOpenCV_CONFIG_FILE=/home/"${USER}"/softwares/opencv/build/install/share/
   -DCaffe_LIBS=/home/"${USER}"/softwares/caffe/build/install/lib/libcaffe.so -DBUILD_CAFFE=OFF ..
 ```
 
-##### SCENARIO 3 -- OpenCV already installed
+##### Scenario 3 - OpenCV already installed
 If Caffe is not already present but OpenCV is, then use the below command.
 ```bash
 cmake -DOpenCV_INCLUDE_DIRS=/home/"${USER}"/softwares/opencv/build/install/include \
@@ -452,3 +452,6 @@ cmake -DOpenCV_INCLUDE_DIRS=/home/"${USER}"/softwares/opencv/build/install/inclu
 ```bash
 cmake -DOpenCV_CONFIG_FILE=/home/"${USER}"/softwares/opencv/build/install/share/OpenCV/OpenCVConfig.cmake ..
 ```
+
+##### Any Other Scenario
+You can check the CMake online documentation to check all the options that CMake provides and its analogs to the CMake-gui ones that we show on this document.

doc/output.md

@@ -5,7 +5,7 @@ OpenPose Demo - Output
 
 ## Contents
 1. [Output Format](#output-format)
-    1. [Keypoint Ordering](#keypoint-ordering)
+    1. [Keypoint Ordering in C++/Python](#keypoint-ordering-in-c-python)
     2. [Heatmap Ordering](#heatmap-ordering)
     3. [Heatmap Saving in Float Format](#heatmap-saving-in-float-format)
     4. [Heatmap Scaling](#heatmap-scaling)
@@ -70,11 +70,11 @@ There are 2 alternatives to save the OpenPose output.
 
 2. (Deprecated) The `write_keypoint` flag uses the OpenCV cv::FileStorage default formats, i.e., JSON (available after OpenCV 3.0), XML, and YML. Note that it does not include any other information othern than keypoints.
 
-Both of them follow the keypoint ordering described in the [Keypoint Ordering](#keypoint-ordering) section.
+Both of them follow the keypoint ordering described in the [Keypoint Ordering in C++/Python](#keypoint-ordering-in-c-python) section.
 
 
 
-### Keypoint Ordering
+### Keypoint Ordering in C++/Python
 The body part mapping order of any body model (e.g., COCO, MPI) can be extracted from the C++ API by using the `getPoseBodyPartMapping(const PoseModel poseModel)` function available in [poseParameters.hpp](../include/openpose/pose/poseParameters.hpp):
 ```
 // C++ API call
@@ -82,6 +82,8 @@ The body part mapping order of any body model (e.g., COCO, MPI) can be extracted
 const auto& poseBodyPartMappingBody25 = getPoseBodyPartMapping(PoseModel::BODY_25);
 const auto& poseBodyPartMappingCoco = getPoseBodyPartMapping(PoseModel::COCO_18);
 const auto& poseBodyPartMappingMpi = getPoseBodyPartMapping(PoseModel::MPI_15);
+const auto& poseBodyPartMappingBody25B = getPoseBodyPartMapping(PoseModel::BODY_25B);
+const auto& poseBodyPartMappingBody135 = getPoseBodyPartMapping(PoseModel::BODY_135);
 
 // Result for BODY_25 (25 body parts consisting of COCO + foot)
 // const std::map<unsigned int, std::string> POSE_BODY_25_BODY_PARTS {
@@ -114,6 +116,15 @@ const auto& poseBodyPartMappingMpi = getPoseBodyPartMapping(PoseModel::MPI_15);
 // };
 ```
 
+In Python, you can check them with the following code:
+```
+poseModel = op.PoseModel.BODY_25
+print(op.getPoseBodyPartMapping(poseModel))
+print(op.getPoseNumberBodyParts(poseModel))
+print(op.getPosePartPairs(poseModel))
+print(op.getPoseMapIndex(poseModel))
+```
+
 
 
 ### Heatmap Ordering

doc/prerequisites.md

@@ -30,7 +30,7 @@ git submodule update --init --recursive --remote
 ### Ubuntu Prerequisites
 1. Ubuntu - **Anaconda should not be installed** on your system. Anaconda includes a Protobuf version that is incompatible with Caffe. Either you uninstall anaconda and install protobuf via apt-get, or you compile your own Caffe and link it to OpenPose.
 2. Install **CMake GUI**:
-    - Ubuntu 14 or 16: run the command `sudo apt-get install cmake-qt-gui`. Note: If you prefer to use CMake through the command line, see [CMake Command Line Configuration (Ubuntu Only)](#cmake-command-line-configuration-ubuntu-only).
+    - Ubuntu 14 or 16: run the command `sudo apt-get install cmake-qt-gui`. Note: If you prefer to use CMake through the command line, see [doc/installation.md#CMake Command Line Configuration (Ubuntu Only)](./installation.md#cmake-command-line-configuration-ubuntu-only).
     - Ubuntu 18: **Download and compile CMake-gui from source**. The default CMake-gui version (3.10) installed via `sudo apt-get install cmake-qt-gui` provokes some compiling errors. Required CMake version >= 3.12.
         - Uninstall your current Cmake-gui version by running `sudo apt purge cmake-qt-gui`.
         - Run `sudo apt-get install qtbase5-dev`.