spatstat (version 1.59-0)

rescale.psp: Convert Line Segment Pattern to Another Unit of Length

Description

Converts a line segment pattern dataset to another unit of length.

Usage

# S3 method for psp
rescale(X, s, unitname)

Arguments

X

Line segment pattern (object of class "psp").

s

Conversion factor: the new units are s times the old units.

unitname

Optional. New name for the unit of length. See unitname.

Value

Another line segment pattern (of class "psp"), representing the same data, but expressed in the new units.

Details

This is a method for the generic function rescale.

The spatial coordinates in the line segment pattern 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 line segment pattern representing the same data but re-expressed in a different unit.

Mark values are unchanged.

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.

See Also

units, affine, rotate, shift

Examples

# NOT RUN {
   data(copper)
   X <- copper$Lines
   X
   # data are in km
   # convert to metres
   rescale(X, 1/1000)

   # convert data and rename unit
   rescale(X, 1/1000, c("metre", "metres"))
# }