calcFPS: Calculates the framerate of a time series, in frames per...

In JoGall/rubitrail: rubitrail, a package to analyse the output of UbiTrail, an open-source video tracking program for analysis of animal locomotion.

Description

Calculates the modal number of frames per second from a matrix, dataframe or list of time series.

Usage

calcFPS(dat)

Arguments

dat	a matrix or dataframe, or list of matrices or dataframes, that contain a variable called 'time'. Data should not not yet be resampled, e.g. by rubitLinearInterpolate

Value

a numeric: the calculated framerate, in frames per second. For a single time series, the median framerate is returned; for a list of time series, the mode of individual framerates is returned.

Note

This function is intended for outputs from the 'rubitrail' package.

See Also

rubitBasic and rubitMetrics for information on re-encoding a new framerate into tracking data.

Examples

data(weevils_raw)

### Framerate of area '08'
calcFPS(weevils_raw[['08']])

### Framerate of each individual area
sapply(weevils_raw, calcFPS)

### Modal framerate of all areas combined
calcFPS(weevils_raw)

JoGall/rubitrail documentation built on May 7, 2019, 10:53 a.m.