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

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

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.

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

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.

            : x(x_),
              y(y_),
              xErr(std::sqrt(matrix(0, 0))),
              yErr(std::sqrt(matrix(1, 1))),
              x_y_Cov(matrix(0, 1)) {}

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.

            : 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.

{ return Centroid(x, y); }

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.

                                                       {
    CentroidCov m;
    m << xErr * xErr, x_y_Cov, x_y_Cov, yErr * yErr;
    return m;
}

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.

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

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.

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

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.

                                                             {
    xErr = std::sqrt(matrix(0, 0));
    yErr = std::sqrt(matrix(1, 1));
    x_y_Cov = matrix(0, 1);
}

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.

                                                                      {
    xErr = _xErr;
    yErr = _yErr;
    x_y_Cov = 0.0;
}

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_base/g3e17d7035e+5b3adc59f5/include/lsst/meas/base/CentroidUtilities.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_base/g3e17d7035e+5b3adc59f5/src/CentroidUtilities.cc