EllipticalComponentConfig#

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

Bases: ShapePriorConfig

Configuration for an elliptically-symmetric component.

This class can be initialized but cannot implement make_component.

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'>`)
`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'>`)
`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

`format_label`(label, name_channel)	Format a label for a band-dependent parameter.
`get_integral_label_default`()	Return the default integral label.
`get_size_label`()	Return the label for the component's size parameters.
`get_transform_flux`()
`get_transform_fluxfrac`()
`get_transform_rho`()
`get_transform_size`()
`get_type_name`()	Return a descriptive component name.
`make_component`(centroid, integral_model)	Make a Component reflecting the current configuration.
`make_flux_parameter`(value[, label])	Make a single IntegralParameterD from this object's configuration.
`make_fluxfrac_parameter`(value[, label])
`make_gaussianparametricellipse`()	Make a GaussianParametericEllipse from this object's configuration.
`make_linear_integral_model`(fluxes[, ...])	Make an lsst.gauss2d.fit.LinearIntegralModel for this component.
`set_rho`(component, rho)	Set the rho parameter value for a component.
`set_size_x`(component, size_x)	Set the x-axis size parameter value for a component.
`set_size_y`(component, size_y)	Set the y-axis size parameter value for a component.

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

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

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

format_label(label: str, name_channel: str) → str#

Format a label for a band-dependent parameter.

Parameters#

label: The label to format.
name_channel: The name of the channel to format with.

Returns#

label_formmated: The formatted label.

static get_integral_label_default() → str#: Return the default integral label.

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

get_transform_flux() → TransformD | None#

get_transform_fluxfrac() → TransformD | None#

get_transform_rho() → TransformD | None#

get_transform_size() → TransformD | None#

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

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

make_flux_parameter(value: float | None, label: str | None = None, **kwargs: Any) → IntegralParameterD#

Make a single IntegralParameterD from this object’s configuration.

Parameters#

value

The initial value. Default is self.flux.value_initial.

label

The label for the parameter. Default empty string.

**kwargs

Other keyword arguments to pass to the IntegralParameterD: constructor.

Returns#

param: The constructed IntegralParameterD.

make_fluxfrac_parameter(value: float | None, label: str | None = None, **kwargs: Any) → ProperFractionParameterD#

make_gaussianparametricellipse() → GaussianParametricEllipse#

Make a GaussianParametericEllipse from this object’s configuration.

Returns#

ellipse: The configured ellipse.

make_linear_integral_model(fluxes: dict[Channel, float], label_integral: str | None = None, **kwargs: Any) → IntegralModel#

Make an lsst.gauss2d.fit.LinearIntegralModel for this component.

Parameters#

fluxes: Configurations, including initial values, for the flux parameters by channel.
label_integral: A label to apply to integral parameters. Can reference the relevant channel with e.g. {channel.name}.
**kwargs: Additional keyword arguments to pass to make_flux_parameter. Some parameters cannot be overriden from their configs.

Returns#

integral_model: The requested lsst.gauss2d.fit.IntegralModel.

static set_rho(component: EllipticalComponent, rho: float) → None#

Set the rho parameter value for a component.

Parameters#

component: The component to set the size for.
rho: The value to set.

static set_size_x(component: EllipticalComponent, size_x: float) → None#

Set the x-axis size parameter value for a component.

Parameters#

component: The component to set the size for.
size_x: The value to set.

static set_size_y(component: EllipticalComponent, size_y: float) → None#

Set the y-axis size parameter value for a component.

Parameters#

component: The component to set the size for.
size_y: The value to set.