edges_analysis.plots.plot_waterfall

edges_analysis.plots.plot_waterfall(data: GSData, load: int = 0, pol: int = 0, which_flags: tuple[str] = None, ignore_flags: tuple[str] = (), ax: Axes | None = None, cbar: bool = True, xlab: bool = True, ylab: bool = True, title: bool | str = True, attribute: str = 'data', **imshow_kwargs)[source]

Plot a waterfall from a GSData object.

Parameters:

  • data – The GSData object to plot.

  • load – The index of the load to plot (only one load is plotted).

  • pol – The polarization to plot (only one polarization is plotted).

  • which_flags – A tuple of flag names to use in order to mask the data. If None, all flags are used. Send an empty tuple to ignore all flags.

  • ignore_flags – A tuple of flag names to ignore.

  • ax – The axis to plot on. If None, a new axis is created.

  • cbar – Whether to plot a colorbar.

  • xlab – Whether to plot an x-axis label.

  • ylab – Whether to plot a y-axis label.

  • title – Whether to plot a title. If True, the title is the year-day representation of the dataset. If a string, use that as the title.

  • attribute – The attribute to actually plot. Can be any attribute of the data object that has the same array shape as the primary data array. This includes “data”, “residuals”, “complete_flags”, “nsamples”.