An intermediate base class for Psfs that use an image representation. More...

#include <ImagePsf.h>

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

Protected Member Functions
	ImagePsf (bool isFixed=false)

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

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

Protected Member Functions inherited from lsst::afw::table::io::Persistable
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...

	Persistable ()

	Persistable (Persistable const &other)

void	operator= (Persistable const &other)

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

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

virtual boost::shared_ptr< Psf >	clone () const =0
	Polymorphic deep-copy. More...

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 bool	isPersistable () const
	Return true if this particular object can be persisted using afw::table::io. More...

virtual	~Persistable ()

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

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

static boost::shared_ptr < ImagePsf >	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

An intermediate base class for Psfs that use an image representation.

ImagePsf exists only to provide implementations of doComputeApertureFlux and doComputeShape for its derived classes. These implementations use the SincFlux and SdssShape algorithms defined in meas_algorithms, and hence could not be included with the Psf base class in afw.

Definition at line 37 of file ImagePsf.h.

Constructor & Destructor Documentation

lsst::meas::algorithms::ImagePsf::ImagePsf ( bool isFixed = false )

inlineexplicitprotected

Definition at line 40 of file ImagePsf.h.

40 : afw::detection::Psf(isFixed) {}

Member Function Documentation

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

protectedvirtual

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 31 of file ImagePsf.cc.

         {
     afw::image::Image<double> const & image(*computeKernelImage(position, color, INTERNAL));
 
     afw::geom::Point2D const center(0.0, 0.0);
     afw::geom::ellipses::Axes const axes(radius, radius);
     base::ApertureFluxResult result = base::ApertureFluxAlgorithm::computeSincFlux(
         image,
         afw::geom::ellipses::Ellipse(axes, center),
         base::ApertureFluxControl()
     );
     return result.flux;
 }

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

protectedvirtual

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 46 of file ImagePsf.cc.

         {
     PTR(Image) image = computeKernelImage(position, color, INTERNAL);
     return meas::base::SdssShapeAlgorithm::computeAdaptiveMoments(
         *image,
         afw::geom::Point2D(0.0, 0.0)  // image has origin at the center
     ).getShape();
 }

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

/home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/include/lsst/meas/algorithms/ImagePsf.h
/home/lsstsw/stack/Linux64/meas_algorithms/11.0-2-gb8b8ce7/src/ImagePsf.cc

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation