xcp_d.interfaces.workbench.CiftiChangeMapping

class xcp_d.interfaces.workbench.CiftiChangeMapping(command=None, terminal_output=None, write_cmdline=False, **inputs)[source]

Wrapped executable: wb_command -cifti-change-mapping.

Convert to scalar, copy mapping, etc.

Take an existing cifti file and change one of the mappings. Exactly one of -series, -scalar, or -from-cifti must be specified. The direction can be either an integer starting from 1, or the strings ‘ROW’ or ‘COLUMN’.

Examples

>>> ccdft = CiftiChangeMapping()
>>> ccdft.inputs.data_cifti = "tpl-fsLR_atlas-Gordon_den-32k_dseg.dlabel.nii"
>>> ccdft.inputs.direction = "ROW"
>>> ccdft.inputs.cifti_out = "out.dscalar.nii"
>>> ccdft.inputs.scalar = True
>>> ccdft.cmdline
wb_command -cifti-change-mapping         tpl-fsLR_atlas-Gordon_den-32k_dseg.dlabel.nii         ROW         out.dscalar.nii         -scalar

Mandatory Inputs:

data_cifti (a pathlike object or string representing an existing file) – The cifti file to use the data from. Maps to a command-line argument: %s (position: 0).
direction (‘ROW’ or ‘COLUMN’) – Which mapping to parcellate (integer, ROW, or COLUMN). Maps to a command-line argument: %s (position: 1).

Optional Inputs:

args (a string) – Additional parameters to the command. Maps to a command-line argument: %s.
cifti_out (a pathlike object or string representing a file) – The output cifti file. Maps to a command-line argument: %s (position: 2).
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: {})
scalar (a boolean) – Set the mapping to scalar. Maps to a command-line argument: -scalar (position: 3). (Nipype default value: False)

Outputs:

cifti_out (a pathlike object or string representing an existing file) – Output CIFTI file.

__init__(command=None, terminal_output=None, write_cmdline=False, **inputs)[source]: Subclasses must implement __init__

Methods

`__init__`([command, terminal_output, ...])	Subclasses must implement __init__
`aggregate_outputs`([runtime, needed_outputs])	Collate expected outputs and apply output traits validation.
`help`([returnhelp])	Prints class help
`load_inputs_from_json`(json_file[, overwrite])	A convenient way to load pre-set inputs from a JSON file.
`raise_exception`(runtime)
`run`([cwd, ignore_exception])	Execute this interface.
`save_inputs_to_json`(json_file)	A convenient way to save current inputs to a JSON file.
`set_default_terminal_output`(output_type)	Set the default terminal output for CommandLine Interfaces.
`version_from_command`([flag, cmd])

Attributes

`always_run`	Should the interface be always run even if the inputs were not changed? Only applies to interfaces being run within a workflow context.
`can_resume`	Defines if the interface can reuse partial results after interruption.
`cmd`	sets base command, immutable
`cmdline`	command plus any arguments (args) validates arguments and generates command line
`resource_monitor`
`terminal_output`
`version`	interfaces should implement a version property
`write_cmdline`