LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
29namespace lsst {
30namespace meas {
31namespace algorithms {
32
36class KernelPsf : public afw::table::io::PersistableFacade<KernelPsf>, public ImagePsf {
37public:
48 explicit KernelPsf(afw::math::Kernel const& kernel,
49 geom::Point2D const& averagePosition = geom::Point2D());
50
53
55 geom::Point2D getAveragePosition() const override;
56
59
61 std::shared_ptr<afw::detection::Psf> resized(int width, int height) const override;
62
64 bool isPersistable() const noexcept override;
65
66protected:
68 explicit KernelPsf(std::shared_ptr<afw::math::Kernel> kernel, geom::Point2D const& averagePosition = geom::Point2D());
69
70 // Name to use persist this object as (should be overridden by derived classes).
71 std::string getPersistenceName() const override;
72
73 // Python module used in persistence to ensure factory is loaded.
74 std::string getPythonModule() const override;
75
76 // Output persistence implementation (should be overridden by derived classes if they add data members).
77 void write(OutputArchiveHandle& handle) const override;
78
79 // For access to protected ctor; avoids unnecessary copies when loading
80 template <typename T, typename K>
81 friend class KernelPsfFactory;
82
83private:
84 std::shared_ptr<Image>
85 doComputeKernelImage(geom::Point2D const& position, afw::image::Color const& color) const override;
86
87 geom::Box2I doComputeBBox(geom::Point2D const& position, afw::image::Color const& color) const override;
88
89 std::shared_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
image::Image< Pixel > Image
Image type returned by computeImage.
Definition Psf.h:89
Kernels are used for convolution with MaskedImages and (eventually) Images.
Definition Kernel.h:110
A CRTP facade class for subclasses of Persistable.
io::OutputArchiveHandle OutputArchiveHandle
An integer coordinate rectangle.
Definition Box.h:55
ImagePsf(bool isFixed=false)
Definition ImagePsf.h:42
A Psf defined by a Kernel.
Definition KernelPsf.h:36
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:33
bool isPersistable() const noexcept override
Whether this object is persistable; just delegates to the kernel.
Definition KernelPsf.cc:66
geom::Box2I doComputeBBox(geom::Point2D const &position, afw::image::Color const &color) const override
Definition KernelPsf.cc:29
std::shared_ptr< Image > doComputeKernelImage(geom::Point2D const &position, afw::image::Color const &color) const override
These virtual member functions are private, not protected, because we only want derived classes to im...
Definition KernelPsf.cc:23
std::shared_ptr< afw::detection::Psf > clone() const override
Polymorphic deep copy.
Definition KernelPsf.cc:41
std::shared_ptr< afw::detection::Psf > resized(int width, int height) const override
Return a clone with specified kernel dimensions.
Definition KernelPsf.cc:43
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition KernelPsf.cc:68
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition KernelPsf.cc:70
std::shared_ptr< afw::math::Kernel const > getKernel() const
Return the Kernel used to define this Psf.
Definition KernelPsf.h:52
geom::Point2D getAveragePosition() const override
Return average position of stars; used as default position.
Definition KernelPsf.cc:47
Point< double, 2 > Point2D
Definition Point.h:324
STL namespace.