lsst.meas.algorithms  13.0-23-gb99accf8+14
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
lsst::meas::algorithms::WarpedPsf Class Reference

A Psf class that maps an arbitrary Psf through a coordinate transformation. More...

#include <WarpedPsf.h>

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

Public Member Functions

 WarpedPsf (boost::shared_ptr< afw::detection::Psf const > undistortedPsf, boost::shared_ptr< afw::geom::XYTransform const > distortion, boost::shared_ptr< afw::math::WarpingControl const > control)
 Construct WarpedPsf from unwarped psf and distortion. More...
 
 WarpedPsf (boost::shared_ptr< afw::detection::Psf const > undistortedPsf, boost::shared_ptr< afw::geom::XYTransform const > distortion, std::string const &kernelName="lanczos3", unsigned int cache=10000)
 
virtual afw::geom::Point2D getAveragePosition () const
 Return the average of the positions of the stars that went into this Psf. More...
 
virtual boost::shared_ptr< afw::detection::Psf > clone () const
 Polymorphic deep copy. Usually unnecessary, as Psfs are immutable. More...
 
virtual boost::shared_ptr< afw::detection::Psf > resized (int width, int height) const
 Return a clone with specified kernel dimensions. More...
 

Protected Member Functions

virtual boost::shared_ptr< afw::detection::Psf::Image > doComputeKernelImage (afw::geom::Point2D const &position, afw::image::Color const &color) const
 
virtual double doComputeApertureFlux (double radius, afw::geom::Point2D const &position, afw::image::Color const &color) const
 
virtual afw::geom::ellipses::Quadrupole doComputeShape (afw::geom::Point2D const &position, afw::image::Color const &color) const
 

Protected Attributes

boost::shared_ptr< afw::detection::Psf const > _undistortedPsf
 
boost::shared_ptr< afw::geom::XYTransform const > _distortion
 

Detailed Description

A Psf class that maps an arbitrary Psf through a coordinate transformation.

If K_0(x,x') is the unwarped PSF, and f is the coordinate transform, then the warped PSF is defined by

K(f(x),f(x')) = K_0(x,x') (*)

We linearize the coordinate transform in the vicinity of the point where the PSF is computed. The definition (*) does not include the Jacobian of the transformation, since the afw convention is that PSF's are normalized to have integral 1 anyway.

Definition at line 49 of file WarpedPsf.h.

Constructor & Destructor Documentation

◆ WarpedPsf() [1/2]

lsst::meas::algorithms::WarpedPsf::WarpedPsf ( boost::shared_ptr< afw::detection::Psf const >  undistortedPsf,
boost::shared_ptr< afw::geom::XYTransform const >  distortion,
boost::shared_ptr< afw::math::WarpingControl const >  control 
)

Construct WarpedPsf from unwarped psf and distortion.

If p is the nominal pixel position, and p' is the true position on the sky, then our convention for the transform is that p' = distortion.forwardTransform(p)

Definition at line 138 of file WarpedPsf.cc.

◆ WarpedPsf() [2/2]

lsst::meas::algorithms::WarpedPsf::WarpedPsf ( boost::shared_ptr< afw::detection::Psf const >  undistortedPsf,
boost::shared_ptr< afw::geom::XYTransform const >  distortion,
std::string const &  kernelName = "lanczos3",
unsigned int  cache = 10000 
)

Definition at line 151 of file WarpedPsf.cc.

Member Function Documentation

◆ clone()

boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::WarpedPsf::clone ( ) const
virtual

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

Definition at line 191 of file WarpedPsf.cc.

◆ doComputeApertureFlux()

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

Definition at line 31 of file ImagePsf.cc.

◆ doComputeKernelImage()

boost::shared_ptr< afw::detection::Psf::Image > lsst::meas::algorithms::WarpedPsf::doComputeKernelImage ( afw::geom::Point2D const &  position,
afw::image::Color const &  color 
) const
protectedvirtual

Definition at line 202 of file WarpedPsf.cc.

◆ doComputeShape()

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

Definition at line 46 of file ImagePsf.cc.

◆ getAveragePosition()

afw::geom::Point2D lsst::meas::algorithms::WarpedPsf::getAveragePosition ( ) const
virtual

Return the average of the positions of the stars that went into this Psf.

For WarpedPsf, this is just the transform of the undistorted Psf's average position.

Definition at line 187 of file WarpedPsf.cc.

◆ resized()

boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::WarpedPsf::resized ( int  width,
int  height 
) const
virtual

Return a clone with specified kernel dimensions.

Definition at line 195 of file WarpedPsf.cc.

Member Data Documentation

◆ _distortion

boost::shared_ptr< afw::geom::XYTransform const > lsst::meas::algorithms::WarpedPsf::_distortion
protected

Definition at line 91 of file WarpedPsf.h.

◆ _undistortedPsf

boost::shared_ptr< afw::detection::Psf const > lsst::meas::algorithms::WarpedPsf::_undistortedPsf
protected

Definition at line 90 of file WarpedPsf.h.


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