LSSTApplications  20.0.0
LSSTDataManagementBasePackage
DoubleGaussianPsf.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_DoubleGaussianPsf_h_INCLUDED
25 #define LSST_MEAS_ALGORITHMS_DoubleGaussianPsf_h_INCLUDED
26 
28 
29 namespace lsst {
30 namespace meas {
31 namespace algorithms {
32 
34 class DoubleGaussianPsf : public afw::table::io::PersistableFacade<DoubleGaussianPsf>, public KernelPsf {
35 public:
45  DoubleGaussianPsf(int width, int height, double sigma1, double sigma2 = 0.0, double b = 0.0);
46 
48  PTR(afw::detection::Psf) clone() const override;
49 
51  PTR(afw::detection::Psf) resized(int width, int height) const override;
52 
54  double getSigma1() const { return _sigma1; }
55 
57  double getSigma2() const { return _sigma2; }
58 
60  double getB() const { return _b; }
61 
63  bool isPersistable() const noexcept override { return true; }
64 
65 protected:
66  std::string getPersistenceName() const override;
67 
68  void write(OutputArchiveHandle& handle) const override;
69 
70 private:
71  double _sigma1;
72  double _sigma2;
73  double _b;
74 };
75 
76 } // namespace algorithms
77 } // namespace meas
78 } // namespace lsst
79 
80 #endif // !LSST_MEAS_ALGORITHMS_DoubleGaussianPsf_h_INCLUDED
std::string
STL class.
lsst::meas::algorithms::DoubleGaussianPsf::getSigma2
double getSigma2() const
Return the radius of the outer Gaussian.
Definition: DoubleGaussianPsf.h:57
sigma2
table::Key< double > sigma2
Definition: FunctionLibrary.cc:21
lsst::meas::algorithms::DoubleGaussianPsf::resized
boost::shared_ptr< afw::detection::Psf > resized(int width, int height) const override
Return a clone with specified kernel dimensions.
Definition: DoubleGaussianPsf.cc:134
lsst::meas::algorithms::DoubleGaussianPsf::clone
boost::shared_ptr< afw::detection::Psf > clone() const override
Polymorphic deep copy. Usually unnecessary, as Psfs are immutable.
Definition: DoubleGaussianPsf.cc:129
sigma1
table::Key< double > sigma1
Definition: FunctionLibrary.cc:20
lsst::meas::algorithms::DoubleGaussianPsf::isPersistable
bool isPersistable() const noexcept override
Whether this Psf is persistable (always true for DoubleGaussianPsf).
Definition: DoubleGaussianPsf.h:63
lsst::meas::algorithms::KernelPsf
A Psf defined by a Kernel.
Definition: KernelPsf.h:36
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::algorithms::DoubleGaussianPsf::DoubleGaussianPsf
DoubleGaussianPsf(int width, int height, double sigma1, double sigma2=0.0, double b=0.0)
Constructor for a DoubleGaussianPsf.
Definition: DoubleGaussianPsf.cc:123
lsst::meas::algorithms::DoubleGaussianPsf::write
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: DoubleGaussianPsf.cc:140
lsst::meas::algorithms::DoubleGaussianPsf::getB
double getB() const
Return the ratio of Gaussian peak amplitudes: outer/inner.
Definition: DoubleGaussianPsf.h:60
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::meas::algorithms::DoubleGaussianPsf
Represent a Psf as a circularly symmetrical double Gaussian.
Definition: DoubleGaussianPsf.h:34
lsst::afw::detection::Psf
A polymorphic base class for representing an image's Point Spread Function.
Definition: Psf.h:76
lsst::meas::algorithms::DoubleGaussianPsf::getSigma1
double getSigma1() const
Return the radius of the inner Gaussian.
Definition: DoubleGaussianPsf.h:54
lsst::meas::algorithms::DoubleGaussianPsf::getPersistenceName
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition: DoubleGaussianPsf.cc:138
lsst::afw::table::io::Persistable::OutputArchiveHandle
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108