aslprep.interfaces.reports module

Interfaces to generate reportlets.

class AboutSummary(from_file=None, resource_monitor=None, **inputs)[source]

Bases: SummaryInterface

A basic summary of the ASLPrep run.

Optional Inputs:

  • command (a string) – ASLPREP command.

  • version (a string) – ASLPREP version.

Outputs:

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

class CBFSummary(from_file=None, resource_monitor=None, **inputs)[source]

Bases: SummaryInterface

A summary of a functional run, with QC measures included.

Optional Inputs:

  • confounds_file (a pathlike object or string representing an existing file) – Confounds file.

  • qc_file (a pathlike object or string representing an existing file) – Qc file.

Outputs:

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

class FunctionalSummary(from_file=None, resource_monitor=None, **inputs)[source]

Bases: SummaryInterface

A summary of a functional run, with QC measures included.

Mandatory Inputs:

  • distortion_correction (a string) – Susceptibility distortion correction method.

  • orientation (a string) – Orientation of the voxel axes.

  • pe_direction (None or ‘i’ or ‘i-’ or ‘j’ or ‘j-’) – Phase-encoding direction detected.

  • registration (‘FSL’ or ‘FreeSurfer’) – Functional/anatomical registration method.

  • registration_dof (6 or 9 or 12) – Registration degrees of freedom.

  • registration_init (‘register’ or ‘header’) – Whether to initialize registration with the “header” or by centering the volumes (“register”).

  • tr (a float) – Repetition time.

Optional Inputs:

  • confounds_file (a pathlike object or string representing an existing file) – Confounds file.

  • fallback (a boolean) – Boundary-based registration rejected.

  • qc_file (a pathlike object or string representing an existing file) – Qc file.

Outputs:

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

class SubjectSummary(from_file=None, resource_monitor=None, **inputs)[source]

Bases: SummaryInterface

A summary describing the subject’s data as a whole.

Optional Inputs:

  • asl (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) – ASL functional series.

  • nstd_spaces (a list of items which are a string) – List of non-standard spaces.

  • std_spaces (a list of items which are a string) – List of standard spaces.

  • subject_id (a string) – Subject ID.

  • subjects_dir (a pathlike object or string representing a directory) – FreeSurfer subjects directory.

  • t1w (a list of items which are a pathlike object or string representing an existing file) – T1w structural images.

  • t2w (a list of items which are a pathlike object or string representing an existing file) – T2w structural images.

Outputs:

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

  • subject_id (a string) – FreeSurfer subject ID.

class SummaryInterface(from_file=None, resource_monitor=None, **inputs)[source]

Bases: SimpleInterface

A basic summary interface.

Outputs:

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