add.hotspot-methods: S4 generic method to add a hotspot to the density grid

Description Usage Arguments Value See Also

Description

Uses a Gaussian decay around a central location to add a hotspot to the density grid.

Usage

1
2
3
4
add.hotspot(object, centre, sigma, amplitude)

## S4 method for signature 'Density'
add.hotspot(object, centre, sigma, amplitude)

Arguments

object

an object of class Density or Simulation

centre

an x,y-coordinate giving the centre of the hotspot

sigma

a value giving the scale parameter for a gaussian decay

amplitude

the height of the hotspot at its centre

Value

the updated Density or Simulation object

See Also

make.density


DSsim documentation built on March 26, 2020, 7:39 p.m.