foxes.output.FarmLayoutOutput.get_figure - foxes 1.2.5 documentation

foxes.output.FarmLayoutOutput.get_figure(color_by=None, fontsize=8, figsize=None, annotate=1, title=None, fig=None, ax=None, normalize_D=False, ret_im=False, bargs={}, anno_delx=0, anno_dely=0, **kwargs)[source]

Creates farm layout figure.

Parameters¶

color_by: str, optional: Set scatter color by variable results. Use “mean_REWS”, etc, for means, also min, max, sum. All wrt states
fontsize: int, optional: Size of the turbine numbers
figsize: tuple, optional: The figsize for plt.Figure
annotate: int, optional: Turbine index printing, Choices: 0 = No annotation 1 = Turbine indices 2 = Turbine names
title: str, optional: The plot title, or None for automatic
fig: matplotlib.pyplot.Figure, optional: The figure object to which to add
ax: matplotlib.pyplot.Axis, optional: The axis object, to which to add
normalize_D: bool: Normalize x, y wrt rotor diameter
ret_im: bool: Flag for returned image object
bargs: dict: Arguments for boundary plotting
anno_delx: float: The annotation delta x
anno_dely: float: The annotation delta y
kwargs: dict, optional: Parameters forwarded to matplotlib.pyplot.scatter