| Name | PAROS JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | PARaxial Optical fundus Scaling (PAROS) |
| upload_time | 2024-01-04 10:46:33 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Lennart Pors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ophthalmology
paraxial optics
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PARaxial Optical fundus Scaling (PAROS)
Paros is a method to calculate the magnification of fundus images based on the optical characteristics of the patient's eye. The full method and validation are described in (article reference to be added upon acceptance)
## License
The code is provided as is, without any warranty, under the [MIT license](LICENSE). This license requires that reusers give credit to the creator. It allows reusers to distribute, remix, adapt, and build upon the material in any medium or format.
## Basic usage
A basic version of PAROS can most easily be run online here: [Basic version](https://mreye-lumc.github.io/PAROS)
The full package is also available for download via PiP:
```
pip install PAROS
```
PAROS consists of two main functions:
- ‘fundus_camera_calibration.ipynb’: a method to calibrate camera using eye phantom measurements.
- ‘calculate_ocular_magnification.ipynb’: a method to calculate magnification fundus images of a subject.
## Implementation
The implementation of PAROS in this repository is functional for the camera in our center, and with the specific software used at our center. Both have impact on the calculated magnification. We therefore recommend calibration of the camera and software using the method described in the article mentioned below before implementation for quantitative purposes.
## Camera constants
Please find here a table of known camera calibration constants; this can be added upon by other contributors.
| Camera type | CCD type | Condenser lens power (D) | First order calibration term |
| --------------- | -------- | ------------------------ | ---------------------------- |
| Topcon TRC-50DX | | 38.0 | -0.011 |
| Topcon TRC-50IX | | 38.0 | -0.012 |
## Referencing
When publishing results obtained with this package, please cite the paper that describes the full method and validation: Pors, L.J., et al. (2023). "Correction method for optical scaling of fundoscopy images: development, validation and first implementation" in press.
## Contributing
Please read our [contribution guidelines](CONTRIBUTING.md) prior to opening a Pull Request.
## Contact
Feel free to contact us for any inquiries:
- L.J. Pors ([email](mailto:l.j.pors@lumc.nl))
- J.W.M. Beenakker ([email](mailto:j.w.m.beenakker@lumc.nl))
Raw data
{
"_id": null,
"home_page": "",
"name": "PAROS",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "ophthalmology,paraxial optics",
"author": "",
"author_email": "\"Lennart J. Pors\" <l.j.pors@lumc.nl>, \"Jan-Willem M. Beenakker\" <j.w.m.beenakker@lumc.nl>, Corn\u00e9 Haasjes <c.haasjes@lumc.nl>",
"download_url": "https://files.pythonhosted.org/packages/d5/d2/b4a878e9c5a84068bea90ca877bdbf0c46483077a6fbcd724836d19ef884/paros-0.1.0.tar.gz",
"platform": null,
"description": "# PARaxial Optical fundus Scaling (PAROS)\n\nParos is a method to calculate the magnification of fundus images based on the optical characteristics of the patient's eye. The full method and validation are described in (article reference to be added upon acceptance)\n\n## License\n\nThe code is provided as is, without any warranty, under the [MIT license](LICENSE). This license requires that reusers give credit to the creator. It allows reusers to distribute, remix, adapt, and build upon the material in any medium or format. \n\n## Basic usage\n\nA basic version of PAROS can most easily be run online here: [Basic version](https://mreye-lumc.github.io/PAROS)\n\nThe full package is also available for download via PiP:\n\n```\npip install PAROS\n``` \n\nPAROS consists of two main functions: \n\n- \u2018fundus_camera_calibration.ipynb\u2019: a method to calibrate camera using eye phantom measurements. \n- \u2018calculate_ocular_magnification.ipynb\u2019: a method to calculate magnification fundus images of a subject. \n\n## Implementation \n\nThe implementation of PAROS in this repository is functional for the camera in our center, and with the specific software used at our center. Both have impact on the calculated magnification. We therefore recommend calibration of the camera and software using the method described in the article mentioned below before implementation for quantitative purposes.\n\n## Camera constants\n\nPlease find here a table of known camera calibration constants; this can be added upon by other contributors. \n| Camera type | CCD type | Condenser lens power (D) | First order calibration term |\n| --------------- | -------- | ------------------------ | ---------------------------- |\n| Topcon TRC-50DX | | 38.0 | -0.011 |\n| Topcon TRC-50IX | | 38.0 | -0.012 |\n\n## Referencing\n\nWhen publishing results obtained with this package, please cite the paper that describes the full method and validation: Pors, L.J., et al. (2023). \"Correction method for optical scaling of fundoscopy images: development, validation and first implementation\" in press.\n\n## Contributing\n\nPlease read our [contribution guidelines](CONTRIBUTING.md) prior to opening a Pull Request.\n\n## Contact\n\nFeel free to contact us for any inquiries:\n\n- L.J. Pors ([email](mailto:l.j.pors@lumc.nl))\n- J.W.M. Beenakker ([email](mailto:j.w.m.beenakker@lumc.nl))",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Lennart Pors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "PARaxial Optical fundus Scaling (PAROS)",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"ophthalmology",
"paraxial optics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d181dd3a55eadae5fd4a319848f1f002a4240ce17402db7285c871a15260b6db",
"md5": "169993541fd11f98d856c2797b946b38",
"sha256": "8a9e1a15334ad9528cadf76dd67617dc2bb5800b82c3c49ac81d100d98d824ea"
},
"downloads": -1,
"filename": "paros-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "169993541fd11f98d856c2797b946b38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14537,
"upload_time": "2024-01-04T10:46:31",
"upload_time_iso_8601": "2024-01-04T10:46:31.473088Z",
"url": "https://files.pythonhosted.org/packages/d1/81/dd3a55eadae5fd4a319848f1f002a4240ce17402db7285c871a15260b6db/paros-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d5d2b4a878e9c5a84068bea90ca877bdbf0c46483077a6fbcd724836d19ef884",
"md5": "4dae29cd6a33e86eb05a29f238c99c66",
"sha256": "7f545c66b13922416ae73ae7812e0051a48a85dacdcb0042a32d9d109f96c737"
},
"downloads": -1,
"filename": "paros-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4dae29cd6a33e86eb05a29f238c99c66",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 55906,
"upload_time": "2024-01-04T10:46:33",
"upload_time_iso_8601": "2024-01-04T10:46:33.186560Z",
"url": "https://files.pythonhosted.org/packages/d5/d2/b4a878e9c5a84068bea90ca877bdbf0c46483077a6fbcd724836d19ef884/paros-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-04 10:46:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "paros"
}
