spatstat.geom (version 2.1-0)

methods.boxx: Methods for Multi-Dimensional Box

Description

Methods for class "boxx".

Usage

# S3 method for boxx
is(x)
  # S3 method for boxx
print(x, ...)
  # S3 method for boxx
unitname(x)
  # S3 method for boxx
unitname(x) <- value
  # S3 method for boxx
scale(x, center=TRUE, scale=TRUE)

Arguments

x

Object of class "boxx" representing a multi-dimensional box.

…

Other arguments passed to print.default.

value

Name of the unit of length. See unitname.

center,scale

Arguments passed to scale.default to determine the rescaling.

Value

For is.boxx the value is a logical. For print.boxx the value is NULL. For unitname.boxx an object of class "units". For unitname<-.boxx and scale.boxx the result is the updated "boxx" object x.

Details

These are methods for the generic functions is, print, unitname, unitname<- and scale for the class "boxx" of multi-dimensional boxes.

The is method checks that the object is of class "boxx", the print method prints a description of the box, the unitname method extracts the name of the unit of length in which the box coordinates are expressed, while the assignment method for unitname assigns this unit name.

The scale method rescales each spatial coordinate of x.

See Also

boxx, is, print, unitname, scale

Examples

# NOT RUN {
   X <- boxx(c(0,10),c(0,10),c(0,5),c(0,1), unitname=c("metre", "metres"))
   X
   is.boxx(X)
   unitname(X)
   # Northern European usage
   unitname(X) <- "meter"
   scale(X)
# }