LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Friends | Related Functions | List of all members
lsst::meas::algorithms::KernelPsf Class Reference

A Psf defined by a Kernel. More...

#include <KernelPsf.h>

Inheritance diagram for lsst::meas::algorithms::KernelPsf:
lsst::afw::table::io::PersistableFacade< KernelPsf > lsst::meas::algorithms::ImagePsf lsst::afw::table::io::PersistableFacade< ImagePsf > lsst::afw::detection::Psf lsst::afw::table::io::PersistableFacade< Psf > lsst::afw::typehandling::Storable lsst::afw::table::io::Persistable lsst::meas::algorithms::DoubleGaussianPsf lsst::meas::algorithms::PcaPsf lsst::meas::algorithms::SingleGaussianPsf

Public Types

enum  ImageOwnerEnum { COPY = 0 , INTERNAL = 1 }
 Enum passed to computeImage and computeKernelImage to determine image ownership. More...
 
using Pixel = math::Kernel::Pixel
 Pixel type of Image returned by computeImage. More...
 
using Image = image::Image< Pixel >
 Image type returned by computeImage. More...
 

Public Member Functions

 KernelPsf (afw::math::Kernel const &kernel, geom::Point2D const &averagePosition=geom::Point2D())
 Construct a KernelPsf with a clone of the given kernel. More...
 
std::shared_ptr< afw::math::Kernel const > getKernel () const
 Return the Kernel used to define this Psf. More...
 
geom::Point2D getAveragePosition () const override
 Return average position of stars; used as default position. More...
 
std::shared_ptr< afw::detection::Psfclone () const override
 Polymorphic deep copy. More...
 
std::shared_ptr< afw::detection::Psfresized (int width, int height) const override
 Return a clone with specified kernel dimensions. More...
 
bool isPersistable () const noexcept override
 Whether this object is persistable; just delegates to the kernel. More...
 
std::shared_ptr< typehandling::Storable > cloneStorable () const override
 Polymorphic deep-copy. More...
 
std::shared_ptr< ImagecomputeImage (lsst::geom::Point2D position, 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< ImagecomputeImage () const
 
std::shared_ptr< ImagecomputeKernelImage (lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 Return an Image of the PSF, in a form suitable for convolution. More...
 
std::shared_ptr< ImagecomputeKernelImage () const
 
double computePeak (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the peak value of the PSF image. More...
 
double computePeak () const
 
double computeApertureFlux (double radius, lsst::geom::Point2D position, image::Color color=image::Color()) const
 Compute the "flux" of the Psf model within a circular aperture of the given radius. More...
 
double computeApertureFlux (double radius) const
 
geom::ellipses::Quadrupole computeShape (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Compute the ellipse corresponding to the second moments of the Psf. More...
 
geom::ellipses::Quadrupole computeShape () const
 
std::shared_ptr< math::Kernel const > getLocalKernel (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return a FixedKernel corresponding to the Psf image at the given point. More...
 
std::shared_ptr< math::Kernel const > getLocalKernel () const
 
image::Color getAverageColor () const
 Return the average Color of the stars used to construct the Psf. More...
 
lsst::geom::Box2I computeBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeKernelImage() More...
 
lsst::geom::Box2I computeBBox () const
 
lsst::geom::Box2I computeImageBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeImage() More...
 
lsst::geom::Box2I computeImageBBox () const
 
lsst::geom::Box2I computeKernelBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeImage() More...
 
lsst::geom::Box2I computeKernelBBox () const
 
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...
 
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...
 

Static Public Member Functions

static std::shared_ptr< KernelPsfreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< KernelPsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< KernelPsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< KernelPsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< ImagePsfreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< ImagePsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< ImagePsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< PsfreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< PsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< PsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< ImagePsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< PsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 
static std::shared_ptr< ImagerecenterKernelImage (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...
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

 KernelPsf (std::shared_ptr< afw::math::Kernel > kernel, geom::Point2D const &averagePosition=geom::Point2D())
 Construct a KernelPsf with the given kernel; it should not be modified afterwards. More...
 
std::string getPersistenceName () const override
 Return the unique name used to persist this object and look up its factory. More...
 
std::string getPythonModule () const override
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
 
void write (OutputArchiveHandle &handle) const override
 Write the object to one or more catalogs. More...
 
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< ImagedoComputeImage (lsst::geom::Point2D const &position, image::Color const &color) const
 These virtual members are protected (rather than private) so that python-implemented derived classes may opt to use the default implementations. More...
 
virtual lsst::geom::Box2I doComputeImageBBox (lsst::geom::Point2D const &position, image::Color const &color) const
 

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

Friends

template<typename T , typename K >
class KernelPsfFactory
 

Related Functions

(Note that these are not member functions.)

std::ostreamoperator<< (std::ostream &os, Storable const &storable)
 Output operator for Storable. More...
 

Detailed Description

A Psf defined by a Kernel.

Definition at line 36 of file KernelPsf.h.

Member Typedef Documentation

◆ Image

Image type returned by computeImage.

Definition at line 83 of file Psf.h.

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

◆ Pixel

using lsst::afw::detection::Psf::Pixel = math::Kernel::Pixel
inherited

Pixel type of Image returned by computeImage.

Definition at line 82 of file Psf.h.

Member Enumeration Documentation

◆ 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 86 of file Psf.h.

86  {
87  COPY = 0,
88  INTERNAL = 1
92  };
@ COPY
The image will be copied before returning; caller will own it.
Definition: Psf.h:87
@ INTERNAL
An internal image will be returned without copying.
Definition: Psf.h:88

Constructor & Destructor Documentation

◆ KernelPsf() [1/2]

lsst::meas::algorithms::KernelPsf::KernelPsf ( afw::math::Kernel const &  kernel,
geom::Point2D const &  averagePosition = geom::Point2D() 
)
explicit

Construct a KernelPsf with a clone of the given kernel.

We clone the Kernel in the public constructor to ensure the Psf is immutable after construction (we don't want someone with another copy of the Kernel to be able to modify the one held by the Psf).

Derived classes may use the protected constructor, which takes a shared_ptr to Kernel and does not copy it.

Definition at line 33 of file KernelPsf.cc.

34  : ImagePsf(!kernel.isSpatiallyVarying()),
35  _kernel(kernel.clone()),
36  _averagePosition(averagePosition) {}
ImagePsf(bool isFixed=false)
Definition: ImagePsf.h:42
afw::table::PointKey< double > averagePosition
Definition: CoaddPsf.cc:349

◆ KernelPsf() [2/2]

lsst::meas::algorithms::KernelPsf::KernelPsf ( std::shared_ptr< afw::math::Kernel kernel,
geom::Point2D const &  averagePosition = geom::Point2D() 
)
explicitprotected

Construct a KernelPsf with the given kernel; it should not be modified afterwards.

Definition at line 38 of file KernelPsf.cc.

39  : ImagePsf(!kernel->isSpatiallyVarying()), _kernel(kernel), _averagePosition(averagePosition) {}

Member Function Documentation

◆ clone()

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

Polymorphic deep copy.

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

Reimplemented in lsst::meas::algorithms::SingleGaussianPsf, and lsst::meas::algorithms::PcaPsf.

Definition at line 41 of file KernelPsf.cc.

41 { return std::make_shared<KernelPsf>(*this); }

◆ cloneStorable()

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

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 116 of file Psf.h.

116 { return clone(); }
virtual std::shared_ptr< Psf > clone() const =0
Polymorphic deep-copy.

◆ computeApertureFlux() [1/2]

double Psf::computeApertureFlux ( double  radius) const
inherited

Definition at line 179 of file Psf.cc.

179  {
180  return computeApertureFlux(radius, makeNullPoint());
181 }
double computeApertureFlux(double radius, lsst::geom::Point2D position, image::Color color=image::Color()) const
Compute the "flux" of the Psf model within a circular aperture of the given radius.
Definition: Psf.cc:183

◆ computeApertureFlux() [2/2]

double Psf::computeApertureFlux ( double  radius,
lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Compute the "flux" of the Psf model within a circular aperture of the given radius.

Parameters
[in]radiusRadius of the aperture to measure.
[in]positionPosition at which to evaluate the PSF.
[in]colorColor 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 183 of file Psf.cc.

183  {
184  if (isPointNull(position)) position = getAveragePosition();
185  if (color.isIndeterminate()) color = getAverageColor();
186  return doComputeApertureFlux(radius, position, color);
187 }
image::Color getAverageColor() const
Return the average Color of the stars used to construct the Psf.
Definition: Psf.h:274
virtual double doComputeApertureFlux(double radius, lsst::geom::Point2D const &position, image::Color const &color) const =0
virtual lsst::geom::Point2D getAveragePosition() const
Return the average position of the stars used to construct the Psf.
Definition: Psf.cc:211
bool isIndeterminate() const noexcept
Whether the color is the special value that indicates that it is unspecified.
Definition: Color.h:37

◆ computeBBox() [1/2]

lsst::geom::Box2I Psf::computeBBox ( ) const
inherited

Definition at line 135 of file Psf.cc.

135  {
136  return computeBBox(makeNullPoint());
137 }
lsst::geom::Box2I computeBBox() const
Definition: Psf.cc:135

◆ computeBBox() [2/2]

lsst::geom::Box2I Psf::computeBBox ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

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

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

Definition at line 139 of file Psf.cc.

139  {
140  if (isPointNull(position)) position = getAveragePosition();
141  if (color.isIndeterminate()) color = getAverageColor();
142  return doComputeBBox(position, color);
143 }
virtual lsst::geom::Box2I doComputeBBox(lsst::geom::Point2D const &position, image::Color const &color) const =0

◆ computeImage() [1/2]

std::shared_ptr< Psf::Image > Psf::computeImage ( ) const
inherited

Definition at line 101 of file Psf.cc.

101  {
102  return computeImage(makeNullPoint());
103 }
std::shared_ptr< Image > computeImage() const
Definition: Psf.cc:101

◆ computeImage() [2/2]

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

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]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().
[in]ownerWhether 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 105 of file Psf.cc.

106  {
107  if (isPointNull(position)) position = getAveragePosition();
108  if (color.isIndeterminate()) color = getAverageColor();
109  std::shared_ptr<Psf::Image> result = (*_imageCache)(
110  detail::PsfCacheKey(position, color),
111  [this](detail::PsfCacheKey const &key) { return doComputeImage(key.position, key.color); });
112  if (owner == COPY) {
113  result = std::make_shared<Image>(*result, true);
114  }
115  return result;
116 }
py::object result
Definition: _schema.cc:429
virtual std::shared_ptr< Image > doComputeImage(lsst::geom::Point2D const &position, image::Color const &color) const
These virtual members are protected (rather than private) so that python-implemented derived classes ...
Definition: Psf.cc:199

◆ computeImageBBox() [1/2]

lsst::geom::Box2I Psf::computeImageBBox ( ) const
inherited

Definition at line 145 of file Psf.cc.

145  {
146  return computeImageBBox(makeNullPoint());
147 }
lsst::geom::Box2I computeImageBBox() const
Definition: Psf.cc:145

◆ computeImageBBox() [2/2]

lsst::geom::Box2I Psf::computeImageBBox ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

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

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

Definition at line 149 of file Psf.cc.

149  {
150  if (isPointNull(position)) position = getAveragePosition();
151  if (color.isIndeterminate()) color = getAverageColor();
152  return doComputeImageBBox(position, color);
153 }
virtual lsst::geom::Box2I doComputeImageBBox(lsst::geom::Point2D const &position, image::Color const &color) const
Definition: Psf.cc:205

◆ computeKernelBBox() [1/2]

lsst::geom::Box2I lsst::afw::detection::Psf::computeKernelBBox ( ) const
inlineinherited

Definition at line 332 of file Psf.h.

332  {
333  return computeBBox();
334  }

◆ computeKernelBBox() [2/2]

lsst::geom::Box2I lsst::afw::detection::Psf::computeKernelBBox ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inlineinherited

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

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor(). Alias for computeBBox

Definition at line 323 of file Psf.h.

324  {
325  return computeBBox(position, color);
326  }

◆ computeKernelImage() [1/2]

std::shared_ptr< Psf::Image > Psf::computeKernelImage ( ) const
inherited

Definition at line 118 of file Psf.cc.

118  {
119  return computeKernelImage(makeNullPoint());
120 }
std::shared_ptr< Image > computeKernelImage() const
Definition: Psf.cc:118

◆ computeKernelImage() [2/2]

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

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]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().
[in]ownerWhether 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 122 of file Psf.cc.

123  {
124  if (_isFixed || isPointNull(position)) position = getAveragePosition();
125  if (_isFixed || color.isIndeterminate()) color = getAverageColor();
126  std::shared_ptr<Psf::Image> result = (*_kernelImageCache)(
127  detail::PsfCacheKey(position, color),
128  [this](detail::PsfCacheKey const &key) { return doComputeKernelImage(key.position, key.color); });
129  if (owner == COPY) {
130  result = std::make_shared<Image>(*result, true);
131  }
132  return result;
133 }
virtual std::shared_ptr< Image > doComputeKernelImage(lsst::geom::Point2D const &position, image::Color const &color) const =0
These virtual member functions are private, not protected, because we only want derived classes to im...

◆ computePeak() [1/2]

double Psf::computePeak ( ) const
inherited

Definition at line 168 of file Psf.cc.

168  {
169  return computePeak(makeNullPoint());
170 }
double computePeak() const
Definition: Psf.cc:168

◆ computePeak() [2/2]

double Psf::computePeak ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

Return the peak value of the PSF image.

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor 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 172 of file Psf.cc.

172  {
173  if (isPointNull(position)) position = getAveragePosition();
174  if (color.isIndeterminate()) color = getAverageColor();
176  return (*image)(-image->getX0(), -image->getY0());
177 }
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.

◆ computeShape() [1/2]

geom::ellipses::Quadrupole Psf::computeShape ( ) const
inherited

Definition at line 189 of file Psf.cc.

189  {
190  return computeShape(makeNullPoint());
191 }
geom::ellipses::Quadrupole computeShape() const
Definition: Psf.cc:189

◆ computeShape() [2/2]

geom::ellipses::Quadrupole Psf::computeShape ( lsst::geom::Point2D  position,
image::Color  color = image::Color() 
) const
inherited

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

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor 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 193 of file Psf.cc.

193  {
194  if (isPointNull(position)) position = getAveragePosition();
195  if (color.isIndeterminate()) color = getAverageColor();
196  return doComputeShape(position, color);
197 }
virtual geom::ellipses::Quadrupole doComputeShape(lsst::geom::Point2D const &position, image::Color const &color) const =0

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

46  {
47  afw::image::Image<double> const& image(*computeKernelImage(position, color, INTERNAL));
48 
49  geom::Point2D const center(0.0, 0.0);
50  afw::geom::ellipses::Axes const axes(radius, radius);
51  base::ApertureFluxResult result = base::ApertureFluxAlgorithm::computeSincFlux(
52  image, afw::geom::ellipses::Ellipse(axes, center), base::ApertureFluxControl());
53  return result.instFlux;
54 }
afw::table::Key< afw::table::Array< ImagePixelT > > image
static Result computeSincFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using Sinc photometry.

◆ doComputeImage()

std::shared_ptr< Psf::Image > Psf::doComputeImage ( lsst::geom::Point2D const &  position,
image::Color const &  color 
) const
protectedvirtualinherited

These virtual members are protected (rather than private) so that python-implemented derived classes may opt to use the default implementations.

C++ derived classes may override these methods, but should not call them. Derived classes should call the corresponding compute* 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.

Definition at line 199 of file Psf.cc.

200  {
201  std::shared_ptr<Psf::Image> im = computeKernelImage(position, color, COPY);
202  return recenterKernelImage(im, position);
203 }
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,...
Definition: Psf.cc:85

◆ doComputeImageBBox()

lsst::geom::Box2I Psf::doComputeImageBBox ( lsst::geom::Point2D const &  position,
image::Color const &  color 
) const
protectedvirtualinherited

Definition at line 205 of file Psf.cc.

206  {
207  std::shared_ptr<Psf::Image> im = computeImage(position, color, INTERNAL);
208  return im->getBBox();
209 }

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

57  {
60  *image, geom::Point2D(0.0, 0.0) // image has origin at the center
61  )
62  .getShape();
63 }
static Result computeAdaptiveMoments(ImageT const &image, geom::Point2D const &position, bool negative=false, Control const &ctrl=Control())
Compute the adaptive Gaussian-weighted moments of an image.
Shape const getShape() const
Return an afw::geom::ellipses object corresponding to xx, yy, xy.

◆ dynamicCast() [1/3]

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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
uint64_t * ptr
Definition: RangeSet.cc:88

◆ dynamicCast() [2/3]

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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

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

◆ dynamicCast() [3/3]

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::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

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

◆ 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
Note
When called on Python classes, this method delegates to __eq__ if it exists.

Reimplemented in lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::geom::SkyWcs, lsst::afw::geom::polygon::Polygon, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 48 of file Storable.cc.

48 { return this == &other; }

◆ getAverageColor()

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

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 274 of file Psf.h.

274 { return image::Color(); }
Describe the colour of a source.
Definition: Color.h:26

◆ getAveragePosition()

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

Return average position of stars; used as default position.

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

Definition at line 47 of file KernelPsf.cc.

47 { return _averagePosition; }

◆ getCacheCapacity()

std::size_t Psf::getCacheCapacity ( ) const
inherited

Return the capacity of the caches.

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

Definition at line 213 of file Psf.cc.

213 { return _kernelImageCache->capacity(); }

◆ getKernel()

std::shared_ptr<afw::math::Kernel const> lsst::meas::algorithms::KernelPsf::getKernel ( ) const
inline

Return the Kernel used to define this Psf.

Definition at line 52 of file KernelPsf.h.

52 { return _kernel; }

◆ getLocalKernel() [1/2]

std::shared_ptr< math::Kernel const > Psf::getLocalKernel ( ) const
inherited

Definition at line 155 of file Psf.cc.

155  {
156  return getLocalKernel(makeNullPoint());
157 }
std::shared_ptr< math::Kernel const > getLocalKernel() const
Definition: Psf.cc:155

◆ getLocalKernel() [2/2]

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

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

Parameters
[in]positionPosition at which to evaluate the PSF.
[in]colorColor of the source for which to evaluate the PSF; defaults to getAverageColor().

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

Definition at line 159 of file Psf.cc.

160  {
161  if (isPointNull(position)) position = getAveragePosition();
162  if (color.isIndeterminate()) color = getAverageColor();
163  // FixedKernel ctor will deep copy image, so we can use INTERNAL.
165  return std::make_shared<math::FixedKernel>(*image);
166 }

◆ getPersistenceName()

std::string lsst::meas::algorithms::KernelPsf::getPersistenceName ( ) const
overrideprotectedvirtual

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.

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

Definition at line 68 of file KernelPsf.cc.

68 { return "KernelPsf"; }

◆ getPythonModule()

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

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 70 of file KernelPsf.cc.

70 { return "lsst.meas.algorithms"; }

◆ hash_value()

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

Return a hash of this object (optional operation).

Exceptions
UnsupportedOperationExceptionThrown if this object is not hashable.
Note
C++ subclass authors are responsible for any associated specializations of std::hash.
When called on Python classes, this method delegates to __hash__ if it exists.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::FilterLabel, and lsst::afw::geom::polygon::Polygon.

Definition at line 44 of file Storable.cc.

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

◆ isPersistable()

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

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

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

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

Definition at line 66 of file KernelPsf.cc.

66 { return _kernel->isPersistable(); }

◆ readFits() [1/9]

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

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< KernelPsf > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [2/9]

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]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }

◆ readFits() [3/9]

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

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }

◆ readFits() [4/9]

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

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

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

◆ readFits() [5/9]

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]managerManager for the memory to read from.
[in]hduHDU 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.

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

◆ readFits() [6/9]

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

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU 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.

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

◆ readFits() [7/9]

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]fileNameName of the file to read.
[in]hduHDU 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.

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

◆ readFits() [8/9]

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

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

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

◆ readFits() [9/9]

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

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU 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.

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

◆ recenterKernelImage()

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

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 85 of file Psf.cc.

88  {
89  // "ir" : (integer, residual)
90  std::pair<int, double> const irX = image::positionToIndex(position.getX(), true);
91  std::pair<int, double> const irY = image::positionToIndex(position.getY(), true);
92 
93  if (irX.second != 0.0 || irY.second != 0.0) {
94  im = math::offsetImage(*im, irX.second, irY.second, warpAlgorithm, warpBuffer);
95  }
96 
97  im->setXY0(irX.first + im->getX0(), irY.first + im->getY0());
98  return im;
99 }
int positionToIndex(double pos)
Convert image position to nearest integer index.
Definition: ImageUtils.h:69
std::shared_ptr< ImageT > offsetImage(ImageT const &image, float dx, float dy, std::string const &algorithmName="lanczos5", unsigned int buffer=0)
Return an image offset by (dx, dy) using the specified algorithm.
Definition: offsetImage.cc:41

◆ resized()

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

Return a clone with specified kernel dimensions.

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

Reimplemented in lsst::meas::algorithms::SingleGaussianPsf, and lsst::meas::algorithms::PcaPsf.

Definition at line 43 of file KernelPsf.cc.

43  {
44  return std::make_shared<KernelPsf>(*_kernel->resized(width, height), _averagePosition);
45 }

◆ setCacheCapacity()

void Psf::setCacheCapacity ( std::size_t  capacity)
inherited

Set the capacity of the caches.

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

Definition at line 215 of file Psf.cc.

215  {
216  _imageCache->reserve(capacity);
217  _kernelImageCache->reserve(capacity);
218 }

◆ 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
TThe class expected of the two objects to be compared.
Parameters
lhs,rhsThe 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 151 of file Storable.h.

151  {
152  auto typedRhs = dynamic_cast<T const*>(&rhs);
153  if (typedRhs != nullptr) {
154  return lhs == *typedRhs;
155  } else {
156  return false;
157  }
158  }

◆ toString()

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

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

Exceptions
UnsupportedOperationExceptionThrown if this object does not have a string representation.
Note
When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::geom::SkyWcs, and lsst::afw::geom::polygon::Polygon.

Definition at line 40 of file Storable.cc.

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

◆ write()

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

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.

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

Definition at line 72 of file KernelPsf.cc.

72  {
73  static KernelPsfPersistenceHelper const& keys = KernelPsfPersistenceHelper::get();
74  afw::table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
75  std::shared_ptr<afw::table::BaseRecord> record = catalog.addNew();
76  record->set(keys.kernel, handle.put(_kernel));
77  record->set(keys.averagePosition, _averagePosition);
78  handle.saveCatalog(catalog);
79 }
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72
static KernelPsfPersistenceHelper const & get()
Definition: KernelPsf.cc:55

◆ writeFits() [1/3]

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

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

◆ 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]managerName of the file to write to.
[in]modeIf "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.

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ writeFits() [3/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]fileNameName of the file to write to.
[in]modeIf "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.

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

Friends And Related Function Documentation

◆ KernelPsfFactory

template<typename T , typename K >
friend class KernelPsfFactory
friend

Definition at line 81 of file KernelPsf.h.

◆ operator<<()

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

Output operator for Storable.

Parameters
osthe desired output stream
storablethe object to print
Returns
a reference to os
Exceptions
UnsupportedOperationExceptionThrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

174  {
175  return os << storable.toString();
176 }
std::ostream * os
Definition: Schema.cc:557

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