nireports.interfaces.fmri module

Functional MRI -specific visualization.

class nireports.interfaces.fmri.FMRISummary(from_file=None, resource_monitor=None, **inputs)[source]

Bases: nipype.interfaces.base.core.SimpleInterface

Prepare an fMRI summary plot for the report.

Mandatory Inputs

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

Optional Inputs

  • drop_trs (an integer) – Dummy scans. (Nipype default value: 0)

  • dvars (a pathlike object or string representing an existing file)

  • fd (a pathlike object or string representing an existing file)

  • fd_thres (a float) – (Nipype default value: 0.2)

  • in_segm (a pathlike object or string representing an existing file)

  • in_spikes_bg (a pathlike object or string representing an existing file)

  • outliers (a pathlike object or string representing an existing file)

  • tr (a float or None) – The TR. (Nipype default value: None)

Outputs

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