nireports.reportlets.surface module

Plotting surface-supported data.

nireports.reportlets.surface.cifti_surfaces_plot(in_cifti, density='32k', surface_type='inflated', clip_range=(0, None), output_file=None, **kwargs)[source]

Plots a CIFTI-2 dense timeseries onto left/right mesh surfaces.

Parameters

  • in_cifti (str) – CIFTI-2 dense timeseries (.dtseries.nii)

  • density (str) – Surface density

  • surface_type (str) – Inflation level of mesh surfaces. Supported: midthickness, inflated, veryinflated

  • clip_range (tuple or None) – Range to clip in_cifti data prior to plotting. If not None, two values must be provided as lower and upper bounds. If values are None, no clipping is performed for that bound.

  • output_file (str or None) – Path where the output figure should be saved. If this is not defined, then the figure will be returned.

  • kwargs (dict) – Keyword arguments for nilearn.plotting.plot_surf

Outputs

  • figure (matplotlib.pyplot.figure) – Surface plot figure. Returned only if output_file is None.

  • output_file (str) – The file where the figure is saved.