ImposeVectorField: Simple helper function for `PlotResult`.

Description

Draws a set of arrows over an existing plot. Will be used internally by PlotResult to visualize the vector field of wind directions over a plot of the wind farm.

Usage

ImposeVectorField(xNum = 5, yNum = 5, ColMain = "black",
  ColBand = "white", Frac = 25, DoSDs = TRUE)

Arguments

xNum

must be a single value containing the desired number of arrows horizontally.

yNum

must be a single value containing the desired number of arrows vertically.

ColMain

must be a single value containing the desired color for the main wind direction arrow.

ColBand

must be a single value containing the desired color for the secondary arrows representing the standard deviation arrows. Only used if DoSDs = TRUE.

Frac

must be a single value containing the desired length information for the arrows. Will be passed to GetArrow internally.

DoSDs

must be TRUE or FALSE. If TRUE, will not only draw one arrow for the main wind direction per point, but also two additional arrows (using color ColBand) representing the main wind direction plus/minus half the standard deviation.

Value

ImposeVectorField returns nothing.

Details

This function will be used internally by PlotResult. ImposeVectorField requires FarmData to be present and an existing plot to impose the vector field over.

Examples

Run this code

# NOT RUN {
plot(c(0, 1), c(0, 1))
ImposeVectorField(ColBand = "red")
# }