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

add.hotspotR Documentation

S4 generic method to add a hotspot to the density grid

Description

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

Usage

add.hotspot(object, centre, sigma, amplitude)

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

Arguments

object

a Density-class object

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-class object

See Also

make.density


dsims documentation built on April 4, 2025, 3:33 a.m.