| Name | SpyGRT JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Toolkit to build SGRT applications |
| upload_time | 2024-09-13 03:21:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.7 |
| license | MIT License
Copyright (c) 2022 The University of Sydney
Authors: Youssef Ben Bouchta
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 |
sgrt
radiation-oncology
radiotherapy
realsense
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SpyGRT
SpyGRT, or Surface Guided Radiotherapy Toolkit in Python is a toolkit that allows fast development of novel surface guidance applications for radiotherapy.
SpyGRT allows easy:
- Operation of the depth camera (current model is Intel Realsense D415)
- Calibration of multiple cameras into the same external frame of reference
- Tracking of motion using an ICP workflow
## Getting Started
### Installing SpyGRT using pip
The preferred method for installing SpyGRT is to use pip. This will download all the required packages, however a list of prerequisites and where to find them are listed in the next section in case you prefer to build them from source.
#### Steps to installing SpyGRT with pip
1. Clone the SpyGRT GitHub repo
2. Open a command prompt
3. Navigate to the SpyGRT folder (not the embedded spygrt folder)
4. Enter the following pip command
```
pip install -e .
```
5. You should now be able to run SpyGRT
### Prerequesites
#### 1. Intel RealSense SDK2.0
If you want to build from source, installation instructions available [here](https://github.com/IntelRealSense/librealsense). The code has currently only been tested up to release version 2.5.0 but should work with more recent releases.
#### 2. Open3D library v.0.15.0 or later
If you want to build it from source, full release available [here](https://github.com/PointCloudLibrary/pcl/releases) and instructions to compile it yourself are available [here](http://www.open3d.org/docs/release/getting_started.html).
#### 3. OpenCV
Full release available [here](https://opencv.org/releases/), if you prefer to build it from source.
#### 4. Numpy
More Information available [here](https://numpy.org/install/)
### Working Examples
The example folder contain three examples that illustrate how to use the basic functions of SpyGRT. More instructions are located in that folder.
### Depth Sensor
SpyGRT is currently built to use [Intel RealSense D415](https://www.intelrealsense.com/depth-camera-d415/) stereo depth sensors for capturing depth data. However, it should be possible to modify the stream module to work with any commercial depth sensors that have a python API.
### Intel RealSense Viewer
While SpyGRT contains the required code for real-time SGRT and analysis of prior recordings, it cannot currently be used to create new recordings. We suggest installing the free realsense-viewer app available [here](https://www.intelrealsense.com/sdk-2/) if you want to create your own recordings.
## Calibrations Boards
### Default SpyGRT Calibration Board
SpyGRT uses a checkerboard to calibrate multiple cameras. By default, it assumes that the checkboard has 5 rows, 8 columns, and that the length of the sides of each square is 4.3 centimeters. If you want to print the default checkerboard, you can find it in a powerpoint file located in the SampleData folder. This file should be printed on an A3 paper to get the accurate dimensions.
### Custom Calibration Board
Any checkerboard can be use to calibrate cameras with SpyGRT. If you want to use a custom checkerboard, you will need to change the following default variables in *calibration.py*
1. **DEFAULT_ROW**: Number of rows in the custom calibration board.
2. **DEFAULT_COLUMN**: Number of columns in the custom calibration board
3. **DEFAULT_SQUARE_SIZE**: Length in meters of the sides of a square in the custom calibration board
## Tracking with SpyGRT
Calibration files are necessary to use the SpyGRT for tracking. By default, SpyGRT will look for calibration files *../Calibrations/*. If you want to change this path, you must change the following constant in *tracker.py*
- **CALIBRATION_FOLDER**
## Author
Youssef Ben Bouchta
Email: youssef.benbouchta@sydney.edu.au
Raw data
{
"_id": null,
"home_page": null,
"name": "SpyGRT",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.7",
"maintainer_email": null,
"keywords": "SGRT, radiation-oncology, radiotherapy, realsense",
"author": null,
"author_email": "Youssef Ben Bouchta <youssef.benbouchta@sydney.edu.au>",
"download_url": "https://files.pythonhosted.org/packages/33/ce/029f4b8c150cade93e07523d6897c3bf5c5cfdb3d41cb057c97e07a14ad9/spygrt-1.0.0.tar.gz",
"platform": null,
"description": "# SpyGRT\n\nSpyGRT, or Surface Guided Radiotherapy Toolkit in Python is a toolkit that allows fast development of novel surface guidance applications for radiotherapy. \n\nSpyGRT allows easy: \n- Operation of the depth camera (current model is Intel Realsense D415)\n- Calibration of multiple cameras into the same external frame of reference\n- Tracking of motion using an ICP workflow \n\n## Getting Started\n\n### Installing SpyGRT using pip\nThe preferred method for installing SpyGRT is to use pip. This will download all the required packages, however a list of prerequisites and where to find them are listed in the next section in case you prefer to build them from source.\n\n#### Steps to installing SpyGRT with pip\n\n 1. Clone the SpyGRT GitHub repo\n 2. Open a command prompt \n 3. Navigate to the SpyGRT folder (not the embedded spygrt folder)\n 4. Enter the following pip command\n \n```\npip install -e . \n```\n 5. You should now be able to run SpyGRT\n\n### Prerequesites\n\n#### 1. Intel RealSense SDK2.0 \n\nIf you want to build from source, installation instructions available [here](https://github.com/IntelRealSense/librealsense). The code has currently only been tested up to release version 2.5.0 but should work with more recent releases. \n\n#### 2. Open3D library v.0.15.0 or later\n\nIf you want to build it from source, full release available [here](https://github.com/PointCloudLibrary/pcl/releases) and instructions to compile it yourself are available [here](http://www.open3d.org/docs/release/getting_started.html).\n\n#### 3. OpenCV \n\nFull release available [here](https://opencv.org/releases/), if you prefer to build it from source. \n\n#### 4. Numpy\nMore Information available [here](https://numpy.org/install/)\n\n### Working Examples\nThe example folder contain three examples that illustrate how to use the basic functions of SpyGRT. More instructions are located in that folder.\n\n### Depth Sensor\nSpyGRT is currently built to use [Intel RealSense D415](https://www.intelrealsense.com/depth-camera-d415/) stereo depth sensors for capturing depth data. However, it should be possible to modify the stream module to work with any commercial depth sensors that have a python API. \n\n### Intel RealSense Viewer\nWhile SpyGRT contains the required code for real-time SGRT and analysis of prior recordings, it cannot currently be used to create new recordings. We suggest installing the free realsense-viewer app available [here](https://www.intelrealsense.com/sdk-2/) if you want to create your own recordings. \n\n## Calibrations Boards\n\n### Default SpyGRT Calibration Board\n\nSpyGRT uses a checkerboard to calibrate multiple cameras. By default, it assumes that the checkboard has 5 rows, 8 columns, and that the length of the sides of each square is 4.3 centimeters. If you want to print the default checkerboard, you can find it in a powerpoint file located in the SampleData folder. This file should be printed on an A3 paper to get the accurate dimensions. \n\n### Custom Calibration Board\nAny checkerboard can be use to calibrate cameras with SpyGRT. If you want to use a custom checkerboard, you will need to change the following default variables in *calibration.py*\n\n1. **DEFAULT_ROW**: Number of rows in the custom calibration board.\n2. **DEFAULT_COLUMN**: Number of columns in the custom calibration board\n3. **DEFAULT_SQUARE_SIZE**: Length in meters of the sides of a square in the custom calibration board \n\n## Tracking with SpyGRT\nCalibration files are necessary to use the SpyGRT for tracking. By default, SpyGRT will look for calibration files *../Calibrations/*. If you want to change this path, you must change the following constant in *tracker.py*\n\n- **CALIBRATION_FOLDER**\n\n## Author\nYoussef Ben Bouchta\n\nEmail: youssef.benbouchta@sydney.edu.au\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2022 The University of Sydney\n \n Authors: Youssef Ben Bouchta\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Toolkit to build SGRT applications",
"version": "1.0.0",
"project_urls": {
"Download": "https://github.com/Image-X-Institute/SpyGRT/archive/refs/tags/v_1.0.0.tar.gz",
"Homepage": "https://github.com/ACRF-Image-X-Institute/SpyGRT"
},
"split_keywords": [
"sgrt",
" radiation-oncology",
" radiotherapy",
" realsense"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "57b1741753d2bfbb14db04deecc75902f71b8ce644214d7d985e3f3461559863",
"md5": "060675af8a4e3e81856615f99d0f88d2",
"sha256": "ea634613a2b9375c444253164dd2eb53f803d3594e867134956075ed06fc2948"
},
"downloads": -1,
"filename": "spygrt-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "060675af8a4e3e81856615f99d0f88d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.7",
"size": 25540,
"upload_time": "2024-09-13T03:21:28",
"upload_time_iso_8601": "2024-09-13T03:21:28.901446Z",
"url": "https://files.pythonhosted.org/packages/57/b1/741753d2bfbb14db04deecc75902f71b8ce644214d7d985e3f3461559863/spygrt-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "33ce029f4b8c150cade93e07523d6897c3bf5c5cfdb3d41cb057c97e07a14ad9",
"md5": "0478dd4ba828b938314514250a1ca7be",
"sha256": "389a5c5cfc717a8091c08b029daabd0c49b0b2b67d2b4989de59c4ad9c86945c"
},
"downloads": -1,
"filename": "spygrt-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0478dd4ba828b938314514250a1ca7be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.7",
"size": 21853,
"upload_time": "2024-09-13T03:21:31",
"upload_time_iso_8601": "2024-09-13T03:21:31.002133Z",
"url": "https://files.pythonhosted.org/packages/33/ce/029f4b8c150cade93e07523d6897c3bf5c5cfdb3d41cb057c97e07a14ad9/spygrt-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 03:21:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Image-X-Institute",
"github_project": "SpyGRT",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "spygrt"
}
