LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
SingleGaussianPsf.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2013 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 
24 #ifndef LSST_MEAS_ALGORITHMS_SingleGaussianPsf_h_INCLUDED
25 #define LSST_MEAS_ALGORITHMS_SingleGaussianPsf_h_INCLUDED
26 
27 #include "lsst/base.h"
29 
30 namespace lsst {
31 namespace meas {
32 namespace algorithms {
33 
37 class SingleGaussianPsf : public afw::table::io::PersistableFacade<SingleGaussianPsf>, public KernelPsf {
38 public:
48  explicit SingleGaussianPsf(int width, int height, double sigma);
49 
51  PTR(afw::detection::Psf) clone() const override;
52 
54  PTR(afw::detection::Psf) resized(int width, int height) const override;
55 
57  double getSigma() const { return _sigma; }
58 
60  bool isPersistable() const noexcept override { return true; }
61 
62 protected:
63  std::string getPersistenceName() const override;
64 
65  void write(OutputArchiveHandle& handle) const override;
66 
67 private:
68  double _sigma;
69 };
70 
71 } // namespace algorithms
72 } // namespace meas
73 } // namespace lsst
74 
75 #endif // !LSST_MEAS_ALGORITHMS_SingleGaussianPsf_h_INCLUDED
lsst::meas::algorithms::SingleGaussianPsf::getSigma
double getSigma() const
Return the radius of the Gaussian.
Definition: SingleGaussianPsf.h:57
lsst::meas::algorithms::SingleGaussianPsf::getPersistenceName
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
std::string
STL class.
lsst::afw::table::io::OutputArchiveHandle
An object passed to Persistable::write to allow it to persist itself.
Definition: OutputArchive.h:118
sigma
afw::table::Key< double > sigma
Definition: GaussianPsf.cc:50
lsst::meas::algorithms::SingleGaussianPsf::write
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
PTR
#define PTR(...)
Definition: base.h:41
base.h
lsst::meas::algorithms::SingleGaussianPsf::resized
boost::shared_ptr< afw::detection::Psf > resized(int width, int height) const override
Return a clone with specified kernel dimensions.
lsst::meas::algorithms::KernelPsf
A Psf defined by a Kernel.
Definition: KernelPsf.h:36
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::algorithms::SingleGaussianPsf::SingleGaussianPsf
SingleGaussianPsf(int width, int height, double sigma)
Constructor for a SingleGaussianPsf.
lsst::meas::algorithms::SingleGaussianPsf
Represent a PSF as a circularly symmetrical Gaussian.
Definition: SingleGaussianPsf.h:37
lsst::afw::table::io::PersistableFacade
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
KernelPsf.h
lsst::afw::detection::Psf
A polymorphic base class for representing an image's Point Spread Function.
Definition: Psf.h:76
lsst::meas::algorithms::SingleGaussianPsf::isPersistable
bool isPersistable() const noexcept override
Whether the Psf is persistable; always true.
Definition: SingleGaussianPsf.h:60
lsst::meas::algorithms::SingleGaussianPsf::clone
boost::shared_ptr< afw::detection::Psf > clone() const override
Polymorphic deep copy; should usually unnecessary because Psfs are immutable.