LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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"
40
41namespace lsst { namespace meas { namespace modelfit {
42
47public:
48
49 GeneralPsfFitterComponentControl(int order_=0, double radiusFactor_=1.0) :
51 radiusFactor(radiusFactor_), radiusPriorSigma(0.5)
52 {}
53
55 order, int,
56 "shapelet order for this component; negative to disable this component completely"
57 );
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 );
65 "sigma in an isotropic 2-d Gaussian prior on the conformal-shear ellipticity eta"
66 );
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 );
75 radiusPriorSigma, double,
76 "sigma in a Gaussian prior on ln(radius/fiducialRadius)"
77 );
78
79};
80
90public:
91
93 inner(-1, 0.5), primary(0, 1.0), wings(0, 2.0), outer(-1, 4.0), defaultNoiseSigma(0.001)
94 {}
95
98 "Innermost shapelet expansion, used to fit PSFs with very sharp cores"
99 );
100
103 "Primary shapelet expansion, typically used to fit the bulk of the PSF "
104 );
105
108 "Wing shapelet expansion (between primary and outer), typically used to fit the wings of the PSF"
109 );
110
113 "Outermost shapelet expansion, used to fit PSFs with very broad wings"
114 );
115
118 "Configuration of the optimizer used to do the fitting"
119 );
120
122 defaultNoiseSigma, double, "Default value for the noiseSigma parameter in GeneralPsfFitter.apply()"
123 );
124
125};
126
149public:
152
162 afw::table::Schema & schema,
163 std::string const & prefix
164 ) const;
165
174 std::shared_ptr<Model> getModel() const { return _model; }
175
182 std::shared_ptr<Prior> getPrior() const { return _prior; }
183
197 shapelet::MultiShapeletFunction const & previousFit,
198 std::shared_ptr<Model> previousModel
199 ) const;
200
202
218 Scalar noiseSigma=-1,
219 int * pState = nullptr
220 ) const;
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
247 shapelet::MultiShapeletFunction const & initial,
248 Scalar noiseSigma=-1,
249 int * pState = nullptr
250 ) const;
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
261private:
265};
266
268public:
269
270 // Structures and routines to manage flaghandler
277
279
281 afw::table::Schema & schema,
282 std::string const & prefix
283 );
284
286 return _key;
287 }
288
290 afw::table::SourceRecord & measRecord,
292 shapelet::MultiShapeletFunction const & initial
293 ) const;
294
296 afw::table::SourceRecord & measRecord,
299 ) const;
300
301 void fail(
302 afw::table::SourceRecord & measRecord,
304 ) const;
305
306private:
309};
310
316public:
317
319 ndarray::Array<Pixel const,2,1> const & image,
320 geom::Point2I const & xy0,
323 ndarray::Array<Scalar const,1,1> const & fixed
324 );
325
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
333
334private:
335 class Impl;
337};
338
339}}} // namespace lsst::meas::modelfit
340
341#endif // !LSST_MEAS_MODELFIT_GeneralPsfFitter_h_INCLUDED
afw::table::Key< double > sigma
std::string prefix
An ellipse core with quadrupole moments as parameters.
Definition Quadrupole.h:47
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
Defines the fields and offsets for a table.
Definition Schema.h:51
Record class that contains measurements made on a single exposure.
Definition Source.h:78
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.
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition exceptions.h:48
static base::FlagDefinition const EXCEPTION
void fail(afw::table::SourceRecord &measRecord, lsst::meas::base::MeasurementError *error=nullptr) const
shapelet::MultiShapeletFunctionKey getKey()
void measure(afw::table::SourceRecord &measRecord, afw::image::Image< double > const &image, afw::geom::ellipses::Quadrupole const &moments) const
static base::FlagDefinition const MAX_INNER_ITERATIONS
void measure(afw::table::SourceRecord &measRecord, afw::image::Image< double > const &image, shapelet::MultiShapeletFunction const &initial) const
static base::FlagDefinitionList const & getFlagDefinitions()
GeneralPsfFitterAlgorithm(GeneralPsfFitterControl const &ctrl, afw::table::Schema &schema, std::string const &prefix)
static base::FlagDefinition const FAILURE
static base::FlagDefinition const MAX_OUTER_ITERATIONS
static base::FlagDefinition const CONTAINS_NAN
Control object used to define one piece of multishapelet fit to a PSF model; see GeneralPsfFitterCont...
double positionPriorSigma
"sigma (in pixels) in an isotropic 2-d Gaussian prior on the center of this shapelet component,...
GeneralPsfFitterComponentControl(int order_=0, double radiusFactor_=1.0)
double ellipticityPriorSigma
"sigma in an isotropic 2-d Gaussian prior on the conformal-shear ellipticity eta" ;
int order
"shapelet order for this component; negative to disable this component completely" ;
double radiusFactor
"Sets the fiducial radius of this component relative to the 'primary radius' of the PSF: either " "th...
double radiusPriorSigma
"sigma in a Gaussian prior on ln(radius/fiducialRadius)" ;
Control object used to configure a multishapelet fit to a PSF model; see GeneralPsfFitter.
GeneralPsfFitterComponentControl primary
"Primary shapelet expansion, typically used to fit the bulk of the PSF " ;
double defaultNoiseSigma
"Default value for the noiseSigma parameter in GeneralPsfFitter.apply()" ;
GeneralPsfFitterComponentControl inner
"Innermost shapelet expansion, used to fit PSFs with very sharp cores" ;
GeneralPsfFitterComponentControl wings
"Wing shapelet expansion (between primary and outer), typically used to fit the wings of the PSF" ;
OptimizerControl optimizer
"Configuration of the optimizer used to do the fitting" ;
GeneralPsfFitterComponentControl outer
"Outermost shapelet expansion, used to fit PSFs with very broad wings" ;
Class for fitting multishapelet models to PSF images.
shapelet::MultiShapeletFunctionKey addFields(afw::table::Schema &schema, std::string const &prefix) const
Add fields to a Schema that can be used to store the MultiShapeletFunction returned by apply().
shapelet::MultiShapeletFunction apply(afw::image::Image< double > const &image, shapelet::MultiShapeletFunction const &initial, Scalar noiseSigma=-1, int *pState=nullptr) const
GeneralPsfFitter(GeneralPsfFitterControl const &ctrl)
Initialize the fitter class with the given control object.
shapelet::MultiShapeletFunction apply(afw::image::Image< Pixel > 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.
std::shared_ptr< Prior > getPrior() const
Return the Prior object that corresponds to the configuration.
shapelet::MultiShapeletFunction apply(afw::image::Image< Pixel > const &image, afw::geom::ellipses::Quadrupole const &moments, Scalar noiseSigma=-1, int *pState=nullptr) const
Perform an initial fit to a PSF image.
shapelet::MultiShapeletFunction adapt(shapelet::MultiShapeletFunction const &previousFit, std::shared_ptr< Model > previousModel) const
Adapt a differently-configured previous fit to be used as an starting point for this GeneralPsfFitter...
shapelet::MultiShapeletFunction apply(afw::image::Image< double > const &image, afw::geom::ellipses::Quadrupole const &moments, Scalar noiseSigma=-1, int *pState=nullptr) const
std::shared_ptr< Model > getModel() const
Return the Model object that corresponds to the configuration.
Base class for optimizer/sampler likelihood functions that compute likelihood at a point.
Definition Likelihood.h:70
Likelihood object used to fit multishapelet models to PSF model images; mostly for internal use by Ge...
void computeModelMatrix(ndarray::Array< Pixel, 2,-1 > const &modelMatrix, ndarray::Array< Scalar const, 1, 1 > const &nonlinear, bool doApplyWeights=true) const override
Evaluate the model for the given vector of nonlinear parameters.
MultiShapeletPsfLikelihood(ndarray::Array< Pixel const, 2, 1 > const &image, geom::Point2I const &xy0, std::shared_ptr< Model > model, Scalar sigma, ndarray::Array< Scalar const, 1, 1 > const &fixed)
Configuration object for Optimizer.
Definition optimizer.h:187
A multi-scale shapelet function.
Class that maps MultiShapeletFunction objects to fields in afw::table objects.
#define LSST_NESTED_CONTROL_FIELD(NAME, MODULE, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs, for nested control object...
Definition config.h:69
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition config.h:43
double Scalar
Typedefs to be used for probability and parameter values.
Definition common.h:44
VectorQ moments
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition FlagHandler.h:40