LSSTApplications  20.0.0
LSSTDataManagementBasePackage
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"
30 #include "lsst/afw/geom/ellipses.h"
31 #include "lsst/afw/table.h"
32 #include "lsst/afw/image.h"
34 #include "lsst/meas/base.h"
35 
36 namespace lsst { namespace meas { namespace extensions { namespace simpleShape {
37 
38 class 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 
52 class 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  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;
91  lsst::meas::base::FlagHandler _flagHandler;
92 };
93 
94 
96 public:
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>
121  double nSigmaRegion=3.0
122  );
123 
151  static Eigen::Matrix<double,5,6> convertRawMoments(
152  Eigen::Matrix<double,6,1> const & q,
153  afw::geom::ellipses::Quadrupole & quadrupole,
154  geom::Point2D & center
155  );
156 
179  static Eigen::Matrix<double, 5, 5> correctWeightedMoments(
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;
198  lsst::meas::base::SafeCentroidExtractor _centroidExtractor;
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
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::SimpleAlgorithm
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
std::bitset< SimpleShape::N_FLAGS >
lsst::meas::extensions::simpleShape::SimpleShape::FAILURE
static base::FlagDefinition const FAILURE
Definition: simpleShape.h:101
std::string
STL class.
lsst::log.log.logContinued.error
def error(fmt, *args)
Definition: logContinued.py:210
lsst::meas::extensions::simpleShape::SimpleShape::convertRawMoments
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.
Definition: simpleShape.cc:203
lsst::afw::table::SourceRecord
Record class that contains measurements made on a single exposure.
Definition: Source.h:80
lsst::afw::image::Exposure< float >
lsst::meas::extensions::simpleShape::SimpleShapeControl::nSigmaRegion
double nSigmaRegion
"Maximum radius for pixels to include, in units of sigma" ;
Definition: simpleShape.h:47
lsst::afw::table::FunctorKey
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition: FunctorKey.h:74
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::get
virtual SimpleShapeResult get(afw::table::BaseRecord const &record) const
Definition: simpleShape.cc:343
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::isValid
bool isValid() const
Return True if the key is valid.
Definition: simpleShape.cc:370
lsst::meas::extensions::simpleShape::SimpleShapeControl
A C++ control class to handle SdssShapeAlgorithm's configuration.
Definition: simpleShape.h:44
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::SimpleShapeResultKey
SimpleShapeResultKey()
Definition: simpleShape.h:60
lsst::meas::extensions::simpleShape::SimpleShapeResult
Struct to hold the results of SimpleShape when we don't run it as a plugin.
Definition: simpleShape.h:204
ellipses.h
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::getFlagHandler
lsst::meas::base::FlagHandler const & getFlagHandler() const
Definition: simpleShape.h:85
lsst::meas::base::MeasurementError
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
lsst::meas::extensions::simpleShape::SimpleShapeResult::flags
std::bitset< SimpleShape::N_FLAGS > flags
Definition: simpleShape.h:211
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::meas::base::SafeCentroidExtractor
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
Definition: InputUtilities.h:39
geom.h
lsst::meas::extensions::simpleShape::SimpleShapeResult::covariance
Eigen::Matrix< double, 5, 5 > covariance
Matrix of uncertainties; ordered Ixx, Iyy, Ixy, Ix, Iy.
Definition: simpleShape.h:208
lsst::afw::table::CovarianceMatrixKey< double, 5 >
lsst::meas::base::FlagDefinitionList
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
lsst::meas::extensions::simpleShape::SimpleShapeResult::ellipse
afw::geom::ellipses::Quadrupole ellipse
Measured second moments.
Definition: simpleShape.h:206
lsst::meas::extensions::simpleShape::SimpleShapeResult::getFlag
bool getFlag(int index) const
Definition: simpleShape.h:215
lsst::afw::table::PointKey< double >
lsst::meas::extensions::simpleShape::SimpleShape::correctWeightedMoments
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 ...
Definition: simpleShape.cc:234
lsst::meas::extensions::simpleShape::SimpleShape::N_FLAGS
static unsigned int const N_FLAGS
Definition: simpleShape.h:100
lsst::afw::image::MaskedImage
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
lsst::meas::extensions::simpleShape::SimpleShapeResultKey
Definition: simpleShape.h:52
lsst::afw::table::QuadrupoleKey
A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys.
Definition: aggregates.h:282
lsst::meas::base::FlagHandler
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::BaseRecord
Base class for all records.
Definition: BaseRecord.h:31
base.h
lsst::meas::extensions::simpleShape::SimpleShapeResult::center
geom::Point2D center
Measured first moments, or the input center if !recentroid.
Definition: simpleShape.h:207
lsst::meas::extensions::simpleShape::SimpleShape::SimpleShape
SimpleShape(Control const &ctrl, std::string const &name, afw::table::Schema &schema)
Definition: simpleShape.cc:378
image.h
LSST_CONTROL_FIELD
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::set
virtual void set(afw::table::BaseRecord &record, SimpleShapeResult const &value) const
Definition: simpleShape.cc:354
Algorithm.h
weight
afw::table::Key< double > weight
Definition: CoaddBoundedField.cc:166
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::geom::ellipses::Ellipse
An ellipse defined by an arbitrary BaseCore and a center point.
Definition: Ellipse.h:51
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::operator!=
bool operator!=(SimpleShapeResultKey const &other) const
Definition: simpleShape.h:79
lsst::afw::geom::ellipses::Quadrupole
An ellipse core with quadrupole moments as parameters.
Definition: Quadrupole.h:47
lsst::meas::base::FlagDefinition
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40
lsst::meas::extensions::simpleShape.name
name
Definition: __init__.py:8
lsst::afw::table::SubSchema
A proxy type for name lookups in a Schema.
Definition: Schema.h:357
lsst::geom::Point< double, 2 >
lsst::meas::extensions::simpleShape::SimpleShape::Control
SimpleShapeControl Control
Definition: simpleShape.h:103
lsst::meas::extensions::simpleShape::SimpleShape::computeMoments
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
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::operator==
bool operator==(SimpleShapeResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
Definition: simpleShape.cc:363
lsst::meas::extensions::simpleShape::SimpleShape::measure
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
Definition: simpleShape.cc:388
config.h
lsst::meas::extensions::simpleShape::SimpleShape::fail
virtual void fail(afw::table::SourceRecord &measRecord, lsst::meas::base::MeasurementError *error=NULL) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
Definition: simpleShape.cc:399
lsst::meas::extensions::simpleShape::SimpleShape
Definition: simpleShape.h:95
lsst::meas::extensions::simpleShape::SimpleShapeResult::SimpleShapeResult
SimpleShapeResult()
Constructor; initializes everything to Nan.
Definition: simpleShape.cc:310
lsst::meas::extensions::simpleShape::SimpleShapeControl::SimpleShapeControl
SimpleShapeControl()
Definition: simpleShape.h:49
lsst::meas::extensions::simpleShape::SimpleShape::getFlagDefinitions
static base::FlagDefinitionList const & getFlagDefinitions()
Definition: simpleShape.cc:37
table.h
lsst::meas::extensions::simpleShape::SimpleShapeControl::sigma
double sigma
"Sigma of circular Gaussian used as weight function, in pixels" ;
Definition: simpleShape.h:46
lsst::meas::extensions::simpleShape::SimpleShapeResultKey::addFields
static SimpleShapeResultKey addFields(afw::table::Schema &schema, std::string const &name)
Definition: simpleShape.cc:319