junifer 0.0.5__py3-none-any.whl → 0.0.5.dev24__py3-none-any.whl

junifer/markers/brainprint.py

@@ -1,459 +0,0 @@
-"""Provide class for BrainPrint."""
-
-# Authors: Synchon Mandal <s.mandal@fz-juelich.de>
-# License: AGPL
-
-import uuid
-from pathlib import Path
-from typing import (
-    Any,
-    ClassVar,
-    Dict,
-    List,
-    Optional,
-    Set,
-    Union,
-)
-
-import numpy as np
-import numpy.typing as npt
-
-from ..api.decorators import register_marker
-from ..external.BrainPrint.brainprint.brainprint import (
-    compute_asymmetry,
-    compute_brainprint,
-)
-from ..external.BrainPrint.brainprint.surfaces import surf_to_vtk
-from ..pipeline import WorkDirManager
-from ..utils import logger, run_ext_cmd
-from .base import BaseMarker
-
-
-__all__ = ["BrainPrint"]
-
-
-@register_marker
-class BrainPrint(BaseMarker):
-    """Class for BrainPrint.
-
-    Parameters
-    ----------
-    num : positive int, optional
-        Number of eigenvalues to compute (default 50).
-    skip_cortex : bool, optional
-        Whether to skip cortical surface or not (default False).
-    keep_eigenvectors : bool, optional
-        Whether to also return eigenvectors or not (default False).
-    norm : str, optional
-        Eigenvalues normalization method (default "none").
-    reweight : bool, optional
-        Whether to reweight eigenvalues or not (default False).
-    asymmetry : bool, optional
-        Whether to calculate asymmetry between lateral structures
-        (default False).
-    asymmetry_distance : {"euc"}, optional
-        Distance measurement to use if ``asymmetry=True``:
-
-        * ``"euc"`` : Euclidean
-
-        (default "euc").
-    use_cholmod : bool, optional
-        If True, attempts to use the Cholesky decomposition for improved
-        execution speed. Requires the ``scikit-sparse`` library. If it cannot
-        be found, an error will be thrown. If False, will use slower LU
-        decomposition (default False).
-    name : str, optional
-        The name of the marker. If None, will use the class name (default
-        None).
-
-    """
-
-    _EXT_DEPENDENCIES: ClassVar[List[Dict[str, Union[str, List[str]]]]] = [
-        {
-            "name": "freesurfer",
-            "commands": [
-                "mri_binarize",
-                "mri_pretess",
-                "mri_mc",
-                "mris_convert",
-            ],
-        },
-    ]
-
-    _DEPENDENCIES: ClassVar[Set[str]] = {"lapy", "numpy"}
-
-    _MARKER_INOUT_MAPPINGS: ClassVar[Dict[str, Dict[str, str]]] = {
-        "FreeSurfer": {
-            "eigenvalues": "scalar_table",
-            "areas": "vector",
-            "volumes": "vector",
-            "distances": "vector",
-        }
-    }
-
-    def __init__(
-        self,
-        num: int = 50,
-        skip_cortex=False,
-        keep_eigenvectors: bool = False,
-        norm: str = "none",
-        reweight: bool = False,
-        asymmetry: bool = False,
-        asymmetry_distance: str = "euc",
-        use_cholmod: bool = False,
-        name: Optional[str] = None,
-    ) -> None:
-        self.num = num
-        self.skip_cortex = skip_cortex
-        self.keep_eigenvectors = keep_eigenvectors
-        self.norm = norm
-        self.reweight = reweight
-        self.asymmetry = asymmetry
-        self.asymmetry_distance = asymmetry_distance
-        self.use_cholmod = use_cholmod
-        super().__init__(name=name, on="FreeSurfer")
-
-    def _create_aseg_surface(
-        self,
-        aseg_path: Path,
-        norm_path: Path,
-        indices: List,
-    ) -> Path:
-        """Generate a surface from the aseg and label files.
-
-        Parameters
-        ----------
-        aseg_path : pathlib.Path
-            The FreeSurfer aseg path.
-        norm_path : pathlib.Path
-            The FreeSurfer norm path.
-        indices : list
-            List of label indices to include in the surface generation.
-
-        Returns
-        -------
-        pathlib.Path
-            Path to the generated surface in VTK format.
-
-        """
-        tempfile_prefix = f"aseg.{uuid.uuid4()}"
-
-        # Set mri_binarize command
-        mri_binarize_output_path = self._tempdir / f"{tempfile_prefix}.mgz"
-        mri_binarize_cmd = [
-            "mri_binarize",
-            f"--i {aseg_path.resolve()}",
-            f"--match {''.join(indices)}",
-            f"--o {mri_binarize_output_path.resolve()}",
-        ]
-        # Call mri_binarize command
-        run_ext_cmd(name="mri_binarize", cmd=mri_binarize_cmd)
-
-        label_value = "1"
-        # Fix label (pretess)
-        # Set mri_pretess command
-        mri_pretess_cmd = [
-            "mri_pretess",
-            f"{mri_binarize_output_path.resolve()}",
-            f"{label_value}",
-            f"{norm_path.resolve()}",
-            f"{mri_binarize_output_path.resolve()}",
-        ]
-        # Call mri_pretess command
-        run_ext_cmd(name="mri_pretess", cmd=mri_pretess_cmd)
-
-        # Run marching cube to extract surface
-        # Set mri_mc command
-        mri_mc_output_path = self._tempdir / f"{tempfile_prefix}.surf"
-        mri_mc_cmd = [
-            "mri_mc",
-            f"{mri_binarize_output_path.resolve()}",
-            f"{label_value}",
-            f"{mri_mc_output_path.resolve()}",
-        ]
-        # Run mri_mc command
-        run_ext_cmd(name="mri_mc", cmd=mri_mc_cmd)
-
-        # Convert to vtk
-        # Set mris_convert command
-        surface_path = (
-            self._element_tempdir / f"aseg.final.{'_'.join(indices)}.vtk"
-        )
-        mris_convert_cmd = [
-            "mris_convert",
-            f"{mri_mc_output_path.resolve()}",
-            f"{surface_path.resolve()}",
-        ]
-        # Run mris_convert command
-        run_ext_cmd(name="mris_convert", cmd=mris_convert_cmd)
-
-        return surface_path
-
-    def _create_aseg_surfaces(
-        self,
-        aseg_path: Path,
-        norm_path: Path,
-    ) -> Dict[str, Path]:
-        """Create surfaces from FreeSurfer aseg labels.
-
-        Parameters
-        ----------
-        aseg_path : pathlib.Path
-            The FreeSurfer aseg path.
-        norm_path : pathlib.Path
-            The FreeSurfer norm path.
-
-        Returns
-        -------
-        dict
-            Dictionary of label names mapped to corresponding surface paths.
-
-        """
-        # Define aseg labels
-
-        # combined and individual aseg labels:
-        # - Left  Striatum: left  Caudate + Putamen + Accumbens
-        # - Right Striatum: right Caudate + Putamen + Accumbens
-        # - CorpusCallosum: 5 subregions combined
-        # - Cerebellum: brainstem + (left+right) cerebellum WM and GM
-        # - Ventricles: (left+right) lat.vent + inf.lat.vent + choroidplexus +
-        #               3rdVent + CSF
-        # - Lateral-Ventricle: lat.vent + inf.lat.vent + choroidplexus
-        # - 3rd-Ventricle: 3rd-Ventricle + CSF
-
-        aseg_labels = {
-            "CorpusCallosum": ["251", "252", "253", "254", "255"],
-            "Cerebellum": ["7", "8", "16", "46", "47"],
-            "Ventricles": ["4", "5", "14", "24", "31", "43", "44", "63"],
-            "3rd-Ventricle": ["14", "24"],
-            "4th-Ventricle": ["15"],
-            "Brain-Stem": ["16"],
-            "Left-Striatum": ["11", "12", "26"],
-            "Left-Lateral-Ventricle": ["4", "5", "31"],
-            "Left-Cerebellum-White-Matter": ["7"],
-            "Left-Cerebellum-Cortex": ["8"],
-            "Left-Thalamus-Proper": ["10"],
-            "Left-Caudate": ["11"],
-            "Left-Putamen": ["12"],
-            "Left-Pallidum": ["13"],
-            "Left-Hippocampus": ["17"],
-            "Left-Amygdala": ["18"],
-            "Left-Accumbens-area": ["26"],
-            "Left-VentralDC": ["28"],
-            "Right-Striatum": ["50", "51", "58"],
-            "Right-Lateral-Ventricle": ["43", "44", "63"],
-            "Right-Cerebellum-White-Matter": ["46"],
-            "Right-Cerebellum-Cortex": ["47"],
-            "Right-Thalamus-Proper": ["49"],
-            "Right-Caudate": ["50"],
-            "Right-Putamen": ["51"],
-            "Right-Pallidum": ["52"],
-            "Right-Hippocampus": ["53"],
-            "Right-Amygdala": ["54"],
-            "Right-Accumbens-area": ["58"],
-            "Right-VentralDC": ["60"],
-        }
-        return {
-            label: self._create_aseg_surface(
-                aseg_path=aseg_path,
-                norm_path=norm_path,
-                indices=indices,
-            )
-            for label, indices in aseg_labels.items()
-        }
-
-    def _create_cortical_surfaces(
-        self,
-        lh_white_path: Path,
-        rh_white_path: Path,
-        lh_pial_path: Path,
-        rh_pial_path: Path,
-    ) -> Dict[str, Path]:
-        """Create cortical surfaces from FreeSurfer labels.
-
-        Parameters
-        ----------
-        lh_white_path : pathlib.Path
-            The FreeSurfer lh.white path.
-        rh_white_path : pathlib.Path
-            The FreeSurfer rh.white path.
-        lh_pial_path : pathlib.Path
-            The FreeSurfer lh.pial path.
-        rh_pial_path : pathlib.Path
-            The FreeSurfer rh.pial path.
-
-        Returns
-        -------
-        dict
-            Cortical surface label names with their paths as dictionary.
-
-        """
-        return {
-            "lh-white-2d": surf_to_vtk(
-                lh_white_path.resolve(),
-                (self._element_tempdir / "lh.white.vtk").resolve(),
-            ),
-            "rh-white-2d": surf_to_vtk(
-                rh_white_path.resolve(),
-                (self._element_tempdir / "rh.white.vtk").resolve(),
-            ),
-            "lh-pial-2d": surf_to_vtk(
-                lh_pial_path.resolve(),
-                (self._element_tempdir / "lh.pial.vtk").resolve(),
-            ),
-            "rh-pial-2d": surf_to_vtk(
-                rh_pial_path.resolve(),
-                (self._element_tempdir / "rh.pial.vtk").resolve(),
-            ),
-        }
-
-    def _fix_nan(
-        self,
-        input_data: List[Union[float, str, npt.ArrayLike]],
-    ) -> np.ndarray:
-        """Convert BrainPrint output with string NaN to ``numpy.nan``.
-
-        Parameters
-        ----------
-        input_data : list of str, float or numpy.ndarray-like
-            The data to convert.
-
-        Returns
-        -------
-        np.ndarray
-            The converted data as ``numpy.ndarray``.
-
-        """
-        arr = np.asarray(input_data)
-        arr[arr == "NaN"] = np.nan
-        return arr.astype(np.float64)
-
-    def compute(
-        self,
-        input: Dict[str, Any],
-        extra_input: Optional[Dict] = None,
-    ) -> Dict:
-        """Compute.
-
-        Parameters
-        ----------
-        input : dict
-            The FreeSurfer data as dictionary.
-        extra_input : dict, optional
-            The other fields in the pipeline data object (default None).
-
-        Returns
-        -------
-        dict
-            The computed result as dictionary. This will be either returned
-            to the user or stored in the storage by calling the store method
-            with this as a parameter. The dictionary has the following keys:
-
-            * ``eigenvalues`` : dictionary with the following keys:
-
-                - ``data`` : eigenvalues as ``np.ndarray``
-                - ``col_names`` : surface labels as list of str
-                - ``row_names`` : eigenvalue count labels as list of str
-                - ``row_header_col_name`` : "eigenvalue"
-                                ()
-            * ``areas`` : dictionary with the following keys:
-
-                - ``data`` : areas as ``np.ndarray``
-                - ``col_names`` : surface labels as list of str
-
-            * ``volumes`` : dictionary with the following keys:
-
-                - ``data`` : volumes as ``np.ndarray``
-                - ``col_names`` : surface labels as list of str
-
-            * ``distances`` : dictionary with the following keys
-                              if ``asymmetry = True``:
-
-                - ``data`` : distances as ``np.ndarray``
-                - ``col_names`` : surface labels as list of str
-
-        References
-        ----------
-        .. [1] Wachinger, C., Golland, P., Kremen, W. et al. (2015)
-               BrainPrint: A discriminative characterization of brain
-               morphology.
-               NeuroImage, Volume 109, Pages 232-248.
-               https://doi.org/10.1016/j.neuroimage.2015.01.032.
-        .. [2] Reuter, M., Wolter, F.E., Peinecke, N. (2006)
-               Laplace-Beltrami spectra as 'Shape-DNA' of surfaces and solids.
-               Computer-Aided Design, Volume 38, Issue 4, Pages 342-366.
-               https://doi.org/10.1016/j.cad.2005.10.011.
-
-        """
-        logger.debug("Computing BrainPrint")
-
-        # Create component-scoped tempdir
-        self._tempdir = WorkDirManager().get_tempdir(prefix="brainprint")
-        # Create element-scoped tempdir so that the files are
-        # available later as nibabel stores file path reference for
-        # loading on computation
-        self._element_tempdir = WorkDirManager().get_element_tempdir(
-            prefix="brainprint"
-        )
-        # Generate surfaces
-        surfaces = self._create_aseg_surfaces(
-            aseg_path=input["aseg"]["path"],
-            norm_path=input["norm"]["path"],
-        )
-        if not self.skip_cortex:
-            cortical_surfaces = self._create_cortical_surfaces(
-                lh_white_path=input["lh_white"]["path"],
-                rh_white_path=input["rh_white"]["path"],
-                lh_pial_path=input["lh_pial"]["path"],
-                rh_pial_path=input["rh_pial"]["path"],
-            )
-            surfaces.update(cortical_surfaces)
-        # Compute brainprint
-        eigenvalues, _ = compute_brainprint(
-            surfaces=surfaces,
-            keep_eigenvectors=self.keep_eigenvectors,
-            num=self.num,
-            norm=self.norm,
-            reweight=self.reweight,
-            use_cholmod=self.use_cholmod,
-        )
-        # Calculate distances (if required)
-        distances = None
-        if self.asymmetry:
-            distances = compute_asymmetry(
-                eigenvalues=eigenvalues,
-                distance=self.asymmetry_distance,
-                skip_cortex=self.skip_cortex,
-            )
-
-        # Delete tempdir
-        WorkDirManager().delete_tempdir(self._tempdir)
-
-        output = {
-            "eigenvalues": {
-                "data": self._fix_nan(
-                    [val[2:] for val in eigenvalues.values()]
-                ).T,
-                "col_names": list(eigenvalues.keys()),
-                "row_names": [f"ev{i}" for i in range(self.num)],
-                "row_header_col_name": "eigenvalue",
-            },
-            "areas": {
-                "data": self._fix_nan(
-                    [val[0] for val in eigenvalues.values()]
-                ),
-                "col_names": list(eigenvalues.keys()),
-            },
-            "volumes": {
-                "data": self._fix_nan(
-                    [val[1] for val in eigenvalues.values()]
-                ),
-                "col_names": list(eigenvalues.keys()),
-            },
-        }
-        if self.asymmetry:
-            output["distances"] = {
-                "data": self._fix_nan(list(distances.values())),
-                "col_names": list(distances.keys()),
-            }
-        return output

junifer/markers/tests/test_brainprint.py

@@ -1,58 +0,0 @@
-"""Provide tests for BrainPrint."""
-
-# Authors: Synchon Mandal <s.mandal@fz-juelich.de>
-# License: AGPL
-
-import socket
-
-import pytest
-
-from junifer.datagrabber import DataladAOMICID1000
-from junifer.datareader import DefaultDataReader
-from junifer.markers import BrainPrint
-from junifer.pipeline.utils import _check_freesurfer
-
-
-@pytest.mark.parametrize(
-    "feature, storage_type",
-    [
-        ("eigenvalues", "scalar_table"),
-        ("areas", "vector"),
-        ("volumes", "vector"),
-        ("distances", "vector"),
-    ],
-)
-def test_get_output_type(feature: str, storage_type: str) -> None:
-    """Test BrainPrint get_output_type().
-
-    Parameters
-    ----------
-    feature : str
-        The parametrized feature name.
-    storage_type : str
-        The parametrized storage type.
-
-    """
-    assert storage_type == BrainPrint().get_output_type(
-        input_type="FreeSurfer", output_feature=feature
-    )
-
-
-@pytest.mark.skipif(
-    _check_freesurfer() is False, reason="requires FreeSurfer to be in PATH"
-)
-@pytest.mark.skipif(
-    socket.gethostname() != "juseless",
-    reason="only for juseless",
-)
-def test_compute() -> None:
-    """Test BrainPrint compute()."""
-    with DataladAOMICID1000(types="FreeSurfer") as dg:
-        # Fetch element
-        element = dg["sub-0001"]
-        # Fetch element data
-        element_data = DefaultDataReader().fit_transform(element)
-        # Compute marker
-        feature_map = BrainPrint().fit_transform(element_data)
-        # Assert the output keys
-        assert {"eigenvalues", "areas", "volumes"} == set(feature_map.keys())