lsst.meas.algorithms g583670f1f2+5289d273bb
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static 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::afw::typehandling::Storable lsst::afw::table::io::Persistable

Public Types

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

Public Member Functions

 SingleGaussianPsf (int width, int height, double sigma)
 Constructor for a SingleGaussianPsf. More...
 
std::shared_ptr< afw::detection::Psfclone () const override
 Polymorphic deep copy; should usually unnecessary because Psfs are immutable. More...
 
std::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...
 
std::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< typehandling::Storable > cloneStorable () const override
 
std::shared_ptr< ImagecomputeImage (lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 
std::shared_ptr< ImagecomputeImage () const
 
std::shared_ptr< ImagecomputeKernelImage (lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 
std::shared_ptr< ImagecomputeKernelImage () const
 
double computePeak (lsst::geom::Point2D position, image::Color color=image::Color()) const
 
double computePeak () const
 
double computeApertureFlux (double radius, lsst::geom::Point2D position, image::Color color=image::Color()) const
 
double computeApertureFlux (double radius) const
 
geom::ellipses::Quadrupole computeShape (lsst::geom::Point2D position, image::Color color=image::Color()) const
 
geom::ellipses::Quadrupole computeShape () const
 
std::shared_ptr< math::Kernel const > getLocalKernel (lsst::geom::Point2D position, image::Color color=image::Color()) const
 
std::shared_ptr< math::Kernel const > getLocalKernel () const
 
image::Color getAverageColor () const
 
lsst::geom::Box2I computeBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 
lsst::geom::Box2I computeBBox () const
 
lsst::geom::Box2I computeImageBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 
lsst::geom::Box2I computeImageBBox () const
 
lsst::geom::Box2I computeKernelBBox (lsst::geom::Point2D position, image::Color color=image::Color()) const
 
lsst::geom::Box2I computeKernelBBox () 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< 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 > 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< 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< T > dynamicCast (std::shared_ptr< Persistable > const &ptr)
 
static std::shared_ptr< T > dynamicCast (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)
 

Public Attributes

 COPY
 
 INTERNAL
 

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
 
virtual std::shared_ptr< ImagedoComputeImage (lsst::geom::Point2D const &position, image::Color const &color) const
 
virtual lsst::geom::Box2I doComputeImageBBox (lsst::geom::Point2D const &position, image::Color const &color) const
 

Static Protected Member Functions

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

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

std::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

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

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

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

Definition at line 65 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()

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.

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

std::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: