act.plotting.TimeSeriesDisplay.qc_flag_block_plot

TimeSeriesDisplay.qc_flag_block_plot(data_field=None, dsname=None, subplot_index=(0,), time_rng=None, assessment_color=None, edgecolor='face', set_shading='auto', **kwargs)[source]

Create a time series plot of embedded quality control values using broken barh plotting.

Parameters:
  • data_field (str) – Name of data field in the object to plot corresponding quality control.

  • dsname (None or str) – If there is more than one datastream in the display object the name of the datastream needs to be specified. If set to None and there is only one datastream ACT will use the sole datastream in the object.

  • subplot_index (1 or 2D tuple, list, or array) – The index of the subplot to set the x range of.

  • time_rng (tuple or list) – List or tuple with (min, max) values to set the x-axis range limits.

  • assessment_color (dict) – Dictionary lookup to override default assessment to color. Make sure assessment work is correctly set with case syntax.

  • edgecolor (str or list) – Color name, list of color names or ‘face’ as defined in matplotlib.axes.Axes.broken_barh

  • set_shading (string) – Option to to set the matplotlib.pcolormesh shading parameter. Default to ‘auto’

  • **kwargs (keyword arguments) – The keyword arguments for plt.broken_barh().