# rescale

##### Convert dataset to another unit of length

Converts between different units of length in a spatial dataset, such as a point pattern or a window.

##### Usage

`rescale(X, s, unitname)`

##### Arguments

- X
- Any suitable dataset representing a two-dimensional
object, such as a point pattern (object of class
`"ppp"`

), or a 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 generic. Methods are provided for many spatial objects.

The spatial coordinates in the dataset `X`

will be re-expressed
in terms of a new unit of length that is `s`

times the current
unit of length given in `X`

.

If `unitname`

is given, it will be taken as the new name of the unit
of length. It should be a valid name for the
unit of length, as described in the help for `unitname`

.

For example if `X`

is a dataset giving coordinates in metres,
then `rescale(X,1000)`

will divide the coordinate values by 1000 to obtain coordinates in
kilometres, and the unit name will be changed from `"metres"`

to `"1000 metres"`

.
Similarly `rescale(X, 1000, "km")`

will divide the coordinate
values by 1000 to obtain coordinates in
kilometres, and the unit name will be changed to `"km"`

.

##### Value

- Another object of the same type, representing the same data, but expressed in the new units.

##### Note

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

.

##### See Also

Available methods:
`rescale.im`

,
`rescale.layered`

,
`rescale.linnet`

,
`rescale.lpp`

,
`rescale.owin`

,
`rescale.ppp`

,
`rescale.psp`

and `rescale.units`

.

*Documentation reproduced from package spatstat, version 1.37-0, License: GPL (>= 2)*