LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Related Symbols | List of all members
lsst::meas::algorithms::DoubleGaussianPsf Class Reference

Represent a Psf as a circularly symmetrical double Gaussian. More...

#include <DoubleGaussianPsf.h>

Inheritance diagram for lsst::meas::algorithms::DoubleGaussianPsf:
lsst::afw::table::io::PersistableFacade< DoubleGaussianPsf > 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

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.
 
using Image = image::Image<Pixel>
 Image type returned by computeImage.
 

Public Member Functions

 DoubleGaussianPsf (int width, int height, double sigma1, double sigma2=0.0, double b=0.0)
 Constructor for a DoubleGaussianPsf.
 
std::shared_ptr< afw::detection::Psfclone () const override
 Polymorphic deep copy. Usually unnecessary, as Psfs are immutable.
 
std::shared_ptr< afw::detection::Psfresized (int width, int height) const override
 Return a clone with specified kernel dimensions.
 
double getSigma1 () const
 Return the radius of the inner Gaussian.
 
double getSigma2 () const
 Return the radius of the outer Gaussian.
 
double getB () const
 Return the ratio of Gaussian peak amplitudes: outer/inner.
 
bool isPersistable () const noexcept override
 Whether this Psf is persistable (always true for DoubleGaussianPsf).
 
std::shared_ptr< afw::math::Kernel const > getKernel () const
 Return the Kernel used to define this Psf.
 
geom::Point2D getAveragePosition () const override
 Return average position of stars; used as default position.
 
std::shared_ptr< typehandling::Storable > cloneStorable () const override
 Polymorphic deep-copy.
 
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.
 
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.
 
double computePeak (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the peak value of the PSF image.
 
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.
 
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.
 
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.
 
image::Color getAverageColor () const
 Return the average Color of the stars used to construct the Psf.
 
lsst::geom::Box2I computeBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeKernelImage()
 
lsst::geom::Box2I computeImageBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeImage()
 
lsst::geom::Box2I computeKernelBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 Return the bounding box of the image returned by computeImage()
 
std::size_t getCacheCapacity () const
 Return the capacity of the caches.
 
void setCacheCapacity (std::size_t capacity)
 Set the capacity of the caches.
 
virtual std::string toString () const
 Create a string representation of this object (optional operation).
 
virtual std::size_t hash_value () const
 Return a hash of this object (optional operation).
 
virtual bool equals (Storable const &other) const noexcept
 Compare this object to another Storable.
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 Write the object to a regular FITS file.
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 Write the object to a FITS image in memory.
 
void writeFits (fits::Fits &fitsfile) const
 Write the object to an already-open FITS object.
 

Static Public Member Functions

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

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

std::string getPersistenceName () const override
 Return the unique name used to persist this object and look up its factory.
 
void write (OutputArchiveHandle &handle) const override
 Write the object to one or more catalogs.
 
std::string getPythonModule () const override
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
 
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.
 
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.
 

Related Symbols

(Note that these are not member symbols.)

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

Detailed Description

Represent a Psf as a circularly symmetrical double Gaussian.

Definition at line 34 of file DoubleGaussianPsf.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

◆ DoubleGaussianPsf()

lsst::meas::algorithms::DoubleGaussianPsf::DoubleGaussianPsf ( int width,
int height,
double sigma1,
double sigma2 = 0.0,
double b = 0.0 )

Constructor for a DoubleGaussianPsf.

Parameters
[in]widthNumber of columns in realisations of Psf
[in]heightNumber of rows in realisations of Psf
[in]sigma1Radius of inner Gaussian
[in]sigma2Radius of outer Gaussian
[in]bRatio of Gaussian peak amplitudes: outer/inner

Definition at line 123 of file DoubleGaussianPsf.cc.

124 : KernelPsf(makeDoubleGaussianKernel(width, height, sigma1, sigma2, b)),
125 _sigma1(sigma1),
126 _sigma2(sigma2),
127 _b(b) {}
table::Key< double > sigma2
table::Key< double > sigma1
table::Key< int > b
KernelPsf(afw::math::Kernel const &kernel, geom::Point2D const &averagePosition=geom::Point2D())
Construct a KernelPsf with a clone of the given kernel.
Definition KernelPsf.cc:33

Member Function Documentation

◆ clone()

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

Polymorphic deep copy. Usually unnecessary, as Psfs are immutable.

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

Definition at line 129 of file DoubleGaussianPsf.cc.

129 {
130 return std::make_shared<DoubleGaussianPsf>(getKernel()->getWidth(), getKernel()->getHeight(), _sigma1,
131 _sigma2, _b);
132}
std::shared_ptr< afw::math::Kernel const > getKernel() const
Return the Kernel used to define this Psf.
Definition KernelPsf.h:52

◆ cloneStorable()

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

Polymorphic deep copy. Usually unnecessary, as Psfs are immutable.

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()

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

165 {
166 if (isPointNull(position)) position = getAveragePosition();
167 if (color.isIndeterminate()) color = getAverageColor();
168 return doComputeApertureFlux(radius, position, color);
169}
image::Color getAverageColor() const
Return the average Color of the stars used to construct the Psf.
Definition Psf.h:239
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:189
bool isIndeterminate() const noexcept
Whether the color is the special value that indicates that it is unspecified.
Definition Color.h:36

◆ computeBBox()

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

127 {
128 if (isPointNull(position)) position = getAveragePosition();
129 if (color.isIndeterminate()) color = getAverageColor();
130 auto cached_image = _kernelImageCache->get(detail::PsfCacheKey(position, color));
131 if (cached_image.has_value()) {
132 return cached_image.value()->getBBox();
133 } else {
134 return doComputeBBox(position, color);
135 }
136}
virtual lsst::geom::Box2I doComputeBBox(lsst::geom::Point2D const &position, image::Color const &color) const =0

◆ computeImage()

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

102 {
103 if (isPointNull(position)) position = getAveragePosition();
104 if (color.isIndeterminate()) color = getAverageColor();
105 std::shared_ptr<Psf::Image> result = (*_imageCache)(
106 detail::PsfCacheKey(position, color),
107 [this](detail::PsfCacheKey const &key) { return doComputeImage(key.position, key.color); });
108 if (owner == COPY) {
109 result = std::make_shared<Image>(*result, true);
110 }
111 return result;
112}
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:177

◆ computeImageBBox()

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

138 {
139 if (isPointNull(position)) position = getAveragePosition();
140 if (color.isIndeterminate()) color = getAverageColor();
141 auto cached_image = _imageCache->get(detail::PsfCacheKey(position, color));
142 if (cached_image.has_value()) {
143 return cached_image.value()->getBBox();
144 } else {
145 return doComputeImageBBox(position, color);
146 }
147}
virtual lsst::geom::Box2I doComputeImageBBox(lsst::geom::Point2D const &position, image::Color const &color) const
Definition Psf.cc:183

◆ computeKernelBBox()

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

277 {
278 return computeBBox(position, color);
279 }
lsst::geom::Box2I computeBBox(lsst::geom::Point2D position, image::Color color=image::Color()) const
Return the bounding box of the image returned by computeKernelImage()
Definition Psf.cc:127

◆ computeKernelImage()

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

115 {
116 if (_isFixed || isPointNull(position)) position = getAveragePosition();
117 if (_isFixed || color.isIndeterminate()) color = getAverageColor();
118 std::shared_ptr<Psf::Image> result = (*_kernelImageCache)(
119 detail::PsfCacheKey(position, color),
120 [this](detail::PsfCacheKey const &key) { return doComputeKernelImage(key.position, key.color); });
121 if (owner == COPY) {
122 result = std::make_shared<Image>(*result, true);
123 }
124 return result;
125}
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()

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

158 {
159 if (isPointNull(position)) position = getAveragePosition();
160 if (color.isIndeterminate()) color = getAverageColor();
162 return (*image)(-image->getX0(), -image->getY0());
163}
std::shared_ptr< Image > computeKernelImage(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.
Definition Psf.cc:114

◆ computeShape()

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

171 {
172 if (isPointNull(position)) position = getAveragePosition();
173 if (color.isIndeterminate()) color = getAverageColor();
174 return doComputeShape(position, color);
175}
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 geom::Point2D const center(0.0, 0.0);
48 afw::geom::ellipses::Axes const axes(radius, radius);
49 afw::geom::ellipses::Ellipse ellipse(axes, center);
50 geom::Box2I box(ellipse.computeBBox());
51 // perhaps needs a grow here
52 afw::image::Image<double> image(*computeKernelImage(position, color, INTERNAL));
53 if (!image.getBBox().contains(box)) {
54 box.include(image.getBBox());
55 afw::image::Image<double> paddedImage(box);
56 paddedImage = 0.0;
57 paddedImage.assign(image, image.getBBox());
58 image = paddedImage;
59 }
61 image, ellipse, base::ApertureFluxControl());
62 return result.instFlux;
63}
afw::table::Key< afw::table::Array< ImagePixelT > > image
An integer coordinate rectangle.
Definition Box.h:55
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.

Reimplemented in lsst::meas::extensions::psfex::PsfexPsf.

Definition at line 177 of file Psf.cc.

178 {
180 return recenterKernelImage(im, position);
181}
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 183 of file Psf.cc.

184 {
186 return im->getBBox();
187}
std::shared_ptr< Image > computeImage(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.
Definition Psf.cc:101

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

66 {
69 *image, geom::Point2D(0.0, 0.0) // image has origin at the center
70 )
71 .getShape();
72}
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/4]

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.

◆ dynamicCast() [2/4]

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.

◆ dynamicCast() [3/4]

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.

◆ dynamicCast() [4/4]

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.

◆ 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::typehandling::StorableHelper< Base >, lsst::afw::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::PhotoCalib, and lsst::afw::image::VisitInfo.

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

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

◆ getAveragePosition()

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

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; }

◆ getB()

double lsst::meas::algorithms::DoubleGaussianPsf::getB ( ) const
inline

Return the ratio of Gaussian peak amplitudes: outer/inner.

Definition at line 60 of file DoubleGaussianPsf.h.

60{ return _b; }

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

191{ return _kernelImageCache->capacity(); }

◆ getKernel()

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

Return the Kernel used to define this Psf.

Definition at line 52 of file KernelPsf.h.

52{ return _kernel; }

◆ getLocalKernel()

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

150 {
151 if (isPointNull(position)) position = getAveragePosition();
152 if (color.isIndeterminate()) color = getAverageColor();
153 // FixedKernel ctor will deep copy image, so we can use INTERNAL.
155 return std::make_shared<math::FixedKernel>(*image);
156}

◆ getPersistenceName()

std::string lsst::meas::algorithms::DoubleGaussianPsf::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.

Definition at line 138 of file DoubleGaussianPsf.cc.

138{ return getDoubleGaussianPsfPersistenceName(); }

◆ getPythonModule()

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

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"; }

◆ getSigma1()

double lsst::meas::algorithms::DoubleGaussianPsf::getSigma1 ( ) const
inline

Return the radius of the inner Gaussian.

Definition at line 54 of file DoubleGaussianPsf.h.

54{ return _sigma1; }

◆ getSigma2()

double lsst::meas::algorithms::DoubleGaussianPsf::getSigma2 ( ) const
inline

Return the radius of the outer Gaussian.

Definition at line 57 of file DoubleGaussianPsf.h.

57{ return _sigma2; }

◆ 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::geom::polygon::Polygon, lsst::afw::image::FilterLabel, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 44 of file Storable.cc.

44 {
45 throw LSST_EXCEPT(UnsupportedOperationException, "Hashes are not supported.");
46}
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48

◆ isPersistable()

bool lsst::meas::algorithms::DoubleGaussianPsf::isPersistable ( ) const
inlineoverridevirtualnoexcept

Whether this Psf is persistable (always true for DoubleGaussianPsf).

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

Definition at line 63 of file DoubleGaussianPsf.h.

63{ return true; }

◆ readFits() [1/12]

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.

◆ readFits() [2/12]

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.

◆ readFits() [3/12]

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.

◆ readFits() [4/12]

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.

◆ readFits() [5/12]

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.

◆ readFits() [6/12]

static std::shared_ptr< DoubleGaussianPsf > lsst::afw::table::io::PersistableFacade< DoubleGaussianPsf >::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.

◆ readFits() [7/12]

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.

◆ readFits() [8/12]

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.

◆ readFits() [9/12]

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.

◆ readFits() [10/12]

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.

◆ readFits() [11/12]

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.

◆ readFits() [12/12]

static std::shared_ptr< DoubleGaussianPsf > lsst::afw::table::io::PersistableFacade< DoubleGaussianPsf >::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.

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

◆ resized()

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

Return a clone with specified kernel dimensions.

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

Definition at line 134 of file DoubleGaussianPsf.cc.

134 {
135 return std::make_shared<DoubleGaussianPsf>(width, height, _sigma1, _sigma2, _b);
136}

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

193 {
194 _imageCache->reserve(capacity);
195 _kernelImageCache->reserve(capacity);
196}

◆ 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::geom::polygon::Polygon, lsst::afw::geom::SkyWcs, lsst::afw::image::FilterLabel, lsst::afw::image::PhotoCalib, lsst::afw::image::VisitInfo, and lsst::afw::typehandling::StorableHelper< Base >.

Definition at line 40 of file Storable.cc.

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

◆ write()

void lsst::meas::algorithms::DoubleGaussianPsf::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.

Definition at line 140 of file DoubleGaussianPsf.cc.

140 {
141 static DoubleGaussianPsfPersistenceHelper const& keys = DoubleGaussianPsfPersistenceHelper::get();
142 afw::table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
143 std::shared_ptr<afw::table::BaseRecord> record = catalog.addNew();
144 (*record).set(keys.dimensions.getX(), getKernel()->getWidth());
145 (*record).set(keys.dimensions.getY(), getKernel()->getHeight());
146 (*record).set(keys.sigma1, getSigma1());
147 (*record).set(keys.sigma2, getSigma2());
148 (*record).set(keys.b, getB());
149 handle.saveCatalog(catalog);
150}
double getSigma1() const
Return the radius of the inner Gaussian.
double getSigma2() const
Return the radius of the outer Gaussian.
double getB() const
Return the ratio of Gaussian peak amplitudes: outer/inner.
CatalogT< BaseRecord > BaseCatalog
Definition fwd.h:72

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

◆ 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 Symbol Documentation

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

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