Skip to main content

Converts and organises source MR image data-sets in accordance with the Brain Imaging Data Structure (BIDS)

Project description

CircleCI Documentation Status

convert_source

Convert source DICOM, PAR REC or NIFTI image data to BIDS directory layout.

The YAML configuration file used as input dictates the search terms used to find and rename files. Please see config/config.default.yml or config/config.example.yml for examples.

Requires dcm2niix and pydicom.

usage: study_proc [-h] [-s STUDY_DIR] [-o OUT_DIR] [-c CONFIG.yml] [--no-gzip]
                  [--compress INT] [--zero-pad INT] [--append-dwi-info]
                  [--verbose] [--version] [--path-env PATH_VAR]

Convert source data of a study's imaging data to BIDS NIFTI data.

optional arguments:
  -h, --help            show this help message and exit

Required Argument(s):
  -s STUDY_DIR, -study STUDY_DIR, --study-dir STUDY_DIR
                        Parent study image directory for all subjects.
  -o OUT_DIR, -out OUT_DIR, --out-dir OUT_DIR
                        Output directory.

Optional Argument(s):
  -c CONFIG.yml, -config CONFIG.yml, --config-file CONFIG.yml
                        Input YAML configuration file. If no configuration
                        file is provided, then the default configuration file
                        is used.
  --no-gzip             DO NOT gzip the resulting BIDS NIFTI files [default:
                        False].
  --compress INT        Compression level [1 - 9] - 1 is fastest, 9 is
                        smallest [default: 6].
  --zero-pad INT        The amount of zeropadding to pad the run numbers of
                        the BIDS NIFTI files (e.g. '--zero-pad=2' corresponds
                        to '01') [default: 2].
  --append-dwi-info     RECOMMENDED: Appends DWI acquisition information
                        (unique non-zero b-values, and TE, in msec.) to BIDS
                        acquisition filename of diffusion weighted image files
                        [default: False].
  --verbose             Enables verbose output to the command line.
  --version             Prints the version of 'convert_source', then exits.

Expert Option(s):
  --path-env PATH_VAR   Environmental path variable or variables for
                        dependencies (e.g. the path to 'dcm2niix'). NOTE: This
                        option is repeatable, and can thus be specified
                        multiple times.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

convert_source-0.1.1.tar.gz (58.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

convert_source-0.1.1-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

File details

Details for the file convert_source-0.1.1.tar.gz.

File metadata

  • Download URL: convert_source-0.1.1.tar.gz
  • Upload date:
  • Size: 58.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for convert_source-0.1.1.tar.gz
Algorithm Hash digest
SHA256 639ed021332e145ae2f585fabba044d341193fe49cb4dbce889e2bc6c2d01160
MD5 3bd629ca234a1c95ebf0c0b4d2985c52
BLAKE2b-256 472cac2ea62e505fe4e7ea540047b1c9c5f28a1191c07d452a20248b4570c5e3

See more details on using hashes here.

File details

Details for the file convert_source-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: convert_source-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 66.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for convert_source-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fc614d6ac4687fba6bd651aa8311724df314cab4ac1ad5fed81f64edea65aaa4
MD5 665b5c628e3247ff83af6328fe4f2f92
BLAKE2b-256 045bc49731e596a1c6abea8355645ed9feb42746835e6f83d5b7b6b50bd15877

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page