lsst.meas.algorithms  15.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Friends | List of all members
lsst::meas::algorithms::DoubleGaussianPsf Class Reference

Represent a Psf as a circularly symmetrical double Gaussian. More...

#include <DoubleGaussianPsf.h>

Inheritance diagram for lsst::meas::algorithms::DoubleGaussianPsf:
lsst::afw::table::io::PersistableFacade< DoubleGaussianPsf > 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 lsst::daf::base::Persistable 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)
 
typedef std::shared_ptr< PersistablePtr
 

Public Member Functions

 DoubleGaussianPsf (int width, int height, double sigma1, double sigma2=0.0, double b=0.0)
 Constructor for a DoubleGaussianPsf. More...
 
virtual boost::shared_ptr< afw::detection::Psfclone () const
 Polymorphic deep copy. Usually unnecessary, as Psfs are immutable. More...
 
virtual boost::shared_ptr< afw::detection::Psfresized (int width, int height) const
 Return a clone with specified kernel dimensions. More...
 
double getSigma1 () const
 Return the radius of the inner Gaussian. More...
 
double getSigma2 () const
 Return the radius of the outer Gaussian. More...
 
double getB () const
 Return the ratio of Gaussian peak amplitudes: outer/inner. More...
 
virtual bool isPersistable () const
 Whether this Psf is persistable (always true for DoubleGaussianPsf). More...
 
boost::shared_ptr< afw::math::Kernel const > getKernel () const
 Return the Kernel used to define this Psf. More...
 
virtual afw::geom::Point2D getAveragePosition () const
 Return average position of stars; used as default position. More...
 
std::shared_ptr< ImagecomputeImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 
std::shared_ptr< ImagecomputeKernelImage (geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
 
double computePeak (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
double computeApertureFlux (double radius, geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
geom::ellipses::Quadrupole computeShape (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
std::shared_ptr< math::Kernel const > getLocalKernel (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
image::Color getAverageColor () const
 
geom::Box2I computeBBox (geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
 
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< DoubleGaussianPsfreadFits (fits::Fits &fitsfile)
 
static std::shared_ptr< DoubleGaussianPsfreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 
static std::shared_ptr< DoubleGaussianPsfreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 
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< ImagerecenterKernelImage (std::shared_ptr< Image > im, 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

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

Friends

class boost::serialization::access
 

Detailed Description

Represent a Psf as a circularly symmetrical double Gaussian.

Definition at line 35 of file DoubleGaussianPsf.h.

Constructor & Destructor Documentation

◆ DoubleGaussianPsf()

lsst::meas::algorithms::DoubleGaussianPsf::DoubleGaussianPsf ( int  width,
int  height,
double  sigma1,
double  sigma2 = 0.0,
double  b = 0.0 
)

Constructor for a DoubleGaussianPsf.

Parameters
[in]widthNumber of columns in realisations of Psf
[in]heightNumber of rows in realisations of Psf
[in]sigma1Radius of inner Gaussian
[in]sigma2Radius of outer Gaussian
[in]bRatio of Gaussian peak amplitudes: outer/inner

Definition at line 123 of file DoubleGaussianPsf.cc.

Member Function Documentation

◆ clone()

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

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

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

Definition at line 128 of file DoubleGaussianPsf.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.

◆ 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::KernelPsf::getAveragePosition ( ) const
virtualinherited

Return average position of stars; used as default position.

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

Definition at line 33 of file KernelPsf.cc.

◆ getB()

double lsst::meas::algorithms::DoubleGaussianPsf::getB ( ) const
inline

Return the ratio of Gaussian peak amplitudes: outer/inner.

Definition at line 62 of file DoubleGaussianPsf.h.

◆ 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::DoubleGaussianPsf::getPersistenceName ( ) const
protectedvirtual

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

Definition at line 143 of file DoubleGaussianPsf.cc.

◆ getPythonModule()

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

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

Definition at line 60 of file KernelPsf.cc.

◆ getSigma1()

double lsst::meas::algorithms::DoubleGaussianPsf::getSigma1 ( ) const
inline

Return the radius of the inner Gaussian.

Definition at line 56 of file DoubleGaussianPsf.h.

◆ getSigma2()

double lsst::meas::algorithms::DoubleGaussianPsf::getSigma2 ( ) const
inline

Return the radius of the outer Gaussian.

Definition at line 59 of file DoubleGaussianPsf.h.

◆ isPersistable()

virtual bool lsst::meas::algorithms::DoubleGaussianPsf::isPersistable ( ) const
inlinevirtual

Whether this Psf is persistable (always true for DoubleGaussianPsf).

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

Definition at line 65 of file DoubleGaussianPsf.h.

◆ resized()

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

Return a clone with specified kernel dimensions.

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

Definition at line 136 of file DoubleGaussianPsf.cc.

◆ write()

void lsst::meas::algorithms::DoubleGaussianPsf::write ( OutputArchiveHandle handle) const
protectedvirtual

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

Definition at line 145 of file DoubleGaussianPsf.cc.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 78 of file DoubleGaussianPsf.h.


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