lsst.meas.modelfit  21.0.0-2-gecfae73+1385e31ff3
DoubleShapeletPsfApprox.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2016 LSST/AURA.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_MEAS_MODELFIT_DoubleShapeletPsfApprox_h_INCLUDED
25 #define LSST_MEAS_MODELFIT_DoubleShapeletPsfApprox_h_INCLUDED
26 
27 #include "lsst/afw/geom.h"
32 
33 namespace lsst { namespace meas { namespace modelfit {
34 
39 public:
40 
42  innerOrder(2), outerOrder(1),
43  radiusRatio(2.0), peakRatio(0.1),
45  {}
46 
47  LSST_CONTROL_FIELD(innerOrder, int, "Shapelet order of inner expansion (0 == Gaussian)");
48 
49  LSST_CONTROL_FIELD(outerOrder, int, "Shapelet order of outer expansion (0 == Gaussian)");
50 
51  LSST_CONTROL_FIELD(radiusRatio, double, "Initial outer radius divided by inner radius");
52 
53  LSST_CONTROL_FIELD(
54  peakRatio, double,
55  "Initial outer Gaussian peak height divided by inner Gaussian peak height"
56  );
57 
58  LSST_CONTROL_FIELD(
59  minRadius, double,
60  "Don't allow the semi-minor radius of any component to drop below this value (pixels)"
61  );
62 
63  LSST_CONTROL_FIELD(
64  minRadiusDiff, double,
65  "Don't allow the determinant radii of the two components to differ by less than this (pixels)"
66  );
67 
68  LSST_CONTROL_FIELD(
69  maxRadiusBoxFraction, double,
70  "Don't allow the semi-major radius of any component to go above this fraction of the PSF image width"
71  );
72 
73  LSST_NESTED_CONTROL_FIELD(
75  "Configuration of the optimizer used by DoubleShapeletPsfsApproxAlgorithm::fitProfile()."
76  );
77 
78 };
79 
80 
97 public:
98 
99  // Structures and routines to manage flaghandler
105 
107 
109 
125  Control const & ctrl,
126  std::string const & name,
127  afw::table::Schema & schema
128  );
129 
138 
162  static void fitMoments(
164  Control const & ctrl,
165  afw::image::Image<Scalar> const & psfImage
166  );
167 
196  afw::geom::ellipses::Ellipse const & moments,
197  Control const & ctrl,
198  afw::image::Image<Scalar> const & psfImage
199  );
200 
201 
218  static void fitProfile(
220  Control const & ctrl,
221  afw::image::Image<Scalar> const & psfImage
222  );
223 
238  static void fitShapelets(
240  Control const & ctrl,
241  afw::image::Image<Scalar> const & psfImage
242  );
243 
249  void measure(
250  afw::table::SourceRecord & measRecord,
251  afw::image::Exposure<float> const & exposure
252  ) const;
253 
257  void fail(
258  afw::table::SourceRecord & measRecord,
259  lsst::meas::base::MeasurementError * error=nullptr
260  ) const;
261 
262 private:
263  Control _ctrl;
264  meas::base::SafeCentroidExtractor _centroidExtractor;
266  lsst::meas::base::FlagHandler _flagHandler;
267 };
268 
269 }}} // namespace lsst::meas::modelfit
270 
271 #endif // !LSST_MEAS_MODELFIT_DoubleShapeletPsfApprox_h_INCLUDED
#define PTR(...)
An algorithm that fits a 2-component shapelet approximation to the PSF model.
DoubleShapeletPsfApproxAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
Failure modes passed by MeasurementErrors thrown by this class.
static boost::shared_ptr< OptimizerObjective > makeObjective(afw::geom::ellipses::Ellipse const &moments, Control const &ctrl, afw::image::Image< Scalar > const &psfImage)
Return an Objective object that can be used to fit the profile of the model.
static shapelet::MultiShapeletFunction initializeResult(Control const &ctrl)
Create a MultiShapeletFunction with orders and radii and amplitude ratios from the control object.
static void fitShapelets(shapelet::MultiShapeletFunction &result, Control const &ctrl, afw::image::Image< Scalar > const &psfImage)
Update a MultiShapeletFunction's higher-order shapelet terms, holding everything else fixed.
static base::FlagDefinitionList const & getFlagDefinitions()
static void fitMoments(shapelet::MultiShapeletFunction &result, Control const &ctrl, afw::image::Image< Scalar > const &psfImage)
Update a MultiShapeletFunction's ellipses to match the first and second moments of a PSF image.
void fail(afw::table::SourceRecord &measRecord, lsst::meas::base::MeasurementError *error=nullptr) const
Handle failures caught by the measurement plugin system, setting failure flags as appropriate.
static void fitProfile(shapelet::MultiShapeletFunction &result, Control const &ctrl, afw::image::Image< Scalar > const &psfImage)
Update a MultiShapeletFunction's zeroth-order profile by fitting radii and amplitudes.
void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Run all fitting stages on the Psf attached to the given Exposure, saving the results in measRecord.
Control object used to configure a 2-shapelet fit to a PSF model; see DoubleShapeletPsfApproxAlgorith...
OptimizerControl optimizer
"Configuration of the optimizer used by DoubleShapeletPsfsApproxAlgorithm::fitProfile()....
int innerOrder
"Shapelet order of inner expansion (0 == Gaussian)" ;
double maxRadiusBoxFraction
"Don't allow the semi-major radius of any component to go above this fraction of the PSF image width"...
double minRadius
"Don't allow the semi-minor radius of any component to drop below this value (pixels)" ;
double radiusRatio
"Initial outer radius divided by inner radius" ;
double minRadiusDiff
"Don't allow the determinant radii of the two components to differ by less than this (pixels)" ;
int outerOrder
"Shapelet order of outer expansion (0 == Gaussian)" ;
double peakRatio
"Initial outer Gaussian peak height divided by inner Gaussian peak height" ;
Configuration object for Optimizer.
Definition: optimizer.h:187
Base class for objective functions for Optimizer.
Definition: optimizer.h:44