RickerWavelet2D¶
-
class
astropy.modeling.functional_models.
RickerWavelet2D
(amplitude=1, x_0=0, y_0=0, sigma=1, **kwargs)[source]¶ Bases:
astropy.modeling.Fittable2DModel
Two dimensional Ricker Wavelet model (sometimes known as a “Mexican Hat” model).
Note
See https://github.com/astropy/astropy/pull/9445 for discussions related to renaming of this model.
- Parameters
- amplitude
python:float
Amplitude
- x_0
python:float
x position of the peak
- y_0
python:float
y position of the peak
- sigma
python:float
Width of the Ricker wavelet
- amplitude
- Other Parameters
- fixed
a
python:dict
, optional A dictionary
{parameter_name: boolean}
of parameters to not be varied during fitting. True means the parameter is held fixed. Alternatively thefixed
property of a parameter may be used.- tied
python:dict
, optional A dictionary
{parameter_name: callable}
of parameters which are linked to some other parameter. The dictionary values are callables providing the linking relationship. Alternatively thetied
property of a parameter may be used.- bounds
python:dict
, optional A dictionary
{parameter_name: value}
of lower and upper bounds of parameters. Keys are parameter names. Values are a list or a tuple of length 2 giving the desired range for the parameter. Alternatively, themin
andmax
properties of a parameter may be used.- eqcons
python:list
, optional A list of functions of length
n
such thateqcons[j](x0,*args) == 0.0
in a successfully optimized problem.- ineqcons
python:list
, optional A list of functions of length
n
such thatieqcons[j](x0,*args) >= 0.0
is a successfully optimized problem.
- fixed
See also
Notes
Model formula:
\[f(x, y) = A \left(1 - \frac{\left(x - x_{0}\right)^{2} + \left(y - y_{0}\right)^{2}}{\sigma^{2}}\right) e^{\frac{- \left(x - x_{0}\right)^{2} - \left(y - y_{0}\right)^{2}}{2 \sigma^{2}}}\]Attributes Summary
This property is used to indicate what units or sets of units the evaluate method expects, and returns a dictionary mapping inputs to units (or
None
if any units are accepted).Methods Summary
evaluate
(x, y, amplitude, x_0, y_0, sigma)Two dimensional Ricker Wavelet model function
Attributes Documentation
-
amplitude
= Parameter('amplitude', value=1.0)¶
-
input_units
¶
-
param_names
= ('amplitude', 'x_0', 'y_0', 'sigma')¶
-
sigma
= Parameter('sigma', value=1.0)¶
-
x_0
= Parameter('x_0', value=0.0)¶
-
y_0
= Parameter('y_0', value=0.0)¶
Methods Documentation