read.image: Read Images

In aoles/RBioFormats: R interface to Bio-Formats

Read Images

Description

Read image files using the Bio-Formats library. A list of supported formats can be found on the Bio-Formats website.

Usage

read.image(
  file,
  filter.metadata = FALSE,
  proprietary.metadata = TRUE,
  normalize = TRUE,
  series,
  resolution,
  subset,
  read.metadata = TRUE
)

Arguments

file	character, file name
filter.metadata	logical, specifies whether ugly metadata (entries with unprintable characters, and extremely large entries) should be discarded from the metadata table
proprietary.metadata	logical, should proprietary metadata be populated to OME-XML
normalize	logical, should the original image data be mapped to the [0,1] range
series	integer vector specifying series to read; if missing all series included in the file are read
resolution	integer vector specifying resolution levels to read; if missing all levels read
subset	named list specifing image subsetting
read.metadata	logical, should image metadata be read

Value

An AnnotatedImage object or an AnnotatedImageList object in case of multi-series data.

Author(s)

Andrzej Oleś <[e-mail]>, 2014-2023

See Also

read.metadata for reading image metadata, read.omexml for reading image metadata as OME-XML

Examples

require(EBImage)
f = system.file("images", "sample-color.png", package="EBImage")

img = read.image(f)
img

aoles/RBioFormats documentation built on May 3, 2024, 7:46 a.m.