21"""Configuration for SED terms in fgcmcal.
22Analogous to colorterms.
25from lsst.pex.config
import Config, Field, ConfigDictField
27__all__ = [
"Sedterm",
"SedtermDict",
"Sedboundaryterm",
"SedboundarytermDict"]
31 """SED boundary term for a pair of bands.
33 The SED slope (in flux units) at the boundary between two bands
is given by:
35 S = -0.921 * (primary - secondary) / (lambda_primary - lambda_secondary)
37 To construct a Sedboundaryterm, use keyword arguments:
40 This
is a subclass of Config. This follows the form of
41 `lsst.pipe.tasks.Colorterm`.
43 primary = Field(dtype=str, doc="name of primary band")
44 secondary = Field(dtype=str, doc=
"name of secondary band")
48 """A mapping of Sedboundaryterm name to Sedterm.
50 To construct a SedboundarytermDict use keyword arguments:
52 where dataDict is a Python dict of name: Sedterm
60 This
is a subclass of Config. This follows the form of
61 `lsst.pipe.tasks.ColortermDict`.
63 data = ConfigDictField(
64 doc="Mapping of Sedboundary term name to Sedboundaryterm",
66 itemtype=Sedboundaryterm,
72 """SED term for a single band.
74 The SED slope (in flux units)
in the middle of a band
is computed either
75 as an
"interpolated" or "extrapolated" computation. See Burke et al. 2018
76 Appendix A (https://ui.adsabs.harvard.edu/abs/2018AJ....155...41B).
78 For interpolation,
with a secondary term::
80 F
'_nu ~ constant * (primaryTerm + secondaryTerm) / 2.0
82 For interpolation, without a secondary term::
84 F'_nu ~ constant * primaryTerm
88 F'_nu ~ primaryTerm + constant * (((lambda_primaryBand - lambda_secondaryBand) /
89 (lambda_primaryBand - lambda_tertiaryBand)) *
90 (primaryTerm - secondaryTerm))
92 where primaryTerm and secondaryTerm are names
from a `SedboundarytermDict`,
and
93 primaryBand, secondaryBand,
and tertiaryBand are band names.
95 To construct a Sedterm, use keyword arguments::
97 Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
98 extrapolated=
False, constant=1.0)
102 Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
103 extrapolated=
True, constant=1.0, primaryBand=primaryBandName,
104 secondaryBand=secondaryBandName, tertiaryBand=tertiaryBandName)
106 This
is a subclass of Config. This follows the form of
107 `lsst.pipe.tasks.Colorterm`.
109 primaryTerm = Field(dtype=str, doc="Name of primary Sedboundaryterm")
110 secondaryTerm = Field(dtype=str, default=
None, optional=
True,
111 doc=
"Name of secondary Sedboundaryterm")
112 extrapolated = Field(dtype=bool, default=
False, doc=
"Extrapolate to compute SED slope")
113 constant = Field(dtype=float, default=1.0, doc=
"Adjustment constant for SED slope")
114 primaryBand = Field(dtype=str, default=
None, optional=
True,
115 doc=
"Primary band name for extrapolation")
116 secondaryBand = Field(dtype=str, default=
None, optional=
True,
117 doc=
"Secondary band name for extrapolation")
118 tertiaryBand = Field(dtype=str, default=
None, optional=
True,
119 doc=
"Tertiary band name for extrapolation")
122 Config.validate(self)
127 raise RuntimeError(
"extrapolated requires primaryBand, secondaryBand, and "
128 "tertiaryBand are provided.")
132 """A mapping of bands to Sedterms.
134 To construct a SedtermDict use keyword arguments::
138 where dataDict is a Python dict of band to Sedterm
142 'g':
Sedterm(primaryTerm=
'gr', secondaryTerm=
'ri', extrapolated=
True, constant=0.25,
143 primaryBand=
'g', secondaryBand=
'r', tertiaryBand=
'i'),
144 'r':
Sedterm(primaryTerm=
'gr', secondaryTerm=
'ri', extrapolated=
False)
147 This
is a subclass of Config. This follows the form of
148 `lsst.pipe.tasks.ColortermDict`.
150 data = ConfigDictField(
151 doc="Mapping of band name to Sedterm",