lsst.meas.algorithms  13.0-24-g22030a45+11
Public Member Functions | Protected Member Functions | Friends | List of all members
lsst::meas::algorithms::SingleGaussianPsf Class Reference

Represent a PSF as a circularly symmetrical Gaussian. More...

#include <SingleGaussianPsf.h>

Inheritance diagram for lsst::meas::algorithms::SingleGaussianPsf:
lsst::meas::algorithms::KernelPsf lsst::meas::algorithms::ImagePsf

Public Member Functions

 SingleGaussianPsf (int width, int height, double sigma)
 Constructor for a SingleGaussianPsf. More...
 
virtual boost::shared_ptr< afw::detection::Psf > clone () const
 Polymorphic deep copy; should usually unnecessary because Psfs are immutable. More...
 
virtual boost::shared_ptr< afw::detection::Psf > resized (int width, int height) const
 Return a clone with specified kernel dimensions. More...
 
double getSigma () const
 Return the radius of the Gaussian. More...
 
virtual bool isPersistable () const
 Whether the Psf is persistable; always true. More...
 
boost::shared_ptr< afw::math::Kernel const > getKernel () const
 Return the Kernel used to define this Psf. More...
 
virtual afw::geom::Point2D getAveragePosition () const
 Return average position of stars; used as default position. More...
 

Protected Member Functions

virtual std::string getPersistenceName () const
 
virtual void write (OutputArchiveHandle &handle) const
 
virtual std::string getPythonModule () const
 
virtual double doComputeApertureFlux (double radius, afw::geom::Point2D const &position, afw::image::Color const &color) const
 
virtual afw::geom::ellipses::Quadrupole doComputeShape (afw::geom::Point2D const &position, afw::image::Color const &color) const
 

Friends

class boost::serialization::access
 

Detailed Description

Represent a PSF as a circularly symmetrical Gaussian.

Definition at line 37 of file SingleGaussianPsf.h.

Constructor & Destructor Documentation

◆ SingleGaussianPsf()

lsst::meas::algorithms::SingleGaussianPsf::SingleGaussianPsf ( int  width,
int  height,
double  sigma 
)
explicit

Constructor for a SingleGaussianPsf.

Parameters
[in]widthNumber of columns in realizations of the PSF at a point.
[in]heightNumber of rows in realizations of the PSF at a point.
[in]sigmaRadius of the Gaussian.

Additional arguments are historical and ignored, and maybe be removed in the future.

Member Function Documentation

◆ clone()

virtual boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::SingleGaussianPsf::clone ( ) const
virtual

Polymorphic deep copy; should usually unnecessary because Psfs are immutable.

Reimplemented from lsst::meas::algorithms::KernelPsf.

◆ doComputeApertureFlux()

double lsst::meas::algorithms::ImagePsf::doComputeApertureFlux ( double  radius,
afw::geom::Point2D const &  position,
afw::image::Color const &  color 
) const
protectedvirtualinherited

Definition at line 31 of file ImagePsf.cc.

◆ doComputeShape()

afw::geom::ellipses::Quadrupole lsst::meas::algorithms::ImagePsf::doComputeShape ( afw::geom::Point2D const &  position,
afw::image::Color const &  color 
) const
protectedvirtualinherited

Definition at line 46 of file ImagePsf.cc.

◆ getAveragePosition()

afw::geom::Point2D lsst::meas::algorithms::KernelPsf::getAveragePosition ( ) const
virtualinherited

Return average position of stars; used as default position.

Definition at line 33 of file KernelPsf.cc.

◆ getKernel()

boost::shared_ptr< afw::math::Kernel const > lsst::meas::algorithms::KernelPsf::getKernel ( ) const
inlineinherited

Return the Kernel used to define this Psf.

Definition at line 52 of file KernelPsf.h.

◆ getPersistenceName()

virtual std::string lsst::meas::algorithms::SingleGaussianPsf::getPersistenceName ( ) const
protectedvirtual

Reimplemented from lsst::meas::algorithms::KernelPsf.

◆ getPythonModule()

std::string lsst::meas::algorithms::KernelPsf::getPythonModule ( ) const
protectedvirtualinherited

Definition at line 60 of file KernelPsf.cc.

◆ getSigma()

double lsst::meas::algorithms::SingleGaussianPsf::getSigma ( ) const
inline

Return the radius of the Gaussian.

Definition at line 58 of file SingleGaussianPsf.h.

◆ isPersistable()

virtual bool lsst::meas::algorithms::SingleGaussianPsf::isPersistable ( ) const
inlinevirtual

Whether the Psf is persistable; always true.

Reimplemented from lsst::meas::algorithms::KernelPsf.

Definition at line 61 of file SingleGaussianPsf.h.

◆ resized()

virtual boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::SingleGaussianPsf::resized ( int  width,
int  height 
) const
virtual

Return a clone with specified kernel dimensions.

Reimplemented from lsst::meas::algorithms::KernelPsf.

◆ write()

virtual void lsst::meas::algorithms::SingleGaussianPsf::write ( OutputArchiveHandle &  handle) const
protectedvirtual

Reimplemented from lsst::meas::algorithms::KernelPsf.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 73 of file SingleGaussianPsf.h.


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