Skip to main content

Dcm2niix plugin for the d2b package

Project description

d2b-dcm2niix

Dcm2niix plugin for the d2b package

PyPI Version

Installation

pip install d2b-dcm2niix

Usage

After installation the d2b run command should have additional dcm2niix-specific flags:

$ d2b run --help
usage: d2b run [-h] -c CONFIG_FILE -p PARTICIPANT -o OUT_DIR [-s SESSION] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--no-dcm2niix | --dcm2niix | --force-dcm2niix] in_dir [in_dir ...]

Organize data in the BIDS format

positional arguments:
  in_dir                Directory(ies) containing files to organize

required arguments:
  -c CONFIG_FILE, --config CONFIG_FILE
                        JSON configuration file (see example/config.json)
  -p PARTICIPANT, --participant PARTICIPANT
                        Participant ID
  -o OUT_DIR, --out-dir OUT_DIR
                        Output BIDS directory
  --no-dcm2niix         Don't run dcm2niix on the input directories. (This is the default)
  --dcm2niix            Run dcm2niix on each of the input directories before organization code executes. dcm2niix execution will be skipped for directories for which converted results from a previous run are found.
  --force-dcm2niix      Run dcm2niix on each of the input directories before organization code executes. Previous dcm2niix results will be overwritten

optional arguments:
  -s SESSION, --session SESSION
                        Session ID
  -l {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        Set logging level

Specifically, the following new (mutually exclusive) options are available:

  • --no-dcm2niix: This is the default behaviour (i.e. the behaviour of the d2b run command if none of the dcm2niix flags are set)

  • --dcm2niix: This will try to run dcm2niix on (copies of) each of the input directories prior to proceeding with BIDS-ification. NOTE: If any NIfTI files are found from a previous d2b run --dcm2niix ... run, then dcm2niix will not be invoked on that (copy of that) specific input directory.

  • --force-dcm2niix: This will run dcm2niix on (copies of) each of the input directories always, regardless of files from previous d2b run runs.

Also, there should be a new subcommand d2b dcm2niix available:

$ d2b dcm2niix --help
usage: d2b dcm2niix [-h] in_dir [in_dir ...] out_dir

Run dcm2niix with the options used by d2b

positional arguments:
  in_dir      DICOM directory(ies)
  out_dir     Output BIDS directory

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

This command is the equivalent of dcm2bids's dcm2bids_helper command. In particular it's serves as a way to run dcm2niix in the exact same way that d2b run --[force-]dcm2niix would run the command (i.e. potentially useful to see what the resulting sidecars/filenames would look like).

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

d2b-dcm2niix-1.0.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

d2b_dcm2niix-1.0.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file d2b-dcm2niix-1.0.0.tar.gz.

File metadata

  • Download URL: d2b-dcm2niix-1.0.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.8.0-1040-azure

File hashes

Hashes for d2b-dcm2niix-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9896c7ae2d753d54777d4adfe1b26d0e1c282369b1128ac141465ecf5c66bd45
MD5 9de97cdf84ea20ac86a180af00806456
BLAKE2b-256 661e7a3fc9097d0b36217b737ccc23ddcd8fefa93935dd59bfc572eea7501521

See more details on using hashes here.

File details

Details for the file d2b_dcm2niix-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: d2b_dcm2niix-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.8.0-1040-azure

File hashes

Hashes for d2b_dcm2niix-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8657a971a266bc1d1a3f8787f46b0ceb9f54f927ab011a0925fb2e8e5534e6a
MD5 1014815a510c23e2060d57395aaadfa5
BLAKE2b-256 ce2ce7b8280eaddb6121709b2beb79984b89755fe11f8b22d1db30fa8465b38f

See more details on using hashes here.

Supported by

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