[Raster-commits] r318 - pkg/raster/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Mar 6 13:19:50 CET 2009
Author: rhijmans
Date: 2009-03-06 13:19:50 +0100 (Fri, 06 Mar 2009)
New Revision: 318
Added:
pkg/raster/man/dataContent.Rd
pkg/raster/man/getRowColCell.Rd
Removed:
pkg/raster/man/data.Rd
pkg/raster/man/get.Rd
Log:
Deleted: pkg/raster/man/data.Rd
===================================================================
--- pkg/raster/man/data.Rd 2009-03-06 11:48:07 UTC (rev 317)
+++ pkg/raster/man/data.Rd 2009-03-06 12:19:50 UTC (rev 318)
@@ -1,48 +0,0 @@
-\name{properties}
-\alias{dataIndices}
-\alias{dataContent}
-\alias{dataSource}
-
-\title{ Get data properties }
-\description{ Information about the data values associated with the object
-}
-
-\usage{
-dataContent(object)
-dataIndices(object)
-dataSource(object)
-}
-
-\arguments{
- \item{object}{ Raster* object }
- }
-
-
-\value{
- dataContent returns one of the following: nodata, all, row, block, sparse
- dataIndices returns the first and last cell number of the data in memory. Or all cell numbers for a sparse RasterLayer
- dataSource returns one of the following: ram, disk
-}
-
-\author{Robert J. Hijmans}
-
-\examples{
-#using a new default raster (1 degree global)
-rs <- raster()
-dataContent(rs)
-dataIndices(rs)
-rs <- setValues(rs, 1:ncell(rs))
-cellValues(rs, c(1, 10, 100))
-dataSource(rs)
-dataContent(rs)
-dataIndices(rs)
-
-rs <- rasterFromFile(system.file("external/test.ag", package="sp"))
-rs <- readAll(rs)
-rs
-dataSource(rs)
-dataContent(rs)
-dataIndices(rs)
-
-}
-\keyword{ spatial }
Added: pkg/raster/man/dataContent.Rd
===================================================================
--- pkg/raster/man/dataContent.Rd (rev 0)
+++ pkg/raster/man/dataContent.Rd 2009-03-06 12:19:50 UTC (rev 318)
@@ -0,0 +1,54 @@
+\name{dataProperties}
+
+\alias{dataIndices}
+\alias{dataContent}
+\alias{dataSource}
+
+\title{Data properties}
+
+\description{
+These are helper functons for programmers and for debugging that provide information about the data values that are associated with the object.
+
+dataContent provides information regrading the values currently in memory (RAM). Possible values are: nodata, all, row, block, sparse
+dataIndices returns the first and last cell number of the data in memory. Or all cell numbers for a sparse RasterLayer
+dataSource returns a value indicating whether the data source is a file on disk or whether it only exists in memory. Possible values are: ram, disk
+}
+
+\usage{
+dataContent(object)
+dataIndices(object)
+dataSource(object)
+}
+
+\arguments{
+ \item{object}{ Raster* object }
+}
+
+\value{
+dataContent: 'nodata', 'all', 'row', 'block', or 'sparse'
+dataIndices: vector
+dataSource: 'disk' or 'ram'
+}
+
+\author{Robert J. Hijmans}
+
+\examples{
+#using a new default raster (1 degree global)
+rs <- raster()
+dataContent(rs)
+dataIndices(rs)
+rs <- setValues(rs, 1:ncell(rs))
+cellValues(rs, c(1, 10, 100))
+dataSource(rs)
+dataContent(rs)
+dataIndices(rs)
+
+rs <- rasterFromFile(system.file("external/test.ag", package="sp"))
+rs <- readAll(rs)
+rs
+dataSource(rs)
+dataContent(rs)
+dataIndices(rs)
+
+}
+\keyword{ spatial }
Deleted: pkg/raster/man/get.Rd
===================================================================
--- pkg/raster/man/get.Rd 2009-03-06 11:48:07 UTC (rev 317)
+++ pkg/raster/man/get.Rd 2009-03-06 12:19:50 UTC (rev 318)
@@ -1,61 +0,0 @@
-\name{getRowColCell}
-
-\alias{colFromCell}
-\alias{rowFromCell}
-\alias{cellFromRowCol}
-\alias{cellFromRowColCombine}
-\alias{cellFromRow}
-\alias{cellFromCol}
-
-
-\title{Get row, column, or cell number}
-
-\description{
-These functions get the row or column number from a cell number of a Raster* object, or vice versa)
-}
-
-\usage{
-colFromCell(object, cell)
-rowFromCell(object, cell)
-cellFromRowCol(object, rownr, colnr)
-cellFromRowColCombine(object, rownr, colnr)
-cellFromRow(object, rownr)
-cellFromCol(object, colnr)
-}
-
-\arguments{
- \item{object}{Raster* object (or a SpatialPixels* or SpatialGrid* object)}
- \item{cell}{cell number(s)}
- \item{colnr}{column number; or vector of column numbers}
- \item{rownr}{row number; or vector of row numbers}
-}
-
-\details{
- The colFromCell and similar functions accept a single value (or x, y pair), or a vector or list of these values,
- Cell numbers start at 1 in the upper left corner, and increase from left to right, and then from top to bottom
- The last cell number equals the number of cells of the Raster* object.
-
- In \code{cellFromRowCol}, \code{rownr} and \code{colnr} should have the same length.
- This is not the case for \code{cellFromRowColCombine}. This function returns the cell numbers obtained by the combination of row and column numbers.
-
-}
-
-\value{
- row, col or cell number(s)
-}
-\author{Robert J. Hijmans }
-
-\examples{
-#using a new default raster (1 degree global)
-r <- raster()
-colFromCell(r, 10000)
-rowFromCell(r, 10000)
-cellFromRowCol(r, 5, 5)
-cellFromRowCol(r, 4:5, 4:5)
-cellFromRowColCombine(r, 4:5, 4:5)
-cellFromCol(r, 1)
-cellFromRow(r, 1)
-
-}
-
-\keyword{spatial}
Added: pkg/raster/man/getRowColCell.Rd
===================================================================
--- pkg/raster/man/getRowColCell.Rd (rev 0)
+++ pkg/raster/man/getRowColCell.Rd 2009-03-06 12:19:50 UTC (rev 318)
@@ -0,0 +1,61 @@
+\name{getRowColCell}
+
+\alias{colFromCell}
+\alias{rowFromCell}
+\alias{cellFromRowCol}
+\alias{cellFromRowColCombine}
+\alias{cellFromRow}
+\alias{cellFromCol}
+
+
+\title{Get row, column, or cell number}
+
+\description{
+These functions get the row or column number from a cell number of a Raster* object, or vice versa)
+}
+
+\usage{
+colFromCell(object, cell)
+rowFromCell(object, cell)
+cellFromRowCol(object, rownr, colnr)
+cellFromRowColCombine(object, rownr, colnr)
+cellFromRow(object, rownr)
+cellFromCol(object, colnr)
+}
+
+\arguments{
+ \item{object}{Raster* object (or a SpatialPixels* or SpatialGrid* object)}
+ \item{cell}{cell number(s)}
+ \item{colnr}{column number; or vector of column numbers}
+ \item{rownr}{row number; or vector of row numbers}
+}
+
+\details{
+ The colFromCell and similar functions accept a single value (or x, y pair), or a vector or list of these values,
+ Cell numbers start at 1 in the upper left corner, and increase from left to right, and then from top to bottom
+ The last cell number equals the number of cells of the Raster* object.
+
+ In \code{cellFromRowCol}, \code{rownr} and \code{colnr} should have the same length.
+ This is not the case for \code{cellFromRowColCombine}. This function returns the cell numbers obtained by the combination of row and column numbers.
+
+}
+
+\value{
+ row, col or cell number(s)
+}
+\author{Robert J. Hijmans }
+
+\examples{
+#using a new default raster (1 degree global)
+r <- raster()
+colFromCell(r, 10000)
+rowFromCell(r, 10000)
+cellFromRowCol(r, 5, 5)
+cellFromRowCol(r, 4:5, 4:5)
+cellFromRowColCombine(r, 4:5, 4:5)
+cellFromCol(r, 1)
+cellFromRow(r, 1)
+
+}
+
+\keyword{spatial}
More information about the Raster-commits
mailing list