lsst.meas.base  14.0-21-gb9e430a+4
Public Member Functions | Public Attributes | List of all members
lsst::meas::base::SdssShapeResult Class Reference

Result object SdssShapeAlgorithm. More...

#include <SdssShape.h>

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

Public Member Functions

bool getFlag (unsigned int index) const
 Flag getter for Swig, which doesn't understand std::bitset. More...
 
bool getFlag (std::string const &name) const
 
 SdssShapeResult ()
 Constructor; initializes everything to NaN. 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 uncertainty elements from the given matrix, with rows and columns ordered (xx, yy, xy) More...
 
void setShapeErr (ErrElement xxSigma, ErrElement yySigma, ErrElement xySigma)
 Set the struct uncertainty elements from the given 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

ErrElement flux_xx_Cov
 flux, xx term in the uncertainty covariance matrix More...
 
ErrElement flux_yy_Cov
 flux, yy term in the uncertainty covariance matrix More...
 
ErrElement flux_xy_Cov
 flux, xy term in the uncertainty covariance matrix More...
 
std::bitset< SdssShapeAlgorithm::N_FLAGSflags
 Status flags (see SdssShapeAlgorithm). More...
 
ShapeElement xx
 
ShapeElement yy
 
ShapeElement xy
 
ErrElement xxSigma
 1-Sigma uncertainty on xx (sqrt of variance) More...
 
ErrElement yySigma
 1-Sigma uncertainty on yy (sqrt of variance) More...
 
ErrElement xySigma
 1-Sigma uncertainty on xy (sqrt of variance) 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...
 
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...
 
Flux flux
 Measured flux in DN. More...
 
FluxErrElement fluxSigma
 1-Sigma error (sqrt of variance) on flux in DN. More...
 

Detailed Description

Result object SdssShapeAlgorithm.

Because we have use cases for running SdssShape outside of the measurement framework (in particular, we need to run it on PSF model images), we provide an interface that doesn't need to use SourceRecord for its inputs and outputs. Instead, it returns an instance of this class.

Note: for what I guess are historical reasons, SdssShape computes covariance terms between the flux and the shape, but not between the flux and centroid or centroid and shape.

This should logically be an inner class, but Swig doesn't know how to parse those.

Definition at line 240 of file SdssShape.h.

Constructor & Destructor Documentation

◆ SdssShapeResult()

lsst::meas::base::SdssShapeResult::SdssShapeResult ( )

Constructor; initializes everything to NaN.

Definition at line 660 of file SdssShape.cc.

Member Function Documentation

◆ getCentroid()

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

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
inherited

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

Definition at line 44 of file CentroidUtilities.cc.

◆ getFlag() [1/2]

bool lsst::meas::base::SdssShapeResult::getFlag ( unsigned int  index) const
inline

Flag getter for Swig, which doesn't understand std::bitset.

Definition at line 250 of file SdssShape.h.

◆ getFlag() [2/2]

bool lsst::meas::base::SdssShapeResult::getFlag ( std::string const &  name) const
inline

Definition at line 252 of file SdssShape.h.

◆ getPoint()

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

Return the 2D point type corresponding to this result.

Definition at line 74 of file CentroidUtilities.h.

◆ getQuadrupole()

afw::geom::ellipses::Quadrupole lsst::meas::base::ShapeResult::getQuadrupole ( )
inlineinherited

Definition at line 90 of file ShapeUtilities.h.

◆ getShape()

Shape const lsst::meas::base::ShapeResult::getShape ( ) const
inherited

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 40 of file ShapeUtilities.cc.

◆ getShapeErr()

ShapeCov const lsst::meas::base::ShapeResult::getShapeErr ( ) const
inherited

Return the 3x3 symmetric covariance matrix, with rows and columns ordered (xx, yy, xy)

Definition at line 48 of file ShapeUtilities.cc.

◆ setCentroid()

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

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)
inherited

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 
)
inherited

Set the struct uncertainty fields from the sigma values.

Definition at line 58 of file CentroidUtilities.cc.

◆ setShape()

void lsst::meas::base::ShapeResult::setShape ( Shape const &  shape)
inherited

Set struct elements from the given Quadrupole object.

Definition at line 42 of file ShapeUtilities.cc.

◆ setShapeErr() [1/2]

void lsst::meas::base::ShapeResult::setShapeErr ( ShapeCov const &  matrix)
inherited

Set the struct uncertainty elements from the given matrix, with rows and columns ordered (xx, yy, xy)

Definition at line 57 of file ShapeUtilities.cc.

◆ setShapeErr() [2/2]

void lsst::meas::base::ShapeResult::setShapeErr ( ErrElement  xxSigma,
ErrElement  yySigma,
ErrElement  xySigma 
)
inherited

Set the struct uncertainty elements from the given values.

Definition at line 66 of file ShapeUtilities.cc.

Member Data Documentation

◆ flags

std::bitset<SdssShapeAlgorithm::N_FLAGS> lsst::meas::base::SdssShapeResult::flags

Status flags (see SdssShapeAlgorithm).

Definition at line 246 of file SdssShape.h.

◆ flux

Flux lsst::meas::base::FluxResult::flux
inherited

Measured flux in DN.

Definition at line 40 of file FluxUtilities.h.

◆ flux_xx_Cov

ErrElement lsst::meas::base::SdssShapeResult::flux_xx_Cov

flux, xx term in the uncertainty covariance matrix

Definition at line 242 of file SdssShape.h.

◆ flux_xy_Cov

ErrElement lsst::meas::base::SdssShapeResult::flux_xy_Cov

flux, xy term in the uncertainty covariance matrix

Definition at line 244 of file SdssShape.h.

◆ flux_yy_Cov

ErrElement lsst::meas::base::SdssShapeResult::flux_yy_Cov

flux, yy term in the uncertainty covariance matrix

Definition at line 243 of file SdssShape.h.

◆ fluxSigma

FluxErrElement lsst::meas::base::FluxResult::fluxSigma
inherited

1-Sigma error (sqrt of variance) on flux in DN.

Definition at line 41 of file FluxUtilities.h.

◆ x

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

x (column) coordinate of the measured position

Definition at line 39 of file CentroidUtilities.h.

◆ x_y_Cov

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

x,y term in the uncertainty convariance matrix

Definition at line 43 of file CentroidUtilities.h.

◆ xSigma

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

1-Sigma uncertainty on x (sqrt of variance)

Definition at line 41 of file CentroidUtilities.h.

◆ xx

ShapeElement lsst::meas::base::ShapeResult::xx
inherited

Definition at line 41 of file ShapeUtilities.h.

◆ xx_xy_Cov

ErrElement lsst::meas::base::ShapeResult::xx_xy_Cov
inherited

xx,xy term in the uncertainty convariance matrix

Definition at line 48 of file ShapeUtilities.h.

◆ xx_yy_Cov

ErrElement lsst::meas::base::ShapeResult::xx_yy_Cov
inherited

xx,yy term in the uncertainty convariance matrix

Definition at line 47 of file ShapeUtilities.h.

◆ xxSigma

ErrElement lsst::meas::base::ShapeResult::xxSigma
inherited

1-Sigma uncertainty on xx (sqrt of variance)

Definition at line 44 of file ShapeUtilities.h.

◆ xy

ShapeElement lsst::meas::base::ShapeResult::xy
inherited

Definition at line 43 of file ShapeUtilities.h.

◆ xySigma

ErrElement lsst::meas::base::ShapeResult::xySigma
inherited

1-Sigma uncertainty on xy (sqrt of variance)

Definition at line 46 of file ShapeUtilities.h.

◆ y

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

y (row) coordinate of the measured position

Definition at line 40 of file CentroidUtilities.h.

◆ ySigma

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

1-Sigma uncertainty on y (sqrt of variance)

Definition at line 42 of file CentroidUtilities.h.

◆ yy

ShapeElement lsst::meas::base::ShapeResult::yy
inherited

Definition at line 42 of file ShapeUtilities.h.

◆ yy_xy_Cov

ErrElement lsst::meas::base::ShapeResult::yy_xy_Cov
inherited

yy,xy term in the uncertainty convariance matrix

Definition at line 49 of file ShapeUtilities.h.

◆ yySigma

ErrElement lsst::meas::base::ShapeResult::yySigma
inherited

1-Sigma uncertainty on yy (sqrt of variance)

Definition at line 45 of file ShapeUtilities.h.


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