Skip to content

Commit d0ba8a6

Browse files
ken-niSaelraK-Rillapre-commit-ci[bot]dedeepyasai
authored
Added docstring to address 'Scaling of RandImageFilterd transform #6857' (#8055)
Fixes #6857 ### Description Added docstring to RandImageFilterd method which informs the user that they need to manually scale the result image when using this method. ### Types of changes <!--- Put an `x` in all the boxes that apply, and remove the not applicable items --> - [x] Non-breaking change (fix or new feature that would not break existing functionality). - [x] In-line docstrings updated. --------- Signed-off-by: dedeepyasai <[email protected]> Signed-off-by: saelra <[email protected]> Signed-off-by: Kelvin R <[email protected]> Signed-off-by: ken-ni <[email protected]> Signed-off-by: Dureti <[email protected]> Signed-off-by: YunLiu <[email protected]> Co-authored-by: saelra <[email protected]> Co-authored-by: Kelvin R. <[email protected]> Co-authored-by: Kelvin R <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: dedeepyasai <[email protected]> Co-authored-by: YunLiu <[email protected]> Co-authored-by: Ratanachat Saelee <[email protected]> Co-authored-by: Dureti <[email protected]> Co-authored-by: Eric Kerfoot <[email protected]>
1 parent b209347 commit d0ba8a6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

monai/transforms/utility/dictionary.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1714,6 +1714,10 @@ class RandImageFilterd(MapTransform, RandomizableTransform):
17141714
Probability the transform is applied to the data
17151715
allow_missing_keys:
17161716
Don't raise exception if key is missing.
1717+
1718+
Note:
1719+
- This transform does not scale output image values automatically to match the range of the input.
1720+
The output should be scaled by later transforms to match the input if this is desired.
17171721
"""
17181722

17191723
backend = ImageFilter.backend

0 commit comments

Comments
 (0)