LSSTApplications  8.0.0.0+107,8.0.0.1+13,9.1+18,9.2,master-g084aeec0a4,master-g0aced2eed8+6,master-g15627eb03c,master-g28afc54ef9,master-g3391ba5ea0,master-g3d0fb8ae5f,master-g4432ae2e89+36,master-g5c3c32f3ec+17,master-g60f1e072bb+1,master-g6a3ac32d1b,master-g76a88a4307+1,master-g7bce1f4e06+57,master-g8ff4092549+31,master-g98e65bf68e,master-ga6b77976b1+53,master-gae20e2b580+3,master-gb584cd3397+53,master-gc5448b162b+1,master-gc54cf9771d,master-gc69578ece6+1,master-gcbf758c456+22,master-gcec1da163f+63,master-gcf15f11bcc,master-gd167108223,master-gf44c96c709
LSSTDataManagementBasePackage
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 (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...
 
Shape const getShape () const
 Return an afw::geom::ellipses object corresponding to xx, yy, xy. More...
 
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...
 
- Public Member Functions inherited from lsst::meas::base::CentroidResult
 CentroidResult ()
 Constructor; initializes everything to NaN. 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...
 
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...
 
- 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

ShapeElement xy4
 A fourth moment used in lensing (RHL needs to clarify; not in the old docs) More...
 
ErrElement xy4Sigma
 1-Sigma uncertainty on xy4 More...
 
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 198 of file SdssShape.h.

Constructor & Destructor Documentation

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

Constructor; initializes everything to NaN.

Definition at line 743 of file SdssShape.cc.

743  :
744  xy4(std::numeric_limits<ShapeElement>::quiet_NaN()),
745  xy4Sigma(std::numeric_limits<ShapeElement>::quiet_NaN()),
746  flux_xx_Cov(std::numeric_limits<ErrElement>::quiet_NaN()),
747  flux_yy_Cov(std::numeric_limits<ErrElement>::quiet_NaN()),
748  flux_xy_Cov(std::numeric_limits<ErrElement>::quiet_NaN())
749 {}
ShapeElement xy4
A fourth moment used in lensing (RHL needs to clarify; not in the old docs)
Definition: SdssShape.h:200
ErrElement xy4Sigma
1-Sigma uncertainty on xy4
Definition: SdssShape.h:201
ErrElement flux_yy_Cov
flux, yy term in the uncertainty covariance matrix
Definition: SdssShape.h:203
ErrElement flux_xx_Cov
flux, xx term in the uncertainty covariance matrix
Definition: SdssShape.h:202
ErrElement flux_xy_Cov
flux, xy term in the uncertainty covariance matrix
Definition: SdssShape.h:204

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

211 { return flags[index]; }
std::bitset< SdssShapeAlgorithm::N_FLAGS > flags
Status flags (see SdssShapeAlgorithm).
Definition: SdssShape.h:207

Member Data Documentation

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

Status flags (see SdssShapeAlgorithm).

Definition at line 207 of file SdssShape.h.

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

flux, xx term in the uncertainty covariance matrix

Definition at line 202 of file SdssShape.h.

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

flux, xy term in the uncertainty covariance matrix

Definition at line 204 of file SdssShape.h.

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

flux, yy term in the uncertainty covariance matrix

Definition at line 203 of file SdssShape.h.

ShapeElement lsst::meas::base::SdssShapeResult::xy4

A fourth moment used in lensing (RHL needs to clarify; not in the old docs)

Definition at line 200 of file SdssShape.h.

ErrElement lsst::meas::base::SdssShapeResult::xy4Sigma

1-Sigma uncertainty on xy4

Definition at line 201 of file SdssShape.h.


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