README.md 1.09 KB
Newer Older
1
# TG263
Gabriel Couture's avatar
Gabriel Couture committed
2

3 4
Basic TG263 implementation. This library could be used as a
structure name filter in your program. 
5

6 7
## Installation

8 9 10 11 12 13
```bash
$ pip install tg263
```

Or from current master branch:

14 15 16 17
```bash
$ pip install git+https://github.com/gacou54/tg263
```

18 19 20 21 22 23
## Usage

### Validating the structure name
```python
import tg263

Gabriel Couture's avatar
Gabriel Couture committed
24
result = tg263.is_structure_name_allowed('Prostate')
Gabriel Couture's avatar
Gabriel Couture committed
25
# Result is `True`
26
```
27

Gabriel Couture's avatar
Gabriel Couture committed
28 29 30 31 32 33 34 35 36 37 38 39 40
### Finding a structure
```python
import tg263

result = tg263.find_structure('SpinalCord_PRV12')

print(result.description)
print(result.anatomic_group)
print(result.target_type)
print(result.major_category)
print(result.minor_category)
print(result.fmaid)
```
41 42 43

## Acknowledgements

Gabriel Couture's avatar
Gabriel Couture committed
44 45 46 47 48 49 50
This work is a basic implementation of the __TG263__
(https://www.aapm.org/pubs/reports/RPT_263.pdf)

The allowed structure names (and corresponding information) were taken from
https://www.aapm.org/pubs/reports/RPT_263_Supplemental/ .

The initial allowed structure names were taken from the __ESAPIX__
51
project (https://github.com/rexcardan/ESAPIX), made by __Rex Cardan__.
52
The ESAPIX license is included in the LICENSE file.