xcp_d.interfaces.report module

Interfaces to generate reportlets.

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

Bases: SummaryInterface

A summary of the xcp_d software used.

Optional Inputs:

  • command (a string) – Xcp_d command.

  • version (a string) – Xcp_d version.

Outputs:

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

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

Bases: SummaryInterface

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.

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

Bases: SummaryInterface

A subject-level summary interface.

Optional Inputs:

  • bold (a list of items which are a pathlike object or string representing an existing file or a list of items which are a pathlike object or string representing an existing file) – BOLD or CIFTI functional series.

  • subject_id (a string) – Subject ID.

Outputs:

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

  • subject_id (a string) – Subject ID.

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

Bases: SimpleInterface

A summary interface.

This is used as a base class for other summary interfaces.

Outputs:

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