Learn R Programming

detrendr (version 0.1.0)

detrended_img: Detrended image class.

Description

A detrended_img is a 3-dimensional array of integers which is the result of a detrending routine. It has 3 attributes:

parameter

The value of the parameter used. This will be the l, tau or degree parameter for the respective methods.

auto

A boolean that is TRUE if the parameter was found automatically or FALSE if it was manually selected.

Usage

detrended_img(img, method, parameter, auto)

Arguments

img

The detrended image series. A 3-dimensional array of non-negative integers.

method

The method used. One of "boxcar", "exponential" or "polynomial".

parameter

A number. The detrend parameter used.

auto

Logical. Was automatic detrending used? This is NA if the detrending parameter is NA.

Value

An object of class detrended_img.