manualPath: Manually track an animal's movement across a series of still...

View source: R/manualPath.R

manualPathR Documentation

Manually track an animal's movement across a series of still frames

Description

This function is similar to the core trackPath of the pathtrackr package. However, rather than automatically tracking the animal, it requires the user to manual click on the position of the animal in each frame. This function is useful when your video is not appropriate for automatic video tracking, such as very low contrast videos, or videos with a lot of background movement. The same output as trackPath will be produced, i.e. a list containing the xy co-ordinates of the animal in each frame, as well as summary statistics. The returned list can be called for plotting and further functions in the pathtrackr package.

Usage

manualPath(dirpath, xarena, yarena, fps = 30)

Arguments

dirpath

a character string specifying a directory containing only jpeg files extracted from a video

xarena

an integer specifying the arena width in mm; this value is used for distance and velocity calculations, an incorrect value will not cause an error but will result in inaccurate calculations

yarena

an integer specifying the arena height in mm; this value is used for distance and velocity calculations, an incorrect value will not cause an error but will result in inaccurate calculations

fps

an integer specifying the frame rate at which jpegs were extracted from a video; this value is used for distance and velocity calculations, an incorrect value will not cause an error but will result in inaccurate calculations

Details

manualPath tracks an individual animal's movement across a series of still frames by requiring the user to manually click onht eanimal's position in each frame.

Value

A list containing a matrix of xy co-ordinates of the animal in each frame, a matrix of movement data including the distance, velocity and trajectories of movement between frames, and summary statistics.


aharmer/pathtrackr documentation built on June 3, 2023, 1:29 p.m.