plot_figure_for_fit

forest.benchmarking.analysis.plot_figure_for_fit(fit_result: lmfit.model.ModelResult, xlabel: str = 'x', ylabel: str = 'y', xscale: float = 1.0, yscale: float = 1.0, title: str = '', figsize=(7, 10), axis_fontsize: tuple = 14, report_fontsize: float = 11) → matplotlib.pyplot.figure

Plots fit and residuals from lmfit with residuals below fit. Also shows fit result text below.

Parameters:
  • fit_result – lmfit fit result object
  • xlabel – label for the shared x axis
  • ylabel – ylabel for fit plot
  • xscale – xaxis will be divided by xscale
  • yscale – yaxis will be divided by yscale
  • title – title of the plot
  • figsize – size of the plot
  • axis_fontsize – size of the font
  • report_fontsize – size of font for the stats report
Returns:

matplotlib figure