R: Convert Window to Another Unit of Length

rescale.owin {spatstat} | R Documentation

## Convert Window to Another Unit of Length

### Description

Converts a window to another unit of length.

### Usage

      ## S3 method for class 'owin'
    rescale(X, s, unitname)

### Arguments

`X` | Window (object of class `"owin"`).
`s` | Conversion factor: the new units are `s` times the old units.
`unitname` | Optional. New name for the unit of length. See `unitname`.

### Details

This is a method for the generic function `rescale`.

The spatial coordinates in the window `X` (and its window) will be re-expressed in terms of a new unit of length that is `s` times the current unit of length given in `X`. (Thus, the coordinate values are divided by `s`, while the unit value is multiplied by `s`).

The result is a window representing the same region of space, but re-expressed in a different unit.

If `s` is missing, then the coordinates will be re-expressed in ‘native’ units; for example if the current unit is equal to 0.1 metres, then the coordinates will be re-expressed in metres.

### Value

Another window object (of class `"owin"`) representing the same window, but expressed in the new units.

### Note

The result of this operation is equivalent to the original window. If you want to actually change the coordinates by a linear transformation, producing a window that is larger or smaller than the original one, use `affine`.

### Author(s)

Adrian Baddeley Adrian.Baddeley@curtin.edu.au

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

### See Also

`unitname`, `rescale`, `rescale.owin`, `affine`, `rotate`, `shift`

### Examples

      data(swedishpines)
      W <- Window(swedishpines)
      W
    # coordinates are in decimetres (0.1 metre)
    # convert to metres:
      rescale(W, 10)
    # or equivalently
      rescale(W)

[Package spatstat version 1.54-0 Index]