lsst.meas.base  13.0-26-g0f127ff+5
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...
 
- Public Member Functions inherited from lsst::meas::base::ShapeResult
 ShapeResult ()
 Constructor; initializes everything to NaN. More...
 
 ShapeResult (ShapeElement xx_, ShapeElement yy_, ShapeElement xy_, ShapeCov const &matrix)
 Constructor; initializes everything from values. More...
 
 ShapeResult (ShapeElement xx_, ShapeElement yy_, ShapeElement xy_, ErrElement xxSigma_, ErrElement yySigma_, ErrElement xySigma_)
 Constructor; initializes everything from values. 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...
 
- Public Member Functions inherited from lsst::meas::base::CentroidResult
 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 Member Functions inherited from lsst::meas::base::FluxResult
 FluxResult ()
 Default constructor; initializes everything to NaN. More...
 
 FluxResult (Flux flux_, FluxErrElement fluxSigma_)
 Constructor from flux and its uncertainty. 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...
 
- Public Attributes inherited from lsst::meas::base::ShapeResult
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...
 
- Public Attributes inherited from lsst::meas::base::CentroidResult
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...
 
- Public Attributes inherited from lsst::meas::base::FluxResult
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 238 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

◆ 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 248 of file SdssShape.h.

◆ getFlag() [2/2]

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

Definition at line 250 of file SdssShape.h.

Member Data Documentation

◆ flags

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

Status flags (see SdssShapeAlgorithm).

Definition at line 244 of file SdssShape.h.

◆ flux_xx_Cov

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

flux, xx term in the uncertainty covariance matrix

Definition at line 240 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 242 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 241 of file SdssShape.h.


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