[Feature] Generalize template alignment(SIFT + delaunay trinagulation) + Contrast preprocessor + coverage module

.gitignore

@@ -14,3 +14,4 @@ outputs/*
 venv/
 OMRChecker.wiki/
 pytestdebug.log
+.coverage

.pre-commit-config.yaml

@@ -1,37 +1,43 @@
 exclude: "(__snapshots__|__image_snapshots__)/.*$"
 default_install_hook_types: [pre-commit, pre-push]
 repos:
-  # Convert the pngs to jpgs inside samples folder
-  - repo: local
-    hooks:
-      - id: convert-images
-        name: Convert png to jpg in samples
-        entry: scripts/hooks/convert_images_hook.py
-        args: ["--trigger-size", "150"]
-        files: ^samples.*\.(png|PNG)$
-        pass_filenames: true
-        stages: [commit]
-        language: python
-        language_version: python3
-        additional_dependencies: [pillow]
-        always_run: true
-        fail_fast: true # Wait for user to remove the png files
+# TODO: debug
+  # # Convert the pngs to jpgs inside samples folder
+  # - repo: local
+  #   hooks:
+  #     - id: convert-images
+  #       name: Convert png to jpg in samples
+  #       entry: scripts/hooks/convert_images_hook.py
+  #       # TODO: support for imports inside pre-commit
+  #       # env:
+  #       #   PYTHONPATH: $PYTHONPATH:$PWD
+  #       args: ["--trigger-size", "150"]
+  #       files: ^samples.*\.(png|PNG)$
+  #       pass_filenames: true
+  #       stages: [commit]
+  #       language: python
+  #       language_version: python3
+  #       additional_dependencies: [pillow]
+  #       always_run: true
+  #       fail_fast: true # Wait for user to remove the png files
 
-  # Run resize image before the compress image check
-  - repo: local
-    hooks:
-      - id: resize-images
-        name: Resize images
-        entry: scripts/hooks/resize_images_hook.py
-        args: ["--max-width", "1500", "--max-height", "1500", "--trigger-size", "150"]
-        files: \.(png|jpg|jpeg|PNG|JPG|JPEG)$
-        pass_filenames: true
-        stages: [commit]
-        language: python
-        language_version: python3
-        additional_dependencies: [pillow]
-        always_run: true
-        fail_fast: false
+  # # Run resize image before the compress image check
+  # - repo: local
+  #   hooks:
+  #     - id: resize-images
+  #       name: Resize images
+  #       entry: scripts/hooks/resize_images_hook.py
+  #       env:
+  #         PYTHONPATH: $PYTHONPATH:./scripts
+  #       args: ["--max-width", "1500", "--max-height", "1500", "--trigger-size", "150"]
+  #       files: \.(png|jpg|jpeg|PNG|JPG|JPEG)$
+  #       pass_filenames: true
+  #       stages: [commit]
+  #       language: python
+  #       language_version: python3
+  #       additional_dependencies: [pillow]
+  #       always_run: true
+  #       fail_fast: false
 
   # Run image compressor before the large files check
   - repo: https://github.com/boidolr/pre-commit-images
@@ -92,7 +98,7 @@ repos:
     hooks:
       - id: pytest-on-commit
         name: Running single sample test
-        entry: python3 -m pytest -rfpsxEX --disable-warnings --verbose -k test_run_omr_marker_mobile
+        entry: pytest -rfpsxEX --disable-warnings --verbose -k test_run_omr_marker_mobile
         language: system
         pass_filenames: false
         always_run: true
@@ -102,7 +108,7 @@ repos:
     hooks:
       - id: pytest-on-push
         name: Running all tests before push...
-        entry: python3 -m pytest -rfpsxEX --disable-warnings --verbose --durations=3
+        entry: ./scripts/run_coverage.sh
         language: system
         pass_filenames: false
         always_run: true

README.md

@@ -19,7 +19,6 @@ OMR stands for Optical Mark Recognition, used to detect and interpret human-mark
 [![GitHub pull-requests closed](https://img.shields.io/github/issues-pr-closed/Udayraj123/OMRChecker.svg)](https://github.com/Udayraj123/OMRChecker/pulls?q=is%3Aclosed)
 [![GitHub issues-closed](https://img.shields.io/github/issues-closed/Udayraj123/OMRChecker.svg)](https://GitHub.com/Udayraj123/OMRChecker/issues?q=is%3Aissue+is%3Aclosed)
 [![Ask me](https://img.shields.io/badge/Discuss-on_Github-purple.svg?style=flat-square)](https://github.com/Udayraj123/OMRChecker/issues/5)
-<!-- [![GitHub contributors](https://img.shields.io/github/contributors/Udayraj123/OMRChecker.svg)](https://GitHub.com/Udayraj123/OMRChecker/graphs/contributors/) -->
 
 [![GitHub stars](https://img.shields.io/github/stars/Udayraj123/OMRChecker.svg?style=social&label=Stars✯)](https://GitHub.com/Udayraj123/OMRChecker/stargazers/)
 [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FUdayraj123%2FOMRChecker&count_bg=%2379C83D&title_bg=%23555555&icon=googlecast.svg&icon_color=%23E7E7E7&title=hits%2829.09.2022%29&edge_flat=false)](https://hits.seeyoufarm.com)
@@ -337,6 +336,12 @@ Here's a snapshot of the [Android OMR Helper App (archived)](https://github.com/
   <img src="https://contrib.rocks/image?repo=Udayraj123/OMRChecker" />
 </a>
 
+<p align="center">
+
+[![GitHub contributors](https://img.shields.io/github/contributors/Udayraj123/OMRChecker.svg)](https://GitHub.com/Udayraj123/OMRChecker/graphs/contributors/)
+
+</p>
+
 ---
 
 ### License

main.py

@@ -49,6 +49,16 @@ def parse_args():
         help="Specify an output directory.",
     )
 
+    argparser.add_argument(
+        "-m",
+        "--outputMode",
+        default="default",
+        required=False,
+        choices=["moderation", "default"],
+        dest="output_mode",
+        help="Specify the output mode. Supported: moderation, default",
+    )
+
     argparser.add_argument(
         "-l",
         "--setLayout",

requirements.dev.txt

@@ -4,5 +4,6 @@ freezegun==1.4.0
 pre-commit==3.7.0
 pytest-mock==3.14.0
 pytest==8.1.1
+coverage==7.6.0
 syrupy==4.6.1
 Pillow==10.3.0

samples/experimental/1-timelines-and-dots/warp-on-points/config.json

@@ -4,6 +4,6 @@
       1000,
       1300
     ],
-    "show_image_level": 5
+    "show_image_level": 0
   }
 }

samples/experimental/1-timelines-and-dots/warp-on-points/template-remap.json

@@ -33,10 +33,10 @@
           "warpMethod": "REMAP"
         },
         "defaultSelector": "OUTER_CORNERS",
-        "scanAreas": [
+        "scanZones": [
           {
-            "areaTemplate": "topLeftDot",
-            "areaDescription": {
+            "zonePreset": "topLeftDot",
+            "zoneDescription": {
               "label": "AdditionalPoint",
               "origin": [
                 48,

samples/experimental/1-timelines-and-dots/warp-on-points/template-warp-stretched-point.json

@@ -33,10 +33,10 @@
           "warpMethod": "HOMOGRAPHY"
         },
         "defaultSelector": "OUTER_CORNERS",
-        "scanAreas": [
+        "scanZones": [
           {
-            "areaTemplate": "topLeftDot",
-            "areaDescription": {
+            "zonePreset": "topLeftDot",
+            "zoneDescription": {
               "label": "AdditionalPoint",
               "origin": [
                 48,

samples/experimental/1-timelines-and-dots/warp-on-points/template.json

@@ -33,10 +33,10 @@
           "warpMethod": "HOMOGRAPHY"
         },
         "defaultSelector": "OUTER_CORNERS",
-        "scanAreas": [
+        "scanZones": [
           {
-            "areaTemplate": "topLeftDot",
-            "areaDescription": {
+            "zonePreset": "topLeftDot",
+            "zoneDescription": {
               "label": "AdditionalPoint",
               "origin": [
                 48,

samples/experimental/2-template-shifts/alignment/config.json

@@ -0,0 +1,11 @@
+{
+  "outputs": {
+    "display_image_dimensions": [
+      1000,
+      1300
+    ],
+    "save_detections": true,
+    "save_image_level": 0,
+    "show_image_level": 0
+  }
+}