Coverage for python/lsst/fgcmcal/sedterms.py : 70%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# This file is part of fgcmcal.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21"""Configuration for SED terms in fgcmcal.
22Analogous to colorterms.
23"""
25from lsst.pex.config import Config, Field, ConfigDictField
27__all__ = ["Sedterm", "SedtermDict", "Sedboundaryterm", "SedboundarytermDict"]
30class Sedboundaryterm(Config):
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:
38 Sedboundaryterm(primary=primaryBandName, secondary=secondaryBandName)
40 This is a subclass of Config. This follows the form of
41 `lsst.pipe.tasks.Colorterm`.
42 """
43 primary = Field(dtype=str, doc="name of primary band")
44 secondary = Field(dtype=str, doc="name of secondary band")
47class SedboundarytermDict(Config):
48 """A mapping of Sedboundaryterm name to Sedterm.
50 To construct a SedboundarytermDict use keyword arguments:
51 SedboundarytermDict(data=dataDict)
52 where dataDict is a Python dict of name: Sedterm
53 For example:
55 SedboundarytermDict(data={
56 'gr': Sedboundaryterm(primary="g", secondary="r"),
57 'ri': Sedboundaryterm(primary="r", secondary="i"),
58 })
60 This is a subclass of Config. This follows the form of
61 `lsst.pipe.tasks.ColortermDict`.
62 """
63 data = ConfigDictField(
64 doc="Mapping of Sedboundary term name to Sedboundaryterm",
65 keytype=str,
66 itemtype=Sedboundaryterm,
67 default={},
68 )
71class Sedterm(Config):
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:
79 F'_nu ~ constant * (primaryTerm + secondaryTerm) / 2.0
81 For interpolation, without a secondary term:
82 F'_nu ~ constant * primaryTerm
84 For extrapolation:
85 F'_nu ~ primaryTerm + constant * (((lambda_primaryBand - lambda_secondaryBand) /
86 (lambda_primaryBand - lambda_tertiaryBand)) *
87 (primaryTerm - secondaryTerm))
89 where primaryTerm and secondaryTerm are names from a `SedboundarytermDict`, and
90 primaryBand, secondaryBand, and tertiaryBand are band names.
92 To construct a Sedterm, use keyword arguments:
94 Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
95 extrapolated=False, constant=1.0)
97 or
99 Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
100 extrapolated=True, constant=1.0, primaryBand=primaryBandName,
101 secondaryBand=secondaryBandName, tertiaryBand=tertiaryBandName)
103 This is a subclass of Config. This follows the form of
104 `lsst.pipe.tasks.Colorterm`.
105 """
106 primaryTerm = Field(dtype=str, doc="Name of primary Sedboundaryterm")
107 secondaryTerm = Field(dtype=str, default=None, optional=True,
108 doc="Name of secondary Sedboundaryterm")
109 extrapolated = Field(dtype=bool, default=False, doc="Extrapolate to compute SED slope")
110 constant = Field(dtype=float, default=1.0, doc="Adjustment constant for SED slope")
111 primaryBand = Field(dtype=str, default=None, optional=True,
112 doc="Primary band name for extrapolation")
113 secondaryBand = Field(dtype=str, default=None, optional=True,
114 doc="Secondary band name for extrapolation")
115 tertiaryBand = Field(dtype=str, default=None, optional=True,
116 doc="Tertiary band name for extrapolation")
118 def validate(self):
119 Config.validate(self)
120 if self.extrapolated:
121 if self.primaryBand is None or \
122 self.secondaryBand is None or \
123 self.tertiaryBand is None:
124 raise RuntimeError("extrapolated requires primaryBand, secondaryBand, and "
125 "tertiaryBand are provided.")
128class SedtermDict(Config):
129 """A mapping of bands to Sedterms.
131 To construct a SedtermDict use keyword arguments:
132 SedtermDict(data=dataDict)
133 where dataDict is a Python dict of band to Sedterm
134 For example:
136 SedtermDict(data={
137 'g': Sedterm(primaryTerm='gr', secondaryTerm='ri', extrapolated=True, constant=0.25,
138 primaryBand='g', secondaryBand='r', tertiaryBand='i'),
139 'r': Sedterm(primaryTerm='gr', secondaryTerm='ri', extrapolated=False)
140 })
142 This is a subclass of Config. This follows the form of
143 `lsst.pipe.tasks.ColortermDict`.
144 """
145 data = ConfigDictField(
146 doc="Mapping of band name to Sedterm",
147 keytype=str,
148 itemtype=Sedterm,
149 default={},
150 )