You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-20Lines changed: 10 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -17,35 +17,25 @@ pip install deepdrr
17
17
18
18
## Usage
19
19
20
-
DeepDRR is designed to be simple to use. The following minimal example loads a CT volume from a NifTi `.nii.gz` file and simulates X-ray projection of the IJK point [100, 100, 100]:
20
+
The following minimal example loads a CT volume from a NifTi `.nii.gz` file and simulates an X-ray projection:
21
21
22
22
```python
23
-
import deepdrr
23
+
from deepdrrimport geo, Volume, MobileCArm, Projector
with deepdrr.Projector(volume, camera_intrinsics, carm) as projector:
37
-
projection = projector()
29
+
with Projector(volume, camera_intrinsics, carm) as projector:
30
+
carm.move_to(alpha=30, beta=10, degrees=True)
31
+
projection = projector()
38
32
```
39
33
40
-
A more detailed example script is given in `example_projector.py`. This script contains a typical use-case for projecting over a volume.
41
-
42
-
## Documentation
43
-
44
-
Documentation is available at [deepdrr.readthedocs.io](https://deepdrr.readthedocs.io).
34
+
The script `example_projector.py` gives an alternative example. Additional tutorials are in progress at [deepdrr.readthedocs.io](https://deepdrr.readthedocs.io). Contributions are welcome.
45
35
46
36
## Contributing
47
37
48
-
Contributions are welcome. Please make a pull request.
38
+
Contributions for bug fixes, enhancements, and other suggestions are welcome. Please make a pull request.
0 commit comments