lsst.afw  21.0.0-46-g27369044f+532d44eec1
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"
33 #include "lsst/afw/math/Kernel.h"
34 #include "lsst/afw/image/Color.h"
37 
38 namespace lsst {
39 namespace afw {
40 namespace detection {
41 namespace detail {
42 
44 struct PsfCacheKey;
45 
46 } // namespace detail
47 
77  static lsst::geom::Point2D makeNullPoint() {
79  }
80 
81 public:
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 
148  std::shared_ptr<Image> computeImage(lsst::geom::Point2D position = makeNullPoint(),
149  image::Color color = image::Color(),
150  ImageOwnerEnum owner = COPY) const;
151 
175  image::Color color = image::Color(),
176  ImageOwnerEnum owner = COPY) const;
177 
189  double computePeak(lsst::geom::Point2D position = makeNullPoint(),
190  image::Color color = image::Color()) const;
191 
203  double computeApertureFlux(double radius, lsst::geom::Point2D position = makeNullPoint(),
204  image::Color color = image::Color()) const;
205 
217  image::Color color = image::Color()) const;
218 
226  image::Color color = image::Color()) const;
227 
234 
240  virtual lsst::geom::Point2D getAveragePosition() const;
241 
245  lsst::geom::Box2I computeBBox(lsst::geom::Point2D position = makeNullPoint(),
246  image::Color color = image::Color()) const;
247 
251  lsst::geom::Box2I computeImageBBox(lsst::geom::Point2D position = makeNullPoint(),
252  image::Color color = image::Color()) const;
253 
258  image::Color color = image::Color()) const {
259  return computeBBox(position, color);
260  }
261 
281  lsst::geom::Point2D const& position,
282  std::string const& warpAlgorithm = "lanczos5",
283  unsigned int warpBuffer = 5);
284 
290 
295  void setCacheCapacity(std::size_t capacity);
296 
297 protected:
305  explicit Psf(bool isFixed = false, std::size_t capacity = 100);
306 
308 
317  image::Color const& color) const;
319  image::Color const& color) const;
321 
322 private:
324 
332  image::Color const& color) const = 0;
333  virtual double doComputeApertureFlux(double radius, lsst::geom::Point2D const& position,
334  image::Color const& color) const = 0;
336  image::Color const& color) const = 0;
338  image::Color const& color) const = 0;
340 
341  bool const _isFixed;
343  std::unique_ptr<PsfCache> _imageCache;
344  std::unique_ptr<PsfCache> _kernelImageCache;
345 };
346 } // namespace detection
347 } // namespace afw
348 } // namespace lsst
349 
350 #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
double computeApertureFlux(double radius, lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Compute the "flux" of the Psf model within a circular aperture of the given radius.
Definition: Psf.cc:156
virtual std::shared_ptr< Psf > resized(int width, int height) const =0
Return clone with specified kernel dimensions.
std::shared_ptr< Image > computeImage(lsst::geom::Point2D position=makeNullPoint(), 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:102
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:86
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:168
geom::ellipses::Quadrupole computeShape(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Compute the ellipse corresponding to the second moments of the Psf.
Definition: Psf.cc:162
image::Image< Pixel > Image
Image type returned by computeImage.
Definition: Psf.h:83
std::shared_ptr< Image > computeKernelImage(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color(), ImageOwnerEnum owner=COPY) const
Return an Image of the PSF, in a form suitable for convolution.
Definition: Psf.cc:115
double computePeak(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Return the peak value of the PSF image.
Definition: Psf.cc:149
std::size_t getCacheCapacity() const
Return the capacity of the caches.
Definition: Psf.cc:182
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::shared_ptr< typehandling::Storable > cloneStorable() const override
Polymorphic deep-copy.
Definition: Psf.h:116
lsst::geom::Box2I computeImageBBox(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Return the bounding box of the image returned by computeImage()
Definition: Psf.cc:134
Psf(Psf const &)
Definition: Psf.cc:79
Psf & operator=(Psf &&)=delete
virtual std::shared_ptr< Psf > clone() const =0
Polymorphic deep-copy.
image::Color getAverageColor() const
Return the average Color of the stars used to construct the Psf.
Definition: Psf.h:233
math::Kernel::Pixel Pixel
Pixel type of Image returned by computeImage.
Definition: Psf.h:82
virtual lsst::geom::Box2I doComputeImageBBox(lsst::geom::Point2D const &position, image::Color const &color) const
Definition: Psf.cc:174
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:184
lsst::geom::Box2I computeBBox(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Return the bounding box of the image returned by computeKernelImage()
Definition: Psf.cc:128
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:180
lsst::geom::Box2I computeKernelBBox(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Alias for computeBBox.
Definition: Psf.h:257
std::shared_ptr< math::Kernel const > getLocalKernel(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Return a FixedKernel corresponding to the Psf image at the given point.
Definition: Psf.cc:140
virtual geom::ellipses::Quadrupole doComputeShape(lsst::geom::Point2D const &position, image::Color const &color) const =0
An ellipse core with quadrupole moments as parameters.
Definition: Quadrupole.h:47
Describe the colour of a source.
Definition: Color.h:26
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
Point< double, 2 > Point2D
A base class for image defects.