Refactor Evaluation; Multi weighted bugfixes; Colored Outputs base

.gitignore

@@ -9,6 +9,7 @@ outputs/*
 
 # Misc
 **/.DS_Store
+**/__ignore__
 **/__pycache__
 venv/
 OMRChecker.wiki/

.pre-commit-config.yaml

@@ -1,17 +1,25 @@
 exclude: "__snapshots__/.*$"
 default_install_hook_types: [pre-commit, pre-push]
 repos:
+  # Run image compressor before the large files check
+  - repo: https://github.com/boidolr/pre-commit-images
+    rev: v1.5.2
+    hooks:
+      - id: optimize-png
+      - id: optimize-jpg
+        args: ["--quality","90"]
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: check-yaml
         stages: [commit]
       - id: check-added-large-files
-        args: ['--maxkb=300']
+        args: ["--maxkb=300"]
         fail_fast: false
         stages: [commit]
       - id: pretty-format-json
-        args: ['--autofix', '--no-sort-keys']
+        args: ["--autofix", "--no-sort-keys"]
       - id: end-of-file-fixer
         exclude_types: ["csv", "json"]
         stages: [commit]
@@ -34,14 +42,21 @@ repos:
     hooks:
       - id: flake8
         args:
-          - "--ignore=E501,W503,E203,E741,F541" # Line too long, Line break occurred before a binary operator, Whitespace before ':'
+          - "--ignore=E203,E501,E741,E731,F541,W503"
+          # https://www.flake8rules.com/
+          # E203: Whitespace before ':'
+          # E501: Line too long
+          # E731: do not assign a lambda expression, use a def
+          # E741: Do not use variables named 'I', 'O', or 'l'
+          # F541: f-string without any placeholders
+          # W503: Line break occurred before a binary operator
         fail_fast: true
         stages: [commit]
   - repo: local
     hooks:
       - id: pytest-on-commit
         name: Running single sample test
-        entry:  python3 -m pytest -rfpsxEX --disable-warnings --verbose -k sample1
+        entry: python3 -m pytest -rfpsxEX --disable-warnings --verbose -k test_run_omr_marker_mobile
         language: system
         pass_filenames: false
         always_run: true

Contributors.md

@@ -20,3 +20,4 @@
 - [aayushibansal2001](https://github.com/aayushibansal2001)
 - [ShamanthVallem](https://github.com/ShamanthVallem)
 - [rudrapsc](https://github.com/rudrapsc)
+- [palash018](https://github.com/palash018)

samples/1-mobile-camera/config.json

@@ -0,0 +1,6 @@
+{
+  "outputs": {
+    "show_image_level": 0,
+    "show_colored_outputs": true
+  }
+}

samples/sample1/template.json → samples/1-mobile-camera/template.json

@@ -36,6 +36,7 @@
   "fieldBlocks": {
     "Medium": {
       "bubblesGap": 41,
+      "fieldType": "CUSTOM",
       "bubbleValues": [
         "E",
         "H"

samples/sample5/README.md → samples/2-omr-marker-scanned/README.md

@@ -3,4 +3,4 @@
 This sample demonstrates multiple things, namely -
 - Running OMRChecker on images scanned using popular document scanning apps
 - Using a common template.json file for sub-folders (e.g. multiple scan batches)
-- Using evaluation.json file with custom marking (without streak-based marking)
+- Using evaluation on custom labels

samples/sample5/template.json → samples/2-omr-marker-scanned/template.json

@@ -48,6 +48,7 @@
   },
   "fieldBlocks": {
     "Medium": {
+      "fieldType": "CUSTOM",
       "bubbleValues": [
         "E",
         "H"

samples/sample4/config.json → samples/3-answer-key/bonus-marking/config.json

@@ -1,9 +1,11 @@
 {
   "dimensions": {
-    "display_width": 1189,
-    "display_height": 1682
+    "display_image_shape": [
+      1682,
+      1189
+    ]
   },
-  "threshold_params": {
+  "thresholding": {
     "MIN_JUMP": 30
   },
   "outputs": {

samples/3-answer-key/bonus-marking/evaluation.json

@@ -0,0 +1,76 @@
+{
+  "source_type": "custom",
+  "options": {
+    "questions_in_order": [
+      "q1..11"
+    ],
+    "answers_in_order": [
+      "B",
+      "D",
+      "C",
+      "B",
+      "D",
+      "C",
+      [
+        "B",
+        "C",
+        "BC"
+      ],
+      "A",
+      "C",
+      "D",
+      "C"
+    ],
+    "should_explain_scoring": true
+  },
+  "outputs_configuration": {
+    "draw_score": {
+      "enabled": true,
+      "position": [
+        600,
+        650
+      ],
+      "size": 1.5
+    },
+    "draw_answers_summary": {
+      "enabled": true,
+      "position": [
+        300,
+        550
+      ],
+      "size": 1.0
+    },
+    "verdict_colors": {
+      "correct": "#00ff00",
+      "incorrect": "#ff0000",
+      "unmarked": "#0000ff"
+    }
+  },
+  "marking_schemes": {
+    "DEFAULT": {
+      "correct": "3",
+      "incorrect": "-1",
+      "unmarked": "0"
+    },
+    "BONUS_MARKS_ON_ATTEMPT": {
+      "marking": {
+        "correct": "3",
+        "incorrect": "3",
+        "unmarked": "0"
+      },
+      "questions": [
+        "q7"
+      ]
+    },
+    "BONUS_MARKS_FOR_ALL": {
+      "marking": {
+        "correct": "3",
+        "incorrect": "3",
+        "unmarked": "3"
+      },
+      "questions": [
+        "q8"
+      ]
+    }
+  }
+}

samples/sample4/template.json → samples/3-answer-key/bonus-marking/template.json

@@ -1,7 +1,7 @@
 {
   "pageDimensions": [
-    1189,
-    1682
+    1200,
+    1500
   ],
   "bubbleDimensions": [
     30,
@@ -32,14 +32,14 @@
     "MCQBlock1": {
       "fieldType": "QTYPE_MCQ4",
       "origin": [
-        134,
-        684
+        138,
+        605
       ],
       "fieldLabels": [
         "q1..11"
       ],
       "bubblesGap": 79,
-      "labelsGap": 62
+      "labelsGap": 55
     }
   }
 }

samples/3-answer-key/using-image/config.json

@@ -0,0 +1,15 @@
+{
+  "dimensions": {
+    "display_image_shape": [
+      2400,
+      1800
+    ],
+    "processing_image_shape": [
+      2400,
+      1800
+    ]
+  },
+  "outputs": {
+    "show_image_level": 0
+  }
+}

samples/community/UPSC-mock/template.json → samples/3-answer-key/using-image/template.json

@@ -27,6 +27,7 @@
       "fieldLabels": [
         "bookletNo"
       ],
+      "fieldType": "CUSTOM",
       "bubbleValues": [
         "A",
         "B",

samples/answer-key/weighted-answers/evaluation.json → samples/3-answer-key/weighted-answers/evaluation.json

@@ -5,7 +5,16 @@
       "q1..5"
     ],
     "answers_in_order": [
-      "C",
+      [
+        [
+          "A",
+          3
+        ],
+        [
+          "C",
+          -2
+        ]
+      ],
       "E",
       [
         "A",
@@ -30,6 +39,16 @@
       "correct": "3",
       "incorrect": "-1",
       "unmarked": "0"
+    },
+    "CUSTOM_NEGATIVE_MARKING": {
+      "questions": [
+        "q5"
+      ],
+      "marking": {
+        "correct": "3",
+        "incorrect": "-2",
+        "unmarked": "0"
+      }
     }
   }
 }

samples/community/Sandeep-1507/config.json

@@ -1,9 +1,13 @@
 {
   "dimensions": {
-    "display_height": 1000,
-    "display_width": 1300,
-    "processing_height": 820,
-    "processing_width": 666
+    "display_image_shape": [
+      1000,
+      1300
+    ],
+    "processing_image_shape": [
+      820,
+      666
+    ]
   },
   "outputs": {
     "save_detections": true,

samples/community/UmarFarootAPS/config.json

@@ -1,9 +1,13 @@
 {
   "dimensions": {
-    "display_height": 960,
-    "display_width": 1280,
-    "processing_height": 1640,
-    "processing_width": 1332
+    "display_image_shape": [
+      960,
+      1280
+    ],
+    "processing_image_shape": [
+      1640,
+      1332
+    ]
   },
   "outputs": {
     "show_image_level": 0

samples/community/ibrahimkilic/template.json

@@ -10,10 +10,11 @@
   "emptyValue": "no",
   "fieldBlocks": {
     "YesNoBlock1": {
-      "direction": "horizontal",
+      "fieldType": "CUSTOM",
       "bubbleValues": [
         "yes"
       ],
+      "direction": "horizontal",
       "origin": [
         15,
         55

samples/experimental/1-timelines-and-dots/README.md

@@ -0,0 +1,31 @@
+## Sample OMRs
+# What is a Dot (index point)?
+We can use any blob-like unique shape on the OMR sheet to be used as the four index points aka Dots.
+These 4 points provided at the 4 corners of the OMR sheet are the most important components of an OMR sheet. The accuracy of evaluation depends on the clarity of these 4 points in the scanned OMR sheet image.
+
+# What is a Timeline on an OMR sheet?
+
+In the old pattern, machine read sheets, were additional black marks placed at equal increments running throughout the length of the sheet on either side or on both sides. This strip of black marks is called a timeline which helps the OMR machine to identify the next row of bubbles. ([source](https://www.addmengroup.com/downloads/Addmen-OMR-Sheet-Design-Guide.pdf))
+
+OMR software can use the timeline to properly locate the bubbles. So any changes in the timeline markers can generate wrong result. It is usually not larger than the size of bubbles
+
+<!-- TODO: image of a timeline -->
+
+# When should I use it?
+
+- If your OMR sheet has this timeline and if adding a custom marker(in four corner points) is not feasible, you can try evaluating your OMR sheet using this method.
+- Since the preprocessor converts the dashed line into a filled rectangular blob and uses that for detection, you can use this preprocessor on any rectangular thick lines or thick dots that can be converted to distinguishable blobs.
+
+# How to use?
+We have provided support for 4 configurations: "ONE_LINE_TWO_DOTS", "TWO_DOTS_ONE_LINE", "TWO_LINES", "FOUR_DOTS".
+Depending on the configuration of your OMR sheet, choose the one that is applicable.
+
+Open the samples in this folder to know how to configure each type in detail.
+
+Also, for further tuning - we support 5 configurations for selecting the points out of the thick blobs: "CENTERS", "INNER_WIDTHS", "INNER_HEIGHTS", "INNER_CORNERS", "OUTER_CORNERS"
+
+### Drawbacks and Improvements
+Currently OMRChecker requires the Dots and Lines to "stand out" from other marks in the sheet. If there's any noise nearby the marker including the print itself, the detection would fail.
+<!-- TODO: insert obstructed OMR -->
+
+Track improvements in this functionality [here](https://github.com/users/Udayraj123/projects/2?pane=issue&itemId=57863176).

samples/experimental/1-timelines-and-dots/four-dots/config.json

@@ -0,0 +1,15 @@
+{
+  "dimensions": {
+    "display_image_shape": [
+      1800,
+      2400
+    ],
+    "processing_image_shape": [
+      1280,
+      906
+    ]
+  },
+  "outputs": {
+    "show_image_level": 0
+  }
+}