LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Public Attributes | List of all members
lsst::meas::base::CentroidResult Struct Reference

A reusable struct for centroid measurements. More...

#include <CentroidUtilities.h>

Inheritance diagram for lsst::meas::base::CentroidResult:
lsst::meas::base::SdssShapeResult

Public Member Functions

 CentroidResult ()
 Constructor; initializes everything to NaN. More...
 
 CentroidResult (CentroidElement x_, CentroidElement y_, CentroidCov const &matrix)
 Constructor; initializes everything from values. More...
 
 CentroidResult (CentroidElement x_, CentroidElement y_, ErrElement xErr_, ErrElement yErr_)
 Constructor; initializes everything from values. More...
 
Centroid const getCentroid () const
 Return a Point object containing the measured x and y. More...
 
void setCentroid (Centroid const &centroid)
 Set the struct fields from the given Point object. More...
 
geom::Point< CentroidElementgetPoint ()
 Return the 2D point type corresponding to this result. More...
 
CentroidCov const getCentroidErr () const
 Return the 2x2 symmetric covariance matrix, with rows and columns ordered (x, y) More...
 
void setCentroidErr (CentroidCov const &matrix)
 Set the struct uncertainty fields from the given matrix, with rows and columns ordered (x, y) More...
 
void setCentroidErr (ErrElement _xErr, ErrElement _yErr)
 Set the struct uncertainty fields from the sigma values. More...
 

Public Attributes

CentroidElement x
 x (column) coordinate of the measured position More...
 
CentroidElement y
 y (row) coordinate of the measured position More...
 
ErrElement xErr
 standard deviation of x More...
 
ErrElement yErr
 standard deviation of y More...
 
ErrElement x_y_Cov
 x,y term in the uncertainty convariance matrix More...
 

Detailed Description

A reusable struct for centroid measurements.

Definition at line 41 of file CentroidUtilities.h.

Constructor & Destructor Documentation

◆ CentroidResult() [1/3]

lsst::meas::base::CentroidResult::CentroidResult ( )

Constructor; initializes everything to NaN.

Definition at line 34 of file CentroidUtilities.cc.

CentroidElement y
y (row) coordinate of the measured position
CentroidElement x
x (column) coordinate of the measured position
ErrElement yErr
standard deviation of y
ErrElement x_y_Cov
x,y term in the uncertainty convariance matrix
ErrElement xErr
standard deviation of x

◆ CentroidResult() [2/3]

lsst::meas::base::CentroidResult::CentroidResult ( CentroidElement  x_,
CentroidElement  y_,
CentroidCov const &  matrix 
)
inlineexplicit

Constructor; initializes everything from values.

Definition at line 52 of file CentroidUtilities.h.

53  : x(x_),
54  y(y_),
55  xErr(std::sqrt(matrix(0, 0))),
56  yErr(std::sqrt(matrix(1, 1))),
57  x_y_Cov(matrix(0, 1)) {}
T sqrt(T... args)

◆ CentroidResult() [3/3]

lsst::meas::base::CentroidResult::CentroidResult ( CentroidElement  x_,
CentroidElement  y_,
ErrElement  xErr_,
ErrElement  yErr_ 
)
inlineexplicit

Constructor; initializes everything from values.

Definition at line 60 of file CentroidUtilities.h.

61  : x(x_), y(y_), xErr(xErr_), yErr(yErr_), x_y_Cov(0.0) {}

Member Function Documentation

◆ getCentroid()

Centroid const lsst::meas::base::CentroidResult::getCentroid ( ) const

Return a Point object containing the measured x and y.

Definition at line 41 of file CentroidUtilities.cc.

41 { return Centroid(x, y); }
geom::Point< CentroidElement, 2 > Centroid
Definition: constants.h:58

◆ getCentroidErr()

CentroidCov const lsst::meas::base::CentroidResult::getCentroidErr ( ) const

Return the 2x2 symmetric covariance matrix, with rows and columns ordered (x, y)

Definition at line 48 of file CentroidUtilities.cc.

48  {
49  CentroidCov m;
50  m << xErr * xErr, x_y_Cov, x_y_Cov, yErr * yErr;
51  return m;
52 }
int m
Definition: SpanSet.cc:48
Eigen::Matrix< ErrElement, 2, 2, Eigen::DontAlign > CentroidCov
Definition: constants.h:59

◆ getPoint()

geom::Point<CentroidElement> lsst::meas::base::CentroidResult::getPoint ( )
inline

Return the 2D point type corresponding to this result.

Definition at line 70 of file CentroidUtilities.h.

70 { return geom::Point<CentroidElement>(x, y); }
A coordinate class intended to represent absolute positions.
Definition: Point.h:169

◆ setCentroid()

void lsst::meas::base::CentroidResult::setCentroid ( Centroid const &  centroid)

Set the struct fields from the given Point object.

Definition at line 43 of file CentroidUtilities.cc.

43  {
44  x = centroid.getX();
45  y = centroid.getY();
46 }
UnitVector3d centroid(VertexIterator const begin, VertexIterator const end)

◆ setCentroidErr() [1/2]

void lsst::meas::base::CentroidResult::setCentroidErr ( CentroidCov const &  matrix)

Set the struct uncertainty fields from the given matrix, with rows and columns ordered (x, y)

Definition at line 54 of file CentroidUtilities.cc.

54  {
55  xErr = std::sqrt(matrix(0, 0));
56  yErr = std::sqrt(matrix(1, 1));
57  x_y_Cov = matrix(0, 1);
58 }

◆ setCentroidErr() [2/2]

void lsst::meas::base::CentroidResult::setCentroidErr ( ErrElement  _xErr,
ErrElement  _yErr 
)

Set the struct uncertainty fields from the sigma values.

Definition at line 60 of file CentroidUtilities.cc.

60  {
61  xErr = _xErr;
62  yErr = _yErr;
63  x_y_Cov = 0.0;
64 }

Member Data Documentation

◆ x

CentroidElement lsst::meas::base::CentroidResult::x

x (column) coordinate of the measured position

Definition at line 42 of file CentroidUtilities.h.

◆ x_y_Cov

ErrElement lsst::meas::base::CentroidResult::x_y_Cov

x,y term in the uncertainty convariance matrix

Definition at line 46 of file CentroidUtilities.h.

◆ xErr

ErrElement lsst::meas::base::CentroidResult::xErr

standard deviation of x

Definition at line 44 of file CentroidUtilities.h.

◆ y

CentroidElement lsst::meas::base::CentroidResult::y

y (row) coordinate of the measured position

Definition at line 43 of file CentroidUtilities.h.

◆ yErr

ErrElement lsst::meas::base::CentroidResult::yErr

standard deviation of y

Definition at line 45 of file CentroidUtilities.h.


The documentation for this struct was generated from the following files: