smriprep.interfaces.reports module
Interfaces to generate reportlets.
- class smriprep.interfaces.reports.AboutSummary(from_file=None, resource_monitor=None, **inputs)[source]
Bases:
SummaryInterface
About section reportlet.
- Optional Inputs:
command (a string) – SMRIPrep command.
version (a string) – SMRIPrep version.
- Outputs:
out_report (a pathlike object or string representing an existing file) – HTML segment containing summary.
- class smriprep.interfaces.reports.FSSurfaceReport(from_file=None, resource_monitor=None, **inputs)[source]
Bases:
SimpleInterface
Replaces
ReconAllRPT
, without need of calling recon-all.- Mandatory Inputs:
subject_id (a string) – Subject name for whom to retrieve data.
subjects_dir (a pathlike object or string representing an existing directory) – Freesurfer subjects directory.
- Optional Inputs:
compress_report (‘auto’ or True or False) – Compress the reportlet using SVGO orWEBP. ‘auto’ - compress if relevant software is installed, True = force,False - don’t attempt to compress. (Nipype default value:
auto
)hemi (‘both’ or ‘lh’ or ‘rh’) – Selects hemisphere specific outputs. (Nipype default value:
both
)out_report (a pathlike object or string representing a file) – Filename for the visual report. (Nipype default value:
report.svg
)
- Outputs:
out_report (a pathlike object or string representing a file) – Filename for the visual report.
- class smriprep.interfaces.reports.SubjectSummary(from_file=None, resource_monitor=None, **inputs)[source]
Bases:
SummaryInterface
Subject html summary reportlet.
- Optional Inputs:
output_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.