Add TODOs

CellProfiler · Dec 10, 2024 · fe4521d · fe4521d
1 parent cdd890a
commit fe4521d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/subpackages/core/cellprofiler_core/constants/modules/namesandtypes.py b/src/subpackages/core/cellprofiler_core/constants/modules/namesandtypes.py
@@ -27,6 +27,7 @@
 ]
 MANUAL_INTENSITY_LABEL = "Maximum intensity"
 
+# TODO - 4955: Revise help text for NamesAndTypes
 RESCALING_HELP_TEXT = """\
 This option determines how the image intensity should be rescaled from
 0.0 – 1.0.

diff --git a/src/subpackages/core/cellprofiler_core/image/abstract_image/file/_file_image.py b/src/subpackages/core/cellprofiler_core/image/abstract_image/file/_file_image.py
@@ -51,8 +51,8 @@ def __init__(
         :type pathname:
         :param filename: Filename of file or last chunk of URL
         :type filename:
-        :param rescale:
-        :type rescale:
+        :param rescale: Whether to do metadata-based rescale (True), type-based rescale (False), or manual rescale (float)
+        :type rescale: boolean or float
         :param series:
         :type series:
         :param index:
@@ -359,6 +359,7 @@ def __set_image(self):
                     stack.append(img)
                 img = numpy.dstack(stack)
         if isinstance(self.rescale, float):
+            # TODO - 4955: careful here with casting
             # Apply a manual rescale
             img = img.astype(numpy.float32) / self.rescale
         self.__image = Image(