units

0th

Percentile

Name for Unit of Length

Inspect or change the name of the unit of length in a spatial dataset.

Keywords
manip, spatial
Usage
units(x)
## S3 method for class 'ppp':
units(x)
## S3 method for class 'owin':
units(x)
## S3 method for class 'im':
units(x)
units(x) <- value
## S3 method for class 'ppp':
units(x) <- value
## S3 method for class 'owin':
units(x) <- value
## S3 method for class 'im':
units(x) <- value
Arguments
x
A spatial dataset. Either a point pattern (object of class "ppp"), a window (object of class "owin") or a pixel image (object of class "im").
value
Character string, or vector of two character strings, containing the name of the unit of length.
Details

Spatial datasets in the spatstat package may include the name of the unit of length. This name is used when printing or plotting the dataset, and in some other applications.

units(x) extracts this name as a character string, and units(x) <- value sets the name to value.

A valid name is either a single character string, or a vector of two character strings giving the singular and plural forms.

Value

  • The value of units(x) is a character string containing the name of the unit of length in x.

See Also

owin, ppp

Aliases
  • units
  • units.owin
  • units.ppp
  • units.im
  • units<-
  • units<-.ppp
  • units<-.owin
  • units<-.im
Examples
data(bei)
  units(bei) <- c("metre", "metres")
Documentation reproduced from package spatstat, version 1.10-2, License: GPL version 2 or newer

Community examples

Looks like there are no examples yet.