dmriprep.interfaces.reports module¶
Interfaces to generate reportlets.
-
class
dmriprep.interfaces.reports.AboutSummary(from_file=None, resource_monitor=None, **inputs)¶ Bases:
dmriprep.interfaces.reports.SummaryInterface- Optional Inputs
command (a string) – DMRIPrep command.
version (a string) – DMRIPrep version.
- Outputs
out_report (a pathlike object or string representing an existing file) – HTML segment containing summary.
-
class
dmriprep.interfaces.reports.SubjectSummary(from_file=None, resource_monitor=None, **inputs)¶ Bases:
dmriprep.interfaces.reports.SummaryInterface- Optional Inputs
dwi (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) – DWI files.
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
dmriprep.interfaces.reports.SummaryInterface(from_file=None, resource_monitor=None, **inputs)¶ Bases:
nipype.interfaces.base.core.SimpleInterface- Outputs
out_report (a pathlike object or string representing an existing file) – HTML segment containing summary.