spatstat.options {spatstat}R Documentation

Internal Options in Spatstat Package

Description

Allows the user to examine and reset the values of global parameters which control actions in the spatstat package.

Usage

  spatstat.options(...)

Arguments

... Either empty, or a succession of parameter names in quotes, or a succession of name=value pairs. See below for the parameter names.

Details

This function is analogous to options and calls the utility function check.options.

If no arguments are given, the current values of all parameters are returned.

If a succession of parameter names is given, the current values of these parameters are returned.

If name=value pairs are given, the named parameters are reset to the given values, and the previous values of these parameters are returned.

The parameters are:

npixel
Controls the number of pixels in the discrete approximation of an irregular window by a binary pixel image as created by as.mask. Either an integer or a pair of integers giving the number of pixels in the x and y directions.
maxedgewt
Edge correction weights will be trimmed so as not to exceed this value. This applies to the weights computed by edge.Trans or edge.Ripley and used in Kest and its relatives.
par.binary
List of arguments to be passed to the function image when displaying a binary image mask (in plot.owin or plot.ppp). Typically used to reset the colours of foreground and background.
par.persp
List of arguments to be passed to the function persp when displaying a real-valued image, such as the fitted surfaces in plot.ppm.

Value

A list of parameters and their values.

Author(s)

Adrian Baddeley adrian@maths.uwa.edu.au http://www.maths.uwa.edu.au/~adrian/ and Rolf Turner rolf@math.unb.ca http://www.math.unb.ca/~rolf

See Also

options

Examples

  spatstat.options(npixel=150)
  spatstat.options(npixel=c(100,200))

  spatstat.options(par.binary=list(col=grey(c(0.5,1))))

  spatstat.options(par.persp=list(theta=-30,phi=40,d=4))
  # see help(persp.default) for other options


[Package spatstat version 1.6-12 Index]