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

#include <PsfexPsf.h>

Inheritance diagram for lsst::meas::extensions::psfex::PsfexPsf:

Public Types
enum	ImageOwnerEnum

typedef math::Kernel::Pixel	Pixel

typedef image::Image< Pixel >	Image

typedef unsigned long	memId

typedef memId(*	memNewCallback) (const memId cid)

typedef memId(*	memCallback) (const Citizen *ptr)

typedef std::shared_ptr< Persistable >	Ptr

Public Member Functions
	PsfexPsf (lsst::meas::extensions::psfex::Psf const &psf, lsst::afw::geom::Point2D const &averagePosition=lsst::afw::geom::Point2D())
	Constructor for a PsfexPsf. More...

virtual	~PsfexPsf ()

virtual boost::shared_ptr< lsst::afw::detection::Psf >	clone () const
	Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x. More...

virtual boost::shared_ptr< afw::detection::Psf >	resized (int width, int height) const
	Return a clone with specified kernel dimensions. More...

virtual lsst::afw::geom::Point2D	getAveragePosition () const
	Return average position of stars; used as default position. More...

boost::shared_ptr< lsst::afw::math::LinearCombinationKernel const >	getKernel (lsst::afw::geom::Point2D=lsst::afw::geom::Point2D(std::numeric_limits< double >::quiet_NaN())) const
	Return the PSF's basis functions as a spatially-invariant LinearCombinationKernel with unit weights. More...

virtual bool	isPersistable () const
	Is this object persistable? More...

void	write (lsst::afw::table::io::OutputArchiveHandle &handle) const

std::shared_ptr< Image >	computeImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const

std::shared_ptr< Image >	computeKernelImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const

double	computePeak (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const

double	computeApertureFlux (double radius, geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const

geom::ellipses::Quadrupole	computeShape (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const

std::shared_ptr< math::Kernel const >	getLocalKernel (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const

image::Color	getAverageColor () const

geom::Box2I	computeBBox (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const

std::size_t	getCacheCapacity () const

void	setCacheCapacity (std::size_t capacity)

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::string	repr () const

void	markPersistent (void)

memId	getId () const

void	serialize (Archive &, unsigned int const)

Static Public Member Functions
static std::shared_ptr< PsfexPsf >	readFits (fits::Fits &fitsfile)

static std::shared_ptr< PsfexPsf >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)

static std::shared_ptr< PsfexPsf >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)

static std::shared_ptr< Image >	recenterKernelImage (std::shared_ptr< Image > im, geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)

static std::shared_ptr< Psf >	readFits (fits::Fits &fitsfile)

static std::shared_ptr< Psf >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)

static std::shared_ptr< Psf >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)

static std::shared_ptr< Psf >	readFits (fits::Fits &fitsfile)

static std::shared_ptr< Psf >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)

static bool	hasBeenCorrupted ()

static memId	getNextMemId ()

static int	init ()

static int	census (int, memId startingMemId=0)

static void	census (std::ostream &stream, memId startingMemId=0)

static const std::vector< const Citizen >	census ()

static int	census (int, memId startingMemId=0)

static void	census (std::ostream &stream, memId startingMemId=0)

static const std::vector< const Citizen >	census ()

static memId	setNewCallbackId (memId id)

static memId	setNewCallbackId (memId id)

static memId	setDeleteCallbackId (memId id)

static memId	setDeleteCallbackId (memId id)

static memNewCallback	setNewCallback (memNewCallback func)

static memCallback	setDeleteCallback (memCallback func)

static memCallback	setCorruptionCallback (memCallback func)

Public Attributes
	COPY

	INTERNAL

	magicSentinel

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions
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

virtual void	write (OutputArchiveHandle &handle) const

Friends
class	detail::PsfexPsfFactory

Detailed Description

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

Definition at line 38 of file PsfexPsf.h.

Constructor & Destructor Documentation

◆ PsfexPsf()

lsst::meas::extensions::psfex::PsfexPsf::PsfexPsf	(	lsst::meas::extensions::psfex::Psf const &	psf,
		lsst::afw::geom::Point2D const &	averagePosition = `lsst::afw::geom::Point2D()`
	)

explicit

Constructor for a PsfexPsf.

Parameters

[in]	psf	Psfex PSF model to be wrapped into an LSST Psf
[in]	averagePosition	Average position of stars used to construct the Psf.

Definition at line 50 of file PsfexPsf.cc.

◆ ~PsfexPsf()

lsst::meas::extensions::psfex::PsfexPsf::~PsfexPsf ( )

virtual

Definition at line 84 of file PsfexPsf.cc.

Member Function Documentation

◆ clone()

boost::shared_ptr< afw::detection::Psf > lsst::meas::extensions::psfex::PsfexPsf::clone ( void ) const

virtual

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

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

Definition at line 90 of file PsfexPsf.cc.

◆ getAveragePosition()

virtual lsst::afw::geom::Point2D lsst::meas::extensions::psfex::PsfexPsf::getAveragePosition ( ) const

inlinevirtual

Return average position of stars; used as default position.

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

Definition at line 59 of file PsfexPsf.h.

◆ getKernel()

boost::shared_ptr< afw::math::LinearCombinationKernel const > lsst::meas::extensions::psfex::PsfexPsf::getKernel ( lsst::afw::geom::Point2D position = lsst::afw::geom::Point2D(std::numeric_limits<double>::quiet_NaN()) ) const

Return the PSF's basis functions as a spatially-invariant LinearCombinationKernel with unit weights.

Definition at line 100 of file PsfexPsf.cc.

◆ isPersistable()

virtual bool lsst::meas::extensions::psfex::PsfexPsf::isPersistable ( ) const

inlinevirtual

Is this object persistable?

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

Definition at line 68 of file PsfexPsf.h.

◆ resized()

boost::shared_ptr< afw::detection::Psf > lsst::meas::extensions::psfex::PsfexPsf::resized	(	int	width,
		int	height
	)		const

virtual

Return a clone with specified kernel dimensions.

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

Definition at line 95 of file PsfexPsf.cc.

◆ write()

void lsst::meas::extensions::psfex::PsfexPsf::write ( lsst::afw::table::io::OutputArchiveHandle & handle ) const

virtual

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 465 of file PsfexPsf.cc.

Friends And Related Function Documentation

◆ detail::PsfexPsfFactory

friend class detail::PsfexPsfFactory

friend

Definition at line 40 of file PsfexPsf.h.

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

include/lsst/meas/extensions/psfex/PsfexPsf.h
src/PsfexPsf.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PsfexPsf()

◆ ~PsfexPsf()

Member Function Documentation

◆ clone()

◆ getAveragePosition()

◆ getKernel()

◆ isPersistable()

◆ resized()

◆ write()

Friends And Related Function Documentation

◆ detail::PsfexPsfFactory