LSST Applications 24.1.6,g063fba187b+56b85ce14a,g0f08755f38+df8a265115,g12f32b3c4e+891a09f10d,g1524ad2192+7a5d7b3fbd,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g28da252d5a+07cb1400be,g2bbee38e9b+ae03bbfc84,g2bc492864f+ae03bbfc84,g3156d2b45e+6e55a43351,g347aa1857d+ae03bbfc84,g35bb328faa+a8ce1bb630,g3a166c0a6a+ae03bbfc84,g3e281a1b8c+c5dd892a6c,g414038480c+6b9177ef31,g41af890bb2+8f257c4c0b,g781aacb6e4+a8ce1bb630,g7af13505b9+7137b3b17d,g80478fca09+6df6903293,g82479be7b0+091ce1d07f,g858d7b2824+df8a265115,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,g9726552aa6+414189b318,ga5288a1d22+4a2bca08d7,gacef1a1666+c9a8ff65f4,gb58c049af0+d64f4d3760,gbcfae0f0a0+de1d42d831,gc28159a63d+ae03bbfc84,gcf0d15dbbd+72117bf34e,gda6a2b7d83+72117bf34e,gdaeeff99f8+1711a396fd,ge500cccec5+c8c9c9af63,ge79ae78c31+ae03bbfc84,gf0baf85859+c1f95f4921,gfa517265be+df8a265115,gfa999e8aa5+17cd334064,gfb92a5be7c+df8a265115
LSST Data Management Base Package
Loading...
Searching...
No Matches
pluginsBase.py
Go to the documentation of this file.
1# This file is part of meas_base.
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
22import traceback
23
24import lsst.pex.config
25from .transforms import PassThroughTransform
26
27__all__ = ("BasePluginConfig", "BasePlugin")
28
29
31 """
32 Base class measurement plugin config classes.
33
34 Notes
35 -----
36 Most derived classes will want to set defaults that make sense for the
37 plugin type.
38 """
39 pass
40
41
43 """
44 Base class for measurement plugins.
45
46 This is the base class for `SingleFramePlugin` and `ForcedPlugin`; derived
47 classes should inherit from one of those.
48
49 Parameters
50 ----------
51 config : `BasePluginConfig`
52 Plugin configuration.
53 name : `str`
54 Plugin name.
55 logName : `str`
56 Logger name.
57
58 Notes
59 -----
60 Relative execution orders are defined by a series of named constants
61 defined in this class: plugins with a lower execution number are run
62 first.
63
64 This approach was chosen instead of a full graph-based analysis of
65 dependencies because algorithm dependencies are usually both quite simple
66 and entirely substitutable: an algorithm that requires a centroid can
67 typically make use of any centroid algorithms outputs. That makes it
68 relatively easy to figure out the correct value to use for any particular
69 algorithm.
70 """
71
72 CENTROID_ORDER = 0.0
73 """Order for algorithms which require only Footprint and Peaks (`float`).
74
75 Notes
76 -----
77 Algorithms with this execution order include centroids.
78 """
79
80 SHAPE_ORDER = 1.0
81 """Order for algorithms which require a centroid (`float`).
82
83 Notes
84 -----
85 These algorithms may refer assume that `getCentroid` will return a good
86 centroid, and that a Footprint and its Peaks are available.
87 """
88
89 FLUX_ORDER = 2.0
90 """Order for algorithms which require a shape and a centroid (`float`).
91
92 Notes
93 -----
94 These algorithms may assume that both `getCentroid` and `getShape` will
95 return good values, and that a Footprint and its Peaks are available.
96 """
97
98 APCORR_ORDER = 3.0
99 """Order for algorithms which require shape, centroid and flux (`float`).
100
101 Notes
102 -----
103 These algorithms may assume that `getCentroid` and `getShape` will return
104 good values, that flux has been measured, and that and that a Footprint
105 and its Peaks are available.
106 """
107
108 DEFAULT_CATALOGCALCULATION = 4.0
109 """Order for catalog calculation plugins.
110
111 Notes
112 -----
113 These plugins only operate on catalogs; they may not access pixel values.
114 """
115
116 ConfigClass = BasePluginConfig
117 """Plugin configuration information (`lsst.pex.config.Config`).
118 """
119
120 @classmethod
122 """Get the relative execution order of this plugin.
123
124 Must be reimplemented as a class method by concrete derived classes.
125 """
126 raise NotImplementedError("All plugins must implement getExecutionOrder()")
127
128 def __init__(self, config, name, logName=None):
129 object.__init__(self)
130 self.config = config
131 self.name = name
132 self.logName = logName
133
134 def getLogName(self):
135 return self.logName
136
137 def fail(self, measRecord, error=None):
138 """Record a failure of the `measure` or `measureN` method.
139
140 Parameters
141 ----------
142 measRecord : `lsst.afw.table.SourceRecord`
143 Table record describing the source being measured.
144 error : `MeasurementError`, optional
145 Only provided if the measurement failed due to a
146 `MeasurementError` being raised; otherwise, will be `None`.
147
148 Notes
149 -----
150 When the plugin raises an exception, framework will call
151 `BasePlugin.fail` to allow the plugin to set its failure flag
152 field(s). When `BasePlugin.measureN` raises an exception,
153 `BasePlugin.fail` will be called repeatedly with all the records that
154 were being measured.
155
156 If the exception is an `MeasurementError`, it will be passed as the
157 error argument; in all other cases the error argument will be `None`,
158 and the failure will be logged by the measurement framework as a
159 warning.
160
161 """
162 traceback.print_exc()
163 message = ("The algorithm '%s' thinks it cannot fail, but it did; "
164 "please report this as a bug (the full traceback is above)."
165 % (self.__class__.__name__,))
166 raise NotImplementedError(message)
167
168 @staticmethod
170 """Get the measurement transformation appropriate to this plugin.
171
172 This returns a subclass of `transforms.MeasurementTransform`, which
173 may be instantiated with details of the algorithm configuration and
174 then called with information about calibration and WCS to convert from
175 raw measurement quantities to calibrated units. Calibrated data is
176 then provided in a separate output table.
177
178 Notes
179 -----
180 By default, we copy everything from the input to the output without
181 transformation.
182 """
183 return PassThroughTransform
fail(self, measRecord, error=None)
__init__(self, config, name, logName=None)