Skip to content

BH.oM.LadybugTools.WindroseCommand

Command that, when executed with the LadybugToolsAdapter, generates a windrose from the epw file using the given parameters. Outputs a string file path if the OutputLocation is given, or the base64 string representation of the image if no path is given.

Class structure

Implemented interfaces and base types

The WindroseCommand is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
EPWFile FileSettings The path to an EPW file. -
AnalysisPeriod AnalysisPeriod The analysis period to use for plotting, default to whole non-leap year. -
NumberOfDirectionBins int The number of directional bins to plot on the windrose. -
ColourMap string A Matplotlib colour map. Corresponds to the 'cmap' parameter of plot methods. See https://matplotlib.org/stable/users/explain/colors/colormaps.html for examples of valid keys. Default of 'viridis'. -
OutputLocation string Full file path (with file name) to save the plot to. Leave blank to output a base 64 string representation of the image instead. -

Code and Schema

C# implementation

C#
public class WindroseCommand : BH.oM.LadybugTools.ISimulationCommand, BH.oM.Adapter.IExecuteCommand, BH.oM.Base.IObject

Assembly: LadybugTools_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/LadybugTools_oM/WindroseCommand.json"
}

The JSON Schema is available on github here: