R/spplot.R

In flahn/scidbst: Spatio Temporal Extension for SciDB (scidbst)

#' @include scidbst-class.R
NULL

.spplot.brick.coerce = function(obj, ...) {
  if (obj@isSpatial) {
    if (obj@isTemporal) {
      if (tmin(obj) == tmax(obj)) {
        obj = slice(obj,tdim(obj),as.character(tmin(obj)))
      } else {
        stop("Cannot plot image with more than two dimensions, please use the 'slice' method to reduce the array to a 2-dimensional array")
      }
    }
  } else {
    stop("No spatial reference to use spplot with.")
  }
  brick = as(obj,"RasterBrick")
  spplot(brick, ...)
}


#' spplot for scidbst objects
#'
#' Like the raster version for spplot, this function plots a spatially referenced scidb array. To make this work on a
#' multidimensional array, the number of dimensions must be reduced to two spatial dimensions. This can
#' be done by using the 'slice' operation of scidb. To plot the array, the data is first downloaded to your machine and then
#' transformed to a RasterBrick object to be plotted.
#'
#' @details
#' The spplot will first assume that the array is spatially referenced and will use the North-South and West-East dimensions to
#' match the rows and columns for the raster brick. If the array is not spatially referenced, but temporal the spplot will
#' result a 1 row x t columns (t = number of time intervals) image.
#'
#' @name spplot,scidbst
#' @param obj scidbst object
#' @param ... Any argument that can be passed to spplot and levelplot
#' @param maxpixels Integer. Number of pixels to sample from each layer of large Raster objects
#'
#' @seealso \code{\link[raster]{spplot}}
#' @export
setMethod("spplot", signature(obj="scidbst"),.spplot.brick.coerce)