siibra 0.4a91__py3-none-any.whl → 0.4a92__py3-none-any.whl

siibra/VERSION

@@ -1 +1 @@
-0.4a91
+0.4a92

siibra/configuration/factory.py

@@ -26,7 +26,7 @@ from ..features.image import sections, volume_of_interest
 from ..core import atlas, parcellation, space, region
 from ..locations import point, pointset
 from ..retrieval import datasets, repositories
-from ..volumes import gifti, volume, nifti, neuroglancer, sparsemap, parcellationmap
+from ..volumes import gifti, volume, nifti, neuroglancer, freesurfer, sparsemap, parcellationmap
 
 from os import path
 import json
@@ -253,7 +253,9 @@ class Factory:
             nifti.NiftiProvider,
             nifti.ZipContainedNiftiProvider,
             gifti.GiftiMesh,
-            gifti.GiftiSurfaceLabeling
+            gifti.GiftiSurfaceLabeling,
+            freesurfer.FreesurferAnnot,
+            freesurfer.ZippedFreesurferAnnot,
         ]
 
         for srctype, provider_spec in spec.get("providers", {}).items():

siibra/retrieval/requests.py

@@ -30,7 +30,7 @@ import json
 from zipfile import ZipFile
 import requests
 import os
-from nibabel import Nifti1Image, GiftiImage, streamlines
+from nibabel import Nifti1Image, GiftiImage, streamlines, freesurfer
 from skimage import io as skimage_io
 import gzip
 from io import BytesIO
@@ -54,6 +54,34 @@ if TYPE_CHECKING:
 
 USER_AGENT_HEADER = {"User-Agent": f"siibra-python/{__version__}"}
 
+
+def read_as_bytesio(function: Callable, suffix: str, bytesio: BytesIO):
+    """
+    Helper method to provide BytesIO to methods that only takes file path and
+    cannot handle BytesIO normally (e.g., `nibabel.freesurfer.read_annot()`).
+
+    Writes the bytes to a temporary file on cache and reads with the
+    original function.
+
+    Parameters
+    ----------
+    function : Callable
+    suffix : str
+        Must match the suffix expected by the function provided.
+    bytesio : BytesIO
+
+    Returns
+    -------
+    Return type of the provided function.
+    """
+    tempfile = CACHE.build_filename(f"temp_{suffix}") + suffix
+    with open(tempfile, "wb") as bf:
+        bf.write(bytesio.getbuffer())
+    result = function(tempfile)
+    os.remove(tempfile)
+    return result
+
+
 DECODERS = {
     ".nii": lambda b: Nifti1Image.from_bytes(b),
     ".gii": lambda b: GiftiImage.from_bytes(b),
@@ -65,6 +93,7 @@ DECODERS = {
     ".zip": lambda b: ZipFile(BytesIO(b)),
     ".png": lambda b: skimage_io.imread(BytesIO(b)),
     ".npy": lambda b: np.load(BytesIO(b)),
+    ".annot": lambda b: read_as_bytesio(freesurfer.read_annot, '.annot', BytesIO(b)),
 }
 
 

siibra/volumes/__init__.py

@@ -18,6 +18,7 @@ from .parcellationmap import Map
 from .neuroglancer import NeuroglancerProvider, NeuroglancerMesh
 from .nifti import NiftiProvider
 from .gifti import GiftiSurfaceLabeling, GiftiMesh
+from .freesurfer import FreesurferAnnot, ZippedFreesurferAnnot
 
 
 def warm_cache():

siibra/volumes/freesurfer.py

@@ -0,0 +1,123 @@
+# Copyright 2018-2025
+# Institute of Neuroscience and Medicine (INM-1), Forschungszentrum Jülich GmbH
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Handles reading and preparing gii files."""
+
+from typing import Union, Dict, TYPE_CHECKING
+
+import numpy as np
+
+from . import volume
+from ..retrieval.requests import HttpRequest, ZipfileRequest
+
+if TYPE_CHECKING:
+    from ..locations import boundingbox as _boundingbox
+
+
+class FreesurferAnnot(volume.VolumeProvider, srctype="freesurfer-annot"):
+    def __init__(self, url: Union[str, dict]):
+        self._init_url = url
+        if isinstance(url, str):  # single mesh labelling
+            self._loaders = {None: HttpRequest(url)}
+        elif isinstance(url, dict):   # named label fragments
+            self._loaders = {lbl: HttpRequest(u) for lbl, u in url.items()}
+        else:
+            raise NotImplementedError(f"Urls for {self.__class__.__name__} are expected to be of type str.")
+
+    def fetch(self, fragment: str = None, label: int = None, **kwargs):
+        """Returns a 1D numpy array of label indices."""
+        vertex_labels = []
+        if fragment is None:
+            matched_frags = list(self._loaders.keys())
+        else:
+            matched_frags = [frg for frg in self._loaders.keys() if fragment.lower() in frg.lower()]
+            if len(matched_frags) != 1:
+                raise ValueError(
+                    f"Requested fragment '{fragment}' could not be matched uniquely "
+                    f"to [{', '.join(self._loaders)}]"
+                )
+        for frag in matched_frags:
+            frag_labels, *_ = self._loaders[frag].data
+            if label is not None:  # create the mask
+                selected_label = frag_labels == label
+                frag_labels[selected_label] = 1
+                frag_labels[~selected_label] = 0
+            else:
+                frag_labels[frag_labels == -1] = 0  # annot files store background as -1 while siibra uses 0
+            vertex_labels.append(frag_labels)
+
+        return {"labels": np.hstack(vertex_labels)}
+
+    @property
+    def boundingbox(self) -> '_boundingbox.BoundingBox':
+        raise NotImplementedError(
+            f"Bounding box access to {self.__class__.__name__} objects not yet implemented."
+        )
+
+    @property
+    def fragments(self):
+        return [k for k in self._loaders if k is not None]
+
+    @property
+    def _url(self) -> Union[str, Dict[str, str]]:
+        return self._init_url
+
+
+class ZippedFreesurferAnnot(volume.VolumeProvider, srctype="zip/freesurfer-annot"):
+    def __init__(self, url: Union[str, dict]):
+        self._init_url = url
+        if isinstance(url, str):  # single mesh labelling
+            self._loaders = {None: ZipfileRequest(*url.split(" "))}
+        elif isinstance(url, dict):   # named label fragments
+            self._loaders = {lbl: ZipfileRequest(*u.split(" ")) for lbl, u in url.items()}
+        else:
+            raise NotImplementedError(f"Urls for {self.__class__.__name__} are expected to be of type str.")
+
+    def fetch(self, fragment: str = None, label: int = None, **kwargs):
+        """Returns a 1D numpy array of label indices."""
+        vertex_labels = []
+        if fragment is None:
+            matched_frags = list(self._loaders.keys())
+        else:
+            matched_frags = [frg for frg in self._loaders.keys() if fragment.lower() in frg.lower()]
+            if len(matched_frags) != 1:
+                raise ValueError(
+                    f"Requested fragment '{fragment}' could not be matched uniquely "
+                    f"to [{', '.join(self._loaders)}]"
+                )
+        for frag in matched_frags:
+            frag_labels, *_ = self._loaders[frag].data
+            if label is not None:  # create the mask
+                selected_label = frag_labels == label
+                frag_labels[selected_label] = 1
+                frag_labels[~selected_label] = 0
+            else:
+                frag_labels[frag_labels == -1] = 0  # annot files store background as -1 while siibra uses 0
+            vertex_labels.append(frag_labels)
+
+        return {"labels": np.hstack(vertex_labels)}
+
+    @property
+    def boundingbox(self) -> '_boundingbox.BoundingBox':
+        raise NotImplementedError(
+            f"Bounding box access to {self.__class__.__name__} objects not yet implemented."
+        )
+
+    @property
+    def fragments(self):
+        return [k for k in self._loaders if k is not None]
+
+    @property
+    def _url(self) -> Union[str, Dict[str, str]]:
+        return self._init_url

siibra/volumes/volume.py

@@ -49,7 +49,9 @@ class Volume:
         "neuroglancer/precompmesh",
         "neuroglancer/precompmesh/surface",
         "gii-mesh",
-        "gii-label"
+        "gii-label",
+        "freesurfer-annot",
+        "zip/freesurfer-annot",
     ]
 
     SUPPORTED_FORMATS = IMAGE_FORMATS + MESH_FORMATS
@@ -218,7 +220,7 @@ class Volume:
         # try the selected format only
         for try_count in range(6):
             try:
-                if selected_format == "gii-label":
+                if selected_format in ["gii-label", "freesurfer-annot", "zip/freesurfer-annot"]:
                     tpl = self.space.get_template(variant=kwargs.get('variant'))
                     mesh = tpl.fetch(**kwargs)
                     labels = self._providers[selected_format].fetch(**kwargs)

{siibra-0.4a91.dist-info → siibra-0.4a92.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: siibra
-Version: 0.4a91
+Version: 0.4a92
 Summary: siibra - Software interfaces for interacting with brain atlases
 Home-page: https://github.com/FZJ-INM1-BDA/siibra-python
 Author: Big Data Analytics Group, Forschungszentrum Juelich, Institute of Neuroscience and Medicine (INM-1)

{siibra-0.4a91.dist-info → siibra-0.4a92.dist-info}/RECORD

@@ -1,9 +1,9 @@
-siibra/VERSION,sha256=0miaCbL3UWtbg4acr9iCvJj5M7KYoOmn_KjDDK2e85c,7
+siibra/VERSION,sha256=r7rbswsvUpFkOmvUh_KLSJ9BH6UKUoIdnkkC3J8IeOc,7
 siibra/__init__.py,sha256=qBxxMRyl9RojNt0twQr2LDk1Nyk5eNsPHFxxoIwnpx4,4540
 siibra/commons.py,sha256=y0yLQw1wWn8N9EgQGW2B0aAuo3FM_5zthMcEcvuvmH8,25895
 siibra/configuration/__init__.py,sha256=-_Kuf0TfMEdFXiSCTAdcHUL_krA8-cxhJypSNNay53Q,752
 siibra/configuration/configuration.py,sha256=x06QsaqGQbce1d9TuFCCYEgMWJBlLbkt8B3zTfYz5RE,6887
-siibra/configuration/factory.py,sha256=olRMm__Q2DeQX5CoBFkmfBdgXlWhZ3Wsy-oKG7s9BuQ,21071
+siibra/configuration/factory.py,sha256=WzfDlD2u7eeONVzy8wdp56Sqe_Uv4yTCveYRl7RRDOg,21170
 siibra/core/__init__.py,sha256=z22elfoi5_TscUb17-pBoGyfT_q9PQpvgOgSLEJe2WE,916
 siibra/core/atlas.py,sha256=YwhVWAIT0XGfzKjSuQUNpljdIE4VP4crNQ3VNfTrgKg,7868
 siibra/core/concept.py,sha256=rKR7FO1HaFdy076Dy0y9Bjcdu_tcYUHbxLYNZxH7XTY,9595
@@ -54,21 +54,22 @@ siibra/retrieval/__init__.py,sha256=pAJ2WsNk9tVY1RddmXzya1iFgJXJarO4TVCJTob1Ej0,
 siibra/retrieval/cache.py,sha256=9Wssws2YHiI_OW4EZp72OzYV9nw8h5cAEAakSxtRMts,5143
 siibra/retrieval/datasets.py,sha256=zDiSgbmL6aqnZpYrJMcfbv2c_Kh-2KMwmHQTJkdF9GM,11267
 siibra/retrieval/repositories.py,sha256=wYE3oYcIBgD3WOqIerS3darsg_TSrfpdDJ72l2uytak,25961
-siibra/retrieval/requests.py,sha256=tRmgocvob7619e_4Vw-dVd8R3JJ95UGkVyESXF2EBE0,22013
+siibra/retrieval/requests.py,sha256=DExE1Bj2QEu6RWjCJRlnqtuFKCskk1k7PuLK6aVfuPY,22889
 siibra/retrieval/exceptions/__init__.py,sha256=_w996kp5rxuvi-_iLhrByrH2OtApxm_TykthkaQvKpo,874
 siibra/vocabularies/__init__.py,sha256=h38zIUd44RRFOR6X09VnKsC-_WrhtB0xFzYWX-Nyncg,1293
 siibra/vocabularies/gene_names.json,sha256=i-gnh753GyZtQfX_dWibNYr_d5ccDPHooOwsdeKUYqE,1647972
 siibra/vocabularies/receptor_symbols.json,sha256=F6DZIArPCBmJV_lWGV-zDpBBH_GOJOZm67LBE4qzMa4,5722
 siibra/vocabularies/region_aliases.json,sha256=T2w1wRlxPNTsPppXn0bzC70tNsb8mOjLsoHuxDSYm2w,8563
-siibra/volumes/__init__.py,sha256=KFOT756W63pIEtw9lZGDzQYExOg94A1wvsuUEgLwVak,965
+siibra/volumes/__init__.py,sha256=fkSZFZhbUiDf8fkWu-lNta-LvCrGI8Pp4-Imkz2SRqg,1028
+siibra/volumes/freesurfer.py,sha256=q5pHcWEvluzQ_2ENaDgy4jfb_k266QXUPa_LLkWniZw,5032
 siibra/volumes/gifti.py,sha256=_LUHgPqndzSj9nNH70Ee2lWMkockVGdi2_JufuaExG4,5551
 siibra/volumes/neuroglancer.py,sha256=HWxhTh2FviLkNHdKL-_OMtl3oC6-WQb5b8skdvQ0ql8,24504
 siibra/volumes/nifti.py,sha256=nGSCedjpsiy43XIiHQ2SRy9rPRK8Ci9QDq4AHKclCck,9030
 siibra/volumes/parcellationmap.py,sha256=phoMzNLI3Ig9rWvuD_c1yBm3ejLxAJGXtTHMXqw-ivc,44243
 siibra/volumes/sparsemap.py,sha256=j41ozLSgKri68-KDsqo46gEs4lT4aYsf2yMF4l-ruCo,21752
-siibra/volumes/volume.py,sha256=h_KrdDkpeoENnOrE7BlTZNXaZQGTrJXHX0eSyArxF-4,11667
-siibra-0.4a91.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-siibra-0.4a91.dist-info/METADATA,sha256=CQFLI6K61JNfgK6wxmsFyFh1RcK8-G11vpm-UbAHab4,8547
-siibra-0.4a91.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-siibra-0.4a91.dist-info/top_level.txt,sha256=NF0OSGLL0li2qyC7MaU0iBB5Y9S09_euPpvisD0-8Hg,7
-siibra-0.4a91.dist-info/RECORD,,
+siibra/volumes/volume.py,sha256=QJDbOkS3DXzuqiC-O-hBqBHkqS91zoDte9UXT-UuMdY,11774
+siibra-0.4a92.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+siibra-0.4a92.dist-info/METADATA,sha256=C3Tm_qAofj15fAvGZrivkoJL3mswTz1tqc3jFu7D89M,8547
+siibra-0.4a92.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+siibra-0.4a92.dist-info/top_level.txt,sha256=NF0OSGLL0li2qyC7MaU0iBB5Y9S09_euPpvisD0-8Hg,7
+siibra-0.4a92.dist-info/RECORD,,