Skip to content

Commit 813b2be

Browse files
authored
Merge pull request #148 from BrainLesion/137-feature-bring-rtd-page-up-to-date
137 feature bring rtd page up to date
2 parents ba9ef14 + f3bd421 commit 813b2be

File tree

4 files changed

+50
-6
lines changed

4 files changed

+50
-6
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,11 +138,17 @@ We provide a (WIP) documentation. Have a look [here](https://brainles-preprocess
138138
Please credit the authors by citing their work.
139139

140140
### Registration
141-
We currently provide support for [ANTs](https://github.com/ANTsX/ANTs) (default), [Niftyreg](https://github.com/KCL-BMEIS/niftyreg) (Linux).
141+
We currently provide support for [ANTs](https://github.com/ANTsX/ANTs) (default), [Niftyreg](https://github.com/KCL-BMEIS/niftyreg) (Linux). We also offer basic support for [greedy](https://greedy.readthedocs.io/en/latest/reference.html#greedy-usage) and [elastix](https://pypi.org/project/itk-elastix/0.13.0/).
142142

143143
### Atlas Reference
144-
We provide the SRI-24 atlas from this [publication](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC2915788/).
145-
However, custom atlases in NIfTI format are supported.
144+
We provide a range of different atlases, namely:
145+
- [SRI24](https://www.nitrc.org/frs/download.php/4502/sri24_anatomy_unstripped_nifti.zip) and its [skull-stripped version](https://www.nitrc.org/frs/download.php/4499/sri24_anatomy_nifti.zip)
146+
- A slightly modified SRI24 atlas as found in the BraTS challenges (also with a skull-stripped version)
147+
- MNI152: [MNI_ICBM_2009c_Nonlinear_Symmetric](https://nist.mni.mcgill.ca/icbm-152-nonlinear-atlases-2009/)
148+
- A slightly modified MNI152 atlas as found in the BraTS challenge
149+
150+
We also support supplying a custom atlas in NIfTI format
151+
146152

147153
### N4 Bias correction
148154
We currently provide support for N4 Bias correction based on [SimpleITK](https://simpleitk.org/)

docs/source/brainles-preprocessing.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,30 @@ brainles_preprocessing
22
============================================
33

44

5-
modality
5+
Modality
66
--------------------------------------------
77

88
.. automodule:: brainles_preprocessing.modality
99

1010

11-
preprocessor
11+
Preprocessor
1212
--------------------------------------------
1313

14-
.. automodule:: brainles_preprocessing.preprocessor
14+
.. automodule:: brainles_preprocessing.preprocessor.preprocessor
1515

1616

17+
.. automodule:: brainles_preprocessing.preprocessor.atlas_centric_preprocessor
18+
19+
20+
.. automodule:: brainles_preprocessing.preprocessor.native_space_preprocessor
21+
22+
23+
Constants
24+
--------------------------------------------
25+
.. automodule:: brainles_preprocessing.constants
26+
27+
28+
Transform
29+
--------------------------------------------
30+
.. automodule:: brainles_preprocessing.transform
31+

docs/source/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ Indices and tables
2929
brainles-preprocessing.rst
3030

3131

32+
.. toctree::
33+
:maxdepth: 2
34+
:caption: N4 Bias Correction:
35+
36+
n4-bias-correction.rst
37+
38+
3239
.. toctree::
3340
:maxdepth: 2
3441
:caption: brain_extraction:

docs/source/n4-bias-correction.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
N4 Bias Correction
2+
============================================
3+
4+
5+
6+
n4_bias_correction.n4_bias_corrector
7+
--------------------------------------------
8+
9+
.. automodule:: brainles_preprocessing.n4_bias_correction.n4_bias_corrector
10+
11+
12+
n4_bias_correction.sitk
13+
--------------------------------------
14+
15+
.. automodule:: brainles_preprocessing.n4_bias_correction.sitk.sitk_n4_bias_corrector
16+

0 commit comments

Comments
 (0)