lsst::meas::base::CentroidResult Struct Reference

A reusable struct for centroid measurements. More...

#include <CentroidUtilities.h>

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

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 _xSigma, ErrElement _ySigma)
	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...
afw::geom::Point< CentroidElement >	getPoint ()
	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 _xSigma, ErrElement _ySigma)
	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	xSigma
	1-Sigma uncertainty on x (sqrt of variance) More...
ErrElement	ySigma
	1-Sigma uncertainty on y (sqrt of variance) 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 36 of file CentroidUtilities.h.

Constructor & Destructor Documentation

lsst::meas::base::CentroidResult::CentroidResult

(

)

Constructor; initializes everything to NaN.

Definition at line 28 of file CentroidUtilities.cc.

                               :
    x(std::numeric_limits<CentroidElement>::quiet_NaN()),
    y(std::numeric_limits<CentroidElement>::quiet_NaN()),
    xSigma(std::numeric_limits<ErrElement>::quiet_NaN()),
    ySigma(std::numeric_limits<ErrElement>::quiet_NaN()),
    x_y_Cov(std::numeric_limits<ErrElement>::quiet_NaN())
{}

lsst::meas::base::CentroidResult::CentroidResult ( CentroidElement  _x, CentroidElement  _y, CentroidCov const &  matrix  )

inlineexplicit

Constructor; initializes everything from values.

Definition at line 47 of file CentroidUtilities.h.

                                                                                               :
        x(_x),
        y(_y),
        xSigma(std::sqrt(matrix(0, 0))),
        ySigma(std::sqrt(matrix(1, 1))),
        x_y_Cov(matrix(0,1))
    {}

lsst::meas::base::CentroidResult::CentroidResult ( CentroidElement  _x, CentroidElement  _y, ErrElement  _xSigma, ErrElement  _ySigma  )

inlineexplicit

Constructor; initializes everything from values.

Definition at line 56 of file CentroidUtilities.h.

                                                                    :
        x(_x),
        y(_y),
        xSigma(_xSigma),
        ySigma(_ySigma),
        x_y_Cov(0.0)
    {}

Member Function Documentation

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

(

)

const

Return a Point object containing the measured x and y.

Definition at line 36 of file CentroidUtilities.cc.

{ return Centroid(x, y); }

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

(

)

const

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

Definition at line 43 of file CentroidUtilities.cc.

                                                       {
    CentroidCov m;
    m <<
        xSigma*xSigma, x_y_Cov,
        x_y_Cov, ySigma*ySigma;
    return m;
}

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

inline

Return the 2D point type corresponding to this result.

Definition at line 72 of file CentroidUtilities.h.

    {
        return afw::geom::Point<CentroidElement>(x, y);
    }

void lsst::meas::base::CentroidResult::setCentroid

(

Centroid const &

centroid

)

Set the struct fields from the given Point object.

Definition at line 38 of file CentroidUtilities.cc.

                                                          {
    x = centroid.getX();
    y = centroid.getY();
}

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 51 of file CentroidUtilities.cc.

                                                              {
    xSigma = std::sqrt(matrix(0, 0));
    ySigma = std::sqrt(matrix(1, 1));
    x_y_Cov = matrix(0, 1);
}

void lsst::meas::base::CentroidResult::setCentroidErr	(	ErrElement	_xSigma,
		ErrElement	_ySigma
	)

Set the struct uncertainty fields from the sigma values.

Definition at line 57 of file CentroidUtilities.cc.

                                                                          {
    xSigma = _xSigma;
    ySigma = _ySigma;
    x_y_Cov = 0.0;
}

Member Data Documentation

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

x (column) coordinate of the measured position

Definition at line 37 of file CentroidUtilities.h.

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

x,y term in the uncertainty convariance matrix

Definition at line 41 of file CentroidUtilities.h.

ErrElement lsst::meas::base::CentroidResult::xSigma

1-Sigma uncertainty on x (sqrt of variance)

Definition at line 39 of file CentroidUtilities.h.

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

y (row) coordinate of the measured position

Definition at line 38 of file CentroidUtilities.h.

ErrElement lsst::meas::base::CentroidResult::ySigma

1-Sigma uncertainty on y (sqrt of variance)

Definition at line 40 of file CentroidUtilities.h.

---

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

• /home/lsstsw/stack/Linux64/meas_base/10.0-28-gf7f57a9+1/include/lsst/meas/base/CentroidUtilities.h
• /home/lsstsw/stack/Linux64/meas_base/10.0-28-gf7f57a9+1/src/CentroidUtilities.cc