lsst.ip.diffim g6c579da96f+2117ded7b3
Loading...
Searching...
No Matches
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"
47
48namespace lsst {
49namespace ip {
50namespace diffim {
51
53public:
54
56};
57
59public:
60
61 explicit DipoleFluxControl() {}
62};
63
68public:
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
81public:
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
99protected:
101 DipoleCentroidAlgorithm(Control const & ctrl, std::string const & name, afw::table::Schema & schema,
102 std::string const & doc, ResultKey const & positiveKeys, ResultKey const & negativeKeys);
103
110};
111
116public:
117
122
126
127 DipoleFluxAlgorithm(Control const & ctrl, std::string const & name, afw::table::Schema & schema,
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
136protected:
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{
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
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");
205}
206
207/*
208class that knows how to calculate centroids as a simple unweighted first
209 * moment of the 3x3 region around the peaks
210 */
212public:
213
215
216 NaiveDipoleFlux(Control const & ctrl, std::string const & name, afw::table::Schema & schema) :
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
233private:
234
235 Control _ctrl;
236 afw::table::Key<int> _numPositiveKey;
237 afw::table::Key<int> _numNegativeKey;
238};
239
244public:
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
271protected:
273 NaiveDipoleCentroid(Control const & ctrl, std::string const & name, afw::table::Schema & schema,
274 ResultKey const & positiveKeys, ResultKey const & negativeKeys);
275
276private:
277
278 Control _ctrl;
279 meas::base::FluxResultKey _fluxResultKey;
280 meas::base::FlagHandler _flagHandler;
281};
282
283
284
285
290public:
291
293
294 PsfDipoleFlux(PsfDipoleFluxControl const & ctrl, std::string const & name, afw::table::Schema & schema) :
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
323private:
324
325 Control _ctrl;
326 afw::table::Key<float> _chi2dofKey;
330
331};
332
333}}}// namespace lsst::ip::diffim
334
335#endif // !LSST_IP_DIFFIM_DIPOLEALGORITHMS_H
table::Key< std::string > name
Intermediate base class for algorithms that compute a centroid.
ResultKey const & getPositiveKeys() const
Return the standard centroid keys registered by this algorithm.
static meas::base::FlagDefinition const FAILURE
meas::base::CentroidResultKey ResultKey
static meas::base::FlagDefinition const POS_FLAG
ResultKey const & getNegativeKeys() const
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.
ResultKey const & getPositiveKeys() const
Return the standard flux keys registered by this algorithm.
static meas::base::FlagDefinition const POS_FLAG
static meas::base::FlagDefinition const NEG_FLAG
ResultKey const & getNegativeKeys() const
meas::base::FluxResultKey _fluxResultKey
DipoleFluxAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema, std::string const &doc)
static meas::base::FlagDefinition const FAILURE
Intermediate base class for algorithms that compute a centroid.
ResultKey const & getPositiveKeys() const
ResultKey const & getNegativeKeys() 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
ResultKey const & getCenterKeys() const
Return the standard centroid keys registered by this algorithm.
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
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
PsfDipoleFlux(PsfDipoleFluxControl const &ctrl, std::string const &name, afw::table::Schema &schema)
void fail(afw::table::SourceRecord &measRecord, meas::base::MeasurementError *error=NULL) const
static CentroidResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, UncertaintyEnum uncertainty)
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinitionList const &flagDefs, FlagDefinitionList const &exclDefs=FlagDefinitionList::getEmptyList())
static FluxResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc)
table::Schema schema