nireports.interfaces.reporting.base module

class mixin and utilities for enabling reports for nipype interfaces.

class nireports.interfaces.reporting.base.RegistrationRC(generate_report=False, **kwargs)

Bases: ReportCapableInterface

An abstract mixin to registration nipype interfaces.

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)

• fixed_params (a dictionary with keys which are a string and with values which are any value) – Pass parameters to plotter. (Nipype default value: {})

• moving_params (a dictionary with keys which are a string and with values which are any value) – Pass parameters to plotter. (Nipype default value: {})

• out_report (a pathlike object or string representing a file) – Filename for the visual report. (Nipype default value: report.svg)

class nireports.interfaces.reporting.base.ReportingInterface(generate_report=True, **kwargs)

Bases: ReportCapableInterface

Interface that always generates a report.

A subclass must define an input_spec and override _generate_report.

Outputs:

out_report (a pathlike object or string representing a file) – Filename for the visual report.

class nireports.interfaces.reporting.base.ResampleBeforeAfterRPT(generate_report=True, **kwargs)

Bases: SimpleBeforeAfterRPT

Mandatory Inputs:

• after (a pathlike object or string representing an existing file) – File after.

• base (‘before’ or ‘after’) – (Nipype default value: before)

• before (a pathlike object or string representing an existing file) – File before.

Optional Inputs:

• after_label (a string) – (Nipype default value: after)

• before_label (a string) – (Nipype default value: before)

• 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)

• dismiss_affine (a boolean) – Rotate image(s) to cardinal axes. (Nipype default value: False)

• fixed_params (a dictionary with keys which are a string and with values which are any value) – Pass parameters to plotter. (Nipype default value: {})

• moving_params (a dictionary with keys which are a string and with values which are any value) – Pass parameters to plotter. (Nipype default value: {})

• out_report (a pathlike object or string representing a file) – Filename for the visual report. (Nipype default value: report.svg)

• wm_seg (a pathlike object or string representing a file) – Reference white matter segmentation mask.

Outputs:

out_report (a pathlike object or string representing a file) – Filename for the visual report.

class nireports.interfaces.reporting.base.SegmentationRC(generate_report=False, **kwargs)

Bases: ReportCapableInterface

An abstract mixin to segmentation nipype interfaces.

class nireports.interfaces.reporting.base.SimpleBeforeAfterRPT(generate_report=True, **kwargs)

Bases: RegistrationRC, ReportingInterface

Mandatory Inputs:

• after (a pathlike object or string representing an existing file) – File after.

• before (a pathlike object or string representing an existing file) – File before.

Optional Inputs:

• after_label (a string) – (Nipype default value: after)

• before_label (a string) – (Nipype default value: before)

• 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)

• dismiss_affine (a boolean) – Rotate image(s) to cardinal axes. (Nipype default value: False)

• fixed_params (a dictionary with keys which are a string and with values which are any value) – Pass parameters to plotter. (Nipype default value: {})

• moving_params (a dictionary with keys which are a string and with values which are any value) – Pass parameters to plotter. (Nipype default value: {})

• out_report (a pathlike object or string representing a file) – Filename for the visual report. (Nipype default value: report.svg)

• wm_seg (a pathlike object or string representing a file) – Reference white matter segmentation mask.

Outputs:

out_report (a pathlike object or string representing a file) – Filename for the visual report.

class nireports.interfaces.reporting.base.SurfaceSegmentationRC(generate_report=False, **kwargs)

Bases: ReportCapableInterface

An abstract mixin to registration nipype interfaces.