Skip to main content

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.

Metadata

Release files for convert-source 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for convert-source 0.1.1
File Size Uploaded
convert_source-0.1.1.tar.gz 58.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for convert-source 0.1.1
File Interpreter ABI Platform
convert_source-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 125.1 kB

Release files / convert_source-0.1.1.tar.gz

Download URL convert_source-0.1.1.tar.gz
Size 58.3 kB
Tags Source
SHA-256 checksum
How to use checksums
639ed021332e145ae2f585fabba044d341193fe49cb4dbce889e2bc6c2d01160
BLAKE2b-256 checksum
How to use checksums
472cac2ea62e505fe4e7ea540047b1c9c5f28a1191c07d452a20248b4570c5e3
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / convert_source-0.1.1-py3-none-any.whl

Download URL convert_source-0.1.1-py3-none-any.whl
Size 66.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fc614d6ac4687fba6bd651aa8311724df314cab4ac1ad5fed81f64edea65aaa4
BLAKE2b-256 checksum
How to use checksums
045bc49731e596a1c6abea8355645ed9feb42746835e6f83d5b7b6b50bd15877
Upload date
Uploaded using Trusted Publishing?
What is 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
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page