getWindEstimates {moveWindSpeed}

Generate wind estimates for a trajectories or data frame with wind speeds

Description

Generate wind estimates for a trajectories or data frame with wind speeds

Usage

getWindEstimates(data, timestamps, ...)

## S4 method for signature 'MoveStack,missing'
getWindEstimates(data, timestamps, ...)

## S4 method for signature 'Move,missing'
getWindEstimates(data, timestamps, groundSpeedXY = NULL, ...)

## S4 method for signature 'data.frame,POSIXct'
getWindEstimates(
  data,
  timestamps,
  windowSize = 29,
  isFocalPoint = function(i, ts) {
     TRUE
 },
  isSamplingRegular = 1,
  focalSampleBefore = 0,
  returnSegmentList = F,
  referenceGroundSpeed = NULL,
  ...
)

## S4 method for signature 'list,ANY'
getWindEstimates(
  data,
  timestamps,
  phi = 0,
  isThermallingFunction = getDefaultIsThermallingFunction(360, 4),
  columnNamesWind = c("estimationSuccessful", "residualVarAirspeed", "windX", "windY",
    "windVarX", "windVarY", "windCovarXY", "windVarMax", "airX", "airY"),
  referenceGroundSpeed = NULL,
  ...
)

Arguments

data

Move object, MoveStack or data.frame containing wind speeds

timestamps

timestamps of the speed observations

...

other possible arguments currently nothing else is implemented

groundSpeedXY

an character of length 2 containing column names from the move object that need to be used as the x and y component of the ground speed vector

windowSize

a numeric vector of length 1 or 2, if length 1 it is the size of the focal window data will be assigned to the central location. If length 2 the window size is sum(windowSize)+1) and the first element is the number of location before the focal locations, the second is the number of locations after the focal location.

isFocalPoint

an function that based on location number and timestamps returns a logical vector if location should be included. Or a numeric/logical vector indicating the location numbers.

isSamplingRegular

either a function that determines based on a vector of timestamps if the sampling interval is regular or a numeric value that corresponds to the time interval between observations in the dataset that is regular

focalSampleBefore

The number of locations that occurred before the move object fed in the getWindEstimates function, used in case stacks are provided for example. This is most cases not useful for users.

returnSegmentList

a logical value indicating if the list of segments to estimate wind over should be returned instead of the estimates

referenceGroundSpeed

a number indicating which of the grounds speed vectors to take as a reference for air speed, by default the 0th/middle location of the window if that is specified by one number.

phi

the auto correlation of air speed.

isThermallingFunction

An function that based on a series of headings and speeds (wind corrected) decides if an segment should be considered thermalling.

columnNamesWind

The column names used for storing the data in the returned objected after it has been calculated.

Value

a Move object, dataframe or a MoveStack depending on input

Examples

data("storks")
# run example for reduced dataset
windEst<-getWindEstimates(storks[format(timestamps(storks),"%H")=="12",][[2:3]])
# Use evolution status 2 to avoid using rgdal (set using sp)
set_evolution_status(2L)
windEst<-spTransform(windEst, center=TRUE)
plot(windEst)
# only plot few arrows of estimates
s<-windEst$estimationSuccessful & format(timestamps(windEst), "%S")=='00'
# enlarge arrows 30 times
arrows(coordinates(windEst)[s,1],coordinates(windEst)[s,2],
   coordinates(windEst)[s,1]+ windEst$windX[s]*30,
   coordinates(windEst)[s,2]+windEst$windY[s]*30)