A circularly symmetric Gaussian Psf class with no spatial variation, intended mostly for testing purposes. More...

#include <GaussianPsf.h>

Inheritance diagram for lsst::afw::detection::GaussianPsf:

Public Member Functions
	GaussianPsf (int width, int height, double sigma)
	Constructor for a GaussianPsf. More...

	GaussianPsf (geom::Extent2I const &dimensions, double sigma)
	Constructor for a GaussianPsf. More...

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

geom::Extent2I	getDimensions () const
	Return the dimensions of the images returned by computeImage() More...

double	getSigma () const
	Return the radius of the Gaussian. More...

virtual bool	isPersistable () const
	Whether the Psf is persistable; always true. More...

Public Member Functions inherited from lsst::afw::detection::Psf
virtual	~Psf ()

boost::shared_ptr< Image >	computeImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
	Return an Image of the PSF, in a form that can be compared directly with star images. More...

boost::shared_ptr< Image >	computeKernelImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
	Return an Image of the PSF, in a form suitable for convolution. More...

double	computePeak (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Return the peak value of the PSF image. More...

double	computeApertureFlux (double radius, geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Compute the "flux" of the Psf model within a circular aperture of the given radius. More...

geom::ellipses::Quadrupole	computeShape (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Compute the ellipse corresponding to the second moments of the Psf. More...

boost::shared_ptr < math::Kernel const >	getLocalKernel (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Return a FixedKernel corresponding to the Psf image at the given point. More...

image::Color	getAverageColor () const
	Return the average Color of the stars used to construct the Psf. More...

virtual geom::Point2D	getAveragePosition () const
	Return the average position of the stars used to construct the Psf. More...

Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)

	Citizen (Citizen const &)

	~Citizen ()

Citizen &	operator= (Citizen const &)

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Public Member Functions inherited from lsst::daf::base::Persistable
	Persistable (void)

virtual	~Persistable (void)

template<class Archive >
void	serialize (Archive &, unsigned int const)

Public Member Functions inherited from lsst::afw::table::io::Persistable
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...

void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...

void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...

virtual	~Persistable ()

Protected Member Functions
virtual std::string	getPersistenceName () const
	Return the unique name used to persist this object and look up its factory. More...

virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...

virtual void	write (OutputArchiveHandle &handle) const
	Write the object to one or more catalogs. More...

Protected Member Functions inherited from lsst::afw::detection::Psf
	Psf (bool isFixed=false)

Protected Member Functions inherited from lsst::afw::table::io::Persistable
	Persistable ()

	Persistable (Persistable const &other)

void	operator= (Persistable const &other)

Private Member Functions
virtual boost::shared_ptr< Image >	doComputeKernelImage (geom::Point2D const &position, image::Color const &color) const

virtual double	doComputeApertureFlux (double radius, geom::Point2D const &position, image::Color const &color) const

virtual geom::ellipses::Quadrupole	doComputeShape (geom::Point2D const &position, image::Color const &color) const

Private Attributes
geom::Extent2I	_dimensions

double	_sigma

Additional Inherited Members
Public Types inherited from lsst::afw::detection::Psf
enum	ImageOwnerEnum { COPY =0, INTERNAL =1 }
	Enum passed to computeImage and computeKernelImage to determine image ownership. More...

typedef boost::shared_ptr< Psf >	Ptr

typedef boost::shared_ptr < const Psf >	ConstPtr

typedef math::Kernel::Pixel	Pixel
	Pixel type of Image returned by computeImage. More...

typedef image::Image< Pixel >	Image
	Image type returned by computeImage. More...

Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...

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

Public Types inherited from lsst::daf::base::Persistable
typedef boost::shared_ptr < Persistable >	Ptr

Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< GaussianPsf >
static boost::shared_ptr < GaussianPsf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr < GaussianPsf >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr < GaussianPsf >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Static Public Member Functions inherited from lsst::afw::detection::Psf
static boost::shared_ptr< Image >	recenterKernelImage (boost::shared_ptr< Image > im, geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)

Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Static Public Member Functions inherited from lsst::afw::table::io::PersistableFacade< Psf >
static boost::shared_ptr< Psf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

static boost::shared_ptr< Psf >	readFits (std::string const &fileName, int hdu=0)
	Read an object from a regular FITS file. More...

static boost::shared_ptr< Psf >	readFits (fits::MemFileManager &manager, int hdu=0)
	Read an object from a FITS file in memory. More...

Protected Types inherited from lsst::afw::table::io::Persistable
typedef io::OutputArchiveHandle	OutputArchiveHandle

Detailed Description

A circularly symmetric Gaussian Psf class with no spatial variation, intended mostly for testing purposes.

This class is essentially an alternate implementation of meas::algorithms::SingleGaussianPsf; While SingleGaussianPsf inherits from ImagePsf and KernelPsf, and hence delegates to those various operations relating to the PSF model image (e.g. computeShape()), GaussianPsf computes these analytically.

Definition at line 41 of file GaussianPsf.h.

Constructor & Destructor Documentation

lsst::afw::detection::GaussianPsf::GaussianPsf	(	int	width,
		int	height,
		double	sigma
	)

Constructor for a GaussianPsf.

Parameters

[in]	width	Number of columns in realizations of the PSF at a point.
[in]	height	Number of rows in realizations of the PSF at a point.
[in]	sigma	Radius of the Gaussian.

Definition at line 100 of file GaussianPsf.cc.

                                                             :
     Psf(true), _dimensions(width, height), _sigma(sigma)
 {
     checkDimensions(_dimensions);
 }

lsst::afw::detection::GaussianPsf::GaussianPsf	(	geom::Extent2I const &	dimensions,
		double	sigma
	)

Constructor for a GaussianPsf.

Parameters

[in]	dimensions	Number of columns, rows in realizations of the PSF at a point.
[in]	sigma	Radius of the Gaussian.

Definition at line 106 of file GaussianPsf.cc.

                                                                       :
     Psf(true), _dimensions(dimensions), _sigma(sigma)
 {
     checkDimensions(_dimensions);
 }

Member Function Documentation

boost::shared_ptr< afw::detection::Psf > lsst::afw::detection::GaussianPsf::clone ( ) const

virtual

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

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

Definition at line 112 of file GaussianPsf.cc.

                                               {
     return boost::make_shared<GaussianPsf>(_dimensions, _sigma);
 }

double lsst::afw::detection::GaussianPsf::doComputeApertureFlux	(	double	radius,
		geom::Point2D const &	position,
		image::Color const &	color
	)		const

privatevirtual

These virtual member functions are private, not protected, because we only want derived classes to implement them, not call them; they should call the corresponding compute*Image member functions instead so as to let the Psf base class handle caching properly.

Derived classes are responsible for ensuring that returned images sum to one.

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

Definition at line 147 of file GaussianPsf.cc.

         {
     return 1.0 - std::exp(-0.5*radius*radius/(_sigma*_sigma));
 }

boost::shared_ptr< GaussianPsf::Image > lsst::afw::detection::GaussianPsf::doComputeKernelImage	(	geom::Point2D const &	position,
		image::Color const &	color
	)		const

privatevirtual

These virtual member functions are private, not protected, because we only want derived classes to implement them, not call them; they should call the corresponding compute*Image member functions instead so as to let the Psf base class handle caching properly.

Derived classes are responsible for ensuring that returned images sum to one.

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

Definition at line 130 of file GaussianPsf.cc.

         {
     PTR(Image) r(new Image(_dimensions));
     Image::Array array = r->getArray();
     r->setXY0(geom::Point2I(-_dimensions / 2)); // integer truncation intentional
     double sum = 0.0;
     for (int yIndex = 0, y = r->getY0(); yIndex < _dimensions.getY(); ++yIndex, ++y) {
         Image::Array::Reference row = array[yIndex];
         for (int xIndex = 0, x = r->getX0(); xIndex < _dimensions.getX(); ++xIndex, ++x) {
             sum += row[xIndex] = std::exp(-0.5*(x*x + y*y)/(_sigma*_sigma));
         }
     }
     array.asEigen() /= sum;
     return r;
 }

geom::ellipses::Quadrupole lsst::afw::detection::GaussianPsf::doComputeShape	(	geom::Point2D const &	position,
		image::Color const &	color
	)		const

privatevirtual

These virtual member functions are private, not protected, because we only want derived classes to implement them, not call them; they should call the corresponding compute*Image member functions instead so as to let the Psf base class handle caching properly.

Derived classes are responsible for ensuring that returned images sum to one.

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

Definition at line 153 of file GaussianPsf.cc.

         {
     return geom::ellipses::Quadrupole(_sigma*_sigma, _sigma*_sigma, 0.0);
 }

geom::Extent2I lsst::afw::detection::GaussianPsf::getDimensions ( ) const

inline

Return the dimensions of the images returned by computeImage()

Definition at line 65 of file GaussianPsf.h.

65 { return _dimensions; }

lsst::afw::detection::GaussianPsf::_dimensions

geom::Extent2I _dimensions

Definition: GaussianPsf.h:103

std::string lsst::afw::detection::GaussianPsf::getPersistenceName ( ) const

protectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

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

Definition at line 116 of file GaussianPsf.cc.

116 { return "GaussianPsf"; }

std::string lsst::afw::detection::GaussianPsf::getPythonModule ( ) const

protectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

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

Definition at line 118 of file GaussianPsf.cc.

118 { return "lsst.afw.detection"; }

double lsst::afw::detection::GaussianPsf::getSigma ( ) const

inline

Return the radius of the Gaussian.

Definition at line 68 of file GaussianPsf.h.

68 { return _sigma; }

lsst::afw::detection::GaussianPsf::_sigma

double _sigma

Definition: GaussianPsf.h:104

virtual bool lsst::afw::detection::GaussianPsf::isPersistable ( ) const

inlinevirtual

Whether the Psf is persistable; always true.

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

Definition at line 71 of file GaussianPsf.h.

71 { return true; }

void lsst::afw::detection::GaussianPsf::write ( OutputArchiveHandle & handle ) const

protectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

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

Definition at line 120 of file GaussianPsf.cc.

                                                           {
     static GaussianPsfPersistenceHelper const & keys = GaussianPsfPersistenceHelper::get();
     afw::table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
     PTR(afw::table::BaseRecord) record = catalog.addNew();
     (*record)[keys.dimensions.getX()] = _dimensions.getX();
     (*record)[keys.dimensions.getY()] = _dimensions.getY();
     (*record)[keys.sigma] = getSigma();
     handle.saveCatalog(catalog);
 }

Member Data Documentation

geom::Extent2I lsst::afw::detection::GaussianPsf::_dimensions

private

Definition at line 103 of file GaussianPsf.h.

double lsst::afw::detection::GaussianPsf::_sigma

private

Definition at line 104 of file GaussianPsf.h.

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

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/detection/GaussianPsf.h
/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/detection/GaussianPsf.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation