A polymorphic base class for representing an image's Point Spread Function. More...

#include <Psf.h>

Inheritance diagram for lsst::afw::detection::Psf:

Public Types
enum	ImageOwnerEnum { COPY = 0, INTERNAL = 1 }
	Enum passed to computeImage and computeKernelImage to determine image ownership. More...

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

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

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 Member Functions
	Psf (Psf const &)

Psf &	operator= (Psf const &)=delete

Psf &	operator= (Psf &&)=delete

	Psf (Psf &&)

	~Psf () override

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

std::shared_ptr< typehandling::Storable >	cloneStorable () const override final
	Polymorphic deep-copy. More...

virtual std::shared_ptr< Psf >	resized (int width, int height) const =0
	Return clone with specified kernel dimensions. More...

std::shared_ptr< Image >	computeImage (lsst::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...

std::shared_ptr< Image >	computeKernelImage (lsst::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 (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Return the peak value of the PSF image. More...

double	computeApertureFlux (double radius, lsst::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 (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Compute the ellipse corresponding to the second moments of the Psf. More...

std::shared_ptr< math::Kernel const >	getLocalKernel (lsst::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 lsst::geom::Point2D	getAveragePosition () const
	Return the average position of the stars used to construct the Psf. More...

lsst::geom::Box2I	computeBBox (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
	Return the bounding box of the image returned by computeKernelImage() More...

std::size_t	getCacheCapacity () const
	Return the capacity of the caches. More...

void	setCacheCapacity (std::size_t capacity)
	Set the capacity of the caches. More...

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...

virtual std::string	toString () const
	Create a string representation of this object (optional operation). More...

virtual std::size_t	hash_value () const
	Return a hash of this object (optional operation). More...

virtual bool	equals (Storable const &other) const noexcept
	Compare this object to another Storable. More...

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

Static Public Member Functions
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)
	Helper function for Psf::doComputeImage(): converts a kernel image (centered at (0,0) when xy0 is taken into account) to an image centered at position when xy0 is taken into account. More...

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 std::shared_ptr< Psf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...

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

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

static std::shared_ptr< Psf >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...

Census
Provide a list of current Citizens
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...

callbackIDs
Set callback Ids. The old Id is returned
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...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
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...

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions
	Psf (bool isFixed=false, std::size_t capacity=100)
	Main constructor for subclasses. More...

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...

Static Protected Member Functions
template<class T >
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
	Test if a Storable is of a particular class and equal to another object. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable. More...

Detailed Description

A polymorphic base class for representing an image's Point Spread Function.

Most of a Psf's functionality involves its evaluation at a position and color, either or both of which may be unspecified (which will result in evaluation at some average position or color). Unlike the closely-related Kernel class, there is no requirement that a Psf have a well-defined spatial function or any parameters. Psfs are not necessarily continuous, and the dimensions of image of the Psf at a point may not be fixed.

Psfs have two methods for getting at image at a point:

the image returned by computeImage() is in the same coordinate system as the pixelized image
the image returned by computeKernelImage() is in an offset coordinate system with the point P at (0,0); this implies that the image (x0,y0) will be negative

Because P does not need to have integer coordinates, these two images are fractionally offset from each other and we use interpolation to get (1) from (2).

Psfs are immutable - derived classes should have no non-const methods, and hence should be fully-defined after construction. This allows shared_ptrs to Psfs to be passed around and shared between objects without concern for whether they will be unexpectedly modified.

In most cases, Psf derived classes should inherit from meas::algorithms::ImagePsf or meas::algorithms::KernelPsf, as these will provide default implementions for several member functions.

Definition at line 76 of file Psf.h.

Member Typedef Documentation

◆ Image

typedef image::Image<Pixel> lsst::afw::detection::Psf::Image

Image type returned by computeImage.

Definition at line 85 of file Psf.h.

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

◆ OutputArchiveHandle

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

◆ Pixel

typedef math::Kernel::Pixel lsst::afw::detection::Psf::Pixel

Pixel type of Image returned by computeImage.

Definition at line 84 of file Psf.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

lsst::daf::base::Citizen::magicSentinel

Definition: Citizen.h:88

◆ ImageOwnerEnum

enum lsst::afw::detection::Psf::ImageOwnerEnum

Enum passed to computeImage and computeKernelImage to determine image ownership.

Enumerator

COPY

The image will be copied before returning; caller will own it.

INTERNAL

An internal image will be returned without copying.

The caller must not modify it, and it may be invalidated the next time a Psf member function is called with different color and/or position.

Definition at line 88 of file Psf.h.

                         {
         COPY = 0,    
         INTERNAL = 1 
     };

Constructor & Destructor Documentation

◆ Psf() [1/3]

lsst::afw::detection::Psf::Psf ( Psf const & other )

Definition at line 79 of file Psf.cc.

79 : Psf(other._isFixed, other.getCacheCapacity()) {}

lsst::afw::detection::Psf::Psf

Psf(Psf const &)

Definition: Psf.cc:79

other

ItemVariant const * other

Definition: Schema.cc:56

◆ Psf() [2/3]

lsst::afw::detection::Psf::Psf ( Psf && other )

Definition at line 81 of file Psf.cc.

         : daf::base::Citizen(std::move(other)),
           _isFixed(other._isFixed),
           _imageCache(std::move(other._imageCache)),
           _kernelImageCache(std::move(other._kernelImageCache)) {}

◆ ~Psf()

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

overridedefault

Definition at line 125 of file psfImpl.cc.

           {
 #if 0                                   // we don't own impl
     psf_end(impl);
 #endif
 }

◆ Psf() [3/3]

lsst::afw::detection::Psf::Psf	(	bool	isFixed = `false`,
		std::size_t	capacity = `100`
	)

explicitprotected

Main constructor for subclasses.

Parameters

[in]	isFixed	Should be true for Psf for which doComputeKernelImage always returns the same image, regardless of color or position arguments.
[in]	capacity	Capacity of the caches.

Definition at line 72 of file Psf.cc.

                                          : daf::base::Citizen(typeid(this)), _isFixed(isFixed) {
     _imageCache = std::make_unique<PsfCache>(capacity);
     _kernelImageCache = std::make_unique<PsfCache>(capacity);
 }

Member Function Documentation

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ clone()

virtual std::shared_ptr<Psf> lsst::afw::detection::Psf::clone ( ) const

pure virtual

Polymorphic deep-copy.

Because Psfs are immutable, clones should generally be unnecessary, but they may be useful in allowing Psfs to maintain separate caches for their most recently returned images.

Implemented in lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::WarpedPsf, lsst::afw::detection::GaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::extensions::psfex::PsfexPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::PcaPsf, and lsst::meas::algorithms::DoubleGaussianPsf.

◆ cloneStorable()

std::shared_ptr<typehandling::Storable> lsst::afw::detection::Psf::cloneStorable ( ) const

inlinefinaloverridevirtual

Polymorphic deep-copy.

This method is an alias of clone that can be called from a reference to Storable.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 118 of file Psf.h.

118 { return clone(); }

lsst::afw::detection::Psf::clone

virtual std::shared_ptr< Psf > clone() const =0

Polymorphic deep-copy.

◆ computeApertureFlux()

double lsst::afw::detection::Psf::computeApertureFlux	(	double	radius,
		lsst::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.

Parameters

[in]	radius	Radius of the aperture to measure.
[in]	position	Position to evaluate the PSF at; defaults to getAveragePosition().
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().

The flux is relative to a Psf image that has been normalized to unit integral, and the radius is in pixels.

Definition at line 151 of file Psf.cc.

                                                                                                {
     if (isPointNull(position)) position = getAveragePosition();
     if (color.isIndeterminate()) color = getAverageColor();
     return doComputeApertureFlux(radius, position, color);
 }

◆ computeBBox()

lsst::geom::Box2I lsst::afw::detection::Psf::computeBBox	(	lsst::geom::Point2D	position = `makeNullPoint()`,
		image::Color	color = `image::Color()`
	)		const

Return the bounding box of the image returned by computeKernelImage()

Definition at line 129 of file Psf.cc.

                                                                                {
     if (isPointNull(position)) position = getAveragePosition();
     if (color.isIndeterminate()) color = getAverageColor();
     return doComputeBBox(position, color);
 }

◆ computeImage()

std::shared_ptr< Psf::Image > lsst::afw::detection::Psf::computeImage	(	lsst::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.

The specified position is a floating point number, and the resulting image will have a Psf centered on that point when the returned image's xy0 is taken into account.

The returned image is normalized to sum to unity.

Parameters

[in]	position	Position to evaluate the PSF at; defaults to getAveragePosition().
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().
[in]	owner	Whether to copy the return value or return an internal image that must be handled with care (see ImageOwnerEnum).

The Psf class caches the most recent return value of computeImage, so repeated calls with the same arguments will be highly optimized.

Note: The real work is done in the virtual private member function Psf::doComputeImage; computeImage only handles caching and default arguments.

Definition at line 103 of file Psf.cc.

                                                                           {
     if (isPointNull(position)) position = getAveragePosition();
     if (color.isIndeterminate()) color = getAverageColor();
     std::shared_ptr<Psf::Image> result = (*_imageCache)(
             detail::PsfCacheKey(position, color),
             [this](detail::PsfCacheKey const &key) { return doComputeImage(key.position, key.color); });
     if (owner == COPY) {
         result = std::make_shared<Image>(*result, true);
     }
     return result;
 }

◆ computeKernelImage()

std::shared_ptr< Psf::Image > lsst::afw::detection::Psf::computeKernelImage	(	lsst::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.

While the position need not be an integer, the center of the PSF image returned by computeKernelImage will in the center of the center pixel of the image, which will be (0,0) when the Image's xy0 is taken into account; this is the same behavior as Kernel::computeImage().

The returned image is normalized to sum to unity.

Parameters

[in]	position	Position to evaluate the PSF at; defaults to getAveragePosition().
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().
[in]	owner	Whether to copy the return value or return an internal image that must be handled with care (see ImageOwnerEnum).

The Psf class caches the most recent return value of computeKernelImage, so repeated calls with the same arguments will be highly optimized.

Note: The real work is done in the virtual private member function Psf::doComputeKernelImage; computeKernelImage only handles caching and default arguments.

Definition at line 116 of file Psf.cc.

                                                                                 {
     if (_isFixed || isPointNull(position)) position = getAveragePosition();
     if (_isFixed || color.isIndeterminate()) color = getAverageColor();
     std::shared_ptr<Psf::Image> result = (*_kernelImageCache)(
             detail::PsfCacheKey(position, color),
             [this](detail::PsfCacheKey const &key) { return doComputeKernelImage(key.position, key.color); });
     if (owner == COPY) {
         result = std::make_shared<Image>(*result, true);
     }
     return result;
 }

◆ computePeak()

double lsst::afw::detection::Psf::computePeak	(	lsst::geom::Point2D	position = `makeNullPoint()`,
		image::Color	color = `image::Color()`
	)		const

Return the peak value of the PSF image.

Parameters

[in]	position	Position to evaluate the PSF at; defaults to getAveragePosition().
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().

This calls computeKernelImage internally, but because this will usually be cached, it shouldn't be expensive (but be careful not to accidentally call it with no arguments when you actually want to call it with the same arguments just used to call computeImage or computeKernelImage).

Definition at line 144 of file Psf.cc.

                                                                         {
     if (isPointNull(position)) position = getAveragePosition();
     if (color.isIndeterminate()) color = getAverageColor();
     std::shared_ptr<Image> image = computeKernelImage(position, color, INTERNAL);
     return (*image)(-image->getX0(), -image->getY0());
 }

◆ computeShape()

geom::ellipses::Quadrupole lsst::afw::detection::Psf::computeShape	(	lsst::geom::Point2D	position = `makeNullPoint()`,
		image::Color	color = `image::Color()`
	)		const

Compute the ellipse corresponding to the second moments of the Psf.

Parameters

[in]	position	Position to evaluate the PSF at; defaults to getAveragePosition().
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().

The algorithm used to compute the moments is up to the derived class, and hence this method should not be used when a particular algorithm or weight function is required.

Definition at line 157 of file Psf.cc.

                                                                                          {
     if (isPointNull(position)) position = getAveragePosition();
     if (color.isIndeterminate()) color = getAverageColor();
     return doComputeShape(position, color);
 }

◆ dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< Psf >::dynamicCast ( std::shared_ptr< Persistable > const & ptr )

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions

lsst::pex::exceptions::LogicError if the cast fails

param[in] ptr The pointer to be cast.

Returns: The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError If the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

                                                                                         {
     auto result = std::dynamic_pointer_cast<T>(ptr);
     if (!result) {
         throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
     }
     return result;
 }

◆ equals()

bool lsst::afw::typehandling::Storable::equals ( Storable const & other ) const

virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns: This implementation returns whether the two objects are the same.

Warning: This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.

See also: singleClassEquals

Reimplemented in lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, lsst::afw::image::Filter, and lsst::afw::image::VisitInfo.

Definition at line 48 of file Storable.cc.

48 { return this == &other; }

other

ItemVariant const * other

Definition: Schema.cc:56

◆ getAverageColor()

image::Color lsst::afw::detection::Psf::getAverageColor ( ) const

inline

Return the average Color of the stars used to construct the Psf.

This is also the Color used to return an image if you don't specify a Color.

Definition at line 235 of file Psf.h.

235 { return image::Color(); }

lsst::afw::image::Color

Describe the colour of a source.

Definition: Color.h:26

◆ getAveragePosition()

lsst::geom::Point2D lsst::afw::detection::Psf::getAveragePosition ( ) const

virtual

Return the average position of the stars used to construct the Psf.

This is also the position used to return an image if you don't specify a position.

Reimplemented in lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::algorithms::KernelPsf.

Definition at line 169 of file Psf.cc.

169 { return lsst::geom::Point2D(); }

lsst::geom::Point2D

Point< double, 2 > Point2D

Definition: Point.h:324

◆ getCacheCapacity()

std::size_t lsst::afw::detection::Psf::getCacheCapacity ( ) const

Return the capacity of the caches.

Both the image and kernel image caches have the same capacity.

Definition at line 171 of file Psf.cc.

171 { return _kernelImageCache->capacity(); }

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

◆ getLocalKernel()

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

Return a FixedKernel corresponding to the Psf image at the given point.

This is implemented by calling computeKernelImage, and is simply provided for convenience.

Definition at line 135 of file Psf.cc.

                                                                                 {
     if (isPointNull(position)) position = getAveragePosition();
     if (color.isIndeterminate()) color = getAverageColor();
     // FixedKernel ctor will deep copy image, so we can use INTERNAL.
     std::shared_ptr<Image> image = computeKernelImage(position, color, INTERNAL);
     return std::make_shared<math::FixedKernel>(*image);
 }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

◆ getPersistenceName()

std::string lsst::afw::table::io::Persistable::getPersistenceName ( ) const

protectedvirtualinherited

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

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented in lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::image::PhotoCalib, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::geom::SkyWcs, lsst::meas::modelfit::Mixture, lsst::afw::detection::Footprint, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::polygon::Polygon, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::image::Filter, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::meas::algorithms::CoaddPsf, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::cameraGeom::DetectorCollection, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::image::CoaddInputs, lsst::afw::detection::GaussianPsf, lsst::afw::math::TransformBoundedField, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, and lsst::meas::algorithms::SingleGaussianPsf.

Definition at line 34 of file Persistable.cc.

34 { return std::string(); }

std::string

STL class.

◆ getPythonModule()

std::string lsst::afw::table::io::Persistable::getPythonModule ( ) const

protectedvirtualinherited

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 in lsst::afw::math::Kernel, lsst::afw::geom::SkyWcs, lsst::meas::modelfit::Mixture, lsst::afw::detection::Footprint, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::image::Filter, lsst::afw::image::TransmissionCurve, lsst::afw::math::ChebyshevBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::afw::math::Function< ReturnT >, lsst::afw::math::Function< Kernel::Pixel >, lsst::afw::cameraGeom::DetectorCollection, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::image::CoaddInputs, lsst::afw::detection::GaussianPsf, lsst::afw::math::TransformBoundedField, and lsst::meas::algorithms::KernelPsf.

Definition at line 36 of file Persistable.cc.

36 { return std::string(); }

std::string

STL class.

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ hash_value()

std::size_t lsst::afw::typehandling::Storable::hash_value ( ) const

virtualinherited

Return a hash of this object (optional operation).

Exceptions

UnsupportedOperationException Thrown if this object is not hashable.

Note: Subclass authors are responsible for any associated specializations of std::hash.

Reimplemented in lsst::afw::image::Filter, lsst::afw::geom::polygon::Polygon, and lsst::afw::image::VisitInfo.

Definition at line 44 of file Storable.cc.

                                      {
     throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

◆ isPersistable()

virtual bool lsst::afw::table::io::Persistable::isPersistable ( ) const

inlinevirtualnoexceptinherited

Return true if this particular object can be persisted using afw::table::io.

Reimplemented in lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::geom::SpanSet, lsst::afw::math::AnalyticKernel, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::image::PhotoCalib, lsst::meas::modelfit::Mixture, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::cameraGeom::Detector, lsst::afw::detection::Footprint, lsst::afw::geom::SkyWcs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::polygon::Polygon, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::image::Filter, lsst::afw::math::ChebyshevBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::afw::image::VisitInfo, lsst::afw::cameraGeom::TransformMap, lsst::afw::cameraGeom::Camera, lsst::afw::cameraGeom::DetectorCollection, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::detection::GaussianPsf, lsst::afw::image::CoaddInputs, lsst::afw::image::ApCorrMap, lsst::afw::math::PixelScaleBoundedField, lsst::afw::math::TransformBoundedField, lsst::meas::extensions::psfex::PsfexPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::DoubleGaussianPsf, and lsst::meas::algorithms::SingleGaussianPsf.

Definition at line 102 of file Persistable.h.

102 { return false; }

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ operator=() [1/2]

Psf& lsst::afw::detection::Psf::operator= ( Psf const & )

delete

◆ operator=() [2/2]

Psf& lsst::afw::detection::Psf::operator= ( Psf && )

delete

◆ readFits() [1/3]

static std::shared_ptr<Psf > lsst::afw::table::io::PersistableFacade< Psf >::readFits ( fits::Fits & fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in] fitsfile FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                          {
         return dynamicCast(Persistable::_readFits(fitsfile));
     }

◆ readFits() [2/3]

static std::shared_ptr<Psf > lsst::afw::table::io::PersistableFacade< Psf >::readFits	(	std::string const &	fileName,
		int	hdu = `fits::DEFAULT_HDU`
	)

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

                                                                                            {
         return dynamicCast(Persistable::_readFits(fileName, hdu));
     }

◆ readFits() [3/3]

static std::shared_ptr<Psf > lsst::afw::table::io::PersistableFacade< Psf >::readFits	(	fits::MemFileManager &	manager,
		int	hdu = `fits::DEFAULT_HDU`
	)

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

                                                                                              {
         return dynamicCast(Persistable::_readFits(manager, hdu));
     }

◆ recenterKernelImage()

std::shared_ptr< image::Image< double > > lsst::afw::detection::Psf::recenterKernelImage	(	std::shared_ptr< Image >	im,
		lsst::geom::Point2D const &	position,
		std::string const &	warpAlgorithm = `"lanczos5"`,
		unsigned int	warpBuffer = `5`
	)

static

Helper function for Psf::doComputeImage(): converts a kernel image (centered at (0,0) when xy0 is taken into account) to an image centered at position when xy0 is taken into account.

warpAlgorithm is passed to afw::math::makeWarpingKernel() and can be "nearest", "bilinear", or "lanczosN"

warpBuffer zero-pads the image before recentering. Recommended value is 1 for bilinear, N for lanczosN (note that it would be cleaner to infer this value from the warping algorithm but this would require mild API changes; same issue occurs in e.g. afw::math::offsetImage()).

The point with integer coordinates (0,0) in the source image (with xy0 taken into account) corresponds to the point position in the destination image. If position is not integer-valued then we will need to fractionally shift the image using interpolation.

Note: if fractional recentering is performed, then a new image will be allocated and returned. If not, then the original image will be returned (after setting XY0).

Definition at line 87 of file Psf.cc.

                                                                                         {
     // "ir" : (integer, residual)
     std::pair<int, double> const irX = image::positionToIndex(position.getX(), true);
     std::pair<int, double> const irY = image::positionToIndex(position.getY(), true);
 
     if (irX.second != 0.0 || irY.second != 0.0) {
         im = math::offsetImage(*im, irX.second, irY.second, warpAlgorithm, warpBuffer);
     }
 
     im->setXY0(irX.first + im->getX0(), irY.first + im->getY0());
     return im;
 }

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ resized()

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

pure virtual

Return clone with specified kernel dimensions.

Parameters

[in]	width	Number of columns in pixels
[in]	height	Number of rows in pixels

Must be implemented by derived classes.

Implemented in lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::WarpedPsf, lsst::afw::detection::GaussianPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::extensions::psfex::PsfexPsf, lsst::meas::algorithms::SingleGaussianPsf, lsst::meas::algorithms::PcaPsf, and lsst::meas::algorithms::DoubleGaussianPsf.

◆ setCacheCapacity()

void lsst::afw::detection::Psf::setCacheCapacity ( std::size_t capacity )

Set the capacity of the caches.

Both the image and kernel image caches will be set to this capacity.

Definition at line 173 of file Psf.cc.

                                              {
     _imageCache->reserve(capacity);
     _kernelImageCache->reserve(capacity);
 }

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

◆ singleClassEquals()

template<class T >

static bool lsst::afw::typehandling::Storable::singleClassEquals	(	T const &	lhs,
		Storable const &	rhs
	)

inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs The objects to compare. Note that rhs need not be a T, while lhs must be.

Returns: true if rhs is a T and lhs == rhs; false otherwise.

Exception Safety: Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.

Note: This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 136 of file Storable.h.

                                                                      {
         auto typedRhs = dynamic_cast<T const*>(&rhs);
         if (typedRhs != nullptr) {
             return lhs == *typedRhs;
         } else {
             return false;
         }
     }

◆ toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const

virtualinherited

Create a string representation of this object (optional operation).

Exceptions

UnsupportedOperationException Thrown if this object does not have a string representation.

Reimplemented in lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, and lsst::afw::image::VisitInfo.

Definition at line 40 of file Storable.cc.

                                    {
     throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
 }

◆ write()

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

protectedvirtualinherited

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 in lsst::afw::math::Chebyshev1Function2< ReturnT >, lsst::afw::math::LinearCombinationKernel, lsst::afw::math::DeltaFunctionKernel, lsst::afw::math::AnalyticKernel, lsst::afw::image::PhotoCalib, lsst::afw::math::PolynomialFunction2< ReturnT >, lsst::afw::math::FixedKernel, lsst::afw::geom::SkyWcs, lsst::meas::modelfit::Mixture, lsst::afw::detection::Footprint, lsst::afw::math::DoubleGaussianFunction2< ReturnT >, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::polygon::Polygon, lsst::afw::math::GaussianFunction2< ReturnT >, lsst::afw::image::Filter, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::VisitInfo, lsst::meas::algorithms::CoaddPsf, lsst::afw::cameraGeom::Camera, lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >, lsst::afw::cameraGeom::DetectorCollection, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::image::CoaddInputs, lsst::afw::detection::GaussianPsf, lsst::afw::math::TransformBoundedField, lsst::meas::algorithms::KernelPsf, lsst::meas::extensions::psfex::PsfexPsf, lsst::meas::algorithms::DoubleGaussianPsf, and lsst::meas::algorithms::SingleGaussianPsf.

Definition at line 38 of file Persistable.cc.

                                                    {
     assert(!isPersistable());
     throw LSST_EXCEPT(pex::exceptions::LogicError,
                       "afw::table-based persistence is not supported for this object.");
 }

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits	(	std::string const &	fileName,
		std::string const &	mode = `"w"`
	)		const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                   {
     fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
     writeFits(fitsfile);
 }

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits	(	fits::MemFileManager &	manager,
		std::string const &	mode = `"w"`
	)		const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                     {
     fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
     writeFits(fitsfile);
 }

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits & fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in] fitsfile Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                     {
     OutputArchive archive;
     archive.put(this);
     archive.writeFits(fitsfile);
 }

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		Storable const &	storable
	)

Parameters

os	the desired output stream
storable	the object to print

Returns: a reference to os

Exceptions

UnsupportedOperationException Thrown if storable does not have an implementation of Storable::toString.

Definition at line 159 of file Storable.h.

                                                                         {
     return os << storable.toString();
 }

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

/j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/include/lsst/afw/detection/Psf.h
/j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/src/detection/Psf.cc
/j/snowflake/release/lsstsw/stack/Linux64/meas_extensions_psfex/18.1.0/src/psfImpl.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Related Functions

Detailed Description

Member Typedef Documentation

◆ Image

◆ memCallback

◆ memId

◆ memNewCallback

◆ OutputArchiveHandle

◆ Pixel

Member Enumeration Documentation

◆ anonymous enum

◆ ImageOwnerEnum

Constructor & Destructor Documentation

◆ Psf() [1/3]

◆ Psf() [2/3]

◆ ~Psf()

◆ Psf() [3/3]

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ clone()

◆ cloneStorable()

◆ computeApertureFlux()

◆ computeBBox()

◆ computeImage()

◆ computeKernelImage()

◆ computePeak()

◆ computeShape()

◆ dynamicCast()

◆ equals()

◆ getAverageColor()

◆ getAveragePosition()

◆ getCacheCapacity()

◆ getId()

◆ getLocalKernel()

◆ getNextMemId()

◆ getPersistenceName()

◆ getPythonModule()

◆ hasBeenCorrupted()

◆ hash_value()

◆ init()

◆ isPersistable()

◆ markPersistent()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ readFits() [1/3]

◆ readFits() [2/3]

◆ readFits() [3/3]

◆ recenterKernelImage()

◆ repr()

◆ resized()

◆ setCacheCapacity()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

◆ singleClassEquals()

◆ toString()

◆ write()

◆ writeFits() [1/3]

◆ writeFits() [2/3]

◆ writeFits() [3/3]

Friends And Related Function Documentation

◆ operator<<()