From 0913ace46103d5600aeb738572473b30a3babce3 Mon Sep 17 00:00:00 2001
From: mdelitroz <maxime.delitroz@idiap.ch>
Date: Thu, 27 Jul 2023 09:25:46 +0200
Subject: [PATCH] [data.image_utils.py] replaced load_pil_baw by
 load_pil_grayscale. Updated the docstring and call in the rest of the package
 accordingly

---
 src/ptbench/data/hivtb/__init__.py                | 4 ++--
 src/ptbench/data/image_utils.py                   | 6 +++---
 src/ptbench/data/indian/__init__.py               | 4 ++--
 src/ptbench/data/tbpoc/__init__.py                | 4 ++--
 src/ptbench/data/tbx11k_simplified/__init__.py    | 6 +++---
 src/ptbench/data/tbx11k_simplified_v2/__init__.py | 6 +++---
 6 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/src/ptbench/data/hivtb/__init__.py b/src/ptbench/data/hivtb/__init__.py
index 88401da0..e004c1dc 100644
--- a/src/ptbench/data/hivtb/__init__.py
+++ b/src/ptbench/data/hivtb/__init__.py
@@ -20,7 +20,7 @@ import os
 from ...utils.rc import load_rc
 from .. import make_dataset
 from ..dataset import JSONDataset
-from ..loader import load_pil_baw, make_delayed
+from ..loader import load_pil_grayscale, make_delayed
 
 _protocols = [
     importlib.resources.files(__name__).joinpath("fold_0.json.bz2"),
@@ -40,7 +40,7 @@ _datadir = load_rc().get("datadir.hivtb", os.path.realpath(os.curdir))
 
 def _raw_data_loader(sample):
     return dict(
-        data=load_pil_baw(os.path.join(_datadir, sample["data"])),
+        data=load_pil_grayscale(os.path.join(_datadir, sample["data"])),
         label=sample["label"],
     )
 
diff --git a/src/ptbench/data/image_utils.py b/src/ptbench/data/image_utils.py
index b1c9d82e..9103126f 100644
--- a/src/ptbench/data/image_utils.py
+++ b/src/ptbench/data/image_utils.py
@@ -96,8 +96,8 @@ def load_pil(path: str | pathlib.Path) -> PIL.Image.Image:
     return PIL.Image.open(path)
 
 
-def load_pil_baw(path: str | pathlib.Path) -> PIL.Image.Image:
-    """Loads a sample data.
+def load_pil_grayscale(path: str | pathlib.Path) -> PIL.Image.Image:
+    """Loads a sample data in grayscale mode ("L").
 
     Parameters
     ----------
@@ -116,7 +116,7 @@ def load_pil_baw(path: str | pathlib.Path) -> PIL.Image.Image:
 
 
 def load_pil_rgb(path: str | pathlib.Path) -> PIL.Image.Image:
-    """Loads a sample data.
+    """Loads a sample data in RGB mode ("RGB").
 
     Parameters
     ----------
diff --git a/src/ptbench/data/indian/__init__.py b/src/ptbench/data/indian/__init__.py
index 5255c783..889cf513 100644
--- a/src/ptbench/data/indian/__init__.py
+++ b/src/ptbench/data/indian/__init__.py
@@ -19,7 +19,7 @@ import os
 from ...utils.rc import load_rc
 from .. import make_dataset
 from ..dataset import JSONDataset
-from ..loader import load_pil_baw, make_delayed
+from ..loader import load_pil_grayscale, make_delayed
 
 _protocols = [
     importlib.resources.files(__name__).joinpath("default.json.bz2"),
@@ -40,7 +40,7 @@ _datadir = load_rc().get("datadir.indian", os.path.realpath(os.curdir))
 
 def _raw_data_loader(sample):
     return dict(
-        data=load_pil_baw(os.path.join(_datadir, sample["data"])),
+        data=load_pil_grayscale(os.path.join(_datadir, sample["data"])),
         label=sample["label"],
     )
 
diff --git a/src/ptbench/data/tbpoc/__init__.py b/src/ptbench/data/tbpoc/__init__.py
index 6108b2fb..4d9f4550 100644
--- a/src/ptbench/data/tbpoc/__init__.py
+++ b/src/ptbench/data/tbpoc/__init__.py
@@ -20,7 +20,7 @@ import os
 from ...utils.rc import load_rc
 from .. import make_dataset
 from ..dataset import JSONDataset
-from ..loader import load_pil_baw, make_delayed
+from ..loader import load_pil_grayscale, make_delayed
 
 _protocols = [
     importlib.resources.files(__name__).joinpath("fold_0.json.bz2"),
@@ -40,7 +40,7 @@ _datadir = load_rc().get("datadir.tbpoc", os.path.realpath(os.curdir))
 
 def _raw_data_loader(sample):
     return dict(
-        data=load_pil_baw(os.path.join(_datadir, sample["data"])),
+        data=load_pil_grayscale(os.path.join(_datadir, sample["data"])),
         label=sample["label"],
     )
 
diff --git a/src/ptbench/data/tbx11k_simplified/__init__.py b/src/ptbench/data/tbx11k_simplified/__init__.py
index 7e66abc3..901975f6 100644
--- a/src/ptbench/data/tbx11k_simplified/__init__.py
+++ b/src/ptbench/data/tbx11k_simplified/__init__.py
@@ -28,7 +28,7 @@ import os
 
 from ...utils.rc import load_rc
 from ..dataset import JSONDataset
-from ..loader import load_pil_baw, make_delayed, make_delayed_bbox
+from ..loader import load_pil_grayscale, make_delayed, make_delayed_bbox
 
 _protocols = [
     importlib.resources.files(__name__).joinpath("default.json.bz2"),
@@ -51,14 +51,14 @@ _datadir = load_rc().get(
 
 def _raw_data_loader(sample):
     return dict(
-        data=load_pil_baw(os.path.join(_datadir, sample["data"])),  # type: ignore
+        data=load_pil_grayscale(os.path.join(_datadir, sample["data"])),  # type: ignore
         label=sample["label"],
     )
 
 
 def _raw_data_loader_bbox(sample):
     return dict(
-        data=load_pil_baw(os.path.join(_datadir, sample["data"])),  # type: ignore
+        data=load_pil_grayscale(os.path.join(_datadir, sample["data"])),  # type: ignore
         label=sample["label"],
         bboxes=sample["bboxes"],
     )
diff --git a/src/ptbench/data/tbx11k_simplified_v2/__init__.py b/src/ptbench/data/tbx11k_simplified_v2/__init__.py
index 57323bee..15e39e26 100644
--- a/src/ptbench/data/tbx11k_simplified_v2/__init__.py
+++ b/src/ptbench/data/tbx11k_simplified_v2/__init__.py
@@ -28,7 +28,7 @@ import os
 
 from ...utils.rc import load_rc
 from ..dataset import JSONDataset
-from ..loader import load_pil_baw, make_delayed, make_delayed_bbox
+from ..loader import load_pil_grayscale, make_delayed, make_delayed_bbox
 
 _protocols = [
     importlib.resources.files(__name__).joinpath("default.json.bz2"),
@@ -51,14 +51,14 @@ _datadir = load_rc().get(
 
 def _raw_data_loader(sample):
     return dict(
-        data=load_pil_baw(os.path.join(_datadir, sample["data"])),  # type: ignore
+        data=load_pil_grayscale(os.path.join(_datadir, sample["data"])),  # type: ignore
         label=sample["label"],
     )
 
 
 def _raw_data_loader_bbox(sample):
     return dict(
-        data=load_pil_baw(os.path.join(_datadir, sample["data"])),  # type: ignore
+        data=load_pil_grayscale(os.path.join(_datadir, sample["data"])),  # type: ignore
         label=sample["label"],
         bboxes=sample["bboxes"],
     )
-- 
GitLab