LSST Applications  21.0.0+3c14b91618,21.0.0+9f51b1e3f7,21.0.0-1-ga51b5d4+6691386486,21.0.0-10-g2408eff+1a328412bf,21.0.0-10-g560fb7b+52fd22d7b4,21.0.0-10-g8d1d15d+2f9043cae0,21.0.0-10-gcf60f90+d15de71c48,21.0.0-11-g25eff31+d43066e4ef,21.0.0-15-g490e301a+a676f0d5cf,21.0.0-2-g103fe59+4758c8ef83,21.0.0-2-g1367e85+a9f57e981a,21.0.0-2-g45278ab+9f51b1e3f7,21.0.0-2-g5242d73+a9f57e981a,21.0.0-2-g7f82c8f+1bcc828e4f,21.0.0-2-g8f08a60+e6fd6d9ff9,21.0.0-2-ga326454+1bcc828e4f,21.0.0-2-gde069b7+66c51b65da,21.0.0-2-gecfae73+251b9830c3,21.0.0-2-gfc62afb+a9f57e981a,21.0.0-20-g09baf175d+e1e7d1c708,21.0.0-3-g357aad2+854c3902c3,21.0.0-3-g4be5c26+a9f57e981a,21.0.0-3-g65f322c+feaa1990e9,21.0.0-3-g7d9da8d+3c14b91618,21.0.0-3-ge02ed75+bda8df9b93,21.0.0-4-g591bb35+bda8df9b93,21.0.0-4-g65b4814+52fd22d7b4,21.0.0-4-g88306b8+656365ce3f,21.0.0-4-gccdca77+86bf7a300d,21.0.0-4-ge8a399c+b99e86088e,21.0.0-5-gd00fb1e+6a0dc09319,21.0.0-51-gd3b42663+bf9f0d1c8b,21.0.0-6-g2d4f3f3+9f51b1e3f7,21.0.0-7-g04766d7+ee2ae02087,21.0.0-7-g98eecf7+3609eddee2,21.0.0-7-gde99fe0+bda8df9b93,21.0.0-8-gd70ce6f+79e45e76e4,master-gac4afde19b+bda8df9b93,w.2021.10
LSST Data Management Base Package
GaussianPsf.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2014 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 #ifndef LSST_AFW_DETECTION_GaussianPsf_h_INCLUDED
24 #define LSST_AFW_DETECTION_GaussianPsf_h_INCLUDED
25 
26 #include "lsst/geom.h"
27 #include "lsst/afw/detection/Psf.h"
28 
29 namespace lsst {
30 namespace afw {
31 namespace detection {
32 
42 class GaussianPsf : public afw::table::io::PersistableFacade<GaussianPsf>, public Psf {
43 public:
51  GaussianPsf(int width, int height, double sigma);
52 
60 
61  ~GaussianPsf() override;
64  GaussianPsf& operator=(GaussianPsf const&) = delete;
66 
69 
71  std::shared_ptr<afw::detection::Psf> resized(int width, int height) const override;
72 
74  lsst::geom::Extent2I getDimensions() const { return _dimensions; }
75 
77  double getSigma() const { return _sigma; }
78 
80  bool isPersistable() const noexcept override { return true; }
81 
82 protected:
83  std::string getPersistenceName() const override;
84 
85  std::string getPythonModule() const override;
86 
87  void write(OutputArchiveHandle& handle) const override;
88 
89 private:
90 #if 0 // We could reimplement this more efficiently than what's in the base class,
91  // but it's tricky to get the position right in all corner cases, and it's
92  // not actually performance-critical, so we should just wait for #3116.
94  lsst::geom::Point2D const & position, image::Color const& color
95  ) const;
96 #endif
97 
98  std::shared_ptr<Image> doComputeKernelImage(lsst::geom::Point2D const& position,
99  image::Color const& color) const override;
100 
101  double doComputeApertureFlux(double radius, lsst::geom::Point2D const& position,
102  image::Color const& color) const override;
103 
104  geom::ellipses::Quadrupole doComputeShape(lsst::geom::Point2D const& position,
105  image::Color const& color) const override;
106 
107  lsst::geom::Box2I doComputeBBox(lsst::geom::Point2D const& position,
108  image::Color const& color) const override;
109 
110  lsst::geom::Extent2I _dimensions;
111  double _sigma;
112 };
113 } // namespace detection
114 } // namespace afw
115 } // namespace lsst
116 
117 #endif // !LSST_AFW_DETECTION_Psf_h_INCLUDED
afw::table::Key< double > sigma
Definition: GaussianPsf.cc:50
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:49
A circularly symmetric Gaussian Psf class with no spatial variation, intended mostly for testing purp...
Definition: GaussianPsf.h:42
std::shared_ptr< afw::detection::Psf > resized(int width, int height) const override
Return a clone with specified kernel dimensions.
Definition: GaussianPsf.cc:117
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition: GaussianPsf.cc:121
double getSigma() const
Return the radius of the Gaussian.
Definition: GaussianPsf.h:77
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: GaussianPsf.cc:125
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition: GaussianPsf.cc:123
bool isPersistable() const noexcept override
Whether the Psf is persistable; always true.
Definition: GaussianPsf.h:80
lsst::geom::Extent2I getDimensions() const
Return the dimensions of the images returned by computeImage()
Definition: GaussianPsf.h:74
GaussianPsf(GaussianPsf const &)
GaussianPsf & operator=(GaussianPsf const &)=delete
std::shared_ptr< afw::detection::Psf > clone() const override
Polymorphic deep copy; should usually be unnecessary because Psfs are immutable.
Definition: GaussianPsf.cc:113
GaussianPsf & operator=(GaussianPsf &&)=delete
GaussianPsf(int width, int height, double sigma)
Constructor for a GaussianPsf.
Definition: GaussianPsf.cc:99
A polymorphic base class for representing an image's Point Spread Function.
Definition: Psf.h:76
virtual std::shared_ptr< Image > doComputeImage(lsst::geom::Point2D const &position, image::Color const &color) const
This virtual member is protected (rather than private) so that python-implemented derived classes may...
Definition: Psf.cc:162
An ellipse core with quadrupole moments as parameters.
Definition: Quadrupole.h:47
Describe the colour of a source.
Definition: Color.h:26
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
An integer coordinate rectangle.
Definition: Box.h:55
A base class for image defects.