LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
DipoleAlgorithms.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008-2015 AURA/LSST
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #ifndef LSST_IP_DIFFIM_DIPOLEALGORITHMS_H
26 #define LSST_IP_DIFFIM_DIPOLEALGORITHMS_H
28 // Control/algorithm hierarchy for dipole measurement.
29 //
30 
31 #include <stdio.h>
32 #include <execinfo.h>
33 #include <signal.h>
34 #include <stdlib.h>
35 #include <unistd.h>
36 #include <array>
37 
38 #include "lsst/base.h"
39 #include "lsst/pex/config.h"
40 #include "ndarray/eigen.h"
41 #include "lsst/afw/table/Source.h"
47 
48 namespace lsst {
49 namespace ip {
50 namespace diffim {
51 
53 public:
54 
55  explicit DipoleCentroidControl() {}
56 };
57 
59 public:
60 
61  explicit DipoleFluxControl() {}
62 };
63 
68 public:
69  LSST_CONTROL_FIELD(stepSizeCoord, float, "Default initial step size for coordinates in non-linear fitter");
70  LSST_CONTROL_FIELD(stepSizeFlux, float, "Default initial step size for flux in non-linear fitter");
71  LSST_CONTROL_FIELD(errorDef, double, "How many sigma the error bars of the non-linear fitter represent");
72  LSST_CONTROL_FIELD(maxFnCalls, int, "Maximum function calls for non-linear fitter; 0 = unlimited");
74  stepSizeCoord(0.1), stepSizeFlux(1.0), errorDef(1.0), maxFnCalls(100000) {}
75 };
76 
81 public:
82 
87 
89 
90  DipoleCentroidAlgorithm(Control const & ctrl, std::string const & name,
91  afw::table::Schema & schema, std::string const & doc);
92 
94 
96  ResultKey const & getPositiveKeys() const { return _positiveKeys; }
97  ResultKey const & getNegativeKeys() const { return _negativeKeys; }
98 
99 protected:
102  std::string const & doc, ResultKey const & positiveKeys, ResultKey const & negativeKeys);
103 
110 };
111 
116 public:
117 
122 
126 
128  std::string const & doc);
129 
130  // A typedef for the FunctorKey which returns the result of this algorithm
133  ResultKey const & getPositiveKeys() const { return _positiveKeys; }
134  ResultKey const & getNegativeKeys() const { return _negativeKeys; }
135 
136 protected:
137 
139  DipoleFluxAlgorithm(Control const & ctrl, std::string const & name,
140  afw::table::Schema & schema, std::string const & doc,
141  ResultKey const & positiveKeys, ResultKey const & negativeKeys);
142 
146 
149 };
150 
152  Control const & ctrl, std::string const & name, afw::table::Schema & schema, std::string const & doc
153  ) :
154  _ctrl(ctrl)
155 {
161  _positiveKeys = ResultKey(schema[name+"_pos"]);
162  _negativeKeys = ResultKey(schema[name+"_neg"]);
163 }
164 
166  Control const & ctrl, std::string const & name, afw::table::Schema & schema, std::string const & doc,
167  ResultKey const & positiveKeys, ResultKey const & negativeKeys
168  ) :
169  _ctrl(ctrl)
170 {
176 
177  _positiveKeys = ResultKey(schema[name+"_pos"]);
178  _negativeKeys = ResultKey(schema[name+"_neg"]);
179 }
180 
182  Control const & ctrl, std::string const & name, afw::table::Schema & schema,
183  std::string const & doc, ResultKey const & positiveKeys, ResultKey const & negativeKeys
184  ) :
185  _ctrl(ctrl)
186 {
188  meas::base::FluxResultKey::addFields(schema, name+"_pos", doc+": positive lobe");
189  meas::base::FluxResultKey::addFields(schema, name+"_neg", doc+": negative lobe");
190  _positiveKeys = ResultKey(positiveKeys);
191  _negativeKeys = ResultKey(negativeKeys);
192 }
193 
195  Control const & ctrl, std::string const & name, afw::table::Schema & schema,
196  std::string const & doc
197  ) :
198  _ctrl(ctrl)
199 {
201  meas::base::FluxResultKey::addFields(schema, name+"_pos", doc+": positive lobe");
202  meas::base::FluxResultKey::addFields(schema, name+"_neg", doc+": negative lobe");
203  _positiveKeys = ResultKey(schema[name+"_pos"]);
204  _negativeKeys = ResultKey(schema[name+"_neg"]);
205 }
206 
207 /*
208 class that knows how to calculate centroids as a simple unweighted first
209  * moment of the 3x3 region around the peaks
210  */
212 public:
213 
215 
217  DipoleFluxAlgorithm(ctrl, name, schema, "raw flux counts"),
218  _numPositiveKey(schema.addField<int>(name+"_npos", "number of positive pixels", "count")),
219  _numNegativeKey(schema.addField<int>(name+"_nneg", "number of negative pixels", "count"))
220  {
221  }
222 
223  void measure(
224  afw::table::SourceRecord & measRecord,
225  afw::image::Exposure<float> const & exposure
226  ) const;
227 
228  void fail(
229  afw::table::SourceRecord & measRecord,
231  ) const;
232 
233 private:
234 
235  Control _ctrl;
236  afw::table::Key<int> _numPositiveKey;
237  afw::table::Key<int> _numNegativeKey;
238 };
239 
244 public:
245 
253 
255  ResultKey const & getCenterKeys() const { return _centerKeys; }
256  ResultKey const & getPositiveKeys() const { return _positiveKeys; }
257  ResultKey const & getNegativeKeys() const { return _negativeKeys; }
258 
259  void measure(
260  afw::table::SourceRecord & measRecord,
261  afw::image::Exposure<float> const & exposure
262  ) const;
263 
264  void mergeCentroids(afw::table::SourceRecord & source, double posValue, double negValue) const;
265 
266  void fail(
267  afw::table::SourceRecord & measRecord,
269  ) const;
270 
271 protected:
274  ResultKey const & positiveKeys, ResultKey const & negativeKeys);
275 
276 private:
277 
278  Control _ctrl;
279  meas::base::FluxResultKey _fluxResultKey;
280  meas::base::FlagHandler _flagHandler;
281 };
282 
283 
284 
285 
290 public:
291 
293 
295  DipoleFluxAlgorithm(ctrl, name, schema, "jointly fitted psf flux counts"),
296  _ctrl(ctrl),
297  _chi2dofKey(schema.addField<float>(name+"_chi2dof",
298  "chi2 per degree of freedom of fit"))
299  {
300  meas::base::CentroidResultKey::addFields(schema, name+"_pos_centroid", "psf fitted center of positive lobe", meas::base::SIGMA_ONLY);
301  meas::base::CentroidResultKey::addFields(schema, name+"_neg_centroid", "psf fitted center of negative lobe", meas::base::SIGMA_ONLY);
302  meas::base::CentroidResultKey::addFields(schema, name+"_centroid", "average of negative and positive lobe positions", meas::base::SIGMA_ONLY);
303  _posCentroid = meas::base::CentroidResultKey(schema[name+"_pos_centroid"]);
304  _negCentroid = meas::base::CentroidResultKey(schema[name+"_neg_centroid"]);
305  _avgCentroid = meas::base::CentroidResultKey(schema[name+"_centroid"]);
306  }
308  afw::image::Exposure<float> const & exposure,
309  double negCenterX, double negCenterY, double negFlux,
310  double posCenterX, double poCenterY, double posFlux
311  ) const;
312 
313  void measure(
314  afw::table::SourceRecord & measRecord,
315  afw::image::Exposure<float> const & exposure
316  ) const;
317 
318  void fail(
319  afw::table::SourceRecord & measRecord,
321  ) const;
322 
323 private:
324 
325  Control _ctrl;
326  afw::table::Key<float> _chi2dofKey;
327  meas::base::CentroidResultKey _avgCentroid;
328  meas::base::CentroidResultKey _negCentroid;
329  meas::base::CentroidResultKey _posCentroid;
330 
331 };
332 
333 }}}// namespace lsst::ip::diffim
334 
335 #endif // !LSST_IP_DIFFIM_DIPOLEALGORITHMS_H
table::Key< std::string > name
Definition: Amplifier.cc:116
table::Schema schema
Definition: python.h:134
Basic LSST definitions.
Defines the fields and offsets for a table.
Definition: Schema.h:50
Record class that contains measurements made on a single exposure.
Definition: Source.h:80
Intermediate base class for algorithms that compute a centroid.
static meas::base::FlagDefinition const FAILURE
ResultKey const & getPositiveKeys() const
Return the standard centroid keys registered by this algorithm.
meas::base::CentroidResultKey ResultKey
ResultKey const & getNegativeKeys() const
static meas::base::FlagDefinition const POS_FLAG
static meas::base::FlagDefinition const NEG_FLAG
static meas::base::FlagDefinitionList const & getFlagDefinitions()
DipoleCentroidAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema, std::string const &doc)
Intermediate base class for algorithms that compute a flux.
meas::base::FluxResultKey ResultKey
static meas::base::FlagDefinitionList const & getFlagDefinitions()
DipoleFluxControl Control
A typedef to the Control object for this algorithm, defined above.
static meas::base::FlagDefinition const POS_FLAG
static meas::base::FlagDefinition const NEG_FLAG
meas::base::FluxResultKey _fluxResultKey
DipoleFluxAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema, std::string const &doc)
ResultKey const & getNegativeKeys() const
static meas::base::FlagDefinition const FAILURE
ResultKey const & getPositiveKeys() const
Return the standard flux keys registered by this algorithm.
Intermediate base class for algorithms that compute a centroid.
ResultKey const & getNegativeKeys() const
NaiveDipoleCentroid(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
ResultKey const & getCenterKeys() const
Return the standard centroid keys registered by this algorithm.
ResultKey const & getPositiveKeys() const
meas::base::CentroidResultKey ResultKey
Tuple type that holds the keys that define a standard centroid algorithm.
NaiveDipoleCentroid(Control const &ctrl, std::string const &name, afw::table::Schema &schema, ResultKey const &positiveKeys, ResultKey const &negativeKeys)
Initialize with a manually-constructed key tuple.
void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Given an image and a pixel position, return a Centroid using a naive 3x3 weighted moment.
void mergeCentroids(afw::table::SourceRecord &source, double posValue, double negValue) const
void fail(afw::table::SourceRecord &measRecord, meas::base::MeasurementError *error=NULL) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Given an image and a pixel position, return a Centroid using a naive 3x3 weighted moment.
void fail(afw::table::SourceRecord &measRecord, meas::base::MeasurementError *error=NULL) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
NaiveDipoleFlux(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
C++ control object for PSF dipole fluxes.
float stepSizeCoord
"Default initial step size for coordinates in non-linear fitter" ;
double errorDef
"How many sigma the error bars of the non-linear fitter represent" ;
float stepSizeFlux
"Default initial step size for flux in non-linear fitter" ;
int maxFnCalls
"Maximum function calls for non-linear fitter; 0 = unlimited" ;
Implementation of Psf dipole flux.
std::pair< double, int > chi2(afw::table::SourceRecord &source, afw::image::Exposure< float > const &exposure, double negCenterX, double negCenterY, double negFlux, double posCenterX, double poCenterY, double posFlux) const
void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
PsfDipoleFlux(PsfDipoleFluxControl const &ctrl, std::string const &name, afw::table::Schema &schema)
void fail(afw::table::SourceRecord &measRecord, meas::base::MeasurementError *error=NULL) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
A FunctorKey for CentroidResult.
static CentroidResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, UncertaintyEnum uncertainty)
Add the appropriate fields to a Schema, and return a CentroidResultKey that manages them.
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinitionList const &flagDefs, FlagDefinitionList const &exclDefs=FlagDefinitionList::getEmptyList())
Add Flag fields to a schema, creating a FlagHandler object to manage them.
Definition: FlagHandler.cc:37
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:59
static FluxResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc)
Add a pair of _instFlux, _instFluxErr fields to a Schema, and return a FluxResultKey that points to t...
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
@ SIGMA_ONLY
Only the diagonal elements of the covariance matrix are provided.
Definition: constants.h:45
A base class for image defects.
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40