nipype.interfaces.bru2nii module

The bru2nii module provides basic functions for dicom conversion

Bru2

Link to code

Bases: CommandLine

Wrapped executable: Bru2.

Uses bru2nii’s Bru2 to convert Bruker files

Examples

>>> from nipype.interfaces.bru2nii import Bru2
>>> converter = Bru2()
>>> converter.inputs.input_dir = "brukerdir"
>>> converter.cmdline  
'Bru2 -o .../data/brukerdir brukerdir'
Mandatory Inputs

input_dir (a pathlike object or string representing an existing directory) – Input Directory. Maps to a command-line argument: %s (position: -1).

Optional Inputs

  • actual_size (a boolean) – Keep actual size - otherwise x10 scale so animals match human. Maps to a command-line argument: -a.

  • append_protocol_name (a boolean) – Append protocol name to output filename. Maps to a command-line argument: -p.

  • args (a string) – Additional parameters to the command. Maps to a command-line argument: %s.

  • compress (a boolean) – Gz compress images (“.nii.gz”). Maps to a command-line argument: -z.

  • environ (a dictionary with keys which are a bytes or None or a value of class ‘str’ and with values which are a bytes or None or a value of class ‘str’) – Environment variables. (Nipype default value: {})

  • force_conversion (a boolean) – Force conversion of localizers images (multiple slice orientations). Maps to a command-line argument: -f.

  • output_filename (a string) – Output filename (“.nii” will be appended, or “.nii.gz” if the “-z” compress option is selected). Maps to a command-line argument: -o %s.

Outputs

nii_file (a pathlike object or string representing an existing file)