lsst.meas.base  13.0-33-gb1a1d47+8
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 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< 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 _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

◆ CentroidResult() [1/3]

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

Constructor; initializes everything to NaN.

Definition at line 29 of file CentroidUtilities.cc.

◆ CentroidResult() [2/3]

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.

◆ CentroidResult() [3/3]

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.

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

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

◆ getPoint()

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.

◆ setCentroid()

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

Set the struct fields from the given Point object.

Definition at line 39 of file CentroidUtilities.cc.

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

◆ setCentroidErr() [2/2]

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

Set the struct uncertainty fields from the sigma values.

Definition at line 58 of file CentroidUtilities.cc.

Member Data Documentation

◆ x

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

x (column) coordinate of the measured position

Definition at line 37 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 41 of file CentroidUtilities.h.

◆ xSigma

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

1-Sigma uncertainty on x (sqrt of variance)

Definition at line 39 of file CentroidUtilities.h.

◆ y

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

y (row) coordinate of the measured position

Definition at line 38 of file CentroidUtilities.h.

◆ ySigma

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: