SourceConfig#

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

Bases: Config

Configuration for an lsst.gauss2d.fit Source.

Sources may contain components with distinct centroids that may be linked by a prior (e.g. a galaxy + AGN + star clusters), although such priors are not yet implemented.

Attributes Summary

component_groups

Components in the source (ConfigDict)

Methods Summary

format_label(label, name_group)

get_component_configs()

get_integral_label_default()

has_prefix_group()

make_psf_model(component_group_fluxes[, ...])

Make an lsst.gauss2d.fit.PsfModel from this configuration.

make_source(component_group_fluxes[, ...])

Make an lsst.gauss2d.fit.Source from this configuration.

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

component_groups#

Components in the source (ConfigDict)

Methods Documentation

static format_label(label: str, name_group: str) str#
get_component_configs() dict[str, EllipticalComponentConfig]#
get_integral_label_default() str#
has_prefix_group() bool#
make_psf_model(component_group_fluxes: list[list[dict[Channel, float]]], label_integral: str | None = None) tuple[PsfModel, list[Prior]]#

Make an lsst.gauss2d.fit.PsfModel from this configuration.

This method will validate that the arguments make a valid PSF model, i.e. with a unity total flux, and only one config for the none band.

Parameters#

component_group_fluxes

A list of CentroidFluxes for each of the self.component_groups when calling make_components.

label_integral

A label to apply to integral parameters. Can reference the relevant component mixture name with ${name_group}.

Returns#

psf_model

An appropriate lsst.gauss2d.fit.PsfModel.

priors

A list of priors from all constituent components.

make_source(component_group_fluxes: list[list[dict[Channel, float]]], label_integral: str | None = None) tuple[Source, list[Prior]]#

Make an lsst.gauss2d.fit.Source from this configuration.

Parameters#

component_group_fluxes

A list of Fluxes for each of the self.component_groups to use when calling make_components.

label_integral

A label to apply to integral parameters. Can reference the relevant component mixture name with ${name_group}.

Returns#

source

An appropriate lsst.gauss2d.fit.Source.

priors

A list of priors from all constituent components.

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.