Sine1D¶
-
class
astropy.modeling.functional_models.
Sine1D
[source] [edit on github]¶ Bases:
astropy.modeling.Fittable1DModel
One dimensional Sine model.
Parameters: amplitude : float
Oscillation amplitude
frequency : float
Oscillation frequency
Other Parameters: fixed : a dict
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 : dict
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 : dict
eqcons : list
A list of functions of length
n
such thateqcons[j](x0,*args) == 0.0
in a successfully optimized problem.ineqcons : list
A list of functions of length
n
such thatieqcons[j](x0,*args) >= 0.0
is a successfully optimized problem.Notes
Model formula:
f(x) = A \sin(2 \pi f x)
Attributes Summary
param_names
Methods Summary
evaluate
(x, amplitude, frequency)One dimensional Sine model function fit_deriv
(x, amplitude, frequency)One dimensional Sine model derivative Attributes Documentation
-
amplitude
¶
-
frequency
¶
-
param_names
= ('amplitude', 'frequency')¶
Methods Documentation
-
static
evaluate
(x, amplitude, frequency)[source] [edit on github]¶ One dimensional Sine model function
-
static
fit_deriv
(x, amplitude, frequency)[source] [edit on github]¶ One dimensional Sine model derivative
-