From d0ba8a60950e4a7ffbffa3bab7349117123f1ddb Mon Sep 17 00:00:00 2001 From: Kennett Vera Date: Fri, 30 Aug 2024 17:07:06 -0700 Subject: [PATCH] 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 - [x] Non-breaking change (fix or new feature that would not break existing functionality). - [x] In-line docstrings updated. --------- Signed-off-by: dedeepyasai Signed-off-by: saelra Signed-off-by: Kelvin R Signed-off-by: ken-ni Signed-off-by: Dureti <98233210+DuretiShemsi@users.noreply.github.com> Signed-off-by: YunLiu <55491388+KumoLiu@users.noreply.github.com> Co-authored-by: saelra Co-authored-by: Kelvin R. <138339140+K-Rilla@users.noreply.github.com> Co-authored-by: Kelvin R Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: dedeepyasai Co-authored-by: YunLiu <55491388+KumoLiu@users.noreply.github.com> Co-authored-by: Ratanachat Saelee <146144408+Saelra@users.noreply.github.com> Co-authored-by: Dureti <98233210+DuretiShemsi@users.noreply.github.com> Co-authored-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com> --- monai/transforms/utility/dictionary.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/monai/transforms/utility/dictionary.py b/monai/transforms/utility/dictionary.py index 7e3a7b0454..2475060f4e 100644 --- a/monai/transforms/utility/dictionary.py +++ b/monai/transforms/utility/dictionary.py @@ -1714,6 +1714,10 @@ class RandImageFilterd(MapTransform, RandomizableTransform): Probability the transform is applied to the data allow_missing_keys: Don't raise exception if key is missing. + + Note: + - This transform does not scale output image values automatically to match the range of the input. + The output should be scaled by later transforms to match the input if this is desired. """ backend = ImageFilter.backend