Skip to content

docs: clarify backward mapping logic for RandAffine and RandAffined #8730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ytl0623 wants to merge 1 commit into
base: dev
Choose a base branch
from
+14 −0
Open

docs: clarify backward mapping logic for RandAffine and RandAffined #8730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions monai/transforms/spatial/array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2436,6 +2436,13 @@ def __init__(
- :py:class:`RandAffineGrid` for the random affine parameters configurations.
- :py:class:`Affine` for the affine transformation parameters configurations.

Note:
The affine transformations in MONAI use a 'backward mapping' (image-to-grid) logic.
This can be counter-intuitive:
- Translation: A positive value shifts the image in the negative direction.
- Scaling: Positive scale_range values decrease the image size; values in [-1, 0) increase it.
- Rotation: The direction (CW/CCW) may vary depending on the axis.

"""
RandomizableTransform.__init__(self, prob)
LazyTransform.__init__(self, lazy=lazy)
Expand Down
7 changes: 7 additions & 0 deletions monai/transforms/spatial/dictionary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1100,6 +1100,13 @@ def __init__(
- :py:class:`monai.transforms.compose.MapTransform`
- :py:class:`RandAffineGrid` for the random affine parameters configurations.

Note:
The affine transformations in MONAI use a 'backward mapping' (image-to-grid) logic.
This can be counter-intuitive:
- Translation: A positive value shifts the image in the negative direction.
- Scaling: Positive scale_range values decrease the image size; values in [-1, 0) increase it.
- Rotation: The direction (CW/CCW) may vary depending on the axis.

"""
MapTransform.__init__(self, keys, allow_missing_keys)
RandomizableTransform.__init__(self, prob)
Expand Down
Loading