% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ImageArray.R
\name{createImageArray}
\alias{createImageArray}
\title{createImageArray}
\usage{
createImageArray(
  image,
  n.levels = NULL,
  series = NULL,
  resolution = NULL,
  max.pixel.threshold = 700,
  engine = "EBImage",
  verbose = FALSE
)
}
\arguments{
\item{image}{the image}

\item{n.levels}{the number of levels of the pyramidal image,
typical an integer starting from 1}

\item{series}{the series IDs of the pyramidal image,
typical an integer starting from 1.}

\item{resolution}{the resolution IDs of the pyramidal image,
typical an integer starting from 1.}

\item{max.pixel.threshold}{the maximum width
and height pixel dimension that the lowest level of the image pyramid
should have, thus the image will be downscaled two folds until both width
and height is below the threshold. Default is 700 pixels.
If \code{n.levels} is provided, this parameter will be ignored.}

\item{engine}{the package to use for each image layer: either
\code{EBImage} or \code{magick-image}}

\item{verbose}{verbose}
}
\value{
An ImageArray object
}
\description{
creates an object of ImageArray class
}
\examples{
# get image
library(EBImage)
img.file <- system.file("images", "sample.png", package="EBImage")

# create ImageArray
imgarray <- createImageArray(img.file, n.levels = 3)
imgarray_raster <- as.raster(imgarray, max.pixel.size = 300)
plot(imgarray_raster)

}
