Skip to content

Commit cacde44

Browse files
committed
Add note that registrator is optional and provide install instructions
1 parent 2d2b513 commit cacde44

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

brainles_preprocessing/registration/elastix/elastix.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ def register(
2626
"""
2727
Register images using elastix.
2828
29+
This is an optional dependency - to use this registrator, you need to install the `brainles_preprocessing` package with the `itk-elastix` extra: `pip install brainles_preprocessing[itk-elastix]`.
30+
2931
Args:
3032
fixed_image_path (str): Path to the fixed image.
3133
moving_image_path (str): Path to the moving image.

brainles_preprocessing/registration/greedy/greedy.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ def register(
2424
log_file_path: Optional[str] = None,
2525
) -> None:
2626
"""
27-
Register images using greedy. Ref: https://pypi.org/project/picsl-greedy/ and https://greedy.readthedocs.io/en/latest/reference.html#greedy-usage
27+
Register images using greedy. Ref: https://pypi.org/project/picsl-greedy/ and https://greedy.readthedocs.io/en/latest/reference.html#greedy-usage.
28+
29+
This is an optional dependency - to use this registrator, you need to install the `brainles_preprocessing` package with the `picsl_greedy` extra: `pip install brainles_preprocessing[picsl_greedy]`.
2830
2931
Args:
3032
fixed_image_path (str): Path to the fixed image.

0 commit comments

Comments
 (0)