Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Simplify template jsons #127

Merged
merged 10 commits into from
Feb 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ repos:
- repo: local
hooks:
- id: pytest-on-commit
name: test run
name: Running single sample test
entry: pytest -k sample1
language: system
pass_filenames: false
Expand All @@ -43,7 +43,7 @@ repos:
- repo: local
hooks:
- id: pytest-on-push
name: pytest-on-push
name: Running all tests before push...
entry: pytest
language: system
pass_filenames: false
Expand Down
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Read OMRs fast and accurately using a scanner 🖨 or your phone 🤳.

#### **Quick Links**
#### **Quick Links**
- [Installation](#getting-started)
- [User Guide](https://github.com/Udayraj123/OMRChecker/wiki)
- [Contributor Guide](https://github.com/Udayraj123/OMRChecker/blob/master/CONTRIBUTING.md)
Expand Down Expand Up @@ -104,7 +104,7 @@ Get a CSV sheet containing the detected responses and evaluated scores:

### 1. Install global dependencies

![opencv 4.0.0](https://img.shields.io/badge/opencv-4.0.0-blue.svg) ![python 3.4+](https://img.shields.io/badge/python-3.4+-blue.svg)
![opencv 4.0.0](https://img.shields.io/badge/opencv-4.0.0-blue.svg) ![python 3.5+](https://img.shields.io/badge/python-3.5+-blue.svg)

To check if python3 and pip is already installed:

Expand Down Expand Up @@ -215,7 +215,7 @@ Command: <code>python3 -m pip install --user --upgrade pip</code>
1. First, [create your own template.json](https://github.com/Udayraj123/OMRChecker/wiki/User-Guide).
2. Configure the tuning parameters.
3. Run OMRChecker with appropriate arguments (See full usage).
<!-- 3. Add answer key( TODO: add answer key/marking scheme guide) -->
<!-- 4. Add answer key( TODO: add answer key/marking scheme guide) -->

## Full Usage

Expand All @@ -231,10 +231,14 @@ Explanation for the arguments:
`--outputDir`: Specify an output directory.
**Notes:**
<details>
<summary>
<b>Deprecation logs</b>
</summary>
- The old `--noCropping` flag has been replaced with the 'CropPage' plugin in "preProcessors" of the template.json(see [samples](https://github.com/Udayraj123/OMRChecker/tree/master/samples)).
- The old `--autoAlign` flag can now be toggled from config.json
</details>
<!-- #### Testing the code
Datasets to test on :
Expand All @@ -243,6 +247,7 @@ Standard Quality Dataset(For ML Based methods) (3 GB)
High Quality Dataset(For custom processing) (6 GB)
-->
## FAQ
<details>
Expand Down Expand Up @@ -314,7 +319,7 @@ Here's a snapshot of the [Android OMR Helper App (archived)](https://github.com/
<p align="center">
<a href="https://github.com/Udayraj123/AndroidOMRHelper">
<img height="350" src="https://raw.githubusercontent.com/wiki/Udayraj123/OMRChecker/extras/Progress/2019-04-26/images/app_flow.PNG">
<img height="300" src="https://raw.githubusercontent.com/wiki/Udayraj123/OMRChecker/extras/Progress/2019-04-26/images/app_flow.PNG">
</a>
</p>
Expand All @@ -340,7 +345,7 @@ For more details see [LICENSE](https://github.com/Udayraj123/OMRChecker/blob/mas
<a href="https://www.buymeacoffee.com/Udayraj123" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a> [![paypal](https://www.paypalobjects.com/en_GB/i/btn/btn_donate_LG.gif)](https://www.paypal.me/Udayraj123/500)
_Find OMRChecker on_ [**_Product Hunt_**](https://www.producthunt.com/posts/omr-checker/) **|** [**_Reddit_**](https://www.reddit.com/r/computervision/comments/ccbj6f/omrchecker_grade_exams_using_python_and_opencv/) **|** [**Discord**](https://discord.gg/qFv2Vqf) **|** [**Linkedin**](https://www.linkedin.com/pulse/open-source-talks-udayraj-udayraj-deshmukh/) **|** [**goodfirstissue.dev**](https://goodfirstissue.dev/language/python) **|** [**codepeak.tech**](https://www.codepeak.tech/) **|** [**fossoverflow.dev**](https://fossoverflow.dev/projects) **|** [**Interview on Console by CodeSee**](https://console.substack.com/p/console-140) **|** [**Open Source Hub**](https://opensourcehub.io/udayraj123/omrchecker)
_Find OMRChecker on_ [**_Product Hunt_**](https://www.producthunt.com/posts/omr-checker/) **|** [**_Reddit_**](https://www.reddit.com/r/computervision/comments/ccbj6f/omrchecker_grade_exams_using_python_and_opencv/) **|** [**Discord**](https://discord.gg/qFv2Vqf) **|** [**Linkedin**](https://www.linkedin.com/pulse/open-source-talks-udayraj-udayraj-deshmukh/) **|** [**goodfirstissue.dev**](https://goodfirstissue.dev/language/python) **|** [**codepeak.tech**](https://www.codepeak.tech/) **|** [**fossoverflow.dev**](https://fossoverflow.dev/projects) **|** [**Interview on Console by CodeSee**](https://console.substack.com/p/console-140) **|** [**Open Source Hub**](https://opensourcehub.io/udayraj123/omrchecker)
<!-- [***Hacker News***](https://news.ycombinator.com/item?id=20420602) **|** -->
<!-- **|** [***Swyya***](https://www.swyya.com/projects/omrchecker) -->
22 changes: 8 additions & 14 deletions samples/community/Antibodyy/template.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
{
"dimensions": [ 299, 398 ],
"pageDimensions": [ 299, 398 ],
"bubbleDimensions": [ 42, 42 ],
"concatenations": {},
"singles": [ "q1", "q2", "q3", "q4", "q5", "q6" ],
"qBlocks": {
"fieldBlocks": {
"MCQBlock1": {
"qType": "QTYPE_MCQ5",
"orig": [ 65, 79 ],
"qNos": [
[
[ "q1", "q2", "q3", "q4", "q5", "q6" ]
]
],
"gaps": [ 43, 50 ],
"bigGaps": [ 30, 30 ]
"fieldType": "QTYPE_MCQ5",
"origin": [65, 79],
"bubblesGap":43,
"labelsGap": 50,
"fieldLabels": ["q1..6"]
}
},
"preProcessors": [
Expand All @@ -24,4 +18,4 @@
}
}
]
}
}
Loading