act.plotting.WindRoseDisplay.plot¶
- WindRoseDisplay.plot(dir_field, spd_field, dsname=None, subplot_index=(0,), cmap=None, set_title=None, num_dirs=20, spd_bins=None, tick_interval=3, legend_loc=0, legend_bbox=None, legend_title=None, calm_threshold=1.0, **kwargs)[source]¶
Makes the wind rose plot from the given dataset.
- Parameters:
dir_field (str) – The name of the field representing the wind direction (in degrees).
spd_field (str) – The name of the field representing the wind speed.
dsname (str) – The name of the datastream to plot from. Set to None to let ACT automatically try to determine this.
subplot_index (2-tuple) – The index of the subplot to place the plot on.
cmap (str or matplotlib colormap) – The name of the matplotlib colormap to use.
set_title (str) – The title of the plot.
num_dirs (int) – The number of directions to split the wind rose into.
spd_bins (1D array-like) – The bin boundaries to sort the wind speeds into.
tick_interval (int) – The interval (in %) for the ticks on the radial axis.
legend_loc (int) – Legend location using matplotlib legend code
legend_bbox (tuple) – Legend bounding box coordinates
legend_title (string) – Legend title
calm_threshold (float) – Winds below this threshold are considered to be calm.
**kwargs (keyword arguments) – Additional keyword arguments will be passed into :func:plt.bar
- Returns:
ax (matplotlib axis handle) – The matplotlib axis handle corresponding to the plot.