Note
Go to the end to download the full example code.
8.5. Extracting root sum of squares from edge-wise timeseries.¶
This example uses a RSSETSMarker to compute root sum of squares
of the edge-wise timeseries using the Schaefer parcellation
(100 rois and 200 rois, 17 Yeo networks) for a 4D nifti BOLD file.
Authors: Leonard Sasse, Sami Hamdan, Nicolas Nieto, Synchon Mandal
License: BSD 3 clause
import tempfile
import junifer.testing.registry # noqa: F401
from junifer.api import collect, run
from junifer.storage import SQLiteFeatureStorage
from junifer.utils import configure_logging
Set the logging level to info to see extra information:
configure_logging(level="INFO")
2024-08-14 13:31:23,680 - JUNIFER - INFO - ===== Lib Versions =====
2024-08-14 13:31:23,680 - JUNIFER - INFO - numpy: 1.26.4
2024-08-14 13:31:23,680 - JUNIFER - INFO - scipy: 1.14.0
2024-08-14 13:31:23,680 - JUNIFER - INFO - pandas: 2.1.4
2024-08-14 13:31:23,680 - JUNIFER - INFO - nilearn: 0.10.4
2024-08-14 13:31:23,680 - JUNIFER - INFO - nibabel: 5.2.1
2024-08-14 13:31:23,680 - JUNIFER - INFO - junifer: 0.0.6.dev23
2024-08-14 13:31:23,680 - JUNIFER - INFO - ========================
Define the DataGrabber interface
datagrabber = {
"kind": "SPMAuditoryTestingDataGrabber",
}
Define the markers interface
markers = [
{
"name": "Schaefer100x17_RSSETS",
"kind": "RSSETSMarker",
"parcellation": "Schaefer100x17",
},
{
"name": "Schaefer200x17_RSSETS",
"kind": "RSSETSMarker",
"parcellation": "Schaefer200x17",
},
]
Create a temporary directory for junifer feature extraction:
At the end you can read the extracted data into a pandas.DataFrame.
with tempfile.TemporaryDirectory() as tmpdir:
# Define the storage interface
storage = {
"kind": "SQLiteFeatureStorage",
"uri": f"{tmpdir}/test.sqlite",
}
# Run the defined junifer feature extraction pipeline
run(
workdir=tmpdir,
datagrabber=datagrabber,
markers=markers,
storage=storage,
elements=["sub001"], # we calculate for one subject only
)
# Collect extracted features data
collect(storage=storage)
# Create storage object to read in extracted features
db = SQLiteFeatureStorage(uri=storage["uri"])
# List all the features
print(db.list_features())
# Read extracted features
df_rssets = db.read_df(feature_name="BOLD_Schaefer200x17_RSSETS_rss_ets")
2024-08-14 13:31:23,682 - JUNIFER - INFO - Validating Marker Collection
2024-08-14 13:31:23,682 - JUNIFER - INFO - DataGrabber output type: ['BOLD', 'T1w']
2024-08-14 13:31:23,682 - JUNIFER - INFO - Validating Data Reader:
2024-08-14 13:31:23,682 - JUNIFER - INFO - Data Reader output type: ['BOLD', 'T1w']
2024-08-14 13:31:23,682 - JUNIFER - INFO - Validating Marker: Schaefer100x17_RSSETS
2024-08-14 13:31:23,682 - JUNIFER - INFO - Marker output type: ['timeseries']
2024-08-14 13:31:23,682 - JUNIFER - INFO - Validating storage for Schaefer100x17_RSSETS
2024-08-14 13:31:23,682 - JUNIFER - INFO - Validating Marker: Schaefer200x17_RSSETS
2024-08-14 13:31:23,682 - JUNIFER - INFO - Marker output type: ['timeseries']
2024-08-14 13:31:23,682 - JUNIFER - INFO - Validating storage for Schaefer200x17_RSSETS
2024-08-14 13:31:23,682 - JUNIFER - INFO - Getting element sub001
2024-08-14 13:31:26,172 - JUNIFER - INFO - Fitting pipeline
2024-08-14 13:31:26,172 - JUNIFER - INFO - Reading BOLD from /tmp/tmpjklyz0d4/sub001_bold.nii.gz
2024-08-14 13:31:26,172 - JUNIFER - INFO - BOLD is of type NIFTI
2024-08-14 13:31:26,173 - JUNIFER - INFO - Reading T1w from /tmp/tmpjklyz0d4/sub001_T1w.nii.gz
2024-08-14 13:31:26,173 - JUNIFER - INFO - T1w is of type NIFTI
2024-08-14 13:31:26,174 - JUNIFER - INFO - Fitting marker Schaefer100x17_RSSETS
2024-08-14 13:31:26,174 - JUNIFER - INFO - Computing BOLD
2024-08-14 13:31:26,175 - JUNIFER - INFO - Fetching one of Schaefer parcellations.
2024-08-14 13:31:26,175 - JUNIFER - INFO - Parcellation parameters:
2024-08-14 13:31:26,175 - JUNIFER - INFO - resolution: 3.0
2024-08-14 13:31:26,175 - JUNIFER - INFO - n_rois: 100
2024-08-14 13:31:26,175 - JUNIFER - INFO - yeo_networks: 17
2024-08-14 13:31:26,175 - JUNIFER - INFO - At least one of the parcellation files are missing. Fetching using nilearn.
Downloading data from https://raw.githubusercontent.com/ThomasYeoLab/CBIG/v0.14.3-Update_Yeo2011_Schaefer2018_labelname/stable_projects/brain_parcellation/Schaefer2018_LocalGlobal/Parcellations/MNI/Schaefer2018_100Parcels_17Networks_order.txt ...
...done. (0 seconds, 0 min)
Downloading data from https://raw.githubusercontent.com/ThomasYeoLab/CBIG/v0.14.3-Update_Yeo2011_Schaefer2018_labelname/stable_projects/brain_parcellation/Schaefer2018_LocalGlobal/Parcellations/MNI/Schaefer2018_100Parcels_17Networks_order_FSLMNI152_2mm.nii.gz ...
...done. (0 seconds, 0 min)
2024-08-14 13:31:26,197 - JUNIFER - INFO - Loading parcellation /home/runner/junifer/data/parcellations/schaefer_2018/Schaefer2018_100Parcels_17Networks_order_FSLMNI152_2mm.nii.gz
2024-08-14 13:31:26,226 - JUNIFER - INFO - Found existing xfm file for MNI152NLin6Asym to MNI152Lin at /home/runner/junifer/data/xfms/MNI152NLin6Asym_to_MNI152Lin/MNI152NLin6Asym_to_MNI152Lin_Composite.h5
2024-08-14 13:31:27,271 - JUNIFER - INFO - Downloading template MNI152Lin in resolution 2
2024-08-14 13:31:27,369 - JUNIFER - INFO - antsApplyTransforms command to be executed:
antsApplyTransforms -d 3 -e 3 -n 'GenericLabel[NearestNeighbor]' -i /tmp/tmpp3v3ecmt/parcellationsep6srkjj/Schaefer100x17.nii.gz -r /tmp/tmpp3v3ecmt/parcellationsep6srkjj/MNI152Lin_T1w_3.0.nii.gz -t /home/runner/junifer/data/xfms/MNI152NLin6Asym_to_MNI152Lin/MNI152NLin6Asym_to_MNI152Lin_Composite.h5 -o /tmp/tmp4p07cfs7/parcellationsu2no2yu8/Schaefer100x17_warped_from_MNI152NLin6Asym_to_MNI152Lin.nii.gz
2024-08-14 13:31:28,775 - JUNIFER - INFO - antsApplyTransforms command succeeded with the following output:
2024-08-14 13:31:31,627 - JUNIFER - INFO - Storing in <SQLiteFeatureStorage @ /tmp/tmpitlmdyeb/test.sqlite (multiple output)>
2024-08-14 13:31:31,648 - JUNIFER - INFO - Fitting marker Schaefer200x17_RSSETS
2024-08-14 13:31:31,648 - JUNIFER - INFO - Computing BOLD
2024-08-14 13:31:31,649 - JUNIFER - INFO - Fetching one of Schaefer parcellations.
2024-08-14 13:31:31,649 - JUNIFER - INFO - Parcellation parameters:
2024-08-14 13:31:31,649 - JUNIFER - INFO - resolution: 3.0
2024-08-14 13:31:31,649 - JUNIFER - INFO - n_rois: 200
2024-08-14 13:31:31,649 - JUNIFER - INFO - yeo_networks: 17
2024-08-14 13:31:31,649 - JUNIFER - INFO - At least one of the parcellation files are missing. Fetching using nilearn.
Downloading data from https://raw.githubusercontent.com/ThomasYeoLab/CBIG/v0.14.3-Update_Yeo2011_Schaefer2018_labelname/stable_projects/brain_parcellation/Schaefer2018_LocalGlobal/Parcellations/MNI/Schaefer2018_200Parcels_17Networks_order.txt ...
...done. (0 seconds, 0 min)
Downloading data from https://raw.githubusercontent.com/ThomasYeoLab/CBIG/v0.14.3-Update_Yeo2011_Schaefer2018_labelname/stable_projects/brain_parcellation/Schaefer2018_LocalGlobal/Parcellations/MNI/Schaefer2018_200Parcels_17Networks_order_FSLMNI152_2mm.nii.gz ...
...done. (0 seconds, 0 min)
2024-08-14 13:31:31,672 - JUNIFER - INFO - Loading parcellation /home/runner/junifer/data/parcellations/schaefer_2018/Schaefer2018_200Parcels_17Networks_order_FSLMNI152_2mm.nii.gz
2024-08-14 13:31:31,704 - JUNIFER - INFO - Found existing xfm file for MNI152NLin6Asym to MNI152Lin at /home/runner/junifer/data/xfms/MNI152NLin6Asym_to_MNI152Lin/MNI152NLin6Asym_to_MNI152Lin_Composite.h5
2024-08-14 13:31:32,773 - JUNIFER - INFO - Downloading template MNI152Lin in resolution 2
2024-08-14 13:31:32,871 - JUNIFER - INFO - antsApplyTransforms command to be executed:
antsApplyTransforms -d 3 -e 3 -n 'GenericLabel[NearestNeighbor]' -i /tmp/tmpp3v3ecmt/parcellationse74az0d8/Schaefer200x17.nii.gz -r /tmp/tmpp3v3ecmt/parcellationse74az0d8/MNI152Lin_T1w_3.0.nii.gz -t /home/runner/junifer/data/xfms/MNI152NLin6Asym_to_MNI152Lin/MNI152NLin6Asym_to_MNI152Lin_Composite.h5 -o /tmp/tmp4p07cfs7/parcellationsa7530hlu/Schaefer200x17_warped_from_MNI152NLin6Asym_to_MNI152Lin.nii.gz
2024-08-14 13:31:34,892 - JUNIFER - INFO - antsApplyTransforms command succeeded with the following output:
2024-08-14 13:31:36,944 - JUNIFER - INFO - Storing in <SQLiteFeatureStorage @ /tmp/tmpitlmdyeb/test.sqlite (multiple output)>
2024-08-14 13:31:36,964 - JUNIFER - INFO - Marker collection fitting done
2024-08-14 13:31:36,966 - JUNIFER - INFO - Collecting data using SQLiteFeatureStorage
2024-08-14 13:31:36,966 - JUNIFER - INFO - Collecting data from /tmp/tmpitlmdyeb/*test.sqlite
file: 0it [00:00, ?it/s]
feature: 0%| | 0/2 [00:00<?, ?it/s]
feature: 100%|██████████| 2/2 [00:00<00:00, 72.01it/s]
file: 1it [00:00, 25.56it/s]
2024-08-14 13:31:37,005 - JUNIFER - INFO - Collect done
{'de47d0513cf22df792d264ecc363085a': {'datagrabber': {'class': 'SPMAuditoryTestingDataGrabber', 'types': ['BOLD', 'T1w']}, 'dependencies': {'nilearn': '0.10.4'}, 'datareader': {'class': 'DefaultDataReader'}, 'type': 'BOLD', 'marker': {'agg_method': 'mean', 'agg_method_params': None, 'class': 'RSSETSMarker', 'masks': None, 'name': 'Schaefer100x17_RSSETS_rss_ets', 'parcellation': 'Schaefer100x17'}, '_element_keys': ['subject'], 'name': 'BOLD_Schaefer100x17_RSSETS_rss_ets'}, '0ff7a9e8f65fc25885bd0cd4936f87a4': {'datagrabber': {'class': 'SPMAuditoryTestingDataGrabber', 'types': ['BOLD', 'T1w']}, 'dependencies': {'nilearn': '0.10.4'}, 'datareader': {'class': 'DefaultDataReader'}, 'type': 'BOLD', 'marker': {'agg_method': 'mean', 'agg_method_params': None, 'class': 'RSSETSMarker', 'masks': None, 'name': 'Schaefer200x17_RSSETS_rss_ets', 'parcellation': 'Schaefer200x17'}, '_element_keys': ['subject'], 'name': 'BOLD_Schaefer200x17_RSSETS_rss_ets'}}
Now we take a look at the dataframe
Total running time of the script: (0 minutes 13.347 seconds)