# Monitrix
Monitrix is a numerical recognition system for monitors and displays utilizing image recognition and OCR technology. Using a YOLO-based custom model, it can extract numerical information from videos and images. / Monitrixは画像認識とOCR技術を活用したモニターやディスプレイ上の数値認識システムです。
## Requirements / 動作環境
- Python 3.10+
- ultralytics 8.x
- easyocr 1.7.x
## Install / インストール
1. [Install pytorch](https://pytorch.org/get-started/locally/)
2. [Install ultralytics](https://docs.ultralytics.com/quickstart/)
3. Install via pip (pipを使用してインストール):
```bash
pip install monitrix
```
## Usage / 使用例
### Command Line Interface / コマンドライン
- Image / 画像
```bash
monitrix_predict [image_path]
```
- Video / 動画
```bash
monitrix_predict_video [video_path]
```
### Python Script / Pythonスクリプト
For simple usage examples, please refer to the Jupyter notebook at `example/example.ipynb`. / 簡単な使用例は`example/example.ipynb`のJupyterノートブックを参照してください。
## Features / 主な機能
- Segmentation using custom YOLO model / カスタムYOLOモデルによるセグメンテーション
- Numerical recognition OCR / 数値認識OCR
- Command line interface / コマンドラインインターフェース
## License / ライセンス
This project is licensed under the GNU Affero General Public License v3 or later (AGPLv3+).
### Third-party Libraries / 使用ライブラリ
- Ultralytics (AGPL-3.0)
- easyocr (Apache License 2.0)
## Source Code / ソースコード
The complete source code is available at:
- [GitHub](https://github.com/arsklab/monitrix)
## Disclaimer / 免責事項
WARNING: This software is intended for non-medical use only, specifically for monitoring and reading numerical values from standard displays and monitors.
注意: 本ソフトウェアは非医療用途に限定され、特に標準的なディスプレイやモニターからの数値読み取りを目的としています。
The accuracy and reliability of readings may be affected by various factors including lighting conditions, display quality, and camera settings.
（読み取りの精度と信頼性は、照明条件、ディスプレイの品質、カメラ設定など、様々な要因の影響を受ける可能性があります）
In addition to the warranty disclaimer and limitation of liability provided by the AGPL-3.0 license:
AGPL-3.0ライセンスで提供される保証の免責事項および責任の制限に加えて：
- This software is not certified as a medical device and is provided for research purposes only
（本ソフトウェアは医療機器として認証されておらず、研究目的でのみ提供されています）
- No warranty is made regarding the accuracy or reliability of any numerical readings
（数値の正確性、信頼性については一切保証いたしません）
- The developers shall not be liable for any medical decisions or actions taken based on the output of this software
（開発者は、本ソフトウェアの出力に基づいて行われるいかなる医療上の決定または行動についても責任を負いません）
- Users acknowledge that they use this software at their own risk for non-medical purposes only
（利用者は、医療目的でない場合に限り、自己の責任において本ソフトウェアを使用することを認めます）
## Citation / 引用
If you use Monitrix in your research, please cite it as follows:
研究でMonitrixを使用する場合は、以下のように引用してください：
### BibTeX
```bibtex
@software{monitrix2024,
title = {Monitrix: A Numerical Recognition System for Displays},
author = {Arisaka Naoya},
year = {2024},
url = {https://github.com/arsklab/monitrix},
}
Raw data
{
"_id": null,
"home_page": null,
"name": "monitrix",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "monitoring, ocr, computer-vision, yolo, image-recognition",
"author": null,
"author_email": "Arisaka Naoya <arisakanaoya@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/08/fb/54f92421518906eb55852b251959bd4c117bd7c226c152a97e6add91ece4/monitrix-0.0.3.dev0.tar.gz",
"platform": null,
"description": "\r\n# Monitrix\r\n\r\n\r\nMonitrix is a numerical recognition system for monitors and displays utilizing image recognition and OCR technology. Using a YOLO-based custom model, it can extract numerical information from videos and images. / Monitrix\u306f\u753b\u50cf\u8a8d\u8b58\u3068OCR\u6280\u8853\u3092\u6d3b\u7528\u3057\u305f\u30e2\u30cb\u30bf\u30fc\u3084\u30c7\u30a3\u30b9\u30d7\u30ec\u30a4\u4e0a\u306e\u6570\u5024\u8a8d\u8b58\u30b7\u30b9\u30c6\u30e0\u3067\u3059\u3002\r\n\r\n## Requirements / \u52d5\u4f5c\u74b0\u5883\r\n- Python 3.10+\r\n- ultralytics 8.x\r\n- easyocr 1.7.x\r\n\r\n## Install / \u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\r\n\r\n1. [Install pytorch](https://pytorch.org/get-started/locally/)\r\n2. [Install ultralytics](https://docs.ultralytics.com/quickstart/)\r\n3. Install via pip (pip\u3092\u4f7f\u7528\u3057\u3066\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb):\r\n ```bash\r\n pip install monitrix\r\n ```\r\n\r\n## Usage / \u4f7f\u7528\u4f8b\r\n\r\n### Command Line Interface / \u30b3\u30de\u30f3\u30c9\u30e9\u30a4\u30f3\r\n- Image / \u753b\u50cf\r\n```bash\r\nmonitrix_predict [image_path]\r\n```\r\n- Video / \u52d5\u753b\r\n```bash\r\nmonitrix_predict_video [video_path]\r\n```\r\n\r\n### Python Script / Python\u30b9\u30af\u30ea\u30d7\u30c8\r\nFor simple usage examples, please refer to the Jupyter notebook at `example/example.ipynb`. / \u7c21\u5358\u306a\u4f7f\u7528\u4f8b\u306f`example/example.ipynb`\u306eJupyter\u30ce\u30fc\u30c8\u30d6\u30c3\u30af\u3092\u53c2\u7167\u3057\u3066\u304f\u3060\u3055\u3044\u3002\r\n\r\n## Features / \u4e3b\u306a\u6a5f\u80fd\r\n- Segmentation using custom YOLO model / \u30ab\u30b9\u30bf\u30e0YOLO\u30e2\u30c7\u30eb\u306b\u3088\u308b\u30bb\u30b0\u30e1\u30f3\u30c6\u30fc\u30b7\u30e7\u30f3\r\n- Numerical recognition OCR / \u6570\u5024\u8a8d\u8b58OCR\r\n- Command line interface / \u30b3\u30de\u30f3\u30c9\u30e9\u30a4\u30f3\u30a4\u30f3\u30bf\u30fc\u30d5\u30a7\u30fc\u30b9\r\n\r\n## License / \u30e9\u30a4\u30bb\u30f3\u30b9\r\nThis project is licensed under the GNU Affero General Public License v3 or later (AGPLv3+).\r\n\r\n### Third-party Libraries / \u4f7f\u7528\u30e9\u30a4\u30d6\u30e9\u30ea\r\n- Ultralytics (AGPL-3.0)\r\n- easyocr (Apache License 2.0)\r\n\r\n## Source Code / \u30bd\u30fc\u30b9\u30b3\u30fc\u30c9\r\nThe complete source code is available at:\r\n- [GitHub](https://github.com/arsklab/monitrix)\r\n\r\n## Disclaimer / \u514d\u8cac\u4e8b\u9805\r\n\r\nWARNING: This software is intended for non-medical use only, specifically for monitoring and reading numerical values from standard displays and monitors.\r\n\r\n\u6ce8\u610f: \u672c\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u306f\u975e\u533b\u7642\u7528\u9014\u306b\u9650\u5b9a\u3055\u308c\u3001\u7279\u306b\u6a19\u6e96\u7684\u306a\u30c7\u30a3\u30b9\u30d7\u30ec\u30a4\u3084\u30e2\u30cb\u30bf\u30fc\u304b\u3089\u306e\u6570\u5024\u8aad\u307f\u53d6\u308a\u3092\u76ee\u7684\u3068\u3057\u3066\u3044\u307e\u3059\u3002\r\n\r\nThe accuracy and reliability of readings may be affected by various factors including lighting conditions, display quality, and camera settings.\r\n\uff08\u8aad\u307f\u53d6\u308a\u306e\u7cbe\u5ea6\u3068\u4fe1\u983c\u6027\u306f\u3001\u7167\u660e\u6761\u4ef6\u3001\u30c7\u30a3\u30b9\u30d7\u30ec\u30a4\u306e\u54c1\u8cea\u3001\u30ab\u30e1\u30e9\u8a2d\u5b9a\u306a\u3069\u3001\u69d8\u3005\u306a\u8981\u56e0\u306e\u5f71\u97ff\u3092\u53d7\u3051\u308b\u53ef\u80fd\u6027\u304c\u3042\u308a\u307e\u3059\uff09\r\n\r\nIn addition to the warranty disclaimer and limitation of liability provided by the AGPL-3.0 license:\r\nAGPL-3.0\u30e9\u30a4\u30bb\u30f3\u30b9\u3067\u63d0\u4f9b\u3055\u308c\u308b\u4fdd\u8a3c\u306e\u514d\u8cac\u4e8b\u9805\u304a\u3088\u3073\u8cac\u4efb\u306e\u5236\u9650\u306b\u52a0\u3048\u3066\uff1a\r\n\r\n- This software is not certified as a medical device and is provided for research purposes only\r\n\uff08\u672c\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u306f\u533b\u7642\u6a5f\u5668\u3068\u3057\u3066\u8a8d\u8a3c\u3055\u308c\u3066\u304a\u3089\u305a\u3001\u7814\u7a76\u76ee\u7684\u3067\u306e\u307f\u63d0\u4f9b\u3055\u308c\u3066\u3044\u307e\u3059\uff09\r\n- No warranty is made regarding the accuracy or reliability of any numerical readings\r\n\uff08\u6570\u5024\u306e\u6b63\u78ba\u6027\u3001\u4fe1\u983c\u6027\u306b\u3064\u3044\u3066\u306f\u4e00\u5207\u4fdd\u8a3c\u3044\u305f\u3057\u307e\u305b\u3093\uff09\r\n- The developers shall not be liable for any medical decisions or actions taken based on the output of this software\r\n\uff08\u958b\u767a\u8005\u306f\u3001\u672c\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u306e\u51fa\u529b\u306b\u57fa\u3065\u3044\u3066\u884c\u308f\u308c\u308b\u3044\u304b\u306a\u308b\u533b\u7642\u4e0a\u306e\u6c7a\u5b9a\u307e\u305f\u306f\u884c\u52d5\u306b\u3064\u3044\u3066\u3082\u8cac\u4efb\u3092\u8ca0\u3044\u307e\u305b\u3093\uff09\r\n- Users acknowledge that they use this software at their own risk for non-medical purposes only\r\n\uff08\u5229\u7528\u8005\u306f\u3001\u533b\u7642\u76ee\u7684\u3067\u306a\u3044\u5834\u5408\u306b\u9650\u308a\u3001\u81ea\u5df1\u306e\u8cac\u4efb\u306b\u304a\u3044\u3066\u672c\u30bd\u30d5\u30c8\u30a6\u30a7\u30a2\u3092\u4f7f\u7528\u3059\u308b\u3053\u3068\u3092\u8a8d\u3081\u307e\u3059\uff09\r\n\r\n\r\n\r\n\r\n## Citation / \u5f15\u7528\r\n\r\nIf you use Monitrix in your research, please cite it as follows:\r\n\u7814\u7a76\u3067Monitrix\u3092\u4f7f\u7528\u3059\u308b\u5834\u5408\u306f\u3001\u4ee5\u4e0b\u306e\u3088\u3046\u306b\u5f15\u7528\u3057\u3066\u304f\u3060\u3055\u3044\uff1a\r\n\r\n### BibTeX\r\n```bibtex\r\n@software{monitrix2024,\r\n title = {Monitrix: A Numerical Recognition System for Displays},\r\n author = {Arisaka Naoya},\r\n year = {2024},\r\n url = {https://github.com/arsklab/monitrix},\r\n}\r\n",
"bugtrack_url": null,
"license": "GNU Affero General Public License v3 or later (AGPLv3+)",
"summary": "An advanced monitoring tool with OCR and image recognition capabilities",
"version": "0.0.3.dev0",
"project_urls": {
"Homepage": "https://github.com/arsklab/monitrix",
"Issues": "https://github.com/arsklab/monitrix/issues",
"Source": "https://github.com/arsklab/monitrix"
},
"split_keywords": [
"monitoring",
" ocr",
" computer-vision",
" yolo",
" image-recognition"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8ffe7ba582bf0dba08d09771e821cbdcb981e41001bebd928800933a019ad74",
"md5": "3c12dba45d0d958c086f1670cb76528e",
"sha256": "91178edb54f391ccc56e862cd89143f1d8b5639e9c27502c9f6240a1e4d1c172"
},
"downloads": -1,
"filename": "monitrix-0.0.3.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c12dba45d0d958c086f1670cb76528e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5453062,
"upload_time": "2024-12-06T00:57:38",
"upload_time_iso_8601": "2024-12-06T00:57:38.337002Z",
"url": "https://files.pythonhosted.org/packages/f8/ff/e7ba582bf0dba08d09771e821cbdcb981e41001bebd928800933a019ad74/monitrix-0.0.3.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "08fb54f92421518906eb55852b251959bd4c117bd7c226c152a97e6add91ece4",
"md5": "40956deac422e249a1c32c1566649091",
"sha256": "feed3a154be58fed849368194734535e9620da07d33d0d863e77c2303fc84e24"
},
"downloads": -1,
"filename": "monitrix-0.0.3.dev0.tar.gz",
"has_sig": false,
"md5_digest": "40956deac422e249a1c32c1566649091",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5451052,
"upload_time": "2024-12-06T00:57:44",
"upload_time_iso_8601": "2024-12-06T00:57:44.966657Z",
"url": "https://files.pythonhosted.org/packages/08/fb/54f92421518906eb55852b251959bd4c117bd7c226c152a97e6add91ece4/monitrix-0.0.3.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 00:57:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arsklab",
"github_project": "monitrix",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "monitrix"
}
JSON
