R: Name for Unit of Length

unitname {spatstat} | R Documentation

## Name for Unit of Length

### Description

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

### Usage

    unitname(x)
    ## S3 method for class 'dppm'
    unitname(x)
    ## S3 method for class 'im'
    unitname(x)
    ## S3 method for class 'kppm'
    unitname(x)
    ## S3 method for class 'minconfit'
    unitname(x)
    ## S3 method for class 'owin'
    unitname(x)
    ## S3 method for class 'ppm'
    unitname(x)
    ## S3 method for class 'ppp'
    unitname(x)
    ## S3 method for class 'psp'
    unitname(x)
    ## S3 method for class 'quad'
    unitname(x)
    ## S3 method for class 'slrm'
    unitname(x)
    ## S3 method for class 'tess'
    unitname(x)
    unitname(x) <- value
    ## S3 replacement method for class 'dppm'
    unitname(x) <- value
    ## S3 replacement method for class 'im'
    unitname(x) <- value
    ## S3 replacement method for class 'kppm'
    unitname(x) <- value
    ## S3 replacement method for class 'minconfit'
    unitname(x) <- value
    ## S3 replacement method for class 'owin'
    unitname(x) <- value
    ## S3 replacement method for class 'ppm'
    unitname(x) <- value
    ## S3 replacement method for class 'ppp'
    unitname(x) <- value
    ## S3 replacement method for class 'psp'
    unitname(x) <- value
    ## S3 replacement method for class 'quad'
    unitname(x) <- value
    ## S3 replacement method for class 'slrm'
    unitname(x) <- value
    ## S3 replacement method for class 'tess'
    unitname(x) <- value

### Arguments

`x` | A spatial dataset. Either a point pattern (object of class `"ppp"`), a line segment pattern (object of class `"psp"`), a window (object of class `"owin"`), a pixel image (object of class `"im"`), a tessellation (object of class `"tess"`), a quadrature scheme (object of class `"quad"`), or a fitted point process model (object of class `"ppm"` or `"kppm"` or `"slrm"` or `"dppm"` or `"minconfit"`).
`value` | Name of the unit of length. See Details.

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

`unitname(x)` extracts this name, and `unitname(x) <- value` sets the name to `value`.

A valid name is either

- a single character string

- a vector of two character strings giving the singular and plural forms of the unit name

- a list of length 3, containing two character strings giving the singular and plural forms of the basic unit, and a number specifying the multiple of this unit.

Note that re-setting the name of the unit of length does not affect the numerical values in `x`. It changes only the string containing the name of the unit of length. To rescale the numerical values, use `rescale`.

### Value

The return value of `unitname` is an object of class `"unitname"` containing the name of the unit of length in `x`. There are methods for `print`, `summary`, `as.character`, `rescale` and `compatible`.

### Author(s)

Adrian Baddeley Adrian.Baddeley@curtin.edu.au, Rolf Turner r.turner@auckland.ac.nz and Ege Rubak rubak@math.aau.dk.

### See Also

`rescale`, `owin`, `ppp`

### Examples

      X <- runifpoint(20)

      # if the unit of length is 1 metre:
      unitname(X) <- c("metre", "metres")

      # if the unit of length is 6 inches:
      unitname(X) <- list("inch", "inches", 6)

[Package spatstat version 1.54-0 Index]