Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created 'derivatives' folder with processed MPM output #38

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions examples/BEP001_examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# BEP001 examples

This branch of the BEP001 repository contains some practical examples of what a BIDS-compatible qMRI dataset will look like.

You can find more about the BEP001 addition to the BIDS standard, and the rationale for the additions/changes that it brings to the BIDS format, here: https://github.com/bids-standard/bep001.

*The datasets in this branch contain empty data files, which might be useful for building simple software tests.
The current branch may eventually be merged with the bids-examples branch of the main bids-standard repo: https://github.com/bids-standard/bids-examples, in which case this disclaimer will be redundant.*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!



## Example 1: MEGRE, multi-echo
This is a sample dataset from a single MEGRE sequence, which yields multiple images, corresponding to different echo times. This dataset has been used to calculate a quantitative susceptibility map (QSM), as well as a T2* map.

## Example 2: MP2RAGE, single echo
This is a sample dataset from a standard MP2RAGE sequence, which includes two GRE images acquired after a single inversion pulse. This data have been used to create a T1-map, as well as a T1-weighted image, corrected for B0 and B1-inhomogeneities, which are both part of the example dataset.

## Example 3: MP2RAGE, multi-echo
This is a sample dataset from an MP2RAGE sequence with two inversion times, and, for the second inversion time, 4 different echoes.

## Example 4: MultiParameter Mapping (MPM) dataset
This is a sample dataset from a MultiParameter Mapping (MPM) sequence (as per Weiskopf et al., 2013), which yields multi-echo FLASH scans that are predominantly T1-, PD-, or MT-weighted by changing repetition time and flip angle.
Note that the raw data for these scans are not called "FLASH" (or MEGRE, following our recommended vendor-neutral notation) in their suffices, rather they are grouped together with the "MPM" suffix and the "acq" tag is used to clarify which weightings the scans are highlighting.
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
"Kirstie Whitaker",
"Gilles de Hollander"
],
"Description": "This virtual dataset is collected using a single FLASH sequence, which yields multiple images, corresponding to different echo times. This data has been used to calculate a quantitative susceptibility map, as well as a T2* map."
"Description": "This virtual dataset is collected using a single MEGRE sequence, which yields multiple images, corresponding to different echo times. This data has been used to calculate a quantitative susceptibility map, as well as a T2* map."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great change ✅

This is what I was thinking of when I said add the information to the dataset_description.json file - adding the text you have describing the dataset in the BEP001_examples.md file to the json itself 😄

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"BasedOn": [
"anat/sub-01_echo-1_part-mag_MEGRE.nii.gz",
"anat/sub-01_echo-1_part-phase_MEGRE.nii.gz"
],
"EstimationMethod": "Schaefer et al., 2011"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"BasedOn": [
"anat/sub-01_echo-1_part-mag_MEGRE.nii.gz",
"anat/sub-01_echo-2_part-mag_MEGRE.nii.gz",
"anat/sub-01_echo-3_part-mag_MEGRE.nii.gz"
],
"EstimationMethod": "Linear least-squares"
}
9 changes: 9 additions & 0 deletions examples/MEGRE_multiecho/sub-01/anat/sub-01_echo-1_MEGRE.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"IntendedFor": ["anat/sub-01_T2starmap.nii.gz",
"anat/sub-01_QSM.nii.gz"],
"MagneticFieldStrength": "3",
"Manufacturer": "GE",
"PulseSequenceType": "SPGR",
"RepetitionTime": "0.0150",
"FlipAngle": "3"
}
9 changes: 9 additions & 0 deletions examples/MEGRE_multiecho/sub-01/anat/sub-01_echo-2_MEGRE.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"IntendedFor": ["anat/sub-01_T2starmap.nii.gz",
"anat/sub-01_QSM.nii.gz"],
"MagneticFieldStrength": "3",
"Manufacturer": "GE",
"PulseSequenceType": "SPGR",
"RepetitionTime": "0.0150",
"FlipAngle": "3"
}
9 changes: 9 additions & 0 deletions examples/MEGRE_multiecho/sub-01/anat/sub-01_echo-3_MEGRE.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"IntendedFor": ["anat/sub-01_T2starmap.nii.gz",
"anat/sub-01_QSM.nii.gz"],
"MagneticFieldStrength": "3",
"Manufacturer": "GE",
"PulseSequenceType": "SPGR",
"RepetitionTime": "0.0150",
"FlipAngle": "3"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"BasedOn": [
"anat/sub-1_inv-1_part-mag_MP2RAGE.nii",
"anat/sub-1_inv-1_part-phase_MP2RAGE.nii",
"anat/sub-1_echo-1_inv-2_part-mag_MP2RAGE.nii",
"anat/sub-1_echo-1_inv-2_part-phase_MP2RAGE.nii",
"fmap/sub-1_B1map.nii"

],
"EstimationReference": "Caan et al., 2019",
"EstimationAlgorithm": "MP2RAGE T1 map",
"EstimationSoftwareName": "pymp2rage",
"EstimationSoftwareVer": "v0.1",
"EstimationSoftwareLang": "Python 3.6",
"EstimationSoftwareEnv": "Mac OS X 10.14.5"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"BasedOn": ["anat/sub-1_echo-1_inv-2_part-mag_MP2RAGE.nii",
"anat/sub-1_echo-2_inv-2_part-mag_MP2RAGE.nii",
"anat/sub-1_echo-3_inv-2_part-mag_MP2RAGE.nii",
"anat/sub-1_echo-4_inv-2_part-mag_MP2RAGE.nii",],

"EstimationAlgorithm": "Ordinary Least Squares in Log-space",
"EstimationSoftwareName": "pymp2rage",
"EstimationSoftwareVer": "v0.1",
"EstimationSoftwareLang": "Python 3.6",
"EstimationSoftwareEnv": "Mac OS X 10.14.5"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"InversionTime": 0.67,
"FlipAngle": 7,
"ExcitationRepetitionTime": 0.0062,
"InversionRepetitionTime": 6.723,
"NumberShots": 150
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"InversionTime": 3.855,
"FlipAngle": 6,
"ExcitationRepetitionTime": 0.032,
"InversionRepetitionTime": 6.723,
"NumberShots": 150,
"EchoTime": 0.006
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"InversionTime": 3.855,
"FlipAngle": 6,
"ExcitationRepetitionTime": 0.032,
"InversionRepetitionTime": 6.723,
"NumberShots": 150,
"EchoTime": 0.0145
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"InversionTime": 3.855,
"FlipAngle": 6,
"ExcitationRepetitionTime": 0.032,
"InversionRepetitionTime": 6.723,
"NumberShots": 150,
"EchoTime": 0.0230
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"InversionTime": 3.855,
"FlipAngle": 6,
"ExcitationRepetitionTime": 0.032,
"InversionRepetitionTime": 6.723,
"NumberShots": 150,
"EchoTime": 0.0315
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"BasedOn": [
"anat/sub-1_inv-1_part-mag_MP2RAGE.nii",
"anat/sub-1_inv-1_part-phase_MP2RAGE.nii",
"anat/sub-1_inv-2_part-mag_MP2RAGE.nii",
"anat/sub-1_inv-2_part-phase_MP2RAGE.nii"
],
"EstimationReference": "Marques et al., 2010",
"EstimationAlgorithm": "MP2RAGE T1UNI",
"EstimationSoftwareName": "pymp2rage",
"EstimationSoftwareVer": "v0.1",
"EstimationSoftwareLang": "Python 3.6",
"EstimationSoftwareEnv": "Mac OS X 10.14.5"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"InversionTime": 0.8,
"FlipAngle": 5,
"ExcitationRepetitionTime": 0.0062,
"InversionRepetitionTime": 5.5,
"NumberShots": 159
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"InversionTime": 2.7,
"FlipAngle": 7,
"ExcitationRepetitionTime": 0.0062,
"InversionRepetitionTime": 5.5,
"NumberShots": 159
}
43 changes: 43 additions & 0 deletions examples/MPM/derivatives/hmri/sub-01/anat/sub-01_MTsat.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{"BasedOn": ["anat/sub-01_echo-1_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-7_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-8_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-T1w_MPM.nii.gz",
"fmap/sub-01_B1minusmap_MTon.json",
"fmap/sub-01_B1minusmap_MToff.json",
"fmap/sub-01_B1minusmap_T1w.json",
"fmap/sub-01_echo-1_B1plusmap.json",
"fmap/sub-01_echo-1_part-mag_B0map.json",
"fmap/sub-01_echo-2_B1plusmap.json",
"fmap/sub-01_echo-2_part-phase_B0map.json",
"fmap/sub-01_echo-2_part-mag_B0map.json"]
"MagneticFieldStrength": "3",
"Manufacturer": "Siemens",
"ManufacturerModelName": "Prisma",
"ScanningSequence": "RM",
"SequenceVariant": "SP",
“SequenceName": "fl3d_1i3d8",
"RepetitionTime": "0.025",
"FlipAngle": ["6","21"],
"EstimationPaper":"Tabelow et al., 2019, Neuroimage",
"EstimationAlgorithm":"Ernst equation",
"EstimationSoftwareName": "SPM hMRI",
"EstimationSoftwareLanguage": "MATLAB",
"EstimationSoftwareVersion": "0.2.0",
"EstimationSoftwareEnv": "OSX 10.14"
}
43 changes: 43 additions & 0 deletions examples/MPM/derivatives/hmri/sub-01/anat/sub-01_PDmap.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{"BasedOn": ["anat/sub-01_echo-1_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-7_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-8_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-T1w_MPM.nii.gz",
"fmap/sub-01_B1minusmap_MTon.json",
"fmap/sub-01_B1minusmap_MToff.json",
"fmap/sub-01_B1minusmap_T1w.json",
"fmap/sub-01_echo-1_B1plusmap.json",
"fmap/sub-01_echo-1_part-mag_B0map.json",
"fmap/sub-01_echo-2_B1plusmap.json",
"fmap/sub-01_echo-2_part-phase_B0map.json",
"fmap/sub-01_echo-2_part-mag_B0map.json"]
"MagneticFieldStrength": "3",
"Manufacturer": "Siemens",
"ManufacturerModelName": "Prisma",
"ScanningSequence": "RM",
"SequenceVariant": "SP",
“SequenceName": "fl3d_1i3d8",
"RepetitionTime": "0.025",
"FlipAngle": ["6","21"],
"EstimationPaper":"Tabelow et al., 2019, Neuroimage",
"EstimationAlgorithm":"Ernst equation",
"EstimationSoftwareName": "SPM hMRI",
"EstimationSoftwareLanguage": "MATLAB",
"EstimationSoftwareVersion": "0.2.0",
"EstimationSoftwareEnv": "OSX 10.14"
}
43 changes: 43 additions & 0 deletions examples/MPM/derivatives/hmri/sub-01/anat/sub-01_R1map.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{"BasedOn": ["anat/sub-01_echo-1_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-7_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-8_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-T1w_MPM.nii.gz",
"fmap/sub-01_B1minusmap_MTon.json",
"fmap/sub-01_B1minusmap_MToff.json",
"fmap/sub-01_B1minusmap_T1w.json",
"fmap/sub-01_echo-1_B1plusmap.json",
"fmap/sub-01_echo-1_part-mag_B0map.json",
"fmap/sub-01_echo-2_B1plusmap.json",
"fmap/sub-01_echo-2_part-phase_B0map.json",
"fmap/sub-01_echo-2_part-mag_B0map.json"]
"MagneticFieldStrength": "3",
"Manufacturer": "Siemens",
"ManufacturerModelName": "Prisma",
"ScanningSequence": "RM",
"SequenceVariant": "SP",
“SequenceName": "fl3d_1i3d8",
"RepetitionTime": "0.025",
"FlipAngle": ["6","21"],
"EstimationPaper":"Tabelow et al., 2019, Neuroimage",
"EstimationAlgorithm":"Ernst equation",
"EstimationSoftwareName": "SPM hMRI",
"EstimationSoftwareLanguage": "MATLAB",
"EstimationSoftwareVersion": "0.2.0",
"EstimationSoftwareEnv": "OSX 10.14"
}
43 changes: 43 additions & 0 deletions examples/MPM/derivatives/hmri/sub-01/anat/sub-01_R2starmap.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{"BasedOn": ["anat/sub-01_echo-1_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-7_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-8_part-mag_acq-MToff_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-MTon_MPM.nii.gz",
"anat/sub-01_echo-1_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-2_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-3_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-4_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-5_part-mag_acq-T1w_MPM.nii.gz",
"anat/sub-01_echo-6_part-mag_acq-T1w_MPM.nii.gz",
"fmap/sub-01_B1minusmap_MTon.json",
"fmap/sub-01_B1minusmap_MToff.json",
"fmap/sub-01_B1minusmap_T1w.json",
"fmap/sub-01_echo-1_B1plusmap.json",
"fmap/sub-01_echo-1_part-mag_B0map.json",
"fmap/sub-01_echo-2_B1plusmap.json",
"fmap/sub-01_echo-2_part-phase_B0map.json",
"fmap/sub-01_echo-2_part-mag_B0map.json"]
"MagneticFieldStrength": "3",
"Manufacturer": "Siemens",
"ManufacturerModelName": "Prisma",
"ScanningSequence": "RM",
"SequenceVariant": "SP",
“SequenceName": "fl3d_1i3d8",
"RepetitionTime": "0.025",
"FlipAngle": ["6","21"],
"EstimationPaper":"Tabelow et al., 2019, Neuroimage",
"EstimationAlgorithm":"Ernst equation",
"EstimationSoftwareName": "SPM hMRI",
"EstimationSoftwareLanguage": "MATLAB",
"EstimationSoftwareVersion": "0.2.0",
"EstimationSoftwareEnv": "OSX 10.14"
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{"IntendedFor": ["anat/sub-01_PDmap.nii.gz",
"anat/sub-01_MTmap.nii.gz",
"anat/sub-01_MTsat.nii.gz",
"anat/sub-01_R1map.nii.gz",
"anat/sub-01_R2starmap.nii.gz"],
"RepetitionTime": 1.02,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{"IntendedFor": ["anat/sub-01_PDmap.nii.gz",
"anat/sub-01_MTmap.nii.gz",
"anat/sub-01_MTsat.nii.gz",
"anat/sub-01_R1map.nii.gz",
"anat/sub-01_R2starmap.nii.gz"]}
Loading