Class S2.image — S2.image-class • adegraphics

A class for the creation of a bi-dimensional plot with a third value represented as a continuous colored surface.

Objects from the Class

S2.image objects can be created by calls of the form new("S2.image", ...).

The regular usage in this package is to use the s.image function.

Slots

data

a list containing data or data's name.

dfxy: the displayed values in the form of a data frame, a name or a matching call.
z: a vector (or a matrix) of values on the dfxy rows.
xax: an integer or a vector indicating the columns of dfxy kept for the x-axes.
yax: an integer or a vector indicating the columns of dfxy kept for the y-axes.
frame: a positive or null integer. It is the number of the frame containing the data (used with sys.frame(..., env = data$frame)). Only if the data are not stored (i.e. data$storeData = FALSE).
storeData: a logical indicating if the data should be stored in the returned object. If FALSE, only the names of the data arguments are stored.

trellis.par

a list of parameters for lattice call. It will be passed directly to par.settings arguments of the lattice function.

adeg.par

a list of graphical parameters, corresponding to the ones given by adegpar() function.

lattice.call

a list to create the trellis object.

g.args

a list containing some method parameters linked with the created object of ADEg.S2 class. The specific slots for S2.image objects are:

gridsize: a 1 or 2-length vector indicating the cell numbers (horizontally and vertically) of the grid for the colored surface.
outsideLimits: specific limits for the surface as a set of polygons. It must be an SpatialPolygons object. Hole are authorized.
span: a value to control the degree of smoothing.
contour: a logical to draw contour lines.
region: a logical to fill inter-contour regions.
col: a NULL value, a color or a colors vector used for the colored cells.

stats

a list of internal preliminary calculations. The specific slot for S2.image objects is:

value: a prediction value yielded by a local polynomial regression fitting.

s.misc

a list of some others internal parameters:

newgrid: the grid expansion calculated within the prepare method.

Call

an object of class call

Extends

Class ADEg.S2, directly.
Class ADEg, by class ADEg.S2, distance 2.
Class ADEgORtrellis, by class ADEg.S2, distance 3.
Class ADEgORADEgSORtrellis, by class ADEg.S2, distance 3.

Methods

The methods of the father classes "ADEg.S2" and "ADEg" can be used by inheritance. The specific methods for S2.image are:

prepare: signature(object = "S2.image"): calls the parent method (prepare for ADEg.S2), modifies some graphical parameters used by default and calculates grid expansion and limits.
panel: signature(object = "S2.image"): draws raster image.

Author

Alice Julien-Laferriere, Aurelie Siberchicot aurelie.siberchicot@univ-lyon1.fr and Stephane Dray

Examples

showClass("S2.image")
#> Class "S2.image" [package "adegraphics"]
#> 
#> Slots:
#>                                                                        
#> Name:          data  trellis.par     adeg.par lattice.call       g.args
#> Class:         list         list         list         list         list
#>                                              
#> Name:         stats       s.misc         Call
#> Class:         list         list         call
#> 
#> Extends: 
#> Class "ADEg.S2", directly
#> Class "ADEg", by class "ADEg.S2", distance 2
#> Class "ADEgORtrellis", by class "ADEg.S2", distance 3
#> Class "ADEgORADEgSORtrellis", by class "ADEg.S2", distance 3

Class `S2.image`