detrended_img {detrendr}

Detrended image class.

Description

A detrended_img is a 4-dimensional array of positive integers in the style of an ijtiff_img (indexed by img[y, x, channel, frame]) which is the result of a detrending routine. It has 4 attributes:

method

The detrending method used. This must be one of "boxcar", "exponential" or "polynomial".

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.

purpose

Either "FCS" or "FFS" to denote whether the detrending was done for the purpose of fluorescence correlation spectroscopy or fluorescence fluctuation spectroscopy calculations respectively. purpose is not required for Robin Hood detrending.

Usage

detrended_img(img, method, parameter, auto, purpose = NULL)

Arguments

img

The detrended image series. A 4-dimensional array of non-negative integers in the style of an ijtiff_img, or a 3-dimensional array of non-negative integers which represents a single channel of an ijtiff_img-style array (indexed by img[y, x, frame]).

method

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

parameter

A number. The detrend parameter used. One per channel.

auto

Logical. Was automatic detrending used? One per channel.

purpose

Either "FCS" or "FFS". Was the image detrended for the purpose of doing FCS or FFS calculations? See detrending. purpose is not required for Robin Hood detrending.

Details

Sometimes when detrending, you can get slight negative values in the detrended image. These values should really just be zero, so this constructor function sets negative values of img to zero.

Value

An object of class detrended_img.