setMask: Set a mask on an object

In gmGeostats: Geostatistics for Compositional Analysis

Set a mask on an object

Description

Set a mask on an object See constructMask() for examples on how to construct masks.

Usage

setMask(x, ...)

## Default S3 method:
setMask(x, mask, coordinates = 1:2, ...)

## S3 method for class 'data.frame'
setMask(x, mask, coordinates = 1:2, ...)

## S3 method for class 'DataFrameStack'
setMask(x, mask, coordinates = attr(x, "coordinates"), ...)

## S3 method for class 'SpatialGrid'
setMask(x, mask, ...)

## S3 method for class 'GridTopology'
setMask(x, mask, ...)

## S3 method for class 'SpatialPoints'
setMask(x, mask, ...)

Arguments

x	an object to mask (for set) or masked (for get)
...	extra arguments for generic compatibility
mask	the mask to impose on x
coordinates	for some of the methods, it is important to specify the names or indices of the columns containing the geographic coordinates (only setMask.data.frame) or else to specify the matrix of spatial coordinates (all setMask methods including it)

Value

The object x appropriately masked (for the setter methods).

Methods (by class)

• default: Set a mask on an object

• data.frame: Set a mask on a data.frame object

• DataFrameStack: Set a mask on a DataFrameStack object

• SpatialGrid: Set a mask on a SpatialGrid object

• GridTopology: Set a mask on a GridTopology object

• SpatialPoints: Set a mask on a SpatialPoints object

See Also

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

gmGeostats documentation built on Aug. 21, 2025, 5:43 p.m.