Const1D

class astropy.modeling.functional_models.Const1D(amplitude=1, **kwargs)[source] [edit on github]

Bases: astropy.modeling.Fittable1DModel

One dimensional Constant model.

Parameters:

amplitude : float

Value of the constant function

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 the fixed 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 the tied property of a parameter may be used.

bounds : dict

A dictionary {parameter_name: boolean} of lower and upper bounds of parameters. Keys are parameter names. Values are a list of length 2 giving the desired range for the parameter. Alternatively the min and max properties of a parameter may be used.

eqcons : list

A list of functions of length n such that eqcons[j](x0,*args) == 0.0 in a successfully optimized problem.

ineqcons : list

A list of functions of length n such that ieqcons[j](x0,*args) >= 0.0 is a successfully optimized problem.

See also

Const2D

Notes

Model formula:

\[f(x) = A\]

Examples

import numpy as np
import matplotlib.pyplot as plt

from astropy.modeling.models import Const1D

plt.figure()
s1 = Const1D()
r = np.arange(-5, 5, .01)

for factor in range(1, 4):
    s1.amplitude = factor
    plt.plot(r, s1(r), color=str(0.25 * factor), lw=2)

plt.axis([-5, 5, -1, 4])
plt.show()

(png, svg, pdf)

../_images/astropy-modeling-functional_models-Const1D-1.png

Attributes Summary

amplitude
input_units
linear
param_names

Methods Summary

evaluate(x, amplitude) One dimensional Constant model function
fit_deriv(x, amplitude) One dimensional Constant model derivative with respect to parameters

Attributes Documentation

amplitude
input_units
linear = True
param_names = ('amplitude',)

Methods Documentation

static evaluate(x, amplitude)[source] [edit on github]

One dimensional Constant model function

static fit_deriv(x, amplitude)[source] [edit on github]

One dimensional Constant model derivative with respect to parameters