[Raster-commits] r324 - pkg/raster/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sat Mar 7 16:19:36 CET 2009
Author: rhijmans
Date: 2009-03-07 16:19:36 +0100 (Sat, 07 Mar 2009)
New Revision: 324
Added:
pkg/raster/man/calc.Rd
Removed:
pkg/raster/man/calc-methods.Rd
Modified:
pkg/raster/man/Arith-methods.Rd
pkg/raster/man/Logic-methods.Rd
pkg/raster/man/Math-methods.Rd
Log:
Modified: pkg/raster/man/Arith-methods.Rd
===================================================================
--- pkg/raster/man/Arith-methods.Rd 2009-03-07 15:11:55 UTC (rev 323)
+++ pkg/raster/man/Arith-methods.Rd 2009-03-07 15:19:36 UTC (rev 324)
@@ -17,10 +17,11 @@
\section{Note}{
If the values of the output RasterLayer cannot be held in memory, they will be saved to a temporary file.
- If you want to set the filename (and perhaps filetype and datatype), use \code{\link[raster]{overlay-methods}} or \code{\link[raster]{calc-methods}} instead of the Arith-methods.
+ If you want to set the filename (and perhaps filetype and datatype), use \code{\link[raster]{overlay}}
+ or \code{\link[raster]{calc}} instead of the Arith-methods.
}
-\seealso{ \code{\link[raster]{Math-methods}}, \code{\link[raster]{overlay-methods}}, \code{\link[raster]{calc-methods}} }
+\seealso{ \code{\link[raster]{Math-methods}}, \code{\link[raster]{overlay}}, \code{\link[raster]{calc}} }
\author{Robert J. Hijmans}
Modified: pkg/raster/man/Logic-methods.Rd
===================================================================
--- pkg/raster/man/Logic-methods.Rd 2009-03-07 15:11:55 UTC (rev 323)
+++ pkg/raster/man/Logic-methods.Rd 2009-03-07 15:19:36 UTC (rev 324)
@@ -25,7 +25,7 @@
If you want to set the filename (and perhaps filetype and datatype), use \code{\link[raster]{calc-methods}} instead.
}
-\seealso{ \code{\link[raster]{Math-methods}}, \code{\link[raster]{overlay-methods}}, \code{\link[raster]{calc-methods}} }
+\seealso{ \code{\link[raster]{Math-methods}}, \code{\link[raster]{overlay}}, \code{\link[raster]{calc}} }
\author{Robert J. Hijmans}
Modified: pkg/raster/man/Math-methods.Rd
===================================================================
--- pkg/raster/man/Math-methods.Rd 2009-03-07 15:11:55 UTC (rev 323)
+++ pkg/raster/man/Math-methods.Rd 2009-03-07 15:19:36 UTC (rev 324)
@@ -10,10 +10,10 @@
}
\section{Note}{
If the values of the output RasterLayer cannot be held in memory, they will be saved to a temporary file.
- If you want to set the filename (and perhaps filetype and datatype), use \code{\link[raster]{calc-methods}} instead of the Math-methods.
+ If you want to set the filename (and perhaps filetype and datatype), use \code{\link[raster]{calc}} instead of the Math-methods.
}
-\seealso{ \code{\link[raster]{Arith-methods}}, \code{\link[raster]{overlay-methods}}, \code{\link[raster]{calc-methods}} }
+\seealso{ \code{\link[raster]{Arith-methods}}, \code{\link[raster]{overlay}}, \code{\link[raster]{calc}} }
\author{Robert J. Hijmans}
Deleted: pkg/raster/man/calc-methods.Rd
===================================================================
--- pkg/raster/man/calc-methods.Rd 2009-03-07 15:11:55 UTC (rev 323)
+++ pkg/raster/man/calc-methods.Rd 2009-03-07 15:19:36 UTC (rev 324)
@@ -1,77 +0,0 @@
-\name{calc-methods}
-\docType{methods}
-\alias{calc}
-\alias{calc,RasterLayer,function-method}
-\alias{calc,RasterStack,function-method}
-\alias{calc,RasterStack,list-method}
-
-\title{ Calculate }
-
-\description{
- Calculate values for a new RasterLayer, from a single RasterLayer or RasterStack
-}
-
-
-\section{Methods}{
-\describe{
-\item{x = "RasterLayer", fun = "function"}{
- \code{calc(x, fun, filename='', overwrite=FALSE, filetype='raster', datatype='FLT4S')}
- \item{\code{x}}{A RasterLayer object}
- \item{\code{fun}}{The function to be applied}
- \item{\code{filename}}{Output filename for a new raster; if NA the result is not written to a file but returned with the RasterLayer object, in the data slot}
- \item{\code{overwrite}}{Logical to indicate whether an existing output file should be overwritten}
- \item{\code{filetype}}{output file type. Either 'raster', 'ascii' or a supported GDAL 'driver' name see \code{\link[raster]{writeRaster}}}
- \item{\code{datatype}}{output data type; see \code{\link[raster]{setDatatype}}}
- \item{\code{track}}{vector of row numbers for which the function will report that they have been processed}
-}
-
-
-\item{x = "RasterStack", fun = "function"}{
- as above
-}
-
-
-\item{x = "RasterStack", fun = "list"}{
- coming soon...
-}
-
-}}
-
-\details{
-if \code{x = "RasterLayer"}, \code{fun} should be a function that takes a single value as input, and returns a single value.
-if \code{x = "RasterStack"}, \code{fun} should be a function that takes a one dimensional vector of value as input, and returns a single value.
-}
-
-
-\value{
- a new RasterLayer
-}
-
-
-\seealso{ \code{\link[raster]{Math-methods}} }
-
-
-\author{ Robert J. Hijmans}
-
-\examples{
-r <- raster(ncols=36, nrows=18)
-r[] <- 1:ncell(r)
-
-# multiply values with 10
-fun <- function(x) { x * 10 }
-rc <- calc(r, fun)
-
-# set values below 100 to NA.
-fun <- function(x) { x[x<100] <- NA; return(x) }
-rc <- calc(r, fun)
-
-# set NA values to -9999
-fun <- function(x) { x[is.na(x)] <- -9999; return(x)}
-rc <- calc(rc, fun)
-}
-
-\keyword{methods}
-\keyword{spatial}
-
-
-
Added: pkg/raster/man/calc.Rd
===================================================================
--- pkg/raster/man/calc.Rd (rev 0)
+++ pkg/raster/man/calc.Rd 2009-03-07 15:19:36 UTC (rev 324)
@@ -0,0 +1,77 @@
+\name{calc-methods}
+\docType{methods}
+\alias{calc}
+\alias{calc,RasterLayer,function-method}
+\alias{calc,RasterStack,function-method}
+\alias{calc,RasterStack,list-method}
+
+\title{ Calculate }
+
+\description{
+ Calculate values for a new RasterLayer, from a single RasterLayer or RasterStack
+}
+
+
+\section{Methods}{
+\describe{
+\item{x = "RasterLayer", fun = "function"}{
+ \code{calc(x, fun, filename='', overwrite=FALSE, filetype='raster', datatype='FLT4S')}
+ \item{\code{x}}{A RasterLayer object}
+ \item{\code{fun}}{The function to be applied}
+ \item{\code{filename}}{Output filename for a new raster; if NA the result is not written to a file but returned with the RasterLayer object, in the data slot}
+ \item{\code{overwrite}}{Logical to indicate whether an existing output file should be overwritten}
+ \item{\code{filetype}}{output file type. Either 'raster', 'ascii' or a supported GDAL 'driver' name see \code{\link[raster]{writeRaster}}}
+ \item{\code{datatype}}{output data type; see \code{\link[raster]{setDatatype}}}
+ \item{\code{track}}{vector of row numbers for which the function will report that they have been processed}
+}
+
+
+\item{x = "RasterStack", fun = "function"}{
+ as above
+}
+
+
+\item{x = "RasterStack", fun = "list"}{
+ coming soon...
+}
+
+}}
+
+\details{
+if \code{x = "RasterLayer"}, \code{fun} should be a function that takes a single value as input, and returns a single value.
+if \code{x = "RasterStack"}, \code{fun} should be a function that takes a one dimensional vector of value as input, and returns a single value.
+}
+
+
+\value{
+ a new RasterLayer
+}
+
+
+\seealso{ \code{\link[raster]{Math-methods}} }
+
+
+\author{ Robert J. Hijmans}
+
+\examples{
+r <- raster(ncols=36, nrows=18)
+r[] <- 1:ncell(r)
+
+# multiply values with 10
+fun <- function(x) { x * 10 }
+rc <- calc(r, fun)
+
+# set values below 100 to NA.
+fun <- function(x) { x[x<100] <- NA; return(x) }
+rc <- calc(r, fun)
+
+# set NA values to -9999
+fun <- function(x) { x[is.na(x)] <- -9999; return(x)}
+rc <- calc(rc, fun)
+}
+
+\keyword{methods}
+\keyword{spatial}
+
+
+
More information about the Raster-commits
mailing list