lsst.meas.algorithms  16.0-20-g21842373+1
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | List of all members
lsst::meas::algorithms::SingleGaussianPsf Class Reference

Represent a PSF as a circularly symmetrical Gaussian. More...

#include <SingleGaussianPsf.h>

Inheritance diagram for lsst::meas::algorithms::SingleGaussianPsf:
lsst::afw::table::io::PersistableFacade< SingleGaussianPsf > 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::daf::base::Citizen PersistableFacade< Psf > lsst::afw::table::io::Persistable

Public Types

enum  ImageOwnerEnum
 
typedef math::Kernel::Pixel Pixel
 
typedef image::Image< PixelImage
 
typedef unsigned long memId
 
typedef memId(* memNewCallback) (const memId cid)
 
typedef memId(* memCallback) (const Citizen *ptr)
 

Public Member Functions

 SingleGaussianPsf (int width, int height, double sigma)
 Constructor for a SingleGaussianPsf. More...
 
boost::shared_ptr< afw::detection::Psfclone () const override
 Polymorphic deep copy; should usually unnecessary because Psfs are immutable. More...
 
boost::shared_ptr< afw::detection::Psfresized (int width, int height) const override
 Return a clone with specified kernel dimensions. More...
 
double getSigma () const
 Return the radius of the Gaussian. More...
 
bool isPersistable () const noexcept override
 Whether the Psf is persistable; always true. More...
 
boost::shared_ptr< afw::math::Kernel const > getKernel () const
 Return the Kernel used to define this Psf. More...
 
geom::Point2D getAveragePosition () const override
 Return average position of stars; used as default position. More...
 
std::shared_ptr< 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)
 
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::string repr () const
 
void markPersistent (void)
 
memId getId () const
 

Static Public Member Functions

static std::shared_ptr< SingleGaussianPsfreadFits (fits::Fits &fitsfile)
 
static std::shared_ptr< SingleGaussianPsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< SingleGaussianPsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< SingleGaussianPsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 
static std::shared_ptr< KernelPsfreadFits (fits::Fits &fitsfile)
 
static std::shared_ptr< KernelPsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< KernelPsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< ImagePsfreadFits (fits::Fits &fitsfile)
 
static std::shared_ptr< ImagePsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< ImagePsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
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< KernelPsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 
static std::shared_ptr< ImagePsfdynamicCast (std::shared_ptr< Persistable > const &ptr)
 
static std::shared_ptr< PsfdynamicCast (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 bool hasBeenCorrupted ()
 
static memId getNextMemId ()
 
static int init ()
 
static int census (int, memId startingMemId=0)
 
static void census (std::ostream &stream, memId startingMemId=0)
 
static const std::vector< const Citizen *> * census ()
 
static int census (int, memId startingMemId=0)
 
static void census (std::ostream &stream, memId startingMemId=0)
 
static const std::vector< const Citizen *> * census ()
 
static memId setNewCallbackId (memId id)
 
static memId setNewCallbackId (memId id)
 
static memId setDeleteCallbackId (memId id)
 
static memId setDeleteCallbackId (memId id)
 
static memNewCallback setNewCallback (memNewCallback func)
 
static memCallback setDeleteCallback (memCallback func)
 
static memCallback setCorruptionCallback (memCallback func)
 

Public Attributes

 COPY
 
 INTERNAL
 
 magicSentinel
 

Protected Types

typedef io::OutputArchiveHandle OutputArchiveHandle
 

Protected Member Functions

std::string getPersistenceName () const override
 
void write (OutputArchiveHandle &handle) const override
 
std::string getPythonModule () const override
 
virtual void write (OutputArchiveHandle &handle) const
 
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
 

Detailed Description

Represent a PSF as a circularly symmetrical Gaussian.

Definition at line 37 of file SingleGaussianPsf.h.

Constructor & Destructor Documentation

◆ SingleGaussianPsf()

lsst::meas::algorithms::SingleGaussianPsf::SingleGaussianPsf ( int  width,
int  height,
double  sigma 
)
explicit

Constructor for a SingleGaussianPsf.

Parameters
[in]widthNumber of columns in realizations of the PSF at a point.
[in]heightNumber of rows in realizations of the PSF at a point.
[in]sigmaRadius of the Gaussian.

Additional arguments are historical and ignored, and maybe be removed in the future.

Member Function Documentation

◆ clone()

boost::shared_ptr< afw::detection::Psf > lsst::meas::algorithms::SingleGaussianPsf::clone ( ) const
overridevirtual

Polymorphic deep copy; should usually unnecessary because Psfs are immutable.

Reimplemented from lsst::meas::algorithms::KernelPsf.

◆ doComputeApertureFlux()

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

Definition at line 45 of file ImagePsf.cc.

◆ doComputeShape()

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

Definition at line 56 of file ImagePsf.cc.

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

◆ getKernel()

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

◆ getPersistenceName()

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

Reimplemented from lsst::meas::algorithms::KernelPsf.

◆ getPythonModule()

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

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

Definition at line 72 of file KernelPsf.cc.

◆ getSigma()

double lsst::meas::algorithms::SingleGaussianPsf::getSigma ( ) const
inline

Return the radius of the Gaussian.

Definition at line 57 of file SingleGaussianPsf.h.

◆ isPersistable()

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

Whether the Psf is persistable; always true.

Reimplemented from lsst::meas::algorithms::KernelPsf.

Definition at line 60 of file SingleGaussianPsf.h.

◆ resized()

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

Return a clone with specified kernel dimensions.

Reimplemented from lsst::meas::algorithms::KernelPsf.

◆ write()

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

Reimplemented from lsst::meas::algorithms::KernelPsf.


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