neutronpy.data.Scans.waterfall

Scans.waterfall(x='e', y='detector', label_column='h', offset=5, fmt='b-', legend=False, show_plot=False)

Create a waterfall plot of all the scans in the collection

Parameters:

x : str, optional

Name of one of the columns that is in each scan to plot along the x-axis. Default: ‘e’.

y : str, optional

Name of one of the columns that is in each scan to plot along the y-axis. Default: ‘detector’.

label_column : str, optional

Name of one of the columns that is in each scan to label each separate scan in the plot. Default: ‘h’.

offset : float, optional

Offset in y, of each successive curve from the previous one. Default: 5.

fmt : str, optional

Matplotlib plot format string. Default: ‘b-‘.

legend : bool, optional

Flag to plot a legend, where True plots a legend. Default: False.