sdcflows.interfaces.reportlets module#

Interfaces to generate speciality reportlets.

class sdcflows.interfaces.reportlets.FieldmapReportlet(**kwargs)[source]#

Bases: ReportCapableInterface

An abstract mixin to registration nipype interfaces.

Mandatory Inputs:

  • fieldmap (a pathlike object or string representing an existing file) – Input fieldmap.

  • reference (a pathlike object or string representing an existing file) – Input reference.

Optional Inputs:

  • apply_mask (a boolean) – Zero values outside mask. (Nipype default value: False)

  • mask (a pathlike object or string representing an existing file) – Brain mask.

  • max_alpha (a float) – Maximum alpha channel. (Nipype default value: 0.7)

  • moving (a pathlike object or string representing an existing file) – Input moving.

  • moving_label (a string) – A label name for the reference mosaic. (Nipype default value: Fieldmap (Hz))

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

  • reference_label (a string) – A label name for the reference mosaic. (Nipype default value: Reference)

  • show (1 or 0 or ‘both’) – Where the fieldmap should be shown. (Nipype default value: 1)

Outputs:

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