Sedterm#

class lsst.fgcmcal.Sedterm(*args, **kw)#

Bases: Config

SED term for a single band.

The SED slope (in flux units) in the middle of a band is computed either as an “interpolated” or “extrapolated” computation. See Burke et al. 2018 Appendix A (https://ui.adsabs.harvard.edu/abs/2018AJ….155…41B).

For interpolation, with a secondary term:

F'_nu ~ constant * (primaryTerm + secondaryTerm) / 2.0

For interpolation, without a secondary term:

F'_nu ~ constant * primaryTerm

For extrapolation:

F'_nu ~ primaryTerm + constant * (((lambda_primaryBand - lambda_secondaryBand) /
                                  (lambda_primaryBand - lambda_tertiaryBand)) *
                                  (primaryTerm - secondaryTerm))

where primaryTerm and secondaryTerm are names from a SedboundarytermDict, and primaryBand, secondaryBand, and tertiaryBand are band names.

To construct a Sedterm, use keyword arguments:

Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
        extrapolated=False, constant=1.0)

or:

Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
        extrapolated=True, constant=1.0, primaryBand=primaryBandName,
        secondaryBand=secondaryBandName, tertiaryBand=tertiaryBandName)

This is a subclass of Config. This follows the form of lsst.pipe.tasks.Colorterm.

Attributes Summary

`constant`	Adjustment constant for SED slope (`float`, default `1.0`)
`extrapolated`	Extrapolate to compute SED slope (`bool`, default `False`)
`primaryBand`	Primary band name for extrapolation (`str`, default `None`)
`primaryTerm`	Name of primary Sedboundaryterm (`str`)
`secondaryBand`	Secondary band name for extrapolation (`str`, default `None`)
`secondaryTerm`	Name of secondary Sedboundaryterm (`str`, default `None`)
`tertiaryBand`	Tertiary band name for extrapolation (`str`, default `None`)

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

constant#: Adjustment constant for SED slope (float, default 1.0)

extrapolated#: Extrapolate to compute SED slope (bool, default False)

primaryBand#: Primary band name for extrapolation (str, default None)

primaryTerm#: Name of primary Sedboundaryterm (str)

secondaryBand#: Secondary band name for extrapolation (str, default None)

secondaryTerm#: Name of secondary Sedboundaryterm (str, default None)

tertiaryBand#: Tertiary band name for extrapolation (str, default None)

Methods Documentation

validate()#

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.