MtreeRing (version 1.1)

imgInput: Read and plot a tree-ring image file

Description

This function can read an image file from the hard disk and plot it in a newly-opened graphical device.

Usage

imgInput(img, dpi = NULL, rotate = 0, 
    RGB = c(0.299, 0.587, 0.114), magick = TRUE)

Arguments

img

A character string indicating the path of the image file. Supported formats include png, tiff, jpg and bmp.

dpi

An integer specifying the dpi of the image file. A minimum of 300 dpi is required when running automatic detection.

rotate

An integer specifying how many degrees to rotate (clockwise). It requires one of the following values: 0, 90, 180 or 270.

RGB

A numeric vector of length 3 giving the weight of RGB color channels.

magick

A logical value. If TRUE, the package magick is used to read images whose file sizes are over 10MB.

Value

A magick image object containing the image data.

Details

Proper image preparation has a great influence on the measurement of ring widths. A tree-ring image should not contain irrelevant or redundant features such as wooden mounts where cores are glued. The larger the file size of an image, the slower the image processing operation will be.

Pith side of a tree-ring sample should be placed on the right side of the graphical window. Use the argument rotate to change its position.

It is highly recommended to use the default value magick = TRUE, because the package magick can significantly reduce the memory usage.

Examples

# NOT RUN {
## Find the image file name in package MtreeRing:
img.name <- system.file("001.png", package = "MtreeRing")

## Read and plot the image:
t1 <- imgInput(img = img.name, dpi = 1200)
# }