lsst.meas.extensions.simpleShape  13.0-5-gaa0a428+23
 All Classes Namespaces Files Functions Variables Typedefs Macros
simpleShape.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 #ifndef LSST_MEAS_EXTENSIONS_simpleShape_h_INCLUDED
24 #define LSST_MEAS_EXTENSIONS_simpleShape_h_INCLUDED
25 
26 #include <bitset>
27 
28 #include "lsst/pex/config.h"
29 #include "lsst/afw/geom/ellipses.h"
30 #include "lsst/afw/table.h"
31 #include "lsst/afw/image.h"
32 #include "lsst/meas/base/Algorithm.h"
33 #include "lsst/meas/base.h"
34 
35 namespace lsst { namespace meas { namespace extensions { namespace simpleShape {
36 
37 class SimpleShapeResult;
38 
44  public:
45  LSST_CONTROL_FIELD(sigma, double, "Sigma of circular Gaussian used as weight function, in pixels");
46  LSST_CONTROL_FIELD(nSigmaRegion, double, "Maximum radius for pixels to include, in units of sigma");
47 
49 };
50 
51 class SimpleShapeResultKey : public afw::table::FunctorKey<SimpleShapeResult> {
52  public:
54  afw::table::Schema & schema,
55  std::string const & name
56  );
57 
58  // Default constructor
60 
70  SimpleShapeResultKey(lsst::afw::table::SubSchema const & s);
71 
72  virtual SimpleShapeResult get(afw::table::BaseRecord const & record) const;
73  virtual void set(afw::table::BaseRecord & record, SimpleShapeResult const & value) const;
74 
76  bool operator==(SimpleShapeResultKey const & other) const;
78  bool operator!=(SimpleShapeResultKey const & other) const { return !(*this == other); }
80 
82  bool isValid() const;
83 
84  lsst::meas::base::FlagHandler const & getFlagHandler() const { return _flagHandler; }
85 
86  private:
87  lsst::afw::table::QuadrupoleKey _shapeResult;
88  lsst::afw::table::Point2DKey _centroidResult;
89  lsst::afw::table::CovarianceMatrixKey<double, 5 > _uncertantyResult;
90  lsst::meas::base::FlagHandler _flagHandler;
91 };
92 
93 
94 class SimpleShape : public lsst::meas::base::SimpleAlgorithm {
95 public:
96 
97  // Structures and routines to manage flaghandler
98  static base::FlagDefinitionList const & getFlagDefinitions();
99  static unsigned int const N_FLAGS = 1;
100  static base::FlagDefinition const FAILURE;
101 
103 
104  SimpleShape(Control const & ctrl, std::string const & name, afw::table::Schema & schema);
105 
116  template <typename T>
118  afw::geom::ellipses::Ellipse const & weight,
119  afw::image::MaskedImage<T> const & image,
120  double nSigmaRegion=3.0
121  );
122 
150  static Eigen::Matrix<double,5,6> convertRawMoments(
151  Eigen::Matrix<double,6,1> const & q,
152  afw::geom::ellipses::Quadrupole & quadrupole,
153  afw::geom::Point2D & center
154  );
155 
178  static Eigen::Matrix<double, 5, 5> correctWeightedMoments(
179  afw::geom::ellipses::Quadrupole const & weight,
180  afw::geom::ellipses::Quadrupole & ellipse,
181  afw::geom::Point2D & center
182  );
183 
184  virtual void measure(
185  afw::table::SourceRecord & measRecord,
186  afw::image::Exposure<float> const & exposure
187  ) const;
188 
189  virtual void fail(
190  afw::table::SourceRecord & measRecord,
191  lsst::meas::base::MeasurementError * error=NULL
192  ) const;
193 
194  private:
195  Control _ctrl;
196  SimpleShapeResultKey _resultKey;
197  lsst::meas::base::SafeCentroidExtractor _centroidExtractor;
198 };
199 
204  public:
205  afw::geom::ellipses::Quadrupole ellipse;
206  afw::geom::Point2D center;
207  Eigen::Matrix<double,5,5> covariance;
208 
209 #ifndef SWIG
210  std::bitset<SimpleShape::N_FLAGS> flags;
211 #endif
212 
213  // Flag getter for Swig which doesn't understand std::bitset
214  bool getFlag(int index) const { return flags[index]; }
215 
217 };
218 
219 
220 }}}} // namespace lsst::meas::extensions::simpleShape
221 
222 #endif // !LSST_MEAS_EXTENSIONS_simpleShape_h_INCLUDED
Struct to hold the results of SimpleShape when we don&#39;t run it as a plugin.
Definition: simpleShape.h:203
static base::FlagDefinitionList const & getFlagDefinitions()
Definition: simpleShape.cc:37
Eigen::Matrix< double, 5, 5 > covariance
Matrix of uncertainties; ordered Ixx, Iyy, Ixy, Ix, Iy.
Definition: simpleShape.h:207
bool operator!=(SimpleShapeResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
Definition: simpleShape.h:78
lsst::meas::base::FlagHandler const & getFlagHandler() const
Definition: simpleShape.h:84
static Eigen::Matrix< double, 5, 5 > correctWeightedMoments(afw::geom::ellipses::Quadrupole const &weight, afw::geom::ellipses::Quadrupole &ellipse, afw::geom::Point2D &center)
Correct moments measured with a Gaussian weight function by assuming the data was also an elliptical ...
Definition: simpleShape.cc:234
static Eigen::Matrix< double, 5, 6 > convertRawMoments(Eigen::Matrix< double, 6, 1 > const &q, afw::geom::ellipses::Quadrupole &quadrupole, afw::geom::Point2D &center)
Convert linear raw moments into an ellipse and centroid, and return the derivative of the conversion...
Definition: simpleShape.cc:203
static base::FlagDefinition const FAILURE
Definition: simpleShape.h:100
virtual void fail(afw::table::SourceRecord &measRecord, lsst::meas::base::MeasurementError *error=NULL) const
Definition: simpleShape.cc:399
SimpleShapeResult()
Constructor; initializes everything to Nan.
Definition: simpleShape.cc:310
SimpleShape(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
A C++ control class to handle SdssShapeAlgorithm&#39;s configuration.
Definition: simpleShape.h:43
static SimpleShapeResult computeMoments(afw::geom::ellipses::Ellipse const &weight, afw::image::MaskedImage< T > const &image, double nSigmaRegion=3.0)
Compute the Gaussian-weighted moments of an image.
Definition: simpleShape.cc:161
std::bitset< SimpleShape::N_FLAGS > flags
Definition: simpleShape.h:210
double nSigmaRegion
&quot;Maximum radius for pixels to include, in units of sigma&quot; ;
Definition: simpleShape.h:46
static SimpleShapeResultKey addFields(afw::table::Schema &schema, std::string const &name)
Definition: simpleShape.cc:319
afw::geom::Point2D center
Measured first moments, or the input center if !recentroid.
Definition: simpleShape.h:206
bool operator==(SimpleShapeResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
double sigma
&quot;Sigma of circular Gaussian used as weight function, in pixels&quot; ;
Definition: simpleShape.h:45
bool isValid() const
Return True if the key is valid.
virtual void set(afw::table::BaseRecord &record, SimpleShapeResult const &value) const
afw::geom::ellipses::Quadrupole ellipse
Measured second moments.
Definition: simpleShape.h:205
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Definition: simpleShape.cc:388