SersicComponentConfig#

class lsst.multiprofit.SersicComponentConfig(*args, **kw)#

Bases: EllipticalComponentConfig

Configuration for an lsst.gauss2d.fit Sersic component.

Notes#

make_component will return a ComponentData with an lsst.gauss2d.fit.GaussianComponent if the Sersic index is fixed at 0.5, or an lsst.gauss2d.fit.SersicMixComponent otherwise.

Attributes Summary

`flux`	Flux parameter(s) config (`FluxParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.FluxParameterConfig'>`)
`fluxfrac`	Fractional flux parameter(s) config (`FluxFractionParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.FluxFractionParameterConfig'>`)
`order`	Sersic mix order (`int`, default `4`)
`prior_axrat_mean`	Prior mean for axis ratio (prior ignored if not >0) (`float`, default `0.7`)
`prior_axrat_stddev`	Prior std.
`prior_size_mean`	Prior mean for size_major (`float`, default `1`)
`prior_size_stddev`	Prior std.
`rho`	Rho parameter config (`ParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.ParameterConfig'>`)
`sersic_index`	Sersic index config (`SersicIndexParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.SersicIndexParameterConfig'>`)
`size_x`	x-axis size parameter config (`ParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.ParameterConfig'>`)
`size_y`	y-axis size parameter config (`ParameterConfig`, default `<class 'lsst.multiprofit.componentconfig.ParameterConfig'>`)
`transform_flux_name`	The name of the reference transform for flux parameters (`str`, default `'log10'`)
`transform_fluxfrac_name`	The name of the reference transform for flux fraction parameters (`str`, default `'logit_fluxfrac'`)
`transform_rho_name`	The name of the reference transform for rho parameters (`str`, default `'logit_rho'`)
`transform_size_name`	The name of the reference transform for size parameters (`str`, default `'log10'`)

Methods Summary

`get_interpolator`(order)	Get the best available interpolator for a given order.
`get_size_label`()	Return the label for the component's size parameters.
`get_type_name`()	Return a descriptive component name.
`is_gaussian_fixed`()	Return True if the Sersic index is fixed at 0.5.
`make_component`(centroid, integral_model)	Make a Component reflecting the current configuration.
`validate`()	Validate the Config, raising an exception if invalid.

Attributes Documentation

flux#: Flux parameter(s) config (FluxParameterConfig, default <class 'lsst.multiprofit.componentconfig.FluxParameterConfig'>)

fluxfrac#: Fractional flux parameter(s) config (FluxFractionParameterConfig, default <class 'lsst.multiprofit.componentconfig.FluxFractionParameterConfig'>)

order#

Sersic mix order (int, default 4)

Allowed values:

'4': Four
'8': Eight
'None': Field is optional

prior_axrat_mean#: Prior mean for axis ratio (prior ignored if not >0) (float, default 0.7)

prior_axrat_stddev#: Prior std. dev. on axis ratio (float, default 0)

prior_size_mean#: Prior mean for size_major (float, default 1)

prior_size_stddev#: Prior std. dev. on size_major (prior ignored if not >0) (float, default 0)

rho#: Rho parameter config (ParameterConfig, default <class 'lsst.multiprofit.componentconfig.ParameterConfig'>)

sersic_index#: Sersic index config (SersicIndexParameterConfig, default <class 'lsst.multiprofit.componentconfig.SersicIndexParameterConfig'>)

size_x#: x-axis size parameter config (ParameterConfig, default <class 'lsst.multiprofit.componentconfig.ParameterConfig'>)

size_y#: y-axis size parameter config (ParameterConfig, default <class 'lsst.multiprofit.componentconfig.ParameterConfig'>)

transform_flux_name#: The name of the reference transform for flux parameters (str, default 'log10')

transform_fluxfrac_name#: The name of the reference transform for flux fraction parameters (str, default 'logit_fluxfrac')

transform_rho_name#: The name of the reference transform for rho parameters (str, default 'logit_rho')

transform_size_name#: The name of the reference transform for size parameters (str, default 'log10')

Methods Documentation

get_interpolator(order: int) → SersicMixInterpolator#

Get the best available interpolator for a given order.

Parameters#

order: The order of the desired interpolator.

Returns#

interpolator: An interpolator of the requested order.

get_size_label() → str#: Return the label for the component’s size parameters.

get_type_name() → str#: Return a descriptive component name.

is_gaussian_fixed() → bool#: Return True if the Sersic index is fixed at 0.5.

make_component(centroid: CentroidParameters, integral_model: IntegralModel) → ComponentData#

Make a Component reflecting the current configuration.

Parameters#

centroid: Centroid parameters for the component.
integral_model: The integral_model for this component.

Returns#

component_data: An appropriate ComponentData including the initialized component.

Notes#

The default gauss2d.fit.LinearIntegralModel can be populated with unit fluxes (gauss2d.fit.IntegralParameterD instances) to prepare for linear least squares fitting.

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.