LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
Psf.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_AFW_DETECTION_Psf_h_INCLUDED
24#define LSST_AFW_DETECTION_Psf_h_INCLUDED
25
26#include <string>
27#include <limits>
28
29#include <memory>
30
31#include "lsst/utils/CacheFwd.h"
37
38namespace lsst {
39namespace afw {
40namespace detection {
41namespace detail {
42
44struct PsfCacheKey;
45
46} // namespace detail
47
77 static lsst::geom::Point2D makeNullPoint() {
79 }
80
81public:
84
87 COPY = 0,
88 INTERNAL = 1
92 };
93
94 Psf(Psf const&);
95 Psf& operator=(Psf const&) = delete;
96 Psf& operator=(Psf&&) = delete;
97
98 Psf(Psf&&);
99 ~Psf() override;
100
108 virtual std::shared_ptr<Psf> clone() const = 0;
109
117
126 virtual std::shared_ptr<Psf> resized(int width, int height) const = 0;
127
149 image::Color color = image::Color(),
150 ImageOwnerEnum owner = COPY) const;
151
152
176 image::Color color = image::Color(),
177 ImageOwnerEnum owner = COPY) const;
178
190 double computePeak(lsst::geom::Point2D position,
191 image::Color color = image::Color()) const;
192
204 double computeApertureFlux(double radius, lsst::geom::Point2D position,
205 image::Color color = image::Color()) const;
206
218 image::Color color = image::Color()) const;
219
231 image::Color color = image::Color()) const;
232
233
240
247
256 image::Color color = image::Color()) const;
257
266 image::Color color = image::Color()) const;
267
277 image::Color color = image::Color()) const {
278 return computeBBox(position, color);
279 }
280
300 lsst::geom::Point2D const& position,
301 std::string const& warpAlgorithm = "lanczos5",
302 unsigned int warpBuffer = 5);
303
309
314 void setCacheCapacity(std::size_t capacity);
315
316protected:
324 explicit Psf(bool isFixed = false, std::size_t capacity = 100);
325
327
336 image::Color const& color) const;
338 image::Color const& color) const;
340
341private:
343
351 image::Color const& color) const = 0;
352 virtual double doComputeApertureFlux(double radius, lsst::geom::Point2D const& position,
353 image::Color const& color) const = 0;
355 image::Color const& color) const = 0;
357 image::Color const& color) const = 0;
359
360 bool const _isFixed;
362 std::unique_ptr<PsfCache> _imageCache;
363 std::unique_ptr<PsfCache> _kernelImageCache;
364};
365} // namespace detection
366} // namespace afw
367} // namespace lsst
368
369#endif // !LSST_AFW_DETECTION_Psf_h_INCLUDED
A polymorphic base class for representing an image's Point Spread Function.
Definition Psf.h:76
Psf & operator=(Psf const &)=delete
std::shared_ptr< typehandling::Storable > cloneStorable() const override
Polymorphic deep-copy.
Definition Psf.h:116
static std::shared_ptr< Image > recenterKernelImage(std::shared_ptr< Image > im, lsst::geom::Point2D const &position, std::string const &warpAlgorithm="lanczos5", unsigned int warpBuffer=5)
Helper function for Psf::doComputeImage(): converts a kernel image (centered at (0,...
Definition Psf.cc:85
lsst::geom::Box2I computeBBox(lsst::geom::Point2D position, image::Color color=image::Color()) const
Return the bounding box of the image returned by computeKernelImage()
Definition Psf.cc:127
math::Kernel::Pixel Pixel
Pixel type of Image returned by computeImage.
Definition Psf.h:82
virtual std::shared_ptr< Image > doComputeImage(lsst::geom::Point2D const &position, image::Color const &color) const
These virtual members are protected (rather than private) so that python-implemented derived classes ...
Definition Psf.cc:177
std::shared_ptr< Image > computeKernelImage(lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
Return an Image of the PSF, in a form suitable for convolution.
Definition Psf.cc:114
virtual std::shared_ptr< Image > doComputeKernelImage(lsst::geom::Point2D const &position, image::Color const &color) const =0
These virtual member functions are private, not protected, because we only want derived classes to im...
std::size_t getCacheCapacity() const
Return the capacity of the caches.
Definition Psf.cc:191
double computeApertureFlux(double radius, lsst::geom::Point2D position, image::Color color=image::Color()) const
Compute the "flux" of the Psf model within a circular aperture of the given radius.
Definition Psf.cc:165
Psf & operator=(Psf &&)=delete
Psf(Psf const &)
Definition Psf.cc:78
std::shared_ptr< Image > computeImage(lsst::geom::Point2D position, image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
Return an Image of the PSF, in a form that can be compared directly with star images.
Definition Psf.cc:101
double computePeak(lsst::geom::Point2D position, image::Color color=image::Color()) const
Return the peak value of the PSF image.
Definition Psf.cc:158
virtual std::shared_ptr< Psf > resized(int width, int height) const =0
Return clone with specified kernel dimensions.
image::Color getAverageColor() const
Return the average Color of the stars used to construct the Psf.
Definition Psf.h:239
virtual std::shared_ptr< Psf > clone() const =0
Polymorphic deep-copy.
virtual lsst::geom::Box2I doComputeImageBBox(lsst::geom::Point2D const &position, image::Color const &color) const
Definition Psf.cc:183
ImageOwnerEnum
Enum passed to computeImage and computeKernelImage to determine image ownership.
Definition Psf.h:86
@ COPY
The image will be copied before returning; caller will own it.
Definition Psf.h:87
@ INTERNAL
An internal image will be returned without copying.
Definition Psf.h:88
virtual lsst::geom::Box2I doComputeBBox(lsst::geom::Point2D const &position, image::Color const &color) const =0
void setCacheCapacity(std::size_t capacity)
Set the capacity of the caches.
Definition Psf.cc:193
std::shared_ptr< math::Kernel const > getLocalKernel(lsst::geom::Point2D position, image::Color color=image::Color()) const
Return a FixedKernel corresponding to the Psf image at the given point.
Definition Psf.cc:149
virtual double doComputeApertureFlux(double radius, lsst::geom::Point2D const &position, image::Color const &color) const =0
virtual lsst::geom::Point2D getAveragePosition() const
Return the average position of the stars used to construct the Psf.
Definition Psf.cc:189
lsst::geom::Box2I computeKernelBBox(lsst::geom::Point2D position, image::Color color=image::Color()) const
Return the bounding box of the image returned by computeImage()
Definition Psf.h:276
virtual geom::ellipses::Quadrupole doComputeShape(lsst::geom::Point2D const &position, image::Color const &color) const =0
geom::ellipses::Quadrupole computeShape(lsst::geom::Point2D position, image::Color color=image::Color()) const
Compute the ellipse corresponding to the second moments of the Psf.
Definition Psf.cc:171
lsst::geom::Box2I computeImageBBox(lsst::geom::Point2D position, image::Color color=image::Color()) const
Return the bounding box of the image returned by computeImage()
Definition Psf.cc:138
An ellipse core with quadrupole moments as parameters.
Definition Quadrupole.h:47
Describe the colour of a source.
Definition Color.h:25
A CRTP facade class for subclasses of Persistable.
Interface supporting iteration over heterogenous containers.
Definition Storable.h:58
Cache of most recently used values.
Definition Cache.h:75
An integer coordinate rectangle.
Definition Box.h:55
Point< double, 2 > Point2D
Definition Point.h:324