Improve python utils

.github/workflows/main.yml

@@ -64,8 +64,8 @@ jobs:
             mkdir MC-Calib/build && cd MC-Calib/build
             cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_BUILD_TYPE=Debug ..
             run-clang-tidy
-
 
+
   unit-tests-with-sanitizers:
     if: ${{ false }}  # TODO: disable for now until understand how to suppress leaks from external libraries like OpenCV
     runs-on: ubuntu-latest
@@ -166,13 +166,44 @@ jobs:
         uses: addnab/docker-run-action@v3
         with:
           image: bailool/mc-calib-prod:latest
-          options: -v ${{ github.workspace }}:/home/MC-Calib
+          options: -v ${{ github.workspace }}:/home/MC-Calib:rw
           run: |
             mkdir MC-Calib/build && cd MC-Calib/build
             cmake -DCMAKE_BUILD_TYPE=Release ..
             make -j4
             ./tests/boost_tests_run
 
+      - name: Collect results
+        run: |
+          cd ${{ github.workspace }}/data/Blender_Images
+          mkdir Results_Blender_Sequences
+
+          mkdir Results_Blender_Sequences/Scenario_1
+          cp -r Scenario_1/Results Results_Blender_Sequences/Scenario_1
+          cp Scenario_1/GroundTruth.yml Results_Blender_Sequences/Scenario_1
+
+          mkdir Results_Blender_Sequences/Scenario_2
+          cp -r Scenario_2/Results Results_Blender_Sequences/Scenario_2
+          cp Scenario_2/GroundTruth.yml Results_Blender_Sequences/Scenario_2
+
+          mkdir Results_Blender_Sequences/Scenario_3
+          cp -r Scenario_3/Results Results_Blender_Sequences/Scenario_3
+          cp Scenario_3/GroundTruth.yml Results_Blender_Sequences/Scenario_3
+
+          mkdir Results_Blender_Sequences/Scenario_4
+          cp -r Scenario_4/Results Results_Blender_Sequences/Scenario_4
+          cp Scenario_4/GroundTruth.yml Results_Blender_Sequences/Scenario_4
+
+          mkdir Results_Blender_Sequences/Scenario_5
+          cp -r Scenario_5/Results Results_Blender_Sequences/Scenario_5
+          cp Scenario_5/GroundTruth.yml Results_Blender_Sequences/Scenario_5
+
+      - name: Archive results artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: results_blender_sequences
+          path: ${{ github.workspace }}/data/Blender_Images/Results_Blender_Sequences
+
 
   code-coverage-testing:
     runs-on: ubuntu-latest
@@ -221,4 +252,54 @@ jobs:
           minimum-coverage: 77
           artifact-name: code-coverage-report-with-github-actions
           github-token: ${{ secrets.GITHUB_TOKEN }}
-          update-comment: true
+          update-comment: true
+
+
+  python-utils-linters:
+    runs-on: ubuntu-latest
+    needs:
+      - unit-tests-in-release-mode
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Run python linters
+        uses: addnab/docker-run-action@v3
+        with:
+          image: bailool/mc-calib-dev:latest
+          options: -v ${{ github.workspace }}:/home/MC-Calib
+          run: |
+            cd MC-Calib/python_utils
+            ./format.sh
+            ./test.sh
+
+
+  python-utils:
+    runs-on: ubuntu-latest
+    needs:
+      - python-utils-linters
+      - unit-tests-in-release-mode
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Download calibration results
+        uses: actions/download-artifact@v4
+        with:
+          name: results_blender_sequences
+          path: ${{ github.workspace }}/data
+
+      - name: Run python utils
+        uses: addnab/docker-run-action@v3
+        with:
+          image: bailool/mc-calib-prod:latest
+          options: -v ${{ github.workspace }}:/home/MC-Calib:rw
+          run: |
+            cd MC-Calib/python_utils
+            python3 post_calibration_analysis.py -d /home/MC-Calib/data/Scenario_1/Results/ /home/MC-Calib/data/Scenario_2/Results/ /home/MC-Calib/data/Scenario_3/Results/ /home/MC-Calib/data/Scenario_4/Results/ /home/MC-Calib/data/Scenario_5/Results/
+
+      - name: Archive results artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: results_blender_sequences_with_python_utils
+          path: ${{ github.workspace }}/data

Dockerfile

@@ -4,6 +4,7 @@ ENV DEBIAN_FRONTEND noninteractive
 RUN apt update && apt install -y --no-install-recommends apt-utils && \
 	apt upgrade -y && apt autoremove -y && \
 	apt install -y build-essential cmake && \
+	apt install -y python-is-python3 python3-pip && \
 	rm -rf /var/lib/apt/lists/*
 
 # suppress GTK warnings about accessibility because there's no dbus
@@ -36,6 +37,11 @@ RUN apt update && apt install -y git && \
 	cd /home && rm -rf ceres-solver" && \
 	rm -rf /var/lib/apt/lists/*
 
+# Install python requirements for python_utils scripts
+RUN --mount=type=bind,source=python_utils/requirements_prod.txt,target=/tmp/requirements.txt \
+    pip install --requirement /tmp/requirements.txt && \
+	rm -rf /var/lib/apt/lists/*
+
 FROM prod as dev
 
 RUN apt update && apt install -y python3-opencv && \
@@ -57,4 +63,9 @@ RUN apt update && apt install -y flex bison && \
 #     For development		    #
 #------------------------------	#
 RUN apt update && apt install -y cppcheck clang-tidy valgrind lcov && \
+	rm -rf /var/lib/apt/lists/*
+
+# Install python requirements for python_utils scripts
+RUN --mount=type=bind,source=python_utils/requirements_dev.txt,target=/tmp/requirements.txt \
+    pip install --requirement /tmp/requirements.txt && \
 	rm -rf /var/lib/apt/lists/*

README.md

@@ -32,7 +32,6 @@ There are several ways to get the environment ready. Choose any of them:
                   --volume="${PWD}:/home/MC-Calib" \
                   --volume="PATH_TO_DATA:/home/MC-Calib/data" \
                   bailool/mc-calib-prod
-      #xhost -local:root  # resetting permissions
       ```
 
 2. It is also possible to build the docker environment manually (see [instructions](/docs/Docker.md))
@@ -124,6 +123,12 @@ Documentation is available [online](https://codedocs.xyz/rameau-fr/MC-Calib/). T
 	./apps/calibrate/calibrate ../configs/calib_param.yml
 	```
 
+8. **Run post-calibration analysis**
+
+	```bash
+	python3 python_utils/post_calibration_analysis.py -d save_path_from_calib_param.yml
+	```
+
 ## Calibration file
 
 For multiple camera calibration configuration examples see `configs/*.yml`.  For easier start, just duplicate the most relevant setup and fill with details.

docs/contributing.rst

@@ -117,7 +117,16 @@ Then, run the valgrind test:
     ./tests/boost_tests_run && make coverage
 
 
-10. Create pull request.
+10. Test python_utils scripts (if applicable)
+
+.. code-block:: bash
+
+    cd python_utils
+    ./format.sh
+    ./test.sh
+
+
+11. Create pull request.
 
 
 Naming convention: