lsst.meas.algorithms  15.0-12-g7952b551+1
KernelPsf.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 #ifndef LSST_MEAS_ALGORITHMS_KernelPsf_h_INCLUDED
24 #define LSST_MEAS_ALGORITHMS_KernelPsf_h_INCLUDED
25 
26 #include "lsst/geom/Box.h"
28 
29 namespace lsst {
30 namespace meas {
31 namespace algorithms {
32 
36 class KernelPsf : public afw::table::io::PersistableFacade<KernelPsf>, public ImagePsf {
37 public:
48  explicit KernelPsf(afw::math::Kernel const& kernel,
50 
52  PTR(afw::math::Kernel const) getKernel() const { return _kernel; }
53 
55  virtual geom::Point2D getAveragePosition() const;
56 
58  virtual PTR(afw::detection::Psf) clone() const;
59 
61  virtual PTR(afw::detection::Psf) resized(int width, int height) const;
62 
64  virtual bool isPersistable() const;
65 
66 protected:
69 
70  // Name to use persist this object as (should be overridden by derived classes).
71  virtual std::string getPersistenceName() const;
72 
73  // Python module used in persistence to ensure factory is loaded.
74  virtual std::string getPythonModule() const;
75 
76  // Output persistence implementation (should be overridden by derived classes if they add data members).
77  virtual void write(OutputArchiveHandle& handle) const;
78 
79  // For access to protected ctor; avoids unnecessary copies when loading
80  template <typename T, typename K>
81  friend class KernelPsfFactory;
82 
83 private:
84  virtual PTR(Image)
85  doComputeKernelImage(geom::Point2D const& position, afw::image::Color const& color) const;
86 
87  virtual geom::Box2I doComputeBBox(geom::Point2D const& position, afw::image::Color const& color) const;
88 
89  PTR(afw::math::Kernel) _kernel;
90  geom::Point2D _averagePosition;
91 };
92 
93 } // namespace algorithms
94 } // namespace meas
95 } // namespace lsst
96 
97 #endif // !LSST_MEAS_ALGORITHMS_KernelPsf_h_INCLUDED
virtual boost::shared_ptr< afw::detection::Psf > clone() const
Polymorphic deep copy.
Definition: KernelPsf.cc:30
A Psf defined by a Kernel.
Definition: KernelPsf.h:36
virtual std::string getPythonModule() const
Definition: KernelPsf.cc:61
#define PTR(...)
boost::shared_ptr< afw::math::Kernel const > getKernel() const
Return the Kernel used to define this Psf.
Definition: KernelPsf.h:52
STL class.
virtual geom::Point2D getAveragePosition() const
Return average position of stars; used as default position.
Definition: KernelPsf.cc:36
afw::table::PointKey< double > averagePosition
Definition: CoaddPsf.cc:329
virtual boost::shared_ptr< afw::detection::Psf > resized(int width, int height) const
Return a clone with specified kernel dimensions.
Definition: KernelPsf.cc:32
virtual void write(OutputArchiveHandle &handle) const
Definition: KernelPsf.cc:63
virtual bool isPersistable() const
Whether this object is persistable; just delegates to the kernel.
Definition: KernelPsf.cc:57
io::OutputArchiveHandle OutputArchiveHandle
An intermediate base class for Psfs that use an image representation.
Definition: ImagePsf.h:40
A PersistableFactory for KernelPsf and its subclasses.
virtual std::string getPersistenceName() const
Definition: KernelPsf.cc:59
KernelPsf(afw::math::Kernel const &kernel, geom::Point2D const &averagePosition=geom::Point2D())
Construct a KernelPsf with a clone of the given kernel.
Definition: KernelPsf.cc:22