read_ybr_tiff: Read in one of Yoshi's behaviour TIFF summary files

Description Usage Arguments Value See Also

View source: R/yoshi_behav_functions.R

Description

Low level function to read in raw data from a Yoshi behaviour summary TIFF file. You can use this to customise how the TIFF file is read in or if you want to extract multiple kinds of information from the same TIFF file using different functions.

Usage

1
read_ybr_tiff(f, all = TRUE, as.is = FALSE, ...)

Arguments

f

Path to a TIFF file on disk or the data from a TIFF that has previously been read into R.

all

logical scalar or integer vector. TIFF files can contain more than one image. If all=TRUE then all images are returned in a list of images. If all is a vector, it gives the (1-based) indices of images to return. Otherwise only the first image is returned.

as.is

logical, if TRUE an attempt will be made to return the original integer values without re-scaling where possible

...

Additional arguments passed to readTIFF

Value

list of TIFF slices with extra class ybr_raw

See Also

readTIFF

Other read_ybr: find_ybr_tiffs(), read_ybr_summary(), read_ybr_xy()


jefferislab/flywatch documentation built on Aug. 6, 2021, 12:14 p.m.