mirageInclusionZoneGrid-class: Class '"mirageInclusionZoneGrid"'

In sampSurf: Sampling Surface Simulation for Areal Sampling Methods

Description

This class is a subclass of "InclusionZoneGrid" that is specifically for use in developing sampling surfaces where the mirage method is to be implemented on a "mirageTract". It has a separate constructor method, which should be used to construct the object.

Objects from the Class

Objects can be created by calls of the form new("mirageInclusionZoneGrid", ...). However, this is not recommended because the objects are quite complex. Instead, please use the object constructor izGridMirage to create new objects. More details are found in the vignettes listed below.

Slots

As noted, this class is a subclass of "InclusionZoneGrid"; it adds several slots to the class, all other slots not defined below are as described in the superclass...

slopOver:

Object of class "logical": A vector of of length four which flags where there was any boundary overlap in the cardinal ('north','south','east','west') directions: TRUE if so, FALSE otherwise. Note that one can easily check this vector to determine whether the associated *.polygon and *.grid slots are non-NULL.

north.polygon:

Object of class "SPNULL": If slopover['north'], then this slot holds the external portion of the inclusion zone polygon due to boundary slopover on the north side. Otherwise, it is NULL.

north.grid:

Object of class "RLNULL": If slopover['north'], then this slot holds the external portion of the extended grid on the north side. Otherwise, it is NULL.

south.polygon:

Object of class "SPNULL": If slopover['south'], then this slot holds the external portion of the inclusion zone polygon due to boundary slopover on the south side. Otherwise, it is NULL.

south.grid:

Object of class "RLNULL": If slopover['south'], then this slot holds the external portion of the extended grid on the south side. Otherwise, it is NULL.

east.polygon:

Object of class "SPNULL": If slopover['east'], then this slot holds the external portion of the inclusion zone polygon due to boundary slopover on the east side. Otherwise, it is NULL.

east.grid:

Object of class "RLNULL": If slopover['east'], then this slot holds the external portion of the extended grid on the east side. Otherwise, it is NULL.

west.polygon:

Object of class "SPNULL": If slopover['west'], then this slot holds the external portion of the inclusion zone polygon due to boundary slopover on the west side. Otherwise, it is NULL.

west.grid:

Object of class "RLNULL": If slopover['west'], then this slot holds the external portion of the extended grid on the west side. Otherwise, it is NULL.

izGrid.extended:

Object of class "izgNULL": This is the object showing the extended grid that encompases any slopover regions external to the boundary, where applicable. Otherwise, it is NULL if there is no slopover on any side.

Extends

Class "InclusionZoneGrid", directly.
Class "izgNULL", by class "InclusionZoneGrid", distance 2.

Methods

plot

signature(x = "mirageInclusionZoneGrid", y = "missing"): This will plot the object.

Author(s)

Jeffrey H. Gove

References

See the “Mirage Method” and “InclusionZoneGrid” vignettes for more explanation.

See Also

izGridMirage, InclusionZoneGrid, sampSurf

Examples

showClass("mirageInclusionZoneGrid")

sampSurf documentation built on March 5, 2021, 3:01 p.m.