lsst.meas.modelfit  18.1.0-3-g8f4a2b1+35
GeneralPsfFitter.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2013 LSST Corporation.
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_GeneralPsfFitter_h_INCLUDED
25 #define LSST_MEAS_MODELFIT_GeneralPsfFitter_h_INCLUDED
26 
27 #include <memory>
28 
29 #include "lsst/pex/config.h"
34 #include "lsst/geom.h"
35 #include "lsst/afw/geom.h"
36 #include "lsst/afw/table/Source.h"
40 
41 namespace lsst { namespace meas { namespace modelfit {
42 
47 public:
48 
49  GeneralPsfFitterComponentControl(int order_=0, double radiusFactor_=1.0) :
51  radiusFactor(radiusFactor_), radiusPriorSigma(0.5)
52  {}
53 
54  LSST_CONTROL_FIELD(
55  order, int,
56  "shapelet order for this component; negative to disable this component completely"
57  );
58  LSST_CONTROL_FIELD(
59  positionPriorSigma, double,
60  "sigma (in pixels) in an isotropic 2-d Gaussian prior on the center of this shapelet component, "
61  "relative to the center of the PSF image"
62  );
63  LSST_CONTROL_FIELD(
64  ellipticityPriorSigma, double,
65  "sigma in an isotropic 2-d Gaussian prior on the conformal-shear ellipticity eta"
66  );
67  LSST_CONTROL_FIELD(
68  radiusFactor, double,
69  "Sets the fiducial radius of this component relative to the 'primary radius' of the PSF: either "
70  "the second-moments radius of the PSF image (in an initial fit), or the radius of the primary "
71  "component in a previous fit. Ignored if the previous fit included this component (as then we "
72  "can just use that radius)."
73  );
74  LSST_CONTROL_FIELD(
75  radiusPriorSigma, double,
76  "sigma in a Gaussian prior on ln(radius/fiducialRadius)"
77  );
78 
79 };
80 
90 public:
91 
93  inner(-1, 0.5), primary(0, 1.0), wings(0, 2.0), outer(-1, 4.0), defaultNoiseSigma(0.001)
94  {}
95 
96  LSST_NESTED_CONTROL_FIELD(
98  "Innermost shapelet expansion, used to fit PSFs with very sharp cores"
99  );
100 
101  LSST_NESTED_CONTROL_FIELD(
103  "Primary shapelet expansion, typically used to fit the bulk of the PSF "
104  );
105 
106  LSST_NESTED_CONTROL_FIELD(
108  "Wing shapelet expansion (between primary and outer), typically used to fit the wings of the PSF"
109  );
110 
111  LSST_NESTED_CONTROL_FIELD(
113  "Outermost shapelet expansion, used to fit PSFs with very broad wings"
114  );
115 
116  LSST_NESTED_CONTROL_FIELD(
118  "Configuration of the optimizer used to do the fitting"
119  );
120 
121  LSST_CONTROL_FIELD(
122  defaultNoiseSigma, double, "Default value for the noiseSigma parameter in GeneralPsfFitter.apply()"
123  );
124 
125 };
126 
149 public:
151  explicit GeneralPsfFitter(GeneralPsfFitterControl const & ctrl);
152 
163  std::string const & prefix
164  ) const;
165 
174  PTR(Model) getModel() const { return _model; }
175 
182  PTR(Prior) getPrior() const { return _prior; }
183 
197  shapelet::MultiShapeletFunction const & previousFit,
198  PTR(Model) previousModel
199  ) const;
200 
202 
217  afw::geom::ellipses::Quadrupole const & moments,
218  Scalar noiseSigma=-1,
219  int * pState = nullptr
220  ) const;
222  afw::image::Image<double> const & image,
223  afw::geom::ellipses::Quadrupole const & moments,
224  Scalar noiseSigma=-1,
225  int * pState = nullptr
226  ) const {
227  return apply(afw::image::Image<float>(image, true), moments, noiseSigma, pState);
228  }
230 
232 
246  afw::image::Image<Pixel> const & image,
247  shapelet::MultiShapeletFunction const & initial,
248  Scalar noiseSigma=-1,
249  int * pState = nullptr
250  ) const;
252  afw::image::Image<double> const & image,
253  shapelet::MultiShapeletFunction const & initial,
254  Scalar noiseSigma=-1,
255  int * pState = nullptr
256  ) const {
257  return apply(afw::image::Image<float>(image, true), initial, noiseSigma);
258  }
260 
261 private:
263  PTR(Model) _model;
264  PTR(Prior) _prior;
265 };
266 
268 public:
269 
270  // Structures and routines to manage flaghandler
271  static base::FlagDefinitionList const & getFlagDefinitions();
277 
279 
281  afw::table::Schema & schema,
282  std::string const & prefix
283  );
284 
286  return _key;
287  }
288 
289  void measure(
290  afw::table::SourceRecord & measRecord,
292  shapelet::MultiShapeletFunction const & initial
293  ) const;
294 
295  void measure(
296  afw::table::SourceRecord & measRecord,
297  afw::image::Image<double> const & image,
298  afw::geom::ellipses::Quadrupole const & moments
299  ) const;
300 
301  void fail(
302  afw::table::SourceRecord & measRecord,
303  lsst::meas::base::MeasurementError * error=nullptr
304  ) const;
305 
306 private:
308  lsst::meas::base::FlagHandler _flagHandler;
309 };
310 
316 public:
317 
319  ndarray::Array<Pixel const,2,1> const & image,
320  geom::Point2I const & xy0,
321  PTR(Model) model,
322  Scalar sigma,
323  ndarray::Array<Scalar const,1,1> const & fixed
324  );
325 
326  void computeModelMatrix(
327  ndarray::Array<Pixel,2,-1> const & modelMatrix,
328  ndarray::Array<Scalar const,1,1> const & nonlinear,
329  bool doApplyWeights=true
330  ) const override;
331 
332  virtual ~MultiShapeletPsfLikelihood();
333 
334 private:
335  class Impl;
336  std::unique_ptr<Impl> _impl;
337 };
338 
339 }}} // namespace lsst::meas::modelfit
340 
341 #endif // !LSST_MEAS_MODELFIT_GeneralPsfFitter_h_INCLUDED
Likelihood object used to fit multishapelet models to PSF model images; mostly for internal use by Ge...
afw::table::Key< afw::table::Array< ImagePixelT > > image
GeneralPsfFitterComponentControl(int order_=0, double radiusFactor_=1.0)
double radiusPriorSigma
"sigma in a Gaussian prior on ln(radius/fiducialRadius)" ;
static base::FlagDefinition const MAX_OUTER_ITERATIONS
double Scalar
Typedefs to be used for probability and parameter values.
Definition: common.h:44
boost::shared_ptr< Model > getModel() const
Return the Model object that corresponds to the configuration.
#define PTR(...)
afw::table::Key< double > sigma
STL class.
Abstract base class and concrete factories that define multi-shapelet galaxy models.
Definition: Model.h:56
static base::FlagDefinition const FAILURE
double positionPriorSigma
"sigma (in pixels) in an isotropic 2-d Gaussian prior on the center of this shapelet component...
Control object used to define one piece of multishapelet fit to a PSF model; see GeneralPsfFitterCont...
shapelet::MultiShapeletFunctionKey getKey()
Configuration object for Optimizer.
Definition: optimizer.h:187
static base::FlagDefinition const MAX_INNER_ITERATIONS
table::Schema schema
Base class for Bayesian priors.
Definition: Prior.h:36
Base class for optimizer/sampler likelihood functions that compute likelihood at a point...
Definition: Likelihood.h:69
Class for fitting multishapelet models to PSF images.
double radiusFactor
"Sets the fiducial radius of this component relative to the &#39;primary radius&#39; of the PSF: either " "th...
std::string prefix
shapelet::MultiShapeletFunction apply(afw::image::Image< double > const &image, afw::geom::ellipses::Quadrupole const &moments, Scalar noiseSigma=-1, int *pState=nullptr) const
Perform an initial fit to a PSF image.
double ellipticityPriorSigma
"sigma in an isotropic 2-d Gaussian prior on the conformal-shear ellipticity eta" ; ...
Control object used to configure a multishapelet fit to a PSF model; see GeneralPsfFitter.
static base::FlagDefinition const CONTAINS_NAN
int order
"shapelet order for this component; negative to disable this component completely" ; ...
shapelet::MultiShapeletFunction apply(afw::image::Image< double > const &image, shapelet::MultiShapeletFunction const &initial, Scalar noiseSigma=-1, int *pState=nullptr) const
Perform a fit to a PSF image, using a previous fit as a starting point.
boost::shared_ptr< Prior > getPrior() const
Return the Prior object that corresponds to the configuration.
static base::FlagDefinition const EXCEPTION