A reusable struct for moments-based shape measurements. More...
#include <ShapeUtilities.h>
Public Member Functions | |
| ShapeResult () | |
| Constructor; initializes everything to NaN. More... | |
| ShapeResult (ShapeElement xx_, ShapeElement yy_, ShapeElement xy_, ShapeCov const &matrix) | |
| Constructor; initializes everything from values. More... | |
| ShapeResult (ShapeElement xx_, ShapeElement yy_, ShapeElement xy_, ErrElement xxErr_, ErrElement yyErr_, ErrElement xyErr_) | |
| Constructor; initializes everything from values. More... | |
| Shape const | getShape () const |
| Return an afw::geom::ellipses object corresponding to xx, yy, xy. More... | |
| afw::geom::ellipses::Quadrupole | getQuadrupole () |
| void | setShape (Shape const &shape) |
| Set struct elements from the given Quadrupole object. More... | |
| ShapeCov const | getShapeErr () const |
| Return the 3x3 symmetric covariance matrix, with rows and columns ordered (xx, yy, xy) More... | |
| void | setShapeErr (ShapeCov const &matrix) |
| Set the struct standard deviation elements from the given matrix, with rows and columns ordered (xx, yy, xy) More... | |
| void | setShapeErr (ErrElement xxErr, ErrElement yyErr, ErrElement xyErr) |
| Set the struct standard deviation elements from the given values. More... | |
Public Attributes | |
| ShapeElement | xx |
| image or model second moment for x^2 More... | |
| ShapeElement | yy |
| image or model second moment for y^2 More... | |
| ShapeElement | xy |
| image or model second moment for xy^2 More... | |
| ErrElement | xxErr |
| standard deviation of xx More... | |
| ErrElement | yyErr |
| standard deviation of yy More... | |
| ErrElement | xyErr |
| standard deviation of xy More... | |
| ErrElement | xx_yy_Cov |
| xx,yy term in the uncertainty convariance matrix More... | |
| ErrElement | xx_xy_Cov |
| xx,xy term in the uncertainty convariance matrix More... | |
| ErrElement | yy_xy_Cov |
| yy,xy term in the uncertainty convariance matrix More... | |
Detailed Description
A reusable struct for moments-based shape measurements.
Shape measurements and their errors should always be in pixels coordinates. This struct should generally be preferred over a custom struct with other ellipse parametrizations unless the measurement takes place in another parametrization and a transformation to this one would result in a loss of information or obfuscate the results of the measurement (i.e. use this one unless you have a good reason not to).
Definition at line 43 of file ShapeUtilities.h.
Constructor & Destructor Documentation
◆ ShapeResult() [1/3]
| lsst::meas::base::ShapeResult::ShapeResult | ( | ) |
Constructor; initializes everything to NaN.
Definition at line 30 of file ShapeUtilities.cc.
◆ ShapeResult() [2/3]
|
inlineexplicit |
Constructor; initializes everything from values.
Definition at line 58 of file ShapeUtilities.h.
◆ ShapeResult() [3/3]
|
inlineexplicit |
Constructor; initializes everything from values.
Definition at line 70 of file ShapeUtilities.h.
Member Function Documentation
◆ getQuadrupole()
|
inline |
Definition at line 91 of file ShapeUtilities.h.
◆ getShape()
| Shape const lsst::meas::base::ShapeResult::getShape | ( | ) | const |
Return an afw::geom::ellipses object corresponding to xx, yy, xy.
This method can be used to return an average radius for the measured shape, e.g. getShape().getDeterminantRadius()
Definition at line 41 of file ShapeUtilities.cc.
◆ getShapeErr()
| ShapeCov const lsst::meas::base::ShapeResult::getShapeErr | ( | ) | const |
Return the 3x3 symmetric covariance matrix, with rows and columns ordered (xx, yy, xy)
Definition at line 49 of file ShapeUtilities.cc.
◆ setShape()
| void lsst::meas::base::ShapeResult::setShape | ( | Shape const & | shape | ) |
Set struct elements from the given Quadrupole object.
Definition at line 43 of file ShapeUtilities.cc.
◆ setShapeErr() [1/2]
| void lsst::meas::base::ShapeResult::setShapeErr | ( | ShapeCov const & | matrix | ) |
Set the struct standard deviation elements from the given matrix, with rows and columns ordered (xx, yy, xy)
Definition at line 56 of file ShapeUtilities.cc.
◆ setShapeErr() [2/2]
| void lsst::meas::base::ShapeResult::setShapeErr | ( | ErrElement | xxErr, |
| ErrElement | yyErr, | ||
| ErrElement | xyErr | ||
| ) |
Set the struct standard deviation elements from the given values.
Definition at line 65 of file ShapeUtilities.cc.
Member Data Documentation
◆ xx
| ShapeElement lsst::meas::base::ShapeResult::xx |
image or model second moment for x^2
Definition at line 44 of file ShapeUtilities.h.
◆ xx_xy_Cov
| ErrElement lsst::meas::base::ShapeResult::xx_xy_Cov |
xx,xy term in the uncertainty convariance matrix
Definition at line 51 of file ShapeUtilities.h.
◆ xx_yy_Cov
| ErrElement lsst::meas::base::ShapeResult::xx_yy_Cov |
xx,yy term in the uncertainty convariance matrix
Definition at line 50 of file ShapeUtilities.h.
◆ xxErr
| ErrElement lsst::meas::base::ShapeResult::xxErr |
standard deviation of xx
Definition at line 47 of file ShapeUtilities.h.
◆ xy
| ShapeElement lsst::meas::base::ShapeResult::xy |
image or model second moment for xy^2
Definition at line 46 of file ShapeUtilities.h.
◆ xyErr
| ErrElement lsst::meas::base::ShapeResult::xyErr |
standard deviation of xy
Definition at line 49 of file ShapeUtilities.h.
◆ yy
| ShapeElement lsst::meas::base::ShapeResult::yy |
image or model second moment for y^2
Definition at line 45 of file ShapeUtilities.h.
◆ yy_xy_Cov
| ErrElement lsst::meas::base::ShapeResult::yy_xy_Cov |
yy,xy term in the uncertainty convariance matrix
Definition at line 52 of file ShapeUtilities.h.
◆ yyErr
| ErrElement lsst::meas::base::ShapeResult::yyErr |
standard deviation of yy
Definition at line 48 of file ShapeUtilities.h.
The documentation for this struct was generated from the following files:
- include/lsst/meas/base/ShapeUtilities.h
- src/ShapeUtilities.cc
