brainles-preprocessing 0.6.10__tar.gz → 0.6.12__tar.gz

{brainles_preprocessing-0.6.10 → brainles_preprocessing-0.6.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brainles_preprocessing
-Version: 0.6.10
+Version: 0.6.12
 Summary: Tool for preprocessing tasks in biomedical imaging, with a focus on (but not limited to) multi-modal brain MRI
 License: Apache-2.0
 License-File: LICENSE

brainles_preprocessing-0.6.12/brainles_preprocessing/brain_extraction/__init__.py

@@ -0,0 +1,6 @@
+from .hd_bet import HDBetExtractor
+
+try:
+    from .synthstrip import SynthStripExtractor
+except ImportError:
+    pass

brainles_preprocessing-0.6.12/brainles_preprocessing/brain_extraction/brain_extractor.py

@@ -0,0 +1,69 @@
+# TODO add typing and docs
+from abc import abstractmethod, ABC
+from pathlib import Path
+from typing import Union
+
+from auxiliary.io import read_image, write_image
+
+
+class BrainExtractor(ABC):
+    @abstractmethod
+    def extract(
+        self,
+        input_image_path: Union[str, Path],
+        masked_image_path: Union[str, Path],
+        brain_mask_path: Union[str, Path],
+        **kwargs,
+    ) -> None:
+        """
+        Abstract method to extract the brain from an input image.
+
+        Args:
+            input_image_path (str or Path): Path to the input image.
+            masked_image_path (str or Path): Path where the brain-extracted image will be saved.
+            brain_mask_path (str or Path): Path where the brain mask will be saved.
+            mode (str or Mode): Extraction mode.
+            **kwargs: Additional keyword arguments.
+        """
+        pass
+
+    def apply_mask(
+        self,
+        input_image_path: Union[str, Path],
+        mask_path: Union[str, Path],
+        bet_image_path: Union[str, Path],
+    ) -> None:
+        """
+        Apply a brain mask to an input image.
+
+        Args:
+            input_image_path (str or Path): Path to the input image (NIfTI format).
+            mask_path (str or Path): Path to the brain mask image (NIfTI format).
+            bet_image_path (str or Path): Path to save the resulting masked image (NIfTI format).
+        """
+
+        try:
+            # Read data
+            input_data = read_image(str(input_image_path))
+            mask_data = read_image(str(mask_path))
+        except FileNotFoundError as e:
+            raise FileNotFoundError(f"File not found: {e.filename}") from e
+        except Exception as e:
+            raise RuntimeError(f"Error reading files: {e}") from e
+
+        # Check that the input and mask have the same shape
+        if input_data.shape != mask_data.shape:
+            raise ValueError("Input image and mask must have the same dimensions.")
+
+        # Mask and save it
+        masked_data = input_data * mask_data
+
+        try:
+            write_image(
+                input_array=masked_data,
+                output_path=str(bet_image_path),
+                reference_path=str(input_image_path),
+                create_parent_directory=True,
+            )
+        except Exception as e:
+            raise RuntimeError(f"Error writing output file: {e}") from e

brainles_preprocessing-0.6.10/brainles_preprocessing/brain_extraction/brain_extractor.py → brainles_preprocessing-0.6.12/brainles_preprocessing/brain_extraction/hd_bet.py

@@ -1,11 +1,9 @@
-# TODO add typing and docs
-import shutil
-from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import Optional, Union
+import shutil
 from enum import Enum
 
-from auxiliary.io import read_image, write_image
+from brainles_preprocessing.brain_extraction.brain_extractor import BrainExtractor
 from brainles_hd_bet import run_hd_bet
 
 
@@ -14,69 +12,6 @@ class Mode(Enum):
     ACCURATE = "accurate"
 
 
-class BrainExtractor:
-    @abstractmethod
-    def extract(
-        self,
-        input_image_path: Union[str, Path],
-        masked_image_path: Union[str, Path],
-        brain_mask_path: Union[str, Path],
-        **kwargs,
-    ) -> None:
-        """
-        Abstract method to extract the brain from an input image.
-
-        Args:
-            input_image_path (str or Path): Path to the input image.
-            masked_image_path (str or Path): Path where the brain-extracted image will be saved.
-            brain_mask_path (str or Path): Path where the brain mask will be saved.
-            mode (str or Mode): Extraction mode.
-            **kwargs: Additional keyword arguments.
-        """
-        pass
-
-    def apply_mask(
-        self,
-        input_image_path: Union[str, Path],
-        mask_path: Union[str, Path],
-        bet_image_path: Union[str, Path],
-    ) -> None:
-        """
-        Apply a brain mask to an input image.
-
-        Args:
-            input_image_path (str or Path): Path to the input image (NIfTI format).
-            mask_path (str or Path): Path to the brain mask image (NIfTI format).
-            bet_image_path (str or Path): Path to save the resulting masked image (NIfTI format).
-        """
-
-        try:
-            # Read data
-            input_data = read_image(str(input_image_path))
-            mask_data = read_image(str(mask_path))
-        except FileNotFoundError as e:
-            raise FileNotFoundError(f"File not found: {e.filename}") from e
-        except Exception as e:
-            raise RuntimeError(f"Error reading files: {e}") from e
-
-        # Check that the input and mask have the same shape
-        if input_data.shape != mask_data.shape:
-            raise ValueError("Input image and mask must have the same dimensions.")
-
-        # Mask and save it
-        masked_data = input_data * mask_data
-
-        try:
-            write_image(
-                input_array=masked_data,
-                output_path=str(bet_image_path),
-                reference_path=str(input_image_path),
-                create_parent_directory=True,
-            )
-        except Exception as e:
-            raise RuntimeError(f"Error writing output file: {e}") from e
-
-
 class HDBetExtractor(BrainExtractor):
     def extract(
         self,

{brainles_preprocessing-0.6.10 → brainles_preprocessing-0.6.12}/brainles_preprocessing/cli.py

@@ -59,11 +59,15 @@ def main(
         ),
     ],
     output_dir: Annotated[
-        str | Path,
+        Path,
         typer.Option(
             "-o",
             "--output_dir",
             help="The path to the output directory",
+            exists=False,
+            file_okay=False,
+            dir_okay=True,
+            resolve_path=True,
         ),
     ],
     input_atlas: Annotated[
@@ -89,7 +93,6 @@ def main(
     Preprocess the input images according to the BraTS protocol.
     """
 
-    output_dir = Path(output_dir)
     output_dir.mkdir(parents=True, exist_ok=True)
 
     # specify a normalizer

{brainles_preprocessing-0.6.10 → brainles_preprocessing-0.6.12}/brainles_preprocessing/preprocessor/preprocessor.py

@@ -11,10 +11,8 @@ from typing import List, Optional, Union
 
 from loguru import logger
 
-from brainles_preprocessing.brain_extraction.brain_extractor import (
-    BrainExtractor,
-    HDBetExtractor,
-)
+from brainles_preprocessing.brain_extraction.brain_extractor import BrainExtractor
+from brainles_preprocessing.brain_extraction.hd_bet import HDBetExtractor
 from brainles_preprocessing.constants import PreprocessorSteps
 from brainles_preprocessing.defacing import Defacer, QuickshearDefacer
 from brainles_preprocessing.modality import CenterModality, Modality

{brainles_preprocessing-0.6.10 → brainles_preprocessing-0.6.12}/brainles_preprocessing/utils/zenodo.py

@@ -4,7 +4,7 @@ import shutil
 import zipfile
 from io import BytesIO
 from pathlib import Path
-from typing import Dict, List, Tuple
+from typing import ClassVar, Dict, List, Tuple
 
 import requests
 from loguru import logger
@@ -56,6 +56,9 @@ class ZenodoException(Exception):
 class ZenodoRecord:
     BASE_URL = "https://zenodo.org/api/records"
 
+    # Process-level cache: maps (record_id, target_dir) -> resolved Path
+    _cache: ClassVar[Dict[Tuple[str, str], Path]] = {}
+
     def __init__(
         self,
         record_id: str,
@@ -66,8 +69,34 @@ class ZenodoRecord:
         self.target_dir = target_dir
         self.label = label
 
+    @classmethod
+    def clear_cache(cls) -> None:
+        """Clear the process-level fetch cache. Primarily intended for testing."""
+        cls._cache.clear()
+
+    def _cache_key(self) -> Tuple[str, str]:
+        return (self.record_id, str(self.target_dir))
+
     def fetch(self) -> Path:
-        """Fetch the latest version of the record from Zenodo or from local storage."""
+        """Fetch the latest version of the record from Zenodo or from local storage.
+
+        Results are cached for the lifetime of the process so that repeated calls
+        (e.g. when processing many subjects in a loop) do not trigger redundant
+        Zenodo API requests.
+        """
+        key = self._cache_key()
+
+        cached = ZenodoRecord._cache.get(key)
+        if cached is not None:
+            logger.debug(f"Using cached {self.label} path: {cached}")
+            return cached
+
+        result = self._fetch_uncached()
+        ZenodoRecord._cache[key] = result
+        return result
+
+    def _fetch_uncached(self) -> Path:
+        """Perform the actual Zenodo check / download without consulting the cache."""
         zenodo_response = self._get_metadata_and_archive_url()
 
         pattern = self._glob_pattern()

{brainles_preprocessing-0.6.10 → brainles_preprocessing-0.6.12}/pyproject.toml

@@ -14,7 +14,7 @@ exclude = [
 ]
 
 name = "brainles_preprocessing"
-version = "0.6.10"                                                                                                              # will be overwritten by poetry-dynamic-versioning but needs to be set
+version = "0.6.12"                                                                                                              # will be overwritten by poetry-dynamic-versioning but needs to be set
 description = "Tool for preprocessing tasks in biomedical imaging, with a focus on (but not limited to) multi-modal brain MRI"
 license = "Apache-2.0"
 

brainles_preprocessing-0.6.10/brainles_preprocessing/brain_extraction/__init__.py

@@ -1 +0,0 @@
-from .brain_extractor import HDBetExtractor