tedana.reporting.static_figures.carpet_plot

carpet_plot(optcom_ts, denoised_ts, hikts, lowkts, mask, io_generator, gscontrol=None)[source]

Generate a set of carpet plots for the combined and denoised data.

Parameters:

  • optcom_ts, denoised_ts, hikts, lowkts ((Mb x T) array_like) – Different types of data to plot, where Mb is samples in base mask, and T is time.

  • mask (img-like) – Binary mask image used to mask the data.

  • io_generator (tedana.io.OutputGenerator) – The output generator for this workflow

  • gscontrol ({None, ‘mir’, ‘gsr’} or list, optional) – Additional denoising steps applied in the workflow. If any gscontrol methods were applied, then additional carpet plots will be generated for pertinent outputs from those steps. Default is None.