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

A Psf defined by a Kernel. More...

#include <KernelPsf.h>

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

Public Member Functions

 KernelPsf (afw::math::Kernel const &kernel, afw::geom::Point2D const &averagePosition=afw::geom::Point2D())
 Construct a KernelPsf with a clone of the given kernel. 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...
 
virtual boost::shared_ptr< afw::detection::Psf > clone () const
 Polymorphic deep copy. More...
 
virtual boost::shared_ptr< afw::detection::Psf > resized (int width, int height) const
 Return a clone with specified kernel dimensions. More...
 
virtual bool isPersistable () const
 Whether this object is persistable; just delegates to the kernel. More...
 

Protected Member Functions

 KernelPsf (boost::shared_ptr< afw::math::Kernel > kernel, afw::geom::Point2D const &averagePosition=afw::geom::Point2D())
 Construct a KernelPsf with the given kernel; it should not be modified afterwards. More...
 
virtual std::string getPersistenceName () const
 
virtual std::string getPythonModule () const
 
virtual void write (OutputArchiveHandle &handle) 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

template<typename T , typename K >
class KernelPsfFactory
 

Detailed Description

A Psf defined by a Kernel.

Definition at line 33 of file KernelPsf.h.

Constructor & Destructor Documentation

◆ KernelPsf() [1/2]

lsst::meas::algorithms::KernelPsf::KernelPsf ( afw::math::Kernel const &  kernel,
afw::geom::Point2D const &  averagePosition = afw::geom::Point2D() 
)
explicit

Construct a KernelPsf with a clone of the given kernel.

We clone the Kernel in the public constructor to ensure the Psf is immutable after construction (we don't want someone with another copy of the Kernel to be able to modify the one held by the Psf).

Derived classes may use the protected constructor, which takes a shared_ptr to Kernel and does not copy it.

Definition at line 22 of file KernelPsf.cc.

◆ KernelPsf() [2/2]

lsst::meas::algorithms::KernelPsf::KernelPsf ( boost::shared_ptr< afw::math::Kernel >  kernel,
afw::geom::Point2D const &  averagePosition = afw::geom::Point2D() 
)
explicitprotected

Construct a KernelPsf with the given kernel; it should not be modified afterwards.

Definition at line 25 of file KernelPsf.cc.

Member Function Documentation

◆ clone()

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

◆ 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
virtual

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
inline

Return the Kernel used to define this Psf.

Definition at line 52 of file KernelPsf.h.

◆ getPersistenceName()

std::string lsst::meas::algorithms::KernelPsf::getPersistenceName ( ) const
protectedvirtual

◆ getPythonModule()

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

Definition at line 60 of file KernelPsf.cc.

◆ isPersistable()

bool lsst::meas::algorithms::KernelPsf::isPersistable ( ) const
virtual

Whether this object is persistable; just delegates to the kernel.

Reimplemented in lsst::meas::algorithms::DoubleGaussianPsf, and lsst::meas::algorithms::SingleGaussianPsf.

Definition at line 56 of file KernelPsf.cc.

◆ resized()

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

Return a clone with specified kernel dimensions.

Reimplemented in lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::DoubleGaussianPsf, and lsst::meas::algorithms::PcaPsf.

Definition at line 30 of file KernelPsf.cc.

◆ write()

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

Friends And Related Function Documentation

◆ KernelPsfFactory

template<typename T , typename K >
friend class KernelPsfFactory
friend

Definition at line 84 of file KernelPsf.h.


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