xcp_d.interfaces.report.FunctionalSummary

class xcp_d.interfaces.report.FunctionalSummary(from_file=None, resource_monitor=None, **inputs)[source]

A functional MRI summary interface.

Mandatory Inputs:

TR (a float) – Repetition time.
bold_file (a string or os.PathLike object) – CIFTI or NIfTI BOLD file. This file does not need to exist, because this input is just used for extracting filename information.
qc_file (a string or os.PathLike object referring to an existing file) – Qc file.

Outputs:

out_report (a pathlike object or string representing an existing file) – HTML segment containing summary.

__init__(from_file=None, resource_monitor=None, **inputs)[source]: Subclasses must implement __init__

Methods

`__init__`([from_file, resource_monitor])	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.
`resource_monitor`
`version`	interfaces should implement a version property