SersicIndexParameterConfig

class lsst.multiprofit.SersicIndexParameterConfig(*args, **kw)

Bases: ParameterConfig

Configuration for an lsst.gauss2d.fit Sersic index parameter.

Attributes Summary

fixed	Whether parameter is fixed or not (free) (bool, default False)
prior_mean	Mean for the prior (untransformed) (float, default 1.0)
prior_stddev	Std.
prior_transformed	Whether the prior should be in transformed values (float, default True)
value_initial	Initial value (float, default 0)

Methods Summary

make_prior(param)	Make a Gaussian prior for a given SersicIndexParameterD.
setDefaults()	Subclass hook for computing defaults.
validate()	Validate the Config, raising an exception if invalid.

Attributes Documentation

fixed

Whether parameter is fixed or not (free) (bool, default False)

prior_mean

Mean for the prior (untransformed) (float, default 1.0)

prior_stddev

Std. dev. for the prior (float, default 0.5)

prior_transformed

Whether the prior should be in transformed values (float, default True)

value_initial

Initial value (float, default 0)

Methods Documentation

make_prior(param: SersicIndexParameterD) → Prior | None

Make a Gaussian prior for a given SersicIndexParameterD.

Parameters

param

The parameter to make a prior for.

Returns

prior

The prior object, set according to the configuration, or none if the required config parameters are None.

setDefaults() → None

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

validate() → None

Validate the Config, raising an exception if invalid.

Raises

lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.