sensortoolkit.plotting._distribution.ref_distrib
- ref_distrib(ref_df, param=None, averaging_interval='1-hour', font_size=18, write_to_file=True, figure_path=None, filename_suffix='')[source]
Plot the distribution of reference values for the passed parameter.
- Parameters
ref_df (pandas DataFrame) – Dataframe containing reference data for the parameter
'param'
and logged at the specified'averaging_interval'
.param (str, optional) – The name of the parameter for which the distribution plot will show the distribution of reference measurements. Defaults to None.
averaging_interval (str, optional) – The averaging interval for the passed dataframe. Defaults to ‘1-hour’.
font_size (int or float, optional) – The font size for the figure. Defaults to 18.
write_to_file (bool, optional) – If true, the figure will be saved as a png image to the
[project_path]/figures
subdirectory. Defaults to True.figure_path (str) – The full directory path to the folder where figures are saved. This should be located at
[project_path]/figures
.filename_suffix (str, optional) – Optional suffix that can be added to the end of filenames to ensure previously created files with similar naming are not overwritten. Defaults to ‘’.
- Returns
None.