LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
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,
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 
86  afw::geom::Point2D const & position,
87  afw::image::Color const & color
88  ) const;
89 
90  PTR(afw::math::Kernel) _kernel;
91  afw::geom::Point2D _averagePosition;
92 };
93 
94 }}} // namespace lsst::meas::algorithms
95 
96 #endif // !LSST_MEAS_ALGORITHMS_KernelPsf_h_INCLUDED
boost::shared_ptr< afw::math::Kernel > _kernel
Definition: KernelPsf.h:90
virtual boost::shared_ptr< Image > doComputeKernelImage(afw::geom::Point2D const &position, afw::image::Color const &color) const
Definition: KernelPsf.cc:8
#define PTR(...)
Definition: base.h:41
A Psf defined by a Kernel.
Definition: KernelPsf.h:33
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:114
virtual boost::shared_ptr< afw::detection::Psf > clone() const
Polymorphic deep copy.
Definition: KernelPsf.cc:22
table::Key< table::Array< Kernel::Pixel > > image
Definition: FixedKernel.cc:117
virtual bool isPersistable() const
Whether this object is persistable; just delegates to the kernel.
Definition: KernelPsf.cc:47
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:16
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:24
afw::geom::Point2D _averagePosition
Definition: KernelPsf.h:91
virtual std::string getPythonModule() const
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition: KernelPsf.cc:51
Point< double, 2 > Point2D
Definition: Point.h:286
An intermediate base class for Psfs that use an image representation.
Definition: ImagePsf.h:37
tbl::PointKey< double > averagePosition
Definition: CoaddPsf.cc:319
A PersistableFactory for KernelPsf and its subclasses.
A polymorphic base class for representing an image&#39;s Point Spread Function.
Definition: Psf.h:68
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:182
Kernels are used for convolution with MaskedImages and (eventually) Images.
Definition: Kernel.h:134
virtual void write(OutputArchiveHandle &handle) const
Write the object to one or more catalogs.
Definition: KernelPsf.cc:53
virtual std::string getPersistenceName() const
Return the unique name used to persist this object and look up its factory.
Definition: KernelPsf.cc:49