R: Methods for Multi-Dimensional Box

methods.boxx {spatstat} | R Documentation

## Methods for Multi-Dimensional Box

### Description

Methods for class `"boxx"`.

### Usage

      ## S3 method for class 'boxx'
    print(x, ...)
      ## S3 method for class 'boxx'
    unitname(x)
      ## S3 replacement method for class 'boxx'
    unitname(x) <- value

### 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`.

### Details

These are methods for the generic functions `print` and `unitname` for the class `"boxx"` of multi-dimensional boxes.

The `print` method prints a description of the box, while the `unitname` method extracts the name of the unit of length in which the box coordinates are expressed.

### Value

For `print.boxx` the value is `NULL`. For `unitname.boxx` an object of class `"units"`.

### Author(s)

Adrian Baddeley Adrian.Baddeley@curtin.edu.au

and Rolf Turner r.turner@auckland.ac.nz

### See Also

`boxx`, `print`, `unitname`

### Examples

       X <- boxx(c(0,10),c(0,10),c(0,5),c(0,1), unitname=c("metre", "metres"))
       X
       unitname(X)
       # Northern European usage
       unitname(X) <- "meter"

[Package spatstat version 1.63-3 Index]