LSSTApplications  20.0.0
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.
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
base.h
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
PTR
#define PTR(...)
Definition: base.h:41
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.