lsst.meas.extensions.psfex  19.0.0-3-gfe04aa6+10
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
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:
lsst::afw::table::io::PersistableFacade< PsfexPsf > lsst::meas::algorithms::ImagePsf lsst::afw::detection::Psf PersistableFacade< Psf > lsst::afw::typehandling::Storable lsst::afw::table::io::Persistable

Public Types

enum  ImageOwnerEnum
 
typedef math::Kernel::Pixel Pixel
 
typedef image::Image< PixelImage
 

Public Member Functions

 PsfexPsf (lsst::meas::extensions::psfex::Psf const &psf, lsst::geom::Point2D const &averagePosition=lsst::geom::Point2D())
 Constructor for a PsfexPsf. More...
 
virtual ~PsfexPsf ()
 
virtual boost::shared_ptr< lsst::afw::detection::Psfclone () const
 Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x. More...
 
virtual boost::shared_ptr< afw::detection::Psfresized (int width, int height) const
 Return a clone with specified kernel dimensions. More...
 
virtual lsst::geom::Point2D getAveragePosition () const
 Return average position of stars; used as default position. More...
 
boost::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. More...
 
virtual bool isPersistable () const noexcept override
 Is this object persistable? More...
 
void write (lsst::afw::table::io::OutputArchiveHandle &handle) const
 
std::shared_ptr< typehandling::Storable > cloneStorable () const override final
 
std::shared_ptr< ImagecomputeImage (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 
std::shared_ptr< ImagecomputeKernelImage (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 
double computePeak (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
double computeApertureFlux (double radius, lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
geom::ellipses::Quadrupole computeShape (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
std::shared_ptr< math::Kernel const > getLocalKernel (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
image::Color getAverageColor () const
 
lsst::geom::Box2I computeBBox (lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
std::size_t getCacheCapacity () const
 
void setCacheCapacity (std::size_t capacity)
 
virtual std::string toString () const
 
virtual std::size_t hash_value () const
 
virtual bool equals (Storable const &other) const noexcept
 
virtual bool equals (Storable const &other) const noexcept
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 
void writeFits (fits::Fits &fitsfile) const
 
std::ostreamoperator<< (std::ostream &os, Storable const &storable)
 
std::ostreamoperator<< (std::ostream &os, Storable const &storable)
 

Static Public Member Functions

static std::shared_ptr< T > readFits (fits::Fits &fitsfile)
 
static std::shared_ptr< T > readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< T > readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< T > dynamicCast (std::shared_ptr< Persistable > const &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)
 
static std::shared_ptr< PsfreadFits (fits::Fits &fitsfile)
 
static std::shared_ptr< PsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< PsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< PsfreadFits (fits::Fits &fitsfile)
 
static std::shared_ptr< PsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< PsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 

Public Attributes

 COPY
 
 INTERNAL
 

Protected Types

typedef io::OutputArchiveHandle 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 void write (OutputArchiveHandle &handle) const
 

Static Protected Member Functions

static bool singleClassEquals (T const &lhs, Storable const &rhs)
 
static bool singleClassEquals (T const &lhs, Storable const &rhs)
 

Friends

class detail::PsfexPsfFactory
 

Detailed Description

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

Definition at line 39 of file PsfexPsf.h.

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[in] Psfex PSF model to be wrapped into an LSST Psf
[in]averagePosition[in] Average position of stars used to construct the Psf.

Definition at line 64 of file PsfexPsf.cc.

◆ ~PsfexPsf()

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

Definition at line 98 of file PsfexPsf.cc.

Member Function Documentation

◆ clone()

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

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.

◆ getAveragePosition()

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

Return average position of stars; used as default position.

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

Definition at line 60 of file PsfexPsf.h.

◆ getKernel()

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

◆ isPersistable()

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

Is this object persistable?

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

Definition at line 69 of file PsfexPsf.h.

◆ resized()

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

Return a clone with specified kernel dimensions.

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

Definition at line 109 of file PsfexPsf.cc.

◆ write()

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

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

Definition at line 479 of file PsfexPsf.cc.

Friends And Related Function Documentation

◆ detail::PsfexPsfFactory

friend class detail::PsfexPsfFactory
friend

Definition at line 41 of file PsfexPsf.h.


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