LSSTApplications  20.0.0
LSSTDataManagementBasePackage
ShapeUtilities.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_ShapeUtilities_h_INCLUDED
25 #define LSST_MEAS_BASE_ShapeUtilities_h_INCLUDED
26 
30 
31 namespace lsst {
32 namespace meas {
33 namespace base {
34 
43 struct ShapeResult {
53 
55  ShapeResult();
56 
58  explicit ShapeResult(ShapeElement xx_, ShapeElement yy_, ShapeElement xy_, ShapeCov const& matrix)
59  : xx(xx_),
60  yy(yy_),
61  xy(xy_),
62  xxErr(std::sqrt(matrix(0, 0))),
63  yyErr(std::sqrt(matrix(1, 1))),
64  xyErr(std::sqrt(matrix(2, 2))),
65  xx_yy_Cov(matrix(0, 1)),
66  xx_xy_Cov(matrix(0, 2)),
67  yy_xy_Cov(matrix(1, 2)) {}
68 
71  ErrElement yyErr_, ErrElement xyErr_)
72  : xx(xx_),
73  yy(yy_),
74  xy(xy_),
75  xxErr(xxErr_),
76  yyErr(yyErr_),
77  xyErr(xyErr_),
78  xx_yy_Cov(0.0),
79  xx_xy_Cov(0.0),
80  yy_xy_Cov(0.0) {}
81 
88  Shape const getShape() const;
89 
90  // get the Quadrupole corresponding to this ShapeResult
92 
94  void setShape(Shape const& shape);
95 
97  ShapeCov const getShapeErr() const;
98 
101  void setShapeErr(ShapeCov const& matrix);
102 
105 };
106 
113 class ShapeResultKey : public afw::table::FunctorKey<ShapeResult> {
114 public:
127  std::string const& doc, UncertaintyEnum uncertainty,
129 
131  ShapeResultKey() : _shape(), _shapeErr() {}
132 
136  : _shape(shape), _shapeErr(shapeErr) {}
137 
148 
150  virtual ShapeResult get(afw::table::BaseRecord const& record) const;
151 
153  virtual void set(afw::table::BaseRecord& record, ShapeResult const& value) const;
154 
156  bool operator==(ShapeResultKey const& other) const {
158  return _shape == other._shape && _shapeErr == other._shapeErr;
159  }
160  bool operator!=(ShapeResultKey const& other) const { return !(*this == other); }
162 
164  bool isValid() const { return _shape.isValid() && _shapeErr.isValid(); }
165 
167  afw::table::QuadrupoleKey getShape() const { return _shape; }
168 
171 
173  afw::table::Key<ShapeElement> getIxx() const { return _shape.getIxx(); }
174 
176  afw::table::Key<ShapeElement> getIyy() const { return _shape.getIyy(); }
177 
179  afw::table::Key<ShapeElement> getIxy() const { return _shape.getIxy(); }
180 
181 private:
184 };
185 
207 
208 } // namespace base
209 } // namespace meas
210 } // namespace lsst
211 
212 #endif // !LSST_MEAS_BASE_ShapeUtilities_h_INCLUDED
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::meas::base::ShapeResult::xy
ShapeElement xy
image or model second moment for xy^2
Definition: ShapeUtilities.h:46
lsst::afw::table::CoordinateType::PIXEL
@ PIXEL
lsst::meas::base::ShapeResult::ShapeResult
ShapeResult(ShapeElement xx_, ShapeElement yy_, ShapeElement xy_, ShapeCov const &matrix)
Constructor; initializes everything from values.
Definition: ShapeUtilities.h:58
std::string
STL class.
lsst::meas::base::UncertaintyEnum
UncertaintyEnum
An enum used to specify how much uncertainty information measurement algorithms provide.
Definition: constants.h:43
lsst::meas::base::ShapeCov
Eigen::Matrix< ErrElement, 3, 3, Eigen::DontAlign > ShapeCov
Definition: constants.h:61
lsst::meas::base::ShapeResult::xxErr
ErrElement xxErr
standard deviation of xx
Definition: ShapeUtilities.h:47
lsst::meas::base::ShapeResultKey::getShape
afw::table::QuadrupoleKey getShape() const
Return a FunctorKey to just the shape value.
Definition: ShapeUtilities.h:167
lsst::meas::base::ShapeResultKey::getShapeErr
afw::table::CovarianceMatrixKey< ErrElement, 3 > getShapeErr() const
Return a FunctorKey to just the uncertainty matrix.
Definition: ShapeUtilities.h:170
lsst::meas::base::ShapeResult::xyErr
ErrElement xyErr
standard deviation of xy
Definition: ShapeUtilities.h:49
base
Definition: __init__.py:1
lsst::meas::base::ShapeResult::yy_xy_Cov
ErrElement yy_xy_Cov
yy,xy term in the uncertainty convariance matrix
Definition: ShapeUtilities.h:52
lsst::afw::table::FunctorKey
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition: FunctorKey.h:74
lsst::meas::base::ShapeResultKey::getIxy
afw::table::Key< ShapeElement > getIxy() const
Return a Key for the xy moment.
Definition: ShapeUtilities.h:179
lsst::meas::base::ShapeResult::ShapeResult
ShapeResult(ShapeElement xx_, ShapeElement yy_, ShapeElement xy_, ErrElement xxErr_, ErrElement yyErr_, ErrElement xyErr_)
Constructor; initializes everything from values.
Definition: ShapeUtilities.h:70
lsst::geom::LinearTransform
A 2D linear coordinate transformation.
Definition: LinearTransform.h:69
lsst::meas::base::ShapeResult::ShapeResult
ShapeResult()
Constructor; initializes everything to NaN.
Definition: ShapeUtilities.cc:30
lsst::afw::table::QuadrupoleKey::getIyy
Key< double > getIyy() const noexcept
Definition: aggregates.h:347
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::meas::base::ShapeResultKey
A FunctorKey for ShapeResult.
Definition: ShapeUtilities.h:113
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
aggregates.h
lsst::meas::base::ShapeResult::yyErr
ErrElement yyErr
standard deviation of yy
Definition: ShapeUtilities.h:48
lsst::afw::table::CovarianceMatrixKey< ErrElement, 3 >
lsst::meas::base::ShapeTrMatrix
Eigen::Matrix< ShapeElement, 3, 3, Eigen::DontAlign > ShapeTrMatrix
Definition: constants.h:62
lsst::afw::table::CovarianceMatrixKey::isValid
bool isValid() const noexcept
Return True if all the constituent error Keys are valid.
Definition: aggregates.cc:294
lsst::afw::table::CoordinateType
CoordinateType
Enum used to set units for geometric FunctorKeys.
Definition: aggregates.h:277
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::ShapeResultKey::getIyy
afw::table::Key< ShapeElement > getIyy() const
Return a Key for the yy moment.
Definition: ShapeUtilities.h:176
lsst::meas::base::ShapeResultKey::addFields
static ShapeResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, UncertaintyEnum uncertainty, afw::table::CoordinateType coordType=afw::table::CoordinateType::PIXEL)
Add the appropriate fields to a Schema, and return a ShapeResultKey that manages them.
Definition: ShapeUtilities.cc:74
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::BaseRecord
Base class for all records.
Definition: BaseRecord.h:31
lsst::meas::base::ShapeResult::setShapeErr
void setShapeErr(ShapeCov const &matrix)
Set the struct standard deviation elements from the given matrix, with rows and columns ordered (xx,...
Definition: ShapeUtilities.cc:56
lsst::meas::base::ShapeResultKey::operator!=
bool operator!=(ShapeResultKey const &other) const
Definition: ShapeUtilities.h:160
lsst::afw::table::Key
A class used as a handle to a particular field in a table.
Definition: fwd.h:45
LinearTransform.h
lsst::meas::base::ShapeResult::yy
ShapeElement yy
image or model second moment for y^2
Definition: ShapeUtilities.h:45
lsst::meas::base::ShapeResultKey::ShapeResultKey
ShapeResultKey(afw::table::QuadrupoleKey const &shape, afw::table::CovarianceMatrixKey< ErrElement, 3 > const &shapeErr)
Construct from a pair of Keys.
Definition: ShapeUtilities.h:134
lsst::meas::base::ShapeResult::xx_xy_Cov
ErrElement xx_xy_Cov
xx,xy term in the uncertainty convariance matrix
Definition: ShapeUtilities.h:51
lsst::meas::base::ShapeResultKey::get
virtual ShapeResult get(afw::table::BaseRecord const &record) const
Get a ShapeResult from the given record.
Definition: ShapeUtilities.cc:127
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::ShapeResult::xx_yy_Cov
ErrElement xx_yy_Cov
xx,yy term in the uncertainty convariance matrix
Definition: ShapeUtilities.h:50
lsst::afw::geom::ellipses::Quadrupole
An ellipse core with quadrupole moments as parameters.
Definition: Quadrupole.h:47
lsst::meas::base::ShapeResultKey::ShapeResultKey
ShapeResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: ShapeUtilities.h:131
lsst::meas::base::ShapeResult::getQuadrupole
afw::geom::ellipses::Quadrupole getQuadrupole()
Definition: ShapeUtilities.h:91
lsst::meas::base::makeShapeTransformMatrix
ShapeTrMatrix makeShapeTransformMatrix(geom::LinearTransform const &xform)
Construct a matrix suitable for transforming second moments.
Definition: ShapeUtilities.cc:143
lsst::meas::base::ErrElement
float ErrElement
Definition: constants.h:55
lsst::afw::table::SubSchema
A proxy type for name lookups in a Schema.
Definition: Schema.h:357
std
STL namespace.
lsst::meas::base::ShapeResult::getShape
Shape const getShape() const
Return an afw::geom::ellipses object corresponding to xx, yy, xy.
Definition: ShapeUtilities.cc:41
lsst::meas::base::ShapeResult::getShapeErr
ShapeCov const getShapeErr() const
Return the 3x3 symmetric covariance matrix, with rows and columns ordered (xx, yy,...
Definition: ShapeUtilities.cc:49
lsst::afw::table::QuadrupoleKey::getIxx
Key< double > getIxx() const noexcept
Return a constituent Key.
Definition: aggregates.h:346
constants.h
lsst::meas::base::ShapeResult::setShape
void setShape(Shape const &shape)
Set struct elements from the given Quadrupole object.
Definition: ShapeUtilities.cc:43
lsst::meas::base::ShapeResult
A reusable struct for moments-based shape measurements.
Definition: ShapeUtilities.h:43
lsst::meas::base::ShapeResultKey::set
virtual void set(afw::table::BaseRecord &record, ShapeResult const &value) const
Set a ShapeResult in the given record.
Definition: ShapeUtilities.cc:136
lsst::meas::base::ShapeResult::xx
ShapeElement xx
image or model second moment for x^2
Definition: ShapeUtilities.h:44
lsst::meas::base::ShapeElement
double ShapeElement
Definition: constants.h:57
lsst::meas::base::ShapeResultKey::operator==
bool operator==(ShapeResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
Definition: ShapeUtilities.h:157
lsst::meas::base::ShapeResultKey::isValid
bool isValid() const
Return True if the shape key is valid.
Definition: ShapeUtilities.h:164
lsst::afw::table::QuadrupoleKey::getIxy
Key< double > getIxy() const noexcept
Definition: aggregates.h:348
lsst::meas::base::ShapeResultKey::getIxx
afw::table::Key< ShapeElement > getIxx() const
Return a Key for the xx moment.
Definition: ShapeUtilities.h:173
lsst::afw::table::QuadrupoleKey::isValid
bool isValid() const noexcept
Return True if all the constituent Keys are valid.
Definition: aggregates.h:342