Result object SdssShapeAlgorithm. More...

#include <SdssShape.h>

Inheritance diagram for lsst::meas::base::SdssShapeResult:

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 standard deviation elements from the given matrix, with rows and columns ordered (xx, yy, xy) More...

void	setShapeErr (ErrElement xxErr, ErrElement yyErr, ErrElement xyErr)
	Set the struct standard deviation 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...

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 _xErr, ErrElement _yErr)
	Set the struct uncertainty fields from the sigma values. More...

Public Attributes
ErrElement	instFlux_xx_Cov
	instFlux, xx term in the uncertainty covariance matrix More...

ErrElement	instFlux_yy_Cov
	instFlux, yy term in the uncertainty covariance matrix More...

ErrElement	instFlux_xy_Cov
	instFlux, xy term in the uncertainty covariance matrix More...

std::bitset< SdssShapeAlgorithm::N_FLAGS >	flags
	Status flags (see SdssShapeAlgorithm). More...

ShapeElement	xx
	image or model second moment for x^2 More...

ShapeElement	yy
	image or model second moment for y^2 More...

ShapeElement	xy
	image or model second moment for xy^2 More...

ErrElement	xxErr
	standard deviation of xx More...

ErrElement	yyErr
	standard deviation of yy More...

ErrElement	xyErr
	standard deviation of xy 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	xErr
	standard deviation of x More...

ErrElement	yErr
	standard deviation of y More...

ErrElement	x_y_Cov
	x,y term in the uncertainty convariance matrix More...

meas::base::Flux	instFlux
	Measured instFlux in DN. More...

meas::base::FluxErrElement	instFluxErr
	Standard deviation of instFlux 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 instFlux and the shape, but not between the instFlux 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 224 of file SdssShape.h.

Constructor & Destructor Documentation

◆ SdssShapeResult()

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

Constructor; initializes everything to NaN.

Definition at line 621 of file SdssShape.cc.

         : instFlux_xx_Cov(std::numeric_limits<ErrElement>::quiet_NaN()),
           instFlux_yy_Cov(std::numeric_limits<ErrElement>::quiet_NaN()),
           instFlux_xy_Cov(std::numeric_limits<ErrElement>::quiet_NaN()) {}

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

41 { return Centroid(x, y); }

lsst::meas::base::Centroid

geom::Point< CentroidElement, 2 > Centroid

Definition: constants.h:58

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

CentroidElement y

y (row) coordinate of the measured position

Definition: CentroidUtilities.h:43

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

CentroidElement x

x (column) coordinate of the measured position

Definition: CentroidUtilities.h:42

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

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

◆ getFlag() [1/2]

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

inline

Definition at line 236 of file SdssShape.h.

                                               {
         return flags[SdssShapeAlgorithm::getFlagDefinitions().getDefinition(name).number];
     }

◆ getFlag() [2/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 234 of file SdssShape.h.

234 { return flags[index]; }

◆ getPoint()

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

inlineinherited

Return the 2D point type corresponding to this result.

Definition at line 70 of file CentroidUtilities.h.

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

lsst::geom::Point

A coordinate class intended to represent absolute positions.

Definition: Point.h:169

◆ getQuadrupole()

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

inlineinherited

Definition at line 91 of file ShapeUtilities.h.

91 { return afw::geom::ellipses::Quadrupole(xx, yy, xy); }

lsst::meas::base::ShapeResult::xy

ShapeElement xy

image or model second moment for xy^2

Definition: ShapeUtilities.h:46

lsst::meas::base::ShapeResult::xx

ShapeElement xx

image or model second moment for x^2

Definition: ShapeUtilities.h:44

lsst::meas::base::ShapeResult::yy

ShapeElement yy

image or model second moment for y^2

Definition: ShapeUtilities.h:45

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

41 { return Shape(xx, yy, xy); }

lsst::meas::base::Shape

afw::geom::ellipses::Quadrupole Shape

Definition: constants.h:60

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

                                               {
     ShapeCov m;
     m << xxErr * xxErr, xx_yy_Cov, xx_xy_Cov, xx_yy_Cov, yyErr * yyErr, yy_xy_Cov, xx_xy_Cov,
             yy_xy_Cov, xyErr * xyErr;
     return m;
 }

◆ setCentroid()

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

inherited

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 )

inherited

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
	)

inherited

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;
 }

◆ setShape()

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

inherited

Set struct elements from the given Quadrupole object.

Definition at line 43 of file ShapeUtilities.cc.

                                              {
     xx = shape.getIxx();
     yy = shape.getIyy();
     xy = shape.getIxy();
 }

◆ setShapeErr() [1/2]

void lsst::meas::base::ShapeResult::setShapeErr	(	ErrElement	xxErr,
		ErrElement	yyErr,
		ErrElement	xyErr
	)

inherited

Set the struct standard deviation elements from the given values.

Definition at line 65 of file ShapeUtilities.cc.

                                                                                      {
     xxErr = _xxErr;
     yyErr = _yyErr;
     xyErr = _xyErr;
     xx_yy_Cov = 0.0;
     xx_xy_Cov = 0.0;
     yy_xy_Cov = 0.0;
 }

◆ setShapeErr() [2/2]

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

inherited

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

Definition at line 56 of file ShapeUtilities.cc.

                                                     {
     xxErr = std::sqrt(matrix(0, 0));
     yyErr = std::sqrt(matrix(1, 1));
     xyErr = std::sqrt(matrix(2, 2));
     xx_yy_Cov = matrix(0, 1);
     xx_xy_Cov = matrix(0, 2);
     yy_xy_Cov = matrix(1, 2);
 }

Member Data Documentation

◆ flags

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

Status flags (see SdssShapeAlgorithm).

Definition at line 230 of file SdssShape.h.

◆ instFlux

meas::base::Flux lsst::meas::base::FluxResult::instFlux

inherited

Measured instFlux in DN.

Definition at line 42 of file FluxUtilities.h.

◆ instFlux_xx_Cov

ErrElement lsst::meas::base::SdssShapeResult::instFlux_xx_Cov

instFlux, xx term in the uncertainty covariance matrix

Definition at line 226 of file SdssShape.h.

◆ instFlux_xy_Cov

ErrElement lsst::meas::base::SdssShapeResult::instFlux_xy_Cov

instFlux, xy term in the uncertainty covariance matrix

Definition at line 228 of file SdssShape.h.

◆ instFlux_yy_Cov

ErrElement lsst::meas::base::SdssShapeResult::instFlux_yy_Cov

instFlux, yy term in the uncertainty covariance matrix

Definition at line 227 of file SdssShape.h.

◆ instFluxErr

meas::base::FluxErrElement lsst::meas::base::FluxResult::instFluxErr

inherited

Standard deviation of instFlux in DN.

Definition at line 43 of file FluxUtilities.h.

◆ x

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

inherited

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

inherited

x,y term in the uncertainty convariance matrix

Definition at line 46 of file CentroidUtilities.h.

◆ xErr

ErrElement lsst::meas::base::CentroidResult::xErr

inherited

standard deviation of x

Definition at line 44 of file CentroidUtilities.h.

◆ xx

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

inherited

image or model second moment for x^2

Definition at line 44 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 51 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 50 of file ShapeUtilities.h.

◆ xxErr

ErrElement lsst::meas::base::ShapeResult::xxErr

inherited

standard deviation of xx

Definition at line 47 of file ShapeUtilities.h.

◆ xy

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

inherited

image or model second moment for xy^2

Definition at line 46 of file ShapeUtilities.h.

◆ xyErr

ErrElement lsst::meas::base::ShapeResult::xyErr

inherited

standard deviation of xy

Definition at line 49 of file ShapeUtilities.h.

◆ y

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

inherited

y (row) coordinate of the measured position

Definition at line 43 of file CentroidUtilities.h.

◆ yErr

ErrElement lsst::meas::base::CentroidResult::yErr

inherited

standard deviation of y

Definition at line 45 of file CentroidUtilities.h.

◆ yy

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

inherited

image or model second moment for y^2

Definition at line 45 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 52 of file ShapeUtilities.h.

◆ yyErr

ErrElement lsst::meas::base::ShapeResult::yyErr

inherited

standard deviation of yy

Definition at line 48 of file ShapeUtilities.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/include/lsst/meas/base/SdssShape.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/src/SdssShape.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SdssShapeResult()

Member Function Documentation

◆ getCentroid()

◆ getCentroidErr()

◆ getFlag() [1/2]

◆ getFlag() [2/2]

◆ getPoint()

◆ getQuadrupole()

◆ getShape()

◆ getShapeErr()

◆ setCentroid()

◆ setCentroidErr() [1/2]

◆ setCentroidErr() [2/2]

◆ setShape()

◆ setShapeErr() [1/2]

◆ setShapeErr() [2/2]

Member Data Documentation

◆ flags

◆ instFlux

◆ instFlux_xx_Cov

◆ instFlux_xy_Cov

◆ instFlux_yy_Cov

◆ instFluxErr

◆ x

◆ x_y_Cov

◆ xErr

◆ xx

◆ xx_xy_Cov

◆ xx_yy_Cov

◆ xxErr

◆ xy

◆ xyErr

◆ y

◆ yErr

◆ yy

◆ yy_xy_Cov

◆ yyErr