gmGeostats (version 0.10-6)

unmask: Unmask a masked object

Description

Unmask a masked object, i.e. recover the original grid and extend potential data containers associated to it with NAs. See examples in constructMask()

Usage

unmask(x, ...)

# S3 method for data.frame unmask( x, mask = attr(x, "mask"), fullgrid = attr(mask, "fullgrid"), forceCheck = is(fullgrid, "GridTopology"), ... )

# S3 method for DataFrameStack unmask( x, mask = attr(x, "mask"), fullgrid = attr(mask, "fullgrid"), forceCheck = is(fullgrid, "GridTopology"), ... )

# S3 method for SpatialPixels unmask( x, mask = NULL, fullgrid = attr(mask, "fullgrid"), forceCheck = FALSE, ... )

# S3 method for SpatialPoints unmask( x, mask = attr(x@data, "mask"), fullgrid = attr(mask, "fullgrid"), forceCheck = FALSE, ... )

Arguments

x

a masked object

...

arguments for generic functionality

mask

the mask; typically has good defaults

fullgrid

the full grid; typically has good defaults

forceCheck

if fullgrid is provided, should the coordinates provided in x and in fullgrid be cross-checked to ensure that they are given in compatible orders? See sortDataInGrid() and setGridOrder() for controlling the ordering of vectors and grids.

Value

The original grid data and extend potential data containers associated to it with NAs. See examples in constructMask(). The nature of the output depends on the nature of x: a "data.frame" produced a "data.frame"; a "unmask.DataFrameStack" produces a "unmask.DataFrameStack"; a "SpatialPoints" produces a "SpatialPoints"; and finally a "SpatialPixels" produces either a "SpatialPixels" or a "SpatialGrid" (if it is full). Note that only in the case that class(x)=="SpatialPixels" is mask required, for the other methods all arguments have reasonable defaults.

Functions

  • unmask: Unmask a masked object

  • unmask.DataFrameStack: Unmask a masked object

  • unmask.SpatialPixels: Unmask a masked object

  • unmask.SpatialPoints: Unmask a masked object

See Also

Other masking functions: constructMask(), getMask(), print.mask(), setMask()