Represent a PSF as a linear combination of PCA (== Karhunen-Loeve) basis functions. More...

#include <PcaPsf.h>

Inheritance diagram for lsst::meas::algorithms::PcaPsf:

Public Types
enum	ImageOwnerEnum
typedef math::Kernel::Pixel	Pixel
typedef image::Image< Pixel >	Image

Public Member Functions
	PcaPsf (std::shared_ptr< afw::math::LinearCombinationKernel > kernel, geom::Point2D const &averagePosition=geom::Point2D())
	Constructor for a PcaPsf.
std::shared_ptr< afw::detection::Psf >	clone () const override
	Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x.
std::shared_ptr< afw::detection::Psf >	resized (int width, int height) const override
	Return a clone with specified kernel dimensions.
std::shared_ptr< afw::math::LinearCombinationKernel const >	getKernel () const
	PcaPsf always has a LinearCombinationKernel, so we can override getKernel to make it more useful.
geom::Point2D	getAveragePosition () const override
	Return average position of stars; used as default position.
bool	isPersistable () const noexcept override
	Whether this object is persistable; just delegates to the kernel.
std::shared_ptr< typehandling::Storable >	cloneStorable () const override
std::shared_ptr< Image >	computeImage (lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
std::shared_ptr< Image >	computeKernelImage (lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
double	computePeak (lsst::geom::Point2D position, image::Color color=image::Color()) const
double	computeApertureFlux (double radius, lsst::geom::Point2D position, image::Color color=image::Color()) const
geom::ellipses::Quadrupole	computeShape (lsst::geom::Point2D position, image::Color color=image::Color()) const
std::shared_ptr< math::Kernel const >	getLocalKernel (lsst::geom::Point2D position, image::Color color=image::Color()) const
image::Color	getAverageColor () const
lsst::geom::Box2I	computeBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
lsst::geom::Box2I	computeImageBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
lsst::geom::Box2I	computeKernelBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
std::size_t	getCacheCapacity () const
void	setCacheCapacity (std::size_t capacity)
virtual std::string	toString () const
virtual std::size_t	hash_value () const
virtual bool	equals (Storable const &other) const noexcept
virtual bool	equals (Storable const &other) const noexcept
void	writeFits (std::string const &fileName, std::string const &mode="w") const
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
void	writeFits (fits::Fits &fitsfile) const
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)

Static Public Member Functions
static std::shared_ptr< T >	readFits (fits::Fits &fitsfile)
static std::shared_ptr< T >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
static std::shared_ptr< T >	readFits (fits::Fits &fitsfile)
static std::shared_ptr< T >	readFits (fits::Fits &fitsfile)
static std::shared_ptr< Psf >	readFits (fits::Fits &fitsfile)
static std::shared_ptr< T >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
static std::shared_ptr< T >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
static std::shared_ptr< Psf >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
static std::shared_ptr< T >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
static std::shared_ptr< Image >	recenterKernelImage (std::shared_ptr< Image > im, lsst::geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)

Public Attributes
	COPY
	INTERNAL

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions
std::string	getPythonModule () const override
void	write (OutputArchiveHandle &handle) const override
virtual void	write (OutputArchiveHandle &handle) const
virtual double	doComputeApertureFlux (double radius, geom::Point2D const &position, afw::image::Color const &color) const
virtual afw::geom::ellipses::Quadrupole	doComputeShape (geom::Point2D const &position, afw::image::Color const &color) const
virtual std::shared_ptr< Image >	doComputeImage (lsst::geom::Point2D const &position, image::Color const &color) const
virtual lsst::geom::Box2I	doComputeImageBBox (lsst::geom::Point2D const &position, image::Color const &color) const

Static Protected Member Functions
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
static bool	singleClassEquals (T const &lhs, Storable const &rhs)

Private Member Functions
std::string	getPersistenceName () const override

Detailed Description

Represent a PSF as a linear combination of PCA (== Karhunen-Loeve) basis functions.

Definition at line 37 of file PcaPsf.h.

Constructor & Destructor Documentation

◆ PcaPsf()

lsst::meas::algorithms::PcaPsf::PcaPsf	(	std::shared_ptr< afw::math::LinearCombinationKernel >	kernel,
		geom::Point2D const &	averagePosition = geom::Point2D() )

explicit

Constructor for a PcaPsf.

Parameters

[in]	kernel	Kernel that defines the Psf.
[in]	averagePosition	Average position of stars used to construct the Psf.

Member Function Documentation

◆ clone()

std::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::PcaPsf::clone ( ) const

overridevirtual

Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x.

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

◆ doComputeApertureFlux()

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

protectedvirtualinherited

Implements lsst::afw::detection::Psf.

Definition at line 45 of file ImagePsf.cc.

◆ doComputeShape()

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

protectedvirtualinherited

Implements lsst::afw::detection::Psf.

Definition at line 65 of file ImagePsf.cc.

◆ getAveragePosition()

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

overridevirtualinherited

Return average position of stars; used as default position.

Reimplemented from lsst::afw::detection::Psf.

Definition at line 47 of file KernelPsf.cc.

◆ getKernel()

std::shared_ptr< afw::math::LinearCombinationKernel const > lsst::meas::algorithms::PcaPsf::getKernel ( ) const

PcaPsf always has a LinearCombinationKernel, so we can override getKernel to make it more useful.

◆ getPersistenceName()

std::string lsst::meas::algorithms::PcaPsf::getPersistenceName ( ) const

inlineoverrideprivatevirtual

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

Definition at line 59 of file PcaPsf.h.

◆ getPythonModule()

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

overrideprotectedvirtualinherited

Reimplemented from lsst::afw::detection::Psf.

Definition at line 70 of file KernelPsf.cc.

◆ isPersistable()

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

overridevirtualnoexceptinherited

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

Reimplemented from lsst::afw::detection::Psf.

Reimplemented in lsst::meas::algorithms::SingleGaussianPsf.

Definition at line 66 of file KernelPsf.cc.

◆ resized()

std::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::PcaPsf::resized	(	int	width,
		int	height ) const

overridevirtual

Return a clone with specified kernel dimensions.

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

◆ write()

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

overrideprotectedvirtualinherited

Reimplemented from lsst::afw::detection::Psf.

Reimplemented in lsst::meas::algorithms::SingleGaussianPsf.

Definition at line 72 of file KernelPsf.cc.

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

include/lsst/meas/algorithms/PcaPsf.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PcaPsf()

Member Function Documentation

◆ clone()

◆ doComputeApertureFlux()

◆ doComputeShape()

◆ getAveragePosition()

◆ getKernel()

◆ getPersistenceName()

◆ getPythonModule()

◆ isPersistable()

◆ resized()

◆ write()