out3Plot.statsPlots.resultHistPlot

resultHistPlot(cfg, dataDF, xName='', scenario='', stat='count', parametersDict='')[source]

create a histogram of values and optional colorcode using scenario name and option to filter simulations using parametersDict

Parameters
  • cfg (configparser object) – configuration info here used outDir

  • dataDF (dataFrame) – dataFrame with info on simulation results and configuration one line per simulation (e.g. aimec resAnalysisDF)

  • xName (str) – column name for x axis

  • scenario (str) – column name used to colorcode values

  • stat (str) – statistical measure to show (percent, probability, density, count, frequency), default count

  • parametersDict (dict) – optional - dictionary filter criteria, parameter name and list of values

Returns

plotPath – path to figure

Return type

pathlib path