xcp_d.interfaces.restingstate.DespikePatch

class xcp_d.interfaces.restingstate.DespikePatch(**inputs)[source]

Wrapped executable: 3dDespike.

Remove ‘spikes’ from the 3D+time input dataset.

For complete details, see the 3dDespike Documentation.

Examples

>>> from nipype.interfaces import afni
>>> despike = afni.Despike()
>>> despike.inputs.in_file = 'functional.nii'
>>> despike.cmdline
'3dDespike -prefix functional_despike functional.nii'
>>> res = despike.run()  

Mandatory Inputs:

in_file (a pathlike object or string representing an existing file) – Input file to 3dDespike. 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.
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: {})
num_threads (an integer) – Set number of threads. (Nipype default value: 1)
out_file (a pathlike object or string representing a file) – Output image file name. Maps to a command-line argument: -prefix %s.
outputtype (‘NIFTI’ or ‘AFNI’ or ‘NIFTI_GZ’) – AFNI output filetype.

Outputs:

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

__init__(**inputs)[source]: Instantiate an AFNI command tool wrapper.

Methods

`__init__`(**inputs)	Instantiate an AFNI command tool wrapper.
`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_output_type`(outputtype)	Set the default output type for AFNI classes.
`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
`num_threads`	Get number of threads.
`resource_monitor`
`terminal_output`
`version`	interfaces should implement a version property
`write_cmdline`