Warning: This document is for an old version of niworkflows. The main version is master.

niworkflows.viz package

niworkflows.viz.plot_carpet(func, atlaslabels=None, detrend=True, nskip=0, size=(950, 800), subplot=None, title=None, output_file=None, legend=False, tr=None, lut=None)[source]

Plot an image representation of voxel intensities across time also know as the “carpet plot” or “Power plot”. See Jonathan Power Neuroimage 2017 Jul 1; 154:150-158.

Parameters

  • func (string) – Path to NIfTI or CIFTI BOLD image

  • atlaslabels (ndarray, optional) – A 3D array of integer labels from an atlas, resampled into img space. Required if func is a NIfTI image.

  • detrend (boolean, optional) – Detrend and standardize the data prior to plotting.

  • nskip (int, optional) – Number of volumes at the beginning of the scan marked as nonsteady state. Not used.

  • size (tuple, optional) – Size of figure.

  • subplot (matplotlib Subplot, optional) – Subplot to plot figure on.

  • title (string, optional) – The title displayed on the figure.

  • output_file (string, or None, optional) – The name of an image file to export the plot to. Valid extensions are .png, .pdf, .svg. If output_file is not None, the plot is saved to a file, and the display is closed.

  • legend (bool) – Whether to render the average functional series with atlaslabels as overlay.

  • tr (float , optional) – Specify the TR, if specified it uses this value. If left as None, # of frames is plotted instead of time.

  • lut (ndarray, optional) – Look up table for segmentations