lsst.meas.base  13.0-32-g2c0c40e+12
GaussianFlux.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2015 AURA/LSST.
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_BASE_GaussianFlux_h_INCLUDED
25 #define LSST_MEAS_BASE_GaussianFlux_h_INCLUDED
26 
27 #include "lsst/pex/config.h"
28 #include "lsst/afw/image/Exposure.h"
35 
36 namespace lsst { namespace meas { namespace base {
37 
42 public:
43  LSST_CONTROL_FIELD(background, double, "FIXME! NEVER DOCUMENTED!");
44 
51  background(0.0)
52  {}
53 };
54 
63 public:
64 
65  // Structures and routines to manage flaghandler
66  static FlagDefinitionList const & getFlagDefinitions();
67  static FlagDefinition const FAILURE;
68 
72 
73  GaussianFluxAlgorithm(Control const & ctrl, std::string const & name, afw::table::Schema & schema);
74 
75  virtual void measure(
76  afw::table::SourceRecord & measRecord,
77  afw::image::Exposure<float> const & exposure
78  ) const;
79 
80  virtual void fail(
81  afw::table::SourceRecord & measRecord,
82  MeasurementError * error=nullptr
83  ) const;
84 
85 private:
86 
87  Control _ctrl;
88  FluxResultKey _fluxResultKey;
89  FlagHandler _flagHandler;
90  SafeCentroidExtractor _centroidExtractor;
91  SafeShapeExtractor _shapeExtractor;
92 };
93 
95 public:
97  GaussianFluxTransform(Control const & ctrl, std::string const & name, afw::table::SchemaMapper & mapper) :
98  FluxTransform{name, mapper} { }
99 };
100 
101 }}} // namespace lsst::meas::base
102 
103 #endif // !LSST_MEAS_BASE_GaussianFlux_h_INCLUDED
GaussianFluxControl Control
A typedef to the Control object for this algorithm, defined above.
Definition: GaussianFlux.h:71
double background
"FIXME! NEVER DOCUMENTED!" ;
Definition: GaussianFlux.h:43
Utility class for measurement algorithms that extracts an ellipse from the Shape slot and handles err...
A C++ control class to handle GaussianFluxAlgorithm&#39;s configuration.
Definition: GaussianFlux.h:41
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:38
This defines the base of measurement transformations.
GaussianFluxTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
Definition: GaussianFlux.h:97
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
Base for flux measurement transformations.
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:156
A measurement algorithm that estimates flux using an elliptical Gaussian weight.
Definition: GaussianFlux.h:62
Definition: mainpage.dox:3
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:56
static FlagDefinition const FAILURE
Definition: GaussianFlux.h:67
GaussianFluxControl()
Default constructor.
Definition: GaussianFlux.h:50
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:184
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:63