xcp_d.interfaces.nilearn.Smooth

class xcp_d.interfaces.nilearn.Smooth(check_import=True, *args, **kwargs)[source]

Smooth image.

Mandatory Inputs:

in_file (a pathlike object or string representing an existing file) – An image to smooth.

Optional Inputs:
  • fwhm (a float or a list of from 3 to 3 items which are a float) – Full width at half maximum. Smoothing strength, as a full-width at half maximum, in millimeters.

  • out_file (a pathlike object or string representing a file) – The name of the smoothed file to write out. smooth_img.nii.gz by default. (Nipype default value: smooth_img.nii.gz)

Outputs:

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

__init__(check_import=True, *args, **kwargs)[source]

Subclasses must implement __init__

Methods

__init__([check_import])

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.

run([cwd, ignore_exception])

Execute this interface.

save_inputs_to_json(json_file)

A convenient way to save current inputs to a JSON file.

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.

imports

resource_monitor

version

interfaces should implement a version property