lsst.meas.algorithms  13.0-23-gb99accf8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
lsst::meas::algorithms::PsfAttributes Class Reference

A class to contain various attributes of the Psf. More...

#include <PSF.h>

Public Types

enum  Method {
  ADAPTIVE_MOMENT, FIRST_MOMENT, SECOND_MOMENT, NOISE_EQUIVALENT,
  BICKERTON
}
 

Public Member Functions

 PsfAttributes (boost::shared_ptr< lsst::afw::detection::Psf const > psf, int const iX, int const iY)
 Constructor for PsfAttributes. More...
 
 PsfAttributes (boost::shared_ptr< lsst::afw::detection::Psf const > psf, lsst::afw::geom::Point2I const &cen)
 Constructor for PsfAttributes. More...
 
double computeGaussianWidth (Method how=ADAPTIVE_MOMENT) const
 Compute the 'sigma' value for an equivalent gaussian psf. More...
 
double computeEffectiveArea () const
 Compute the effective area of the psf ( sum(I)^2/sum(I^2) ) More...
 

Detailed Description

A class to contain various attributes of the Psf.

Deprecated:
This class is deprecated in favour of virtual methods on Psf

An example of the new API is:

* afwGeom::ellipses::Quadrupole shape = psf->computeShape();
* double const smoothingSigma = shape.getDeterminantRadius();
*

Definition at line 66 of file PSF.h.

Member Enumeration Documentation

Enumerator
ADAPTIVE_MOMENT 

Calculate width using adaptive Gaussian weights.

FIRST_MOMENT 

Calculate width using <r>

SECOND_MOMENT 

Calculate width using <r^2>

NOISE_EQUIVALENT 

Calculate width as sqrt(n_eff/(4 pi))

BICKERTON 

Weight <r^2> by I^2 to avoid negative fluxes.

Definition at line 68 of file PSF.h.

Constructor & Destructor Documentation

lsst::meas::algorithms::PsfAttributes::PsfAttributes ( boost::shared_ptr< lsst::afw::detection::Psf const >  psf,
int const  iX,
int const  iY 
)

Constructor for PsfAttributes.

Parameters
psfThe psf whose attributes we want
iXthe x position in the frame we want the attributes at
iYthe y position in the frame we want the attributes at

Definition at line 60 of file PsfAttributes.cc.

lsst::meas::algorithms::PsfAttributes::PsfAttributes ( boost::shared_ptr< lsst::afw::detection::Psf const >  psf,
lsst::afw::geom::Point2I const &  cen 
)

Constructor for PsfAttributes.

Parameters
psfThe psf whose attributes we want
centhe position in the frame we want the attributes at

Definition at line 73 of file PsfAttributes.cc.

Member Function Documentation

double lsst::meas::algorithms::PsfAttributes::computeEffectiveArea ( ) const

Compute the effective area of the psf ( sum(I)^2/sum(I^2) )

Definition at line 355 of file PsfAttributes.cc.

double lsst::meas::algorithms::PsfAttributes::computeGaussianWidth ( PsfAttributes::Method  how = ADAPTIVE_MOMENT) const

Compute the 'sigma' value for an equivalent gaussian psf.

Definition at line 300 of file PsfAttributes.cc.


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