[Raster-commits] r124 - pkg/raster/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Tue Jan 13 01:30:25 CET 2009
Author: rhijmans
Date: 2009-01-13 01:30:25 +0100 (Tue, 13 Jan 2009)
New Revision: 124
Modified:
pkg/raster/man/Arith-methods.Rd
pkg/raster/man/bbox.Rd
pkg/raster/man/calc.Rd
pkg/raster/man/generic.read.Rd
pkg/raster/man/map.Rd
pkg/raster/man/misc.Rd
pkg/raster/man/properties.Rd
pkg/raster/man/raster-package.Rd
pkg/raster/man/raster.change.Rd
Log:
Modified: pkg/raster/man/Arith-methods.Rd
===================================================================
--- pkg/raster/man/Arith-methods.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/Arith-methods.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -4,7 +4,7 @@
\alias{Arith,numeric,RasterLayer-method}
\alias{Arith,RasterLayer,numeric-method}
\alias{Arith,RasterLayer,RasterLayer-method}
-\title{ Methods for arithmic function for RasterLayer objects }
+\title{Methods for arithmic function for RasterLayer objects}
\description{
The following standard arithmic functions can be used for computations with RasterLayers objects and numeric values.
\begin{verbatim}
Modified: pkg/raster/man/bbox.Rd
===================================================================
--- pkg/raster/man/bbox.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/bbox.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -11,7 +11,7 @@
\alias{changeBbox}
-\title{ Bounding box functions }
+\title{Bounding box functions}
\description{
getBbox extracts a bounding box from a Raster* or Spatial* object (or from a BoundingBox object). It will also create a BoundingBox object from a matrix (2 x 2) or vector (length=4)
newBbox creates a new bounding box (as in the "Spatial" object from the SP package)
@@ -27,12 +27,12 @@
}
\arguments{
- \item{xmn}{ the minimum x coordinate of the bounding box }
- \item{xmx}{ the maximum x coordinate of the bounding box }
- \item{ymn}{ the minimum y coordinate of the bounding box }
- \item{ymx}{ the maximum y coordinate of the bounding box }
- \item{object}{A Raster* object }
- \item{bndbox}{ An object of class BoundingBox (which you can create with newBbox() ) }
+ \item{xmn}{the minimum x coordinate of the bounding box}
+ \item{xmx}{the maximum x coordinate of the bounding box}
+ \item{ymn}{the minimum y coordinate of the bounding box}
+ \item{ymx}{the maximum y coordinate of the bounding box}
+ \item{object}{A Raster* object}
+ \item{bndbox}{An object of class BoundingBox (which you can create with newBbox() )}
\item{keepres}{logical. If \code{TRUE}, the resolution of the cells will stay the same after adjusting the bounding box (by adjusting the number of rows and columns). if \code{FALSE}, the number of rows and columns will stay the same, and the resolution will be adjusted}
}
@@ -44,4 +44,4 @@
rs <- changeBbox(rs, ymx = 90)
}
-\keyword{ spatial }
+\keyword{spatial}
Modified: pkg/raster/man/calc.Rd
===================================================================
--- pkg/raster/man/calc.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/calc.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -1,4 +1,5 @@
\name{calc}
+
\alias{calc}
\alias{reclass}
\alias{neighborhood}
@@ -6,7 +7,7 @@
\alias{setNA}
\alias{init}
-\title{ RasterLayer calculate }
+\title{RasterLayer calculate}
\description{
Calculate values for a new raster, from scratch or based on a single existing raster
}
@@ -20,16 +21,16 @@
}
\arguments{
- \item{raster}{ a RasterLayer object }
- \item{fun}{ the function to be applied }
- \item{value}{ the (threshold) value to replace with NA or that should be set to NA }
- \item{operator}{ the operator in setNA relative to the \code{value}, to set e.g. all values <= 2 to NA}
- \item{rclmat}{ matrix for reclassifcation. (see below) }
- \item{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{overwrite}{ logical to indicate whether an existing output file should be overwritten }
- \item{ForceIntOutput}{ logical. If \code{TRUE}, output will be integer values }
- \item{ngb}{ neighborhood size in number of cells }
- \item{keepdata}{logical. If \code{TRUE}, NA will be removed for neighborhood computations. The result will only be NA if all cells are NA }
+ \item{raster}{A RasterLayer object}
+ \item{fun}{The function to be applied}
+ \item{value}{The (threshold) value to replace with NA or that should be set to NA}
+ \item{operator}{The operator in setNA relative to the \code{value}, to set e.g. all values <= 2 to NA}
+ \item{rclmat}{Matrix for reclassifcation. (see below)}
+ \item{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{overwrite}{Logical to indicate whether an existing output file should be overwritten}
+ \item{ForceIntOutput}{logical. If \code{TRUE}, output will be integer values}
+ \item{ngb}{Neighborhood size. Expressed in number of cells in a single direction. I.e. 3 refers to 2 cells at each side of the focal cell. Queen's case, 8 cells in total}
+ \item{keepdata}{Logical. If \code{TRUE}, NA will be removed for neighborhood computations. The result will only be NA if all cells are NA}
}
\details{
@@ -46,7 +47,7 @@
\value{
a new raster file (on disk and/or in memory) and associated object (in the R environment)
}
-\author{ Robert J. Hijmans \email{r.hijmans at gmail.com} }
+\author{Robert J. Hijmans \email{r.hijmans at gmail.com}}
\examples{
@@ -82,4 +83,4 @@
#hist(r4)
}
-\keyword{ spatial }
+\keyword{spatial}
Modified: pkg/raster/man/generic.read.Rd
===================================================================
--- pkg/raster/man/generic.read.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/generic.read.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -1,12 +1,4 @@
-\name{Raster read functions}
-\docType{class}
-\alias{readAll}
-\alias{readRow}
-\alias{readRows}
-\alias{readPartOfRow}
-\alias{readBlock}
-\alias{readRandom}
-\alias{readSkip}
+\name{Read Raster* data}
\alias{readAll,RasterLayer-method}
\alias{readAll,RasterStack-method}
@@ -17,8 +9,17 @@
\alias{readBlock,RasterLayer-method}
\alias{readRows,RasterLayer-method}
-\title{Read values from disk }
-\description{ Read values from a raster file associated with a RasterLayer, RasterStack or RasterBrick object into memory.
+\alias{readAll}
+\alias{readRow}
+\alias{readRows}
+\alias{readPartOfRow}
+\alias{readBlock}
+\alias{readRandom}
+\alias{readSkip}
+
+
+\title{Read values from disk}
+\description{Read values from a raster file associated with a RasterLayer, RasterStack or RasterBrick object into memory.
You can either read all the data (memory permitting), or read data by row, part of row, block, by cellnumber, or for (x,y) coordinates. Data can be read from 'native raster' binary files, as well as for other formats that are supported by the rgdal package.
}
@@ -34,33 +35,23 @@
}
\arguments{
- \item{object}{ a Raster* object }
- \item{raster}{ a RasterLayer object }
- \item{rownr}{ the row number of the row to read (between 1 and nrows(raster)) }
- \item{startrow}{ the frist row to read (>= 1 & <= nrows(raster)) }
- \item{nrows}{ the number of the rows to read (>= 1 & <= nrows(raster)) }
- \item{startcol}{ first column of the block ( (>= 1 & <= nrows(raster)) }
- \item{ncolumns}{ number of columns to read on this each row ( (>= 1 & <= ncols(raster) & > firstcol) }
- \item{maxdim}{ sets the density for regular sampling }
- \item{bndbox}{ sets a bouding box within the raster, for regular sampling within that box }
- \item{asRaster}{ Logical. If \code{TRUE}, a rasterLayer is returned, rather then the sampled values}
- \item{n}{ size of random sample }
- \item{na.rm}{Logical. If \code{TRUE} NA values are removed from random sample }
+ \item{object}{a Raster* object}
+ \item{raster}{a RasterLayer object}
+ \item{rownr}{the row number of the row to read (between 1 and nrows(raster))}
+ \item{startrow}{the frist row to read (>= 1 & <= nrows(raster))}
+ \item{nrows}{the number of the rows to read (>= 1 & <= nrows(raster))}
+ \item{startcol}{first column of the block ( (>= 1 & <= nrows(raster))}
+ \item{ncolumns}{number of columns to read on this each row ( (>= 1 & <= ncols(raster) & > firstcol)}
+ \item{maxdim}{sets the density for regular sampling}
+ \item{bndbox}{sets a bouding box within the raster, for regular sampling within that box}
+ \item{asRaster}{Logical. If \code{TRUE}, a rasterLayer is returned, rather then the sampled values}
+ \item{n}{size of random sample}
+ \item{na.rm}{Logical. If \code{TRUE} NA values are removed from random sample}
}
+\note{After read* the values are accessible with the "values(object)" function}
-\section{Methods}{
- \describe{
- \item(readAll) {\code{signature(object = "RasterLayer")}: reads all values of a RasterLayer into memory }
- \item(readAll) {\code{signature(object = "RasterStack")}: reads all values of a RasterStack into memory }
- \item(readRow) {\code{signature(object = "RasterLayer")}: reads values for a single row of a RasterLayer into memory }
- \item(readRow) {\code{signature(object = "RasterStack")}: reads values for a single row if a RasterStack into memory }
- }
-}
-
-\note{ After read* the values are accessible with the "values(object)" function }
-
\author{Robert J. Hijmans \email{r.hijmans at gmail.com}}
\examples{
Modified: pkg/raster/man/map.Rd
===================================================================
--- pkg/raster/man/map.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/map.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -21,9 +21,9 @@
\item{subsample}{Logical. If \code{TRUE}, the image is resampled using maxdim}
\item{maxdim}{Maximum requested number of pixels in the map display (either vertical or horizontal) }
\item{addbox}{Logical. If \code{TRUE} a box is drawn around the map }
- \item{axes}{see ?image}
- \item{xlab}{see ?image}
- \item{ylab}{see ?image}
+ \item{axes}{see "?image"}
+ \item{xlab}{see "?image"}
+ \item{ylab}{see "?image"}
\item{...}{Any argument that can be passed to image.plot(fields) and to image(graphics)}
}
\details{
Modified: pkg/raster/man/misc.Rd
===================================================================
--- pkg/raster/man/misc.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/misc.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -8,7 +8,7 @@
\alias{CV}
\alias{readIniFile}
-\title{ Miscellaneous functions }
+\title{Miscellaneous functions}
\description{
Low level functions for file and string handling. Get or change file extension or extract the filename or path from a full name (path + filename). Trim a string of characters (remove the whitespace before or after the string).
And two miscellanous statistical functions (mode and coefficient of variation)
@@ -24,13 +24,13 @@
readIniFile(filename)
}
\arguments{
- \item{filename}{ a filename with or without the path }
- \item{newextension}{ a file extension, e.g., ".txt" }
- \item{astring}{ a string that needs to be trimmed }
- \item{x}{a vector of numbers (typically integers for mode) }
+ \item{filename}{A filename with or without the path}
+ \item{newextension}{A file extension, e.g., ".txt" }
+ \item{astring}{A string that needs to be trimmed}
+ \item{x}{A vector of numbers (typically integers for mode)}
\item{ties}{character. Indicates how to treat ties. Either 'random', 'lowest', 'highest', or 'NA'}
- \item{na.rm}{ remove (ignore) NA values }
- \item{singlevalueaszero}{ if TRUE a zero is returned (rather than an NA) if the mode of single value is computed }
+ \item{na.rm}{Remove (ignore) NA values}
+ \item{singlevalueaszero}{If \code{TRUE} a zero is returned (rather than an NA) if the mode of single value is computed}
}
\value{
@@ -53,5 +53,4 @@
Mode(data)
CV(data)
}
-\keyword{ spatial }
-
+\keyword{spatial}
Modified: pkg/raster/man/properties.Rd
===================================================================
--- pkg/raster/man/properties.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/properties.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -20,7 +20,7 @@
\alias{nbands}
-\title{ RasterLayer properties }
+\title{RasterLayer properties}
\description{
get the column, row, or cell number of a Raster (or RasterStack) for a x and/or y coordinate or get the coordinates of the center of a raster-cell from a column, or cell number(s)
@@ -47,9 +47,9 @@
}
\arguments{
- \item{object}{ Raster* object }
- \item{x}{ Raster* object }
- \item{asText}{logical. If \code{TRUE}, the projection is returned as text. Otherwise a CRS object is returned }
+ \item{object}{Raster* object}
+ \item{x}{Raster* object}
+ \item{asText}{logical. If \code{TRUE}, the projection is returned as text. Otherwise a CRS object is returned}
}
@@ -83,4 +83,4 @@
nbands(rs)
band(rs)
}
-\keyword{ spatial }
+\keyword{spatial}
Modified: pkg/raster/man/raster-package.Rd
===================================================================
--- pkg/raster/man/raster-package.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/raster-package.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -24,8 +24,7 @@
}
\author{
Robert J. Hijmans and Jacob van Etten
-
Maintainer: Robert J. Hijmans \email{r.hijmans at gmail.com}
}
-\keyword{ package }
-\keyword{ spatial }
+\keyword{package}
+\keyword{spatial}
Modified: pkg/raster/man/raster.change.Rd
===================================================================
--- pkg/raster/man/raster.change.Rd 2009-01-12 14:51:25 UTC (rev 123)
+++ pkg/raster/man/raster.change.Rd 2009-01-13 00:30:25 UTC (rev 124)
@@ -5,7 +5,7 @@
\alias{Merge}
\alias{expand}
-\title{ Change raster database }
+\title{Change raster database}
\description{
Use existing raster(s) to create a new raster with different spatial extent or resolution
}
@@ -18,17 +18,17 @@
}
\arguments{
- \item{raster}{ a RasterLayer object }
- \item{rasters}{ a list of RasterLayer objects }
- \item{bndbox}{bounding box used to crop a raster. Any object that is or has a bounding box (see below) }
- \item{filename}{ output filename for a new raster }
- \item{fun}{ function used to Aggregate values. It should return one number. E.g. mean or max }
- \item{fact}{ degree of aggregation or disaggregation expressed as number of cells (horizontally and vertically). See details }
- \item{expand}{ if \code{expand == TRUE} grids will get larger if \code{factor} if the number of the division of the columns or rows with factor does not return an integer }
- \item{rm.NA}{ if \code{rm.NA == TRUE}, remove NA cells from calculations }
- \item{ForceIntOutput}{ logical. If \code{TRUE} the values will be rounded and stored as integer }
- \item{overwrite}{ if TRUE, "filename" will be overwritten if it exists }
- \item{tolerance}{ difference permissable (relative to the cell resolution) for objects to be 'equal'. See ?all.equal }
+ \item{raster}{a RasterLayer object}
+ \item{rasters}{a list of RasterLayer objects}
+ \item{bndbox}{bounding box used to crop a raster. Any object that is or has a bounding box (see below)}
+ \item{filename}{output filename for a new raster}
+ \item{fun}{function used to Aggregate values. It should return one number. E.g. mean or max}
+ \item{fact}{degree of aggregation or disaggregation expressed as number of cells (horizontally and vertically). See details}
+ \item{expand}{if \code{expand == TRUE} grids will get larger if \code{factor} if the number of the division of the columns or rows with factor does not return an integer}
+ \item{rm.NA}{if \code{rm.NA == TRUE}, remove NA cells from calculations}
+ \item{ForceIntOutput}{logical. If \code{TRUE} the values will be rounded and stored as integer}
+ \item{overwrite}{if TRUE, "filename" will be overwritten if it exists}
+ \item{tolerance}{difference permissable (relative to the cell resolution) for objects to be 'equal'. See ?all.equal}
}
\details{
@@ -44,7 +44,7 @@
\value{
a new RasterLayer object (in the R environment) which is in some cases written to disk
}
-\author{ Robert J. Hijmans \email{r.hijmans at gmail.com} }
+\author{Robert J. Hijmans \email{r.hijmans at gmail.com}}
\examples{
rs <- newRaster()
@@ -63,5 +63,5 @@
rsd <- disaggregate(rse, 3)
}
-\keyword{ spatial }
+\keyword{spatial}
More information about the Raster-commits
mailing list