Result object SdssShapeAlgorithm. More...

#include <SdssShape.h>

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

Public Member Functions
bool	getFlag (int index) const
	Flag getter for Swig, which doesn't understand std::bitset. More...

	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< 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 _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_FLAGS >	flags
	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 211 of file SdssShape.h.

Constructor & Destructor Documentation

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

Constructor; initializes everything to NaN.

Definition at line 640 of file SdssShape.cc.

                                  :
     flux_xx_Cov(std::numeric_limits<ErrElement>::quiet_NaN()),
     flux_yy_Cov(std::numeric_limits<ErrElement>::quiet_NaN()),
     flux_xy_Cov(std::numeric_limits<ErrElement>::quiet_NaN())
 {}

Member Function Documentation

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

inline

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

Definition at line 222 of file SdssShape.h.

222 { return flags[index]; }

lsst::meas::base::SdssShapeResult::flags

std::bitset< SdssShapeAlgorithm::N_FLAGS > flags

Status flags (see SdssShapeAlgorithm).

Definition: SdssShape.h:218

Member Data Documentation

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

Status flags (see SdssShapeAlgorithm).

Definition at line 218 of file SdssShape.h.

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

flux, xx term in the uncertainty covariance matrix

Definition at line 213 of file SdssShape.h.

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

flux, xy term in the uncertainty covariance matrix

Definition at line 215 of file SdssShape.h.

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

flux, yy term in the uncertainty covariance matrix

Definition at line 214 of file SdssShape.h.

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

/home/lsstsw/stack/Linux64/meas_base/11.0+1/include/lsst/meas/base/SdssShape.h
/home/lsstsw/stack/Linux64/meas_base/11.0+1/src/SdssShape.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation