lsst.meas.modelfit  19.0.0-2-g9b11441+34
CModel.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_CModelFit_h_INCLUDED
25 #define LSST_MEAS_MODELFIT_CModelFit_h_INCLUDED
26 
27 #include <bitset>
28 #include <string>
29 
30 #include "ndarray.h"
31 
32 #include "lsst/geom.h"
33 #include "lsst/pex/config.h"
35 #include "lsst/afw/table/Source.h"
45 
46 namespace lsst { namespace meas { namespace modelfit {
47 
143 
145  profileName("lux"),
146  priorSource("EMPIRICAL"),
147  priorName(),
148  nComponents(8),
149  maxRadius(0),
150  usePixelWeights(false),
151  weightsMultiplier(1.0),
152  doRecordHistory(true),
153  doRecordTime(true)
154  {}
155 
158  }
159 
160  PTR(Model) getModel() const;
161 
162  PTR(Prior) getPrior() const;
163 
164  LSST_CONTROL_FIELD(
166  "Name of the shapelet.RadialProfile that defines the model to fit"
167  );
168 
169  LSST_CONTROL_FIELD(
171  "One of 'FILE', 'LINEAR', 'EMPIRICAL', or 'NONE', indicating whether the prior should be loaded "
172  "from disk, created from one of the nested prior config/control objects, or None"
173  );
174 
175  LSST_CONTROL_FIELD(
177  "Name of the Prior that defines the model to fit (a filename in $MEAS_MODELFIT_DIR/data, "
178  "with no extension), if priorSource='FILE'. Ignored for forced fitting."
179  );
180 
181  LSST_NESTED_CONTROL_FIELD(
183  "Configuration for a linear prior, used if priorSource='LINEAR'."
184  );
185 
186  LSST_NESTED_CONTROL_FIELD(
188  "Configuration for an empirical prior, used if priorSource='EMPIRICAL'."
189  );
190 
191  LSST_CONTROL_FIELD(nComponents, int, "Number of Gaussian used to approximate the profile");
192 
193  LSST_CONTROL_FIELD(
194  maxRadius,
195  int,
196  "Maximum radius used in approximating profile with Gaussians (0=default for this profile)"
197  );
198 
199  LSST_CONTROL_FIELD(
201  bool,
202  "Use per-pixel variances as weights in the nonlinear fit (the final linear fit for"
203  " flux never uses per-pixel variances)"
204  );
205 
206  LSST_CONTROL_FIELD(
208  double,
209  "Scale the likelihood by this factor to artificially reweight it w.r.t. the prior."
210  );
211 
212  LSST_NESTED_CONTROL_FIELD(
214  "Configuration for how the objective surface is explored. Ignored for forced fitting"
215  );
216 
217  LSST_CONTROL_FIELD(
218  doRecordHistory, bool,
219  "Whether to record the steps the optimizer takes (or just the number, if running as a plugin)"
220  );
221 
222  LSST_CONTROL_FIELD(
223  doRecordTime, bool,
224  "Whether to record the time spent in this stage"
225  );
226 
227 };
228 
234 
236  psfName("modelfit_DoubleShapeletPsfApprox"),
237  minInitialRadius(0.1),
238  fallbackInitialMomentsPsfFactor(1.5)
239  {
240  initial.nComponents = 3; // use very rough model in initial fit
241  initial.optimizer.gradientThreshold = 1E-3; // with slightly coarser convergence criteria
242  initial.optimizer.minTrustRadiusThreshold = 1E-2;
243  initial.usePixelWeights = true;
244  dev.profileName = "luv";
245  exp.nComponents = 6;
246  exp.optimizer.maxOuterIterations = 250;
247  }
248 
249  LSST_CONTROL_FIELD(
250  psfName,
251  std::string,
252  "Field name prefix of the Shapelet PSF approximation used to convolve the galaxy model; "
253  "must contain a set of fields matching the schema defined by shapelet.MultiShapeletFunctionKey."
254  );
255 
256  LSST_NESTED_CONTROL_FIELD(
258  "Configuration parameters related to the determination of the pixels to include in the fit."
259  );
260 
261  LSST_NESTED_CONTROL_FIELD(
263  "An initial fit (usually with a fast, approximate model) used to warm-start the exp and dev fits, "
264  "convolved with only the zeroth-order terms in the multi-shapelet PSF approximation."
265  );
266 
267  LSST_NESTED_CONTROL_FIELD(
269  "Independent fit of the exponential component"
270  );
271 
272  LSST_NESTED_CONTROL_FIELD(
274  "Independent fit of the de Vaucouleur component"
275  );
276 
277  LSST_CONTROL_FIELD(
278  minInitialRadius, double,
279  "Minimum initial radius in pixels (used to regularize initial moments-based PSF deconvolution)"
280  );
281 
282  LSST_CONTROL_FIELD(
283  fallbackInitialMomentsPsfFactor, double,
284  "If the 2nd-moments shape used to initialize the fit failed, use the PSF moments multiplied by this."
285  " If <= 0.0, abort the fit early instead."
286  );
287 
288 };
289 
294 
296  enum FlagBit {
297  FAILED=0,
298  TR_SMALL,
299  MAX_ITERATIONS,
301  NUMERIC_ERROR,
303  BAD_REFERENCE,
306  N_FLAGS
307  };
308 
310 
321 
322  ndarray::Array<Scalar const,1,1> nonlinear;
323  ndarray::Array<Scalar const,1,1> amplitudes;
324  ndarray::Array<Scalar const,1,1> fixed;
325 
328 };
329 
334 struct CModelResult {
335 
337  enum FlagBit {
338  FAILED=0,
339  REGION_MAX_AREA,
341  REGION_MAX_BAD_PIXEL_FRACTION,
342  REGION_USED_FOOTPRINT_AREA,
344  REGION_USED_PSF_AREA,
347  REGION_USED_INITIAL_ELLIPSE_MIN,
349  REGION_USED_INITIAL_ELLIPSE_MAX,
351  NO_SHAPE,
353  SMALL_SHAPE,
355  NO_SHAPELET_PSF,
360  N_FLAGS
361  };
362 
363  CModelResult();
364 
369  Scalar objective;
371 
375 
378 
381 };
382 
392 public:
393 
396 
410  std::string const & name,
411  Control const & ctrl,
412  afw::table::Schema & schema
413  );
414 
431  std::string const & name,
432  Control const & ctrl,
433  afw::table::SchemaMapper & schemaMapper
434  );
435 
443  explicit CModelAlgorithm(Control const & ctrl);
444 
446  Control const & getControl() const { return _ctrl; }
447 
464  Result apply(
465  afw::image::Exposure<Pixel> const & exposure,
467  geom::Point2D const & center,
468  afw::geom::ellipses::Quadrupole const & moments,
469  Scalar approxFlux=-1,
470  Scalar kronRadius=-1,
471  int footprintArea=-1
472  ) const;
473 
486  Result applyForced(
487  afw::image::Exposure<Pixel> const & exposure,
489  geom::Point2D const & center,
490  Result const & reference,
491  Scalar approxFlux=-1
492  ) const;
493 
506  void measure(
507  afw::table::SourceRecord & measRecord,
508  afw::image::Exposure<Pixel> const & exposure
509  ) const;
510 
526  void measure(
527  afw::table::SourceRecord & measRecord,
528  afw::image::Exposure<Pixel> const & exposure,
529  afw::table::SourceRecord const & refRecord
530  ) const;
531 
540  void fail(
541  afw::table::SourceRecord & measRecord,
543  ) const;
544 
546  void writeResultToRecord(Result const & result, afw::table::BaseRecord & record) const;
547 
548 private:
549 
550  friend class CModelAlgorithmControl;
551 
552  // Actual implementations go here; we use an output argument for the result so we can get partial
553  // results to the plugin version when we throw.
554  void _applyImpl(
555  Result & result,
556  afw::image::Exposure<Pixel> const & exposure,
558  geom::Point2D const & center,
559  afw::geom::ellipses::Quadrupole const & moments,
560  Scalar approxFlux,
561  Scalar kronRadius=-1,
562  int footprintArea=-1
563  ) const;
564 
565  // Actual implementations go here; we use an output argument for the result so we can get partial
566  // results to the SourceRecord version when we throw.
567  void _applyForcedImpl(
568  Result & result,
569  afw::image::Exposure<Pixel> const & exposure,
571  geom::Point2D const & center,
572  Result const & reference,
573  Scalar approxFlux
574  ) const;
575 
576  // gets/checks inputs from SourceRecord that are needed by both apply and applyForced
577  template <typename PixelT>
578  shapelet::MultiShapeletFunction _processInputs(
579  afw::table::SourceRecord & source,
580  afw::image::Exposure<PixelT> const & exposure
581  ) const;
582 
583  class Impl;
584 
585  Control _ctrl;
586  PTR(Impl) _impl;
587 };
588 
589 }}} // namespace lsst::meas::modelfit
590 
591 #endif // !LSST_MEAS_MODELFIT_CModelFit_h_INCLUDED
shapelet::RadialProfile const & getProfile() const
Definition: CModel.h:156
LocalUnitTransform fitSysToMeasSys
Transforms to the coordinate system where parameters are defined.
Definition: CModel.h:379
boost::shared_ptr< OptimizerObjective > objfunc
Objective class used by the optimizer.
Definition: CModel.h:313
Control const & getControl() const
Return the control object the algorithm was constructed with.
Definition: CModel.h:446
Scalar objective
Value of the objective function at the best fit point: chisq/2 - ln(prior)
Definition: CModel.h:318
Scalar instFluxInner
Flux measured strictly within the fit region (no extrapolation).
Definition: CModel.h:367
std::bitset< N_FLAGS > flags
Array of flags.
Definition: CModel.h:380
ndarray::Array< Scalar const, 1, 1 > amplitudes
Opaque linear parameters in specialized units.
Definition: CModel.h:323
afw::geom::ellipses::Quadrupole ellipse
Best fit half-light ellipse in pixel coordinates.
Definition: CModel.h:320
Scalar instFluxErr
Flux uncertainty from the final linear fit.
Definition: CModel.h:366
double Scalar
Typedefs to be used for probability and parameter values.
Definition: common.h:44
boost::shared_ptr< Model > model
Model object that defines the parametrization (defined fully by Control struct)
Definition: CModel.h:311
#define PTR(...)
ndarray::Array< Scalar const, 1, 1 > nonlinear
Opaque nonlinear parameters in specialized units.
Definition: CModel.h:322
Key< int > psf
CModelResult Result
Typedef to the master Result struct.
Definition: CModel.h:395
double weightsMultiplier
"Scale the likelihood by this factor to artificially reweight it w.r.t. the prior." ;
Definition: CModel.h:210
std::string profileName
"Name of the shapelet.RadialProfile that defines the model to fit" ;
Definition: CModel.h:167
bool doRecordTime
"Whether to record the time spent in this stage" ;
Definition: CModel.h:225
Nested control object for CModel that configures one of the three ("initial", "exp", "dev") nonlinear fitting stages.
Definition: CModel.h:142
CModelStageResult dev
Results from the de Vaucouleur (Sersic n=4) fit.
Definition: CModel.h:374
static RadialProfile & get(std::string const &name)
STL class.
CModelStageResult initial
Results from the initial approximate nonlinear fit that feeds the others.
Definition: CModel.h:372
Abstract base class and concrete factories that define multi-shapelet galaxy models.
Definition: Model.h:56
boost::shared_ptr< Prior > prior
Bayesian priors on the parameters (defined fully by Control struct)
Definition: CModel.h:312
std::string priorSource
"One of &#39;FILE&#39;, &#39;LINEAR&#39;, &#39;EMPIRICAL&#39;, or &#39;NONE&#39;, indicating whether the prior should be loaded " "fr...
Definition: CModel.h:173
Main public interface class for CModel algorithm.
Definition: CModel.h:391
std::bitset< N_FLAGS > flags
Array of flags.
Definition: CModel.h:327
std::string priorName
"Name of the Prior that defines the model to fit (a filename in $MEAS_MODELFIT_DIR/data, " "with no extension), if priorSource=&#39;FILE&#39;. Ignored for forced fitting." ;
Definition: CModel.h:179
The main control object for CModel, containing parameters for the final linear fit and aggregating th...
Definition: CModel.h:233
Scalar instFluxInner
Flux measured strictly within the fit region (no extrapolation).
Definition: CModel.h:317
afw::geom::ellipses::Quadrupole initialFitRegion
Pixels used in the initial fit.
Definition: CModel.h:376
afw::geom::ellipses::Quadrupole finalFitRegion
Pixels used in the exp, dev, and linear fits.
Definition: CModel.h:377
Scalar instFluxErr
Flux uncertainty from just this stage fit.
Definition: CModel.h:316
Scalar time
Time spent in this fit in seconds.
Definition: CModel.h:319
int nComponents
"Number of Gaussian used to approximate the profile" ;
Definition: CModel.h:191
bool doRecordHistory
"Whether to record the steps the optimizer takes (or just the number, if running as a plugin)" ; ...
Definition: CModel.h:220
SoftenedLinearPriorControl linearPriorConfig
"Configuration for a linear prior, used if priorSource=&#39;LINEAR&#39;." ;
Definition: CModel.h:184
Configuration object for Optimizer.
Definition: optimizer.h:187
std::unique_ptr< SchemaItem< U > > result
Scalar fracDev
Fraction of flux from the final linear fit in the de Vaucouleur component (always between 0 and 1)...
Definition: CModel.h:368
Base class for Bayesian priors.
Definition: Prior.h:36
FlagBit
Flags that apply to all four CModel fits or just the last one.
Definition: CModel.h:337
A local mapping between two UnitSystems.
Definition: UnitSystem.h:80
boost::shared_ptr< UnitTransformedLikelihood > likelihood
Object used to evaluate models and compare to data.
Definition: CModel.h:314
SemiEmpiricalPriorControl empiricalPriorConfig
"Configuration for an empirical prior, used if priorSource=&#39;EMPIRICAL&#39;." ;
Definition: CModel.h:189
Scalar instFlux
Flux from the final linear fit.
Definition: CModel.h:365
CModelControl Control
Typedef to the master Control struct.
Definition: CModel.h:394
bool usePixelWeights
"Use per-pixel variances as weights in the nonlinear fit (the final linear fit for" " flux never uses...
Definition: CModel.h:204
int maxRadius
"Maximum radius used in approximating profile with Gaussians (0=default for this profile)" ; ...
Definition: CModel.h:197
Reference fit failed, so forced fit will fail as well.
Definition: CModel.h:358
FlagBit
Flags for a single CModel stage (note that there are additional flags for the full multi-stage fit) ...
Definition: CModel.h:296
Base class for objective functions for Optimizer.
Definition: optimizer.h:44
ndarray::Array< Scalar const, 1, 1 > fixed
Opaque fixed parameters in specialized units.
Definition: CModel.h:324
afw::table::BaseCatalog history
Trace of the optimizer&#39;s path, if enabled by diagnostic options.
Definition: CModel.h:326
Master result object for CModel, containing results for the final linear fit and three nested CModelS...
Definition: CModel.h:334
boost::shared_ptr< Prior > getPrior() const
Result object for a single nonlinear fitting stage of the CModel algorithm.
Definition: CModel.h:293
OptimizerControl optimizer
"Configuration for how the objective surface is explored. Ignored for forced fitting" ; ...
Definition: CModel.h:215
boost::shared_ptr< Model > getModel() const
A concrete Likelihood class that does not require its parameters and data to be in the same UnitSyste...
Input centroid did not land within the fit region.
Definition: CModel.h:357
Scalar instFlux
Flux measured from just this stage fit.
Definition: CModel.h:315
CModelStageResult exp
Results from the exponential (Sersic n=1) fit.
Definition: CModel.h:373