LSST Applications g0f08755f38+82efc23009,g12f32b3c4e+e7bdf1200e,g1653933729+a8ce1bb630,g1a0ca8cf93+50eff2b06f,g28da252d5a+52db39f6a5,g2bbee38e9b+37c5a29d61,g2bc492864f+37c5a29d61,g2cdde0e794+c05ff076ad,g3156d2b45e+41e33cbcdc,g347aa1857d+37c5a29d61,g35bb328faa+a8ce1bb630,g3a166c0a6a+37c5a29d61,g3e281a1b8c+fb992f5633,g414038480c+7f03dfc1b0,g41af890bb2+11b950c980,g5fbc88fb19+17cd334064,g6b1c1869cb+12dd639c9a,g781aacb6e4+a8ce1bb630,g80478fca09+72e9651da0,g82479be7b0+04c31367b4,g858d7b2824+82efc23009,g9125e01d80+a8ce1bb630,g9726552aa6+8047e3811d,ga5288a1d22+e532dc0a0b,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+37c5a29d61,gcf0d15dbbd+2acd6d4d48,gd7358e8bfb+778a810b6e,gda3e153d99+82efc23009,gda6a2b7d83+2acd6d4d48,gdaeeff99f8+1711a396fd,ge2409df99d+6b12de1076,ge79ae78c31+37c5a29d61,gf0baf85859+d0a5978c5a,gf3967379c6+4954f8c433,gfb92a5be7c+82efc23009,gfec2e1e490+2aaed99252,w.2024.46
LSST Data Management Base Package
Loading...
Searching...
No Matches
sedterms.py
Go to the documentation of this file.
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"""
24
25from lsst.pex.config import Config, Field, ConfigDictField
26
27__all__ = ["Sedterm", "SedtermDict", "Sedboundaryterm", "SedboundarytermDict"]
28
29
31 """SED boundary term for a pair of bands.
32
33 The SED slope (in flux units) at the boundary between two bands is given by:
34
35 S = -0.921 * (primary - secondary) / (lambda_primary - lambda_secondary)
36
37 To construct a Sedboundaryterm, use keyword arguments:
38 Sedboundaryterm(primary=primaryBandName, secondary=secondaryBandName)
39
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")
45
46
48 """A mapping of Sedboundaryterm name to Sedterm.
49
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::
54
55 SedboundarytermDict(data={
56 'gr': Sedboundaryterm(primary="g", secondary="r"),
57 'ri': Sedboundaryterm(primary="r", secondary="i"),
58 })
59
60 This is a subclass of Config. This follows the form of
61 `lsst.pipe.tasks.ColortermDict`.
62 """
64 doc="Mapping of Sedboundary term name to Sedboundaryterm",
65 keytype=str,
66 itemtype=Sedboundaryterm,
67 default={},
68 )
69
70
72 """SED term for a single band.
73
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).
77
78 For interpolation, with a secondary term::
79
80 F'_nu ~ constant * (primaryTerm + secondaryTerm) / 2.0
81
82 For interpolation, without a secondary term::
83
84 F'_nu ~ constant * primaryTerm
85
86 For extrapolation::
87
88 F'_nu ~ primaryTerm + constant * (((lambda_primaryBand - lambda_secondaryBand) /
89 (lambda_primaryBand - lambda_tertiaryBand)) *
90 (primaryTerm - secondaryTerm))
91
92 where primaryTerm and secondaryTerm are names from a `SedboundarytermDict`, and
93 primaryBand, secondaryBand, and tertiaryBand are band names.
94
95 To construct a Sedterm, use keyword arguments::
96
97 Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
98 extrapolated=False, constant=1.0)
99
100 or::
101
102 Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
103 extrapolated=True, constant=1.0, primaryBand=primaryBandName,
104 secondaryBand=secondaryBandName, tertiaryBand=tertiaryBandName)
105
106 This is a subclass of Config. This follows the form of
107 `lsst.pipe.tasks.Colorterm`.
108 """
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")
120
121 def validate(self):
122 Config.validate(self)
123 if self.extrapolated:
124 if self.primaryBand is None or \
125 self.secondaryBand is None or \
126 self.tertiaryBand is None:
127 raise RuntimeError("extrapolated requires primaryBand, secondaryBand, and "
128 "tertiaryBand are provided.")
129
130
132 """A mapping of bands to Sedterms.
133
134 To construct a SedtermDict use keyword arguments::
135
136 SedtermDict(data=dataDict)
137
138 where dataDict is a Python dict of band to Sedterm
139 For example::
140
141 SedtermDict(data={
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)
145 })
146
147 This is a subclass of Config. This follows the form of
148 `lsst.pipe.tasks.ColortermDict`.
149 """
151 doc="Mapping of band name to Sedterm",
152 keytype=str,
153 itemtype=Sedterm,
154 default={},
155 )