Scale

class astropy.modeling.functional_models.Scale(factor=1, **kwargs)[source]

Bases: astropy.modeling.Fittable1DModel

Multiply a model by a dimensionless factor.

Parameters
factorfloat

Factor by which to scale a coordinate.

Notes

If factor is a Quantity then the units will be stripped before the scaling operation.

Attributes Summary

factor

fittable

input_units

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).

linear

param_names

Methods Summary

evaluate(x, factor)

One dimensional Scale model function

fit_deriv(x, \*params)

One dimensional Scale model derivative with respect to parameter

Attributes Documentation

factor = Parameter('factor', value=1.0)
fittable = True
input_units

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).

Model sub-classes can also use function annotations in evaluate to indicate valid input units, in which case this property should not be overridden since it will return the input units based on the annotations.

linear = True
param_names = ('factor',)

Methods Documentation

static evaluate(x, factor)[source]

One dimensional Scale model function

static fit_deriv(x, *params)[source]

One dimensional Scale model derivative with respect to parameter