lsst.meas.algorithms  13.0-13-gf5c99ad+4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
27 
28 namespace lsst { namespace meas { namespace algorithms {
29 
33 class KernelPsf : public afw::table::io::PersistableFacade<KernelPsf>, public ImagePsf {
34 public:
35 
46  explicit KernelPsf(
47  afw::math::Kernel const & kernel,
48  afw::geom::Point2D const & averagePosition=afw::geom::Point2D()
49  );
50 
52  PTR(afw::math::Kernel const) getKernel() const { return _kernel; }
53 
55  virtual afw::geom::Point2D getAveragePosition() const;
56 
58  virtual PTR(afw::detection::Psf) clone() const;
59 
61  virtual bool isPersistable() const;
62 
63 protected:
64 
66  explicit KernelPsf(
67  PTR(afw::math::Kernel) kernel,
68  afw::geom::Point2D const & averagePosition=afw::geom::Point2D()
69  );
70 
71  // Name to use persist this object as (should be overridden by derived classes).
72  virtual std::string getPersistenceName() const;
73 
74  // Python module used in persistence to ensure factory is loaded.
75  virtual std::string getPythonModule() const;
76 
77  // Output persistence implementation (should be overridden by derived classes if they add data members).
78  virtual void write(OutputArchiveHandle & handle) const;
79 
80  // For access to protected ctor; avoids unnecessary copies when loading
81  template <typename T, typename K> friend class KernelPsfFactory;
82 
83 private:
84 
85  virtual PTR(Image) doComputeKernelImage(
86  afw::geom::Point2D const & position,
87  afw::image::Color const & color
88  ) const;
89 
90  virtual afw::geom::Box2I doComputeBBox(
91  afw::geom::Point2D const & position,
92  afw::image::Color const & color
93  ) const;
94 
95  PTR(afw::math::Kernel) _kernel;
96  afw::geom::Point2D _averagePosition;
97 };
98 
99 }}} // namespace lsst::meas::algorithms
100 
101 #endif // !LSST_MEAS_ALGORITHMS_KernelPsf_h_INCLUDED
A Psf defined by a Kernel.
Definition: KernelPsf.h:33
virtual boost::shared_ptr< afw::detection::Psf > clone() const
Polymorphic deep copy.
Definition: KernelPsf.cc:28
virtual bool isPersistable() const
Whether this object is persistable; just delegates to the kernel.
Definition: KernelPsf.cc:53
KernelPsf(afw::math::Kernel const &kernel, afw::geom::Point2D const &averagePosition=afw::geom::Point2D())
Construct a KernelPsf with a clone of the given kernel.
Definition: KernelPsf.cc:22
boost::shared_ptr< afw::math::Kernel const > getKernel() const
Return the Kernel used to define this Psf.
Definition: KernelPsf.h:52
virtual afw::geom::Point2D getAveragePosition() const
Return average position of stars; used as default position.
Definition: KernelPsf.cc:30
virtual std::string getPythonModule() const
Definition: KernelPsf.cc:57
An intermediate base class for Psfs that use an image representation.
Definition: ImagePsf.h:37
tbl::PointKey< double > averagePosition
Definition: CoaddPsf.cc:352
A PersistableFactory for KernelPsf and its subclasses.
virtual void write(OutputArchiveHandle &handle) const
Definition: KernelPsf.cc:59
virtual std::string getPersistenceName() const
Definition: KernelPsf.cc:55