lsst::meas::extensions::psfex::PsfexPsf Class Reference

Represent a PSF as a linear combination of PSFEX (== Karhunen-Loeve) basis functions. More...

#include <PsfexPsf.h>

Inheritance diagram for lsst::meas::extensions::psfex::PsfexPsf:

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
	PsfexPsf (lsst::meas::extensions::psfex::Psf const &psf, lsst::geom::Point2D const &averagePosition=lsst::geom::Point2D())
	Constructor for a PsfexPsf.
	~PsfexPsf () override
std::shared_ptr< lsst::afw::detection::Psf >	clone () const override
	Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x.
std::shared_ptr< afw::detection::Psf >	resized (int width, int height) const override
	Return a clone with specified kernel dimensions.
lsst::geom::Point2D	getAveragePosition () const override
	Return average position of stars; used as default position.
std::shared_ptr< lsst::afw::math::LinearCombinationKernel const >	getKernel (lsst::geom::Point2D=lsst::geom::Point2D(std::numeric_limits< double >::quiet_NaN())) const
	Return the PSF's basis functions as a spatially-invariant LinearCombinationKernel with unit weights.
bool	isPersistable () const noexcept override
	Is this object persistable?
void	write (lsst::afw::table::io::OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs.
std::shared_ptr< typehandling::Storable >	cloneStorable () const override
	Polymorphic deep-copy.
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.
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.
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< PsfexPsf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< PsfexPsf >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< PsfexPsf >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< PsfexPsf >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.
static std::shared_ptr< ImagePsf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< ImagePsf >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< ImagePsf >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< Psf >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< Psf >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< Psf >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< ImagePsf >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.
static std::shared_ptr< Psf >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.
static std::shared_ptr< Image >	recenterKernelImage (std::shared_ptr< Image > im, lsst::geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)
	Helper function for Psf::doComputeImage(): converts a kernel image (centered at (0,0) when xy0 is taken into account) to an image centered at position when xy0 is taken into account.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
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 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.

Private Member Functions
virtual std::shared_ptr< lsst::afw::detection::Psf::Image >	_doComputeImage (lsst::geom::Point2D const &position, lsst::afw::image::Color const &color, lsst::geom::Point2D const &center) const
	Compute an image of the Psf at the specified position/colour, at pixel position in the output image.
std::shared_ptr< lsst::afw::detection::Psf::Image >	doComputeKernelImage (lsst::geom::Point2D const &position, lsst::afw::image::Color const &color) const override
	Compute an image of the Psf at the specified position/colour, at pixel (0.0, 0.0) in the output image.
std::shared_ptr< lsst::afw::detection::Psf::Image >	doComputeImage (lsst::geom::Point2D const &position, lsst::afw::image::Color const &color) const override
	Compute an image of the Psf at the specified position/colour, at pixel position in the output image.
lsst::geom::Box2I	doComputeBBox (lsst::geom::Point2D const &position, lsst::afw::image::Color const &color) const override
	Compute the bbox of the kernel image at the specified position/color.
std::string	getPersistenceName () const override
	Name used in table persistence.
std::string	getPythonModule () const override
	The python module name (for use in table persistence)

Friends
class	detail::PsfexPsfFactory

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

Detailed Description

Represent a PSF as a linear combination of PSFEX (== Karhunen-Loeve) basis functions.

Definition at line 39 of file PsfexPsf.h.

Member Typedef Documentation

Image

using lsst::afw::detection::Psf::Image = image::Image<Pixel>

inherited

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 lsst::afw::detection::Psf::ImageOwnerEnum

inherited

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.

                        {
        COPY = 0,    
        INTERNAL = 1 
    };

Constructor & Destructor Documentation

PsfexPsf()

lsst::meas::extensions::psfex::PsfexPsf::PsfexPsf ( lsst::meas::extensions::psfex::Psf const & psf, lsst::geom::Point2D const & averagePosition = lsst::geom::Point2D() )

explicit

Constructor for a PsfexPsf.

Parameters

[in]	psf	Psfex PSF model to be wrapped into an LSST Psf
[in]	averagePosition	Average position of stars used to construct the Psf.

Definition at line 64 of file PsfexPsf.cc.

                    : ImagePsf(), _averagePosition(averagePosition),
                      _size(psf.impl->dim),
                      _comp(psf.impl->npix),
                      _context(psf.impl->poly->ndim)
 
{
    _poly = poly_copy(psf.impl->poly);
 
    _pixstep = psf.impl->pixstep;
 
    std::copy(psf.impl->size, psf.impl->size + psf.impl->dim, _size.begin());
 
    std::copy(psf.impl->comp, psf.impl->comp + psf.impl->npix, _comp.begin());
 
    for (int i = 0; i != psf.impl->poly->ndim; ++i) {
        _context[i].first = psf.impl->contextoffset[i];
        _context[i].second = psf.impl->contextscale[i];
    }
}

~PsfexPsf()

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

override

Definition at line 98 of file PsfexPsf.cc.

{
    poly_end(_poly);
}

Member Function Documentation

_doComputeImage()

std::shared_ptr< afw::detection::Psf::Image > lsst::meas::extensions::psfex::PsfexPsf::_doComputeImage ( lsst::geom::Point2D const & position, lsst::afw::image::Color const & color, lsst::geom::Point2D const & center ) const

privatevirtual

Compute an image of the Psf at the specified position/colour, at pixel position in the output image.

Parameters

position	position within the chip
color	colour of object
center	position of center of image in the output image

Definition at line 225 of file PsfexPsf.cc.

{
    double pos[MAXCONTEXT];
    int const ndim = _context.size();
    if (ndim != 2) {                    // we're only handling spatial variation for now
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                          str(boost::format("Only spatial variation (ndim == 2) is supported; saw %d")
                              % ndim));
 
    }
 
    for (int i = 0; i < ndim; ++i) {
        pos[i] = (position[i] - _context[i].first)/_context[i].second;
    }
 
    poly_func(_poly, pos);              // evaluate polynomial
 
    int const w = _size[0], h = _size[1];
    std::vector<float> fullresIm(w*h);       // accumulate full-resolution image into this buffer
    const int nbasis = _size.size() > 2 ? _size[2] : 1; // number of basis functions
 
    /* Sum each component */
    int const npix = w*h;
    for (int i = 0; i != nbasis; ++i) {
        float *pl = &fullresIm[0];
        float const fac = _poly->basis[i];
        float const *ppc = &_comp[i*w*h];
 
        for (int j = 0; j != npix; ++j) {
            pl[j] +=  fac*ppc[j];
        }
    }
    /*
     * We now have the image reconstructed at internal resolution; resample it onto the output resolution
     * and subpixel offset
     */
    float const vigstep = 1/_pixstep;
    float dx = center[0] - static_cast<int>(center[0]);
    float dy = center[1] - static_cast<int>(center[1]);
    if (dx > 0.5) dx -= 1.0;
    if (dy > 0.5) dy -= 1.0;
    //
    // And copy it into place
    //
    geom::Box2I bbox = _doComputeBBox(position, center);
    std::shared_ptr<afw::detection::Psf::Image> im = std::make_shared<afw::detection::Psf::Image>(bbox);
 
    int sampleW = bbox.getWidth();
    int sampleH = bbox.getHeight();
 
    std::vector<float> sampledIm(sampleW*sampleH);
 
    vignet_resample(&fullresIm[0], w, h,
                    &sampledIm[0], sampleW, sampleH,
                    -dx*vigstep, -dy*vigstep, vigstep, 1.0);
    {
        float *pl = &sampledIm[0];
        float const sum = std::accumulate(pl, pl + sampleW*sampleH, static_cast<float>(0));
        for (int y = 0; y != sampleH; ++y) {
            for (int x = 0; x != sampleW; ++x) {
                (*im)(x, y) = *pl++/sum;
            }
        }
    }
 
    return im;
}

clone()

std::shared_ptr< afw::detection::Psf > lsst::meas::extensions::psfex::PsfexPsf::clone ( ) const

overridevirtual

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

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

Definition at line 104 of file PsfexPsf.cc.

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

cloneStorable()

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

inlineoverridevirtualinherited

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

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.

{ return clone(); }

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]	radius	Radius of the aperture to measure.
[in]	position	Position at which to evaluate the PSF.
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().

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

Definition at line 165 of file Psf.cc.

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

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]	position	Position at which to evaluate the PSF.
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().

Definition at line 127 of file Psf.cc.

                                                                               {
    if (isPointNull(position)) position = getAveragePosition();
    if (color.isIndeterminate()) color = getAverageColor();
    auto cached_image = _kernelImageCache->get(detail::PsfCacheKey(position, color));
    if (cached_image.has_value()) {
        return cached_image.value()->getBBox();
    } else {
        return doComputeBBox(position, color);
    }
}

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

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

Note

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

Definition at line 101 of file Psf.cc.

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

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]	position	Position at which to evaluate the PSF.
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().

Definition at line 138 of file Psf.cc.

                                                                                    {
    if (isPointNull(position)) position = getAveragePosition();
    if (color.isIndeterminate()) color = getAverageColor();
    auto cached_image = _imageCache->get(detail::PsfCacheKey(position, color));
    if (cached_image.has_value()) {
        return cached_image.value()->getBBox();
    } else {
        return doComputeImageBBox(position, color);
    }
}

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]	position	Position at which to evaluate the PSF.
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor(). Alias for computeBBox

Definition at line 276 of file Psf.h.

                                                                               {
        return computeBBox(position, color);
    }

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

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

Note

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

Definition at line 114 of file Psf.cc.

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

computePeak()

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

inherited

Return the peak value of the PSF image.

Parameters

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

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

Definition at line 158 of file Psf.cc.

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

computeShape()

geom::ellipses::Quadrupole 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]	position	Position at which to evaluate the PSF.
[in]	color	Color of the source for which to evaluate the PSF; defaults to getAverageColor().

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

Definition at line 171 of file Psf.cc.

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

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.

                                                                         {
    geom::Point2D const center(0.0, 0.0);
    afw::geom::ellipses::Axes const axes(radius, radius);
    afw::geom::ellipses::Ellipse ellipse(axes, center);
    geom::Box2I box(ellipse.computeBBox());
    // perhaps needs a grow here
    afw::image::Image<double> image(*computeKernelImage(position, color, INTERNAL));
    if (!image.getBBox().contains(box)) {
        box.include(image.getBBox());
        afw::image::Image<double> paddedImage(box);
        paddedImage = 0.0;
        paddedImage.assign(image, image.getBBox());
        image = paddedImage;
    }
    base::ApertureFluxResult result = base::ApertureFluxAlgorithm::computeSincFlux(
            image, ellipse, base::ApertureFluxControl());
    return result.instFlux;
}

doComputeBBox()

geom::Box2I lsst::meas::extensions::psfex::PsfexPsf::doComputeBBox ( lsst::geom::Point2D const & position, lsst::afw::image::Color const & color ) const

overrideprivatevirtual

Compute the bbox of the kernel image at the specified position/color.

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

Definition at line 196 of file PsfexPsf.cc.

                                                                  {
    return _doComputeBBox(position, geom::Point2D(0, 0));
}

doComputeImage()

std::shared_ptr< afw::detection::Psf::Image > lsst::meas::extensions::psfex::PsfexPsf::doComputeImage ( lsst::geom::Point2D const & position, lsst::afw::image::Color const & color ) const

overrideprivatevirtual

Compute an image of the Psf at the specified position/colour, at pixel position in the output image.

Parameters

position	position within the chip
color	colour of object

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

Definition at line 184 of file PsfexPsf.cc.

                                                            {
    return _doComputeImage(position, color, position);
}

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.

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

doComputeKernelImage()

std::shared_ptr< afw::detection::Psf::Image > lsst::meas::extensions::psfex::PsfexPsf::doComputeKernelImage ( lsst::geom::Point2D const & position, lsst::afw::image::Color const & color ) const

overrideprivatevirtual

Compute an image of the Psf at the specified position/colour, at pixel (0.0, 0.0) in the output image.

Parameters

position	position within the chip
color	colour of object

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

Definition at line 190 of file PsfexPsf.cc.

{
    return _doComputeImage(position, color, geom::Point2D(0, 0));
}

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.

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

dynamicCast() [1/3]

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

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

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

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

dynamicCast() [2/3]

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

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

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

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

dynamicCast() [3/3]

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

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

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

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 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.

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

{ return image::Color(); }

getAveragePosition()

lsst::geom::Point2D lsst::meas::extensions::psfex::PsfexPsf::getAveragePosition ( ) const

inlineoverridevirtual

Return average position of stars; used as default position.

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

Definition at line 60 of file PsfexPsf.h.

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

{ return _kernelImageCache->capacity(); }

getKernel()

std::shared_ptr< afw::math::LinearCombinationKernel const > lsst::meas::extensions::psfex::PsfexPsf::getKernel

(

lsst::geom::Point2D

position = lsst::geom::Point2D(std::numeric_limits<double>::quiet_NaN())

)

const

Return the PSF's basis functions as a spatially-invariant LinearCombinationKernel with unit weights.

Definition at line 114 of file PsfexPsf.cc.

{
    double pos[MAXCONTEXT];
    int const ndim = _context.size();
    if (ndim != 2) {                    // we're only handling spatial variation for now
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                          str(boost::format("Only spatial variation (ndim == 2) is supported; saw %d")
                              % ndim));
 
    }
    // where we want to evaluate the basis function's weights
    if (!std::isfinite(position[0])) {
        position = _averagePosition;
    }
 
    for (int i = 0; i < ndim; ++i) {
        pos[i] = (position[i] - _context[i].first)/_context[i].second;
    }
 
    poly_func(_poly, pos);              // evaluate polynomial
 
    int const w = _size[0], h = _size[1];
    std::vector<float> fullresIm(w*h);       // accumulate full-resolution image into this buffer
    /*
     * Create a fixed Kernel out of each component, and then create a LinearCombinationKernel from them
     */
    const int nbasis = _size.size() > 2 ? _size[2] : 1; // number of basis functions
    afw::math::KernelList kernels; kernels.reserve(nbasis); // the insides of the LinearCombinationKernel
    std::vector<double>   weights; weights.reserve(nbasis);
 
    float const vigstep = 1/_pixstep;
    float const dx = 0.0, dy = 0.0;
 
    geom::Box2I bbox = _doComputeBBox(position, geom::Point2D(0, 0));
    afw::detection::Psf::Image kim(bbox); // a basis function image, to be copied into a FixedKernel
 
    int sampleW = bbox.getWidth();
    int sampleH = bbox.getHeight();
 
    std::vector<float> sampledBasis(sampleW*sampleH);
 
    for (int i = 0; i != nbasis; ++i) {
        /*
         * Resample the basis function onto the output resolution (and potentially subpixel offset)
         */
        vignet_resample(const_cast<float *>(&_comp[i*w*h]), w, h,
                        &sampledBasis[0],  sampleW, sampleH,
                        -dx*vigstep, -dy*vigstep, vigstep, 1.0);
        //
        // And copy it into place
        //
        {
            float *pl = &sampledBasis[0];
            for (int y = 0; y != sampleH; ++y) {
                for (int x = 0; x != sampleW; ++x) {
                    kim(x, y) = *pl++;
                }
            }
        }
 
        kernels.push_back(std::make_shared<afw::math::FixedKernel>(kim));
        weights.push_back(_poly->basis[i]);
    }
 
    _kernel = std::make_shared<afw::math::LinearCombinationKernel>(kernels, weights);
 
    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]	position	Position at which to evaluate the PSF.
[in]	color	Color 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.

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

getPersistenceName()

std::string lsst::meas::extensions::psfex::PsfexPsf::getPersistenceName ( ) const

overrideprivatevirtual

Name used in table persistence.

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

Definition at line 477 of file PsfexPsf.cc.

{ return getPsfexPsfPersistenceName(); }

getPythonModule()

std::string lsst::meas::extensions::psfex::PsfexPsf::getPythonModule ( ) const

overrideprivatevirtual

The python module name (for use in table persistence)

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

Definition at line 475 of file PsfexPsf.cc.

{ return "lsst.meas.extensions.psfex"; }

hash_value()

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

virtualinherited

Return a hash of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object is not hashable.

Note

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.

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

isPersistable()

bool lsst::meas::extensions::psfex::PsfexPsf::isPersistable ( ) const

inlineoverridevirtualnoexcept

Is this object persistable?

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

Definition at line 69 of file PsfexPsf.h.

{ return true; }

readFits() [1/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]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

readFits() [2/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]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

readFits() [3/9]

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

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

readFits() [4/9]

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

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

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

Definition at line 205 of file Persistable.h.

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]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

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]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

readFits() [7/9]

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

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

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

Definition at line 194 of file Persistable.h.

readFits() [8/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]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

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]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

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.

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

resized()

std::shared_ptr< afw::detection::Psf > lsst::meas::extensions::psfex::PsfexPsf::resized ( int width, int height ) const

overridevirtual

Return a clone with specified kernel dimensions.

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

Definition at line 109 of file PsfexPsf.cc.

                                             {
    throw LSST_EXCEPT(pex::exceptions::LogicError, "Not Implemented");
}

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.

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

singleClassEquals()

template<class T >

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

inlinestaticprotectedinherited

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

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

Template Parameters

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

Parameters

lhs,rhs

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

Returns

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

Exception Safety

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

Note

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

This method template is typically called from equals as:

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

Definition at line 151 of file Storable.h.

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

toString()

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

virtualinherited

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

Exceptions

UnsupportedOperationException

Thrown if this object does not have a string representation.

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.

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

write()

void lsst::meas::extensions::psfex::PsfexPsf::write ( lsst::afw::table::io::OutputArchiveHandle & handle ) const

overridevirtual

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 479 of file PsfexPsf.cc.

                                                                 {
    // First write the dimensions of the various arrays to an HDU, so we can construct the second
    // HDU using them when we read the Psf back
    {
        PsfexPsfSchema1 const keys;
        afw::table::BaseCatalog cat = handle.makeCatalog(keys.schema);
        std::shared_ptr<afw::table::BaseRecord> record = cat.addNew();
 
        // Sizes in _poly
        record->set(keys.ndim, _poly->ndim);
        record->set(keys.ngroup, _poly->ngroup);
        record->set(keys.ncoeff, _poly->ncoeff);
        // Other scalars
        record->set(keys.averagePosition, _averagePosition);
        record->set(keys._pixstep, _pixstep);
        record->set(keys._size_size, _size.size());
        record->set(keys._comp_size, _comp.size());
        record->set(keys._context_size, _context.size());
 
        handle.saveCatalog(cat);
    }
    // Now we can write the data
    {
        PsfexPsfSchema2 const keys(_poly->ndim, _poly->ngroup, _poly->ncoeff,
                                   _size.size(), _comp.size(), _context.size());
        afw::table::BaseCatalog cat = handle.makeCatalog(keys.schema);
        // _poly
        std::shared_ptr<afw::table::BaseRecord> record = cat.addNew();
        {
            int *begin = record->getElement(keys.group);
            std::copy(_poly->group, _poly->group + _poly->ndim, begin);
        }
        {
            int *begin = record->getElement(keys.degree);
            std::copy(_poly->degree, _poly->degree + _poly->ngroup, begin);
        }
        {
            double *begin = record->getElement(keys.basis);
            std::copy(_poly->basis, _poly->basis + _poly->ncoeff, begin);
        }
        {
            double *begin = record->getElement(keys.coeff);
            std::copy(_poly->coeff, _poly->coeff + _poly->ncoeff, begin);
        }
        // vectors
        {
            int *begin = record->getElement(keys._size);
            std::copy(_size.begin(), _size.end(), begin);
        }
        {
            float *begin = record->getElement(keys._comp);
            std::copy(_comp.begin(), _comp.end(), begin);
        }
        {
            double *begin1 = record->getElement(keys._context_first);
            double *begin2 = record->getElement(keys._context_second);
            for (unsigned int i = 0; i != _context.size(); ++i) {
                begin1[i] = _context[i].first;
                begin2[i] = _context[i].second;
            }
        }
 
        handle.saveCatalog(cat);
    }
}

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]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

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

writeFits() [2/3]

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

inherited

Write the object to a FITS image in memory.

Parameters

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

Definition at line 29 of file Persistable.cc.

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

writeFits() [3/3]

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

inherited

Write the object to a regular FITS file.

Parameters

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

Definition at line 24 of file Persistable.cc.

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

Friends And Related Symbol Documentation

detail::PsfexPsfFactory

friend class detail::PsfexPsfFactory

friend

Definition at line 41 of file PsfexPsf.h.

operator<<()

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

related

Output operator for Storable.

Parameters

os	the desired output stream
storable	the object to print

Returns

a reference to os

Exceptions

UnsupportedOperationException

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

Definition at line 174 of file Storable.h.

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

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_extensions_psfex/g2305ad1205+c0501b3732/include/lsst/meas/extensions/psfex/PsfexPsf.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_extensions_psfex/g2305ad1205+c0501b3732/src/PsfexPsf.cc