Behavior and Neuroimaging Core User Manual
  • About
  • Infrastructure Overview
  • XNAT
    • Getting Started
    • Accessing XNAT
    • BIDS Ready Protocols
    • New XNAT projects
    • Uploading Data
    • Downloading Data
  • Demo Dataset
    • Introduction
    • How to access it
    • Protocol Information
    • Basic analysis example: checks task
  • XNAT to BIDS
    • Getting Started
    • XNAT2BIDS Software
    • Exporting to BIDS using Oscar
      • Oscar Utility Script
        • Running xnat2bids using default configuration
        • Running xnat2bids with a custom configuration
        • Syncing your XNAT project & Oscar data directory
        • Extra tools & features
      • Step-wise via Interact Session
    • BIDS Validation
      • Oscar
      • Docker
    • Converting non-MR data
      • Physiological data
      • EEG data
  • XNAT TO BIDS (Legacy)
    • Oscar SBATCH Scripts
  • BIDS and BIDS Containers
    • Introduction to BIDS
    • mriqc
    • fmriprep
    • BIDS to NIMH Data Archive (NDA)
  • Analysis Pipelines
    • Freesurfer
    • 🚧CONN Toolbox
    • FSL topup and eddy
    • Tractography: DSI Studio
    • Brown University MRS Data Collection and Preprocessing Protocol
    • LC Model
      • Installation
      • Example Run
      • Running LCModel on your own data
    • Quantitative Susceptibility Mapping (QSM)
  • Standalone Tools
    • Multi-session spectroscopy with voxalign
    • dicomsort: a tool to organize DICOM files
    • ironmap
    • convert enhanced multi-frame DICOMs to legacy single-frame
    • DICOM anonymization
  • MRF GUIDES
    • MRI simulator room
      • Motion Trainer: Balloon Task
      • Simulating scanner triggers
    • Stimulus display & response collection
    • Eyetracking at the scanner
    • Exporting data via scannershare
    • EEG in the scanner
    • Exporting spectroscopy RDA files
  • Community
    • MRF/BNC user community meetings
Powered by GitBook
On this page
  • BIDS Naming Pattern
  • Additional Sample Protocols
  • Important considerations
  • Scouts and Localizers
  • Incompatible symbols
  • Naming Runs
  • Cancelled Runs
  • Functional
  • MEMPRAGE
  • Fieldmaps
  • Scanner derivatives

Was this helpful?

  1. XNAT

BIDS Ready Protocols

How to name your protocols so they are easily converted to BIDS format

PreviousAccessing XNATNextNew XNAT projects

Last updated 1 year ago

Was this helpful?

BIDS Naming Pattern

We provide custom code () to export your XNAT imaging sessions to BIDS format. The process relies on naming your series in a BIDS friendly manner. If you are new to BIDS, it may be helpful to familiarize yourself with the . We also provide a short overview of BIDS in .

When naming your series at the scanner you will need to think of the different parts that make up the BIDS name. More explicitly, the name of the series is composed of different parts that provide information about the sequence type (i.e, anatomical, functional, etc), task information, acquisition parameters, the run id, among others. The examples and diagram below show the parts of the BIDS name that you need to pay attention when naming your series at the scanner. These are only a subset of the full set defined by the BIDS specification. You can refer to the of the BIDS specification for a full reference.

To create the final name, the different parts shown above are concatenated using underscores (_)

Additional Sample Protocols

anat-scout_acq-aascout
anat-scout_acq-localizer
anat-T1w_acq-memprage
fmap_acq-greAP
func-bold_task-TSSblock_acq-2dot4mmSMS4TR1200AP_run+
anat-scout_acq-localizer
anat-scout_acq-aascout
anat-t1w_acq-memprage
func-bold_task-lum_run+
dwi_acq-122_dir-ap
dwi_acq-b0_dir-pa

Important considerations

Scouts and Localizers

All scout and localizer sequences need to have a scout label. For example:

  • anat-scout_acq-localizer

  • anat-scout_acq-aascout

Scout series will remain in the sourcedata directory of your bids output, but will not be present in your anat folder.

Incompatible symbols

Do not use "+", "_", "-" or "." within SESID, TASKID, ACQLABEL, RUNID. The only exception is the use of run+

Naming Runs

To indicate runs in your protocol, without explicitly indicating the run number, simply label the run as run+

Cancelled Runs

If run was canceled you will need to skip that series when calling the BIDS exporting code xnat2bids. We encourage adding a note to that series in XNAT to indicate that the run was cancelled. This will improve bookkeeping and maintainability.

Functional

Functional runs must have _task- field defined

MEMPRAGE

You can choose (on the scanner) whether to send each individual echo along with the RMS image. Regardless, this data should now be converted appropriately to BIDS format.

Fieldmaps

Scanner derivatives

Currently the fieldmaps collected with our Siemens scanner use the "old way" described

Some sequences are derivatives of the scanner and are not yet handled by our xnat2bids software smoothly. We recommend not exporting those sequences to BIDS at the moment. (This behavior may change in the future. See for more details)

here
here
xnat-tools package
BIDS Standard
this section
Entity Table
Color coded examples of BIDS compliant protocols
Table how to build series at the scanner for BIDS compliance