unmask {gmGeostats} | R Documentation |
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 class 'data.frame'
unmask(
x,
mask = attr(x, "mask"),
fullgrid = attr(mask, "fullgrid"),
forceCheck = is(fullgrid, "GridTopology"),
...
)
## S3 method for class 'DataFrameStack'
unmask(
x,
mask = attr(x, "mask"),
fullgrid = attr(mask, "fullgrid"),
forceCheck = is(fullgrid, "GridTopology"),
...
)
## S3 method for class 'SpatialPixels'
unmask(
x,
mask = NULL,
fullgrid = attr(mask, "fullgrid"),
forceCheck = FALSE,
...
)
## S3 method for class '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 |
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 is(x,"SpatialPixels")=TRUE
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()