Skip to content

Commit 11269a4

Browse files
committed
fix README.md for installation instructions and update expected labels in usage examples
1 parent b0a9f75 commit 11269a4

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This repo contains implementation of various label fusion approaches that can be
1212

1313
## Installation
1414

15-
### For Usage
15+
### Default
1616
```sh
1717
conda create -n venv_labelFusion python=3.12 -y
1818
conda activate venv_labelFusion
@@ -31,7 +31,7 @@ pip install -e .
3131
# initiate pull request
3232
```
3333

34-
## Available LabelFusion:
34+
## Available fusion methods:
3535

3636
- [Voting (ITK)](https://simpleitk.org/doxygen/latest/html/classitk_1_1simple_1_1LabelVotingImageFilter.html): [DOI:10.1016/j.patrec.2005.03.017](https://doi.org/10.1016/j.patrec.2005.03.017)
3737
- [STAPLE (ITK)](https://simpleitk.org/doxygen/latest/html/classitk_1_1simple_1_1MultiLabelSTAPLEImageFilter.html): [DOI:10.1109/TMI.2004.830803](https://doi.org/10.1109/TMI.2004.830803)
@@ -47,7 +47,7 @@ pip install -e .
4747
python fusion_run -h
4848
-h, --help show this help message and exit
4949
-inputs INPUTS The absolute, comma-separated paths of labels that need to be fused
50-
-classes CLASSES The expected labels; for example, for BraTS, this should be '0,1,2,4' - not used for STAPLE or ITKVoting
50+
-classes CLASSES The expected labels; for example, for BraTS, this should be '0,1,2,3' - not used for STAPLE or ITKVoting
5151
-method METHOD The method to apply; currently available: STAPLE | ITKVoting | MajorityVoting | SIMPLE
5252
-output OUTPUT The output file to write the results
5353
```
@@ -57,7 +57,7 @@ Example:
5757
# continue from previous shell
5858
python fusion_run \
5959
-inputs /path/to/seg_algo_0.nii.gz,/path/to/seg_algo_1.nii.gz,/path/to/seg_algo_2.nii.gz \
60-
-classes 0,1,2,4 \
60+
-classes 0,1,2,3 \
6161
-method STAPLE \
6262
-output /path/to/seg_fusion.nii.gz
6363
```
@@ -77,13 +77,13 @@ images_to_fuse.append(sitk.ReadImage(label_to_fuse_0, sitk.sitkUInt8))
7777
images_to_fuse.append(sitk.ReadImage(label_to_fuse_1, sitk.sitkUInt8))
7878
fused_staple = fuse_images(images_to_fuse, 'staple') # class_list is not needed for staple/itkvoting
7979
sitk.WriteImage(fused_staple, '/path/to/output_staple.nii.gz')
80-
fused_simple = fuse_images(images_to_fuse, 'simple', class_list=[0,1,2,4])
80+
fused_simple = fuse_images(images_to_fuse, 'simple', class_list=[0,1,2,3])
8181
sitk.WriteImage(fused_simple, '/path/to/output_simple.nii.gz')
8282
```
8383

8484
## Testing
8585

86-
This repo has continuous integration enabled via [Azure DevOps](https://dev.azure.com/FETS-AI/LabelFusion/_build?definitionId=2&_a=summary) for the following [operating systems](https://github.com/FETS-AI/LabelFusion/blob/a51b82ad9880d466ed1d42441dd46de37e931df4/azure-pipelines.yml#L9):
86+
This repo has continuous integration enabled via [GitHub Actions](https://github.com/FeTS-AI/LabelFusion/actions/workflows/test.yml) for the following [operating systems](https://github.com/FeTS-AI/LabelFusion/blob/main/.github/workflows/test.yml#L18):
8787

8888
- Windows
8989
- Ubuntu

0 commit comments

Comments
 (0)