lsst.meas.extensions.simpleShape gcf0d15dbbd+c34e8be1fa
Loading...
Searching...
No Matches
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/geom.h"
31#include "lsst/afw/table.h"
32#include "lsst/afw/image.h"
34#include "lsst/meas/base.h"
35
36namespace lsst { namespace meas { namespace extensions { namespace simpleShape {
37
38class SimpleShapeResult;
39
45 public:
46 LSST_CONTROL_FIELD(sigma, double, "Sigma of circular Gaussian used as weight function, in pixels");
47 LSST_CONTROL_FIELD(nSigmaRegion, double, "Maximum radius for pixels to include, in units of sigma");
48
50};
51
52class SimpleShapeResultKey : public afw::table::FunctorKey<SimpleShapeResult> {
53 public:
56 std::string const & name
57 );
58
59 // Default constructor
61
72
73 virtual SimpleShapeResult get(afw::table::BaseRecord const & record) const;
74 virtual void set(afw::table::BaseRecord & record, SimpleShapeResult const & value) const;
75
77
78 bool operator==(SimpleShapeResultKey const & other) const;
79 bool operator!=(SimpleShapeResultKey const & other) const { return !(*this == other); }
81
83 bool isValid() const;
84
85 lsst::meas::base::FlagHandler const & getFlagHandler() const { return _flagHandler; }
86
87 private:
89 lsst::afw::table::Point2DKey _centroidResult;
92};
93
94
96public:
97
98 // Structures and routines to manage flaghandler
100 static unsigned int const N_FLAGS = 1;
102
104
105 SimpleShape(Control const & ctrl, std::string const & name, afw::table::Schema & schema);
106
117 template <typename T>
119 afw::geom::ellipses::Ellipse const & weight,
120 afw::image::MaskedImage<T> const & image,
121 double nSigmaRegion=3.0
122 );
123
151 static Eigen::Matrix<double,5,6> convertRawMoments(
152 Eigen::Matrix<double,6,1> const & q,
154 geom::Point2D & center
155 );
156
179 static Eigen::Matrix<double, 5, 5> correctWeightedMoments(
180 afw::geom::ellipses::Quadrupole const & weight,
182 geom::Point2D & center
183 );
184
185 virtual void measure(
186 afw::table::SourceRecord & measRecord,
187 afw::image::Exposure<float> const & exposure
188 ) const;
189
190 virtual void fail(
191 afw::table::SourceRecord & measRecord,
193 ) const;
194
195 private:
196 Control _ctrl;
197 SimpleShapeResultKey _resultKey;
199};
200
205 public:
208 Eigen::Matrix<double,5,5> covariance;
209
210#ifndef SWIG
212#endif
213
214 // Flag getter for Swig which doesn't understand std::bitset
215 bool getFlag(int index) const { return flags[index]; }
216
218};
219
220
221}}}} // namespace lsst::meas::extensions::simpleShape
222
223#endif // !LSST_MEAS_EXTENSIONS_simpleShape_h_INCLUDED
A C++ control class to handle SdssShapeAlgorithm's configuration.
Definition simpleShape.h:44
double sigma
"Sigma of circular Gaussian used as weight function, in pixels" ;
Definition simpleShape.h:46
double nSigmaRegion
"Maximum radius for pixels to include, in units of sigma" ;
Definition simpleShape.h:47
static Eigen::Matrix< double, 5, 5 > correctWeightedMoments(afw::geom::ellipses::Quadrupole const &weight, afw::geom::ellipses::Quadrupole &ellipse, geom::Point2D &center)
Correct moments measured with a Gaussian weight function by assuming the data was also an elliptical ...
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.
virtual void fail(afw::table::SourceRecord &measRecord, lsst::meas::base::MeasurementError *error=NULL) const
static base::FlagDefinitionList const & getFlagDefinitions()
static base::FlagDefinition const FAILURE
static Eigen::Matrix< double, 5, 6 > convertRawMoments(Eigen::Matrix< double, 6, 1 > const &q, afw::geom::ellipses::Quadrupole &quadrupole, geom::Point2D &center)
Convert linear raw moments into an ellipse and centroid, and return the derivative of the conversion.
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Struct to hold the results of SimpleShape when we don't run it as a plugin.
geom::Point2D center
Measured first moments, or the input center if !recentroid.
SimpleShapeResult()
Constructor; initializes everything to Nan.
Eigen::Matrix< double, 5, 5 > covariance
Matrix of uncertainties; ordered Ixx, Iyy, Ixy, Ix, Iy.
std::bitset< SimpleShape::N_FLAGS > flags
afw::geom::ellipses::Quadrupole ellipse
Measured second moments.
virtual SimpleShapeResult get(afw::table::BaseRecord const &record) const
bool operator!=(SimpleShapeResultKey const &other) const
Definition simpleShape.h:79
bool isValid() const
Return True if the key is valid.
bool operator==(SimpleShapeResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
lsst::meas::base::FlagHandler const & getFlagHandler() const
Definition simpleShape.h:85
static SimpleShapeResultKey addFields(afw::table::Schema &schema, std::string const &name)
table::Schema schema