LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
PsfexPsf.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 
24 # if !defined(LSST_MEAS_EXTENSIONS_PSFEX_PSFEX_H)
25 #define LSST_MEAS_EXTENSIONS_PSFEX_PSFEX_H 1
26 
27 #include "lsst/geom/Box.h"
29 #include "lsst/meas/extensions/psfex/psf.hh"
30 
31 namespace lsst { namespace meas { namespace extensions { namespace psfex {
32  namespace detail {
33  class PsfexPsfFactory;
34  }
35 
42 public:
46  explicit PsfexPsf(
47  lsst::meas::extensions::psfex::Psf const& psf,
50  );
51  ~PsfexPsf() override;
52 
55 
57  std::shared_ptr<afw::detection::Psf> resized(int width, int height) const override;
58 
60  lsst::geom::Point2D getAveragePosition() const override { return _averagePosition; }
61 
67 
69  bool isPersistable() const noexcept override { return true; }
70 
71  void write(lsst::afw::table::io::OutputArchiveHandle & handle) const override;
72 private:
73  lsst::geom::Point2D _averagePosition;
74  // Here are the unpacked fields from the psfex psf struct
75  struct poly *_poly; // Polynom describing the PSF variations
76  float _pixstep; // Mask oversampling (pixel)
77  std::vector<int> _size; // PSF dimensions
78  std::vector<float> _comp; // Complete pix. data (PSF components)
79  std::vector<std::pair<double, double> > _context; // Offset/scale to apply to context data
80  mutable std::shared_ptr<lsst::afw::math::LinearCombinationKernel> _kernel; // keep a reference to getKernel()'s kernel
81 
83  explicit PsfexPsf();
84 
87  lsst::geom::Point2D const & position,
88  lsst::afw::image::Color const& color,
89  lsst::geom::Point2D const& center
90  ) const;
91 
94  lsst::geom::Point2D const & position,
95  lsst::afw::image::Color const& color
96  ) const override;
97 
100  lsst::geom::Point2D const & position,
101  lsst::afw::image::Color const& color
102  ) const override;
103 
105  lsst::geom::Box2I doComputeBBox(
106  lsst::geom::Point2D const & position,
107  lsst::afw::image::Color const & color
108  ) const override;
109 
113  lsst::geom::Box2I _doComputeBBox(
114  lsst::geom::Point2D const & position,
115  lsst::geom::Point2D const & center
116  ) const;
117 
119  std::string getPersistenceName() const override;
121  std::string getPythonModule() const override;
122 };
123 
124 }}}}
125 
126 #endif // !LSST_MEAS_EXTENSIONS_PSFEX_PSFEX_H
Describe the colour of a source.
Definition: Color.h:26
An object passed to Persistable::write to allow it to persist itself.
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
An integer coordinate rectangle.
Definition: Box.h:55
An intermediate base class for Psfs that use an image representation.
Definition: ImagePsf.h:40
Represent a PSF as a linear combination of PSFEX (== Karhunen-Loeve) basis functions.
Definition: PsfexPsf.h:40
std::shared_ptr< lsst::afw::math::LinearCombinationKernel const > getKernel(lsst::geom::Point2D=lsst::geom::Point2D(std::numeric_limits< double >::quiet_NaN())) const
Return the PSF's basis functions as a spatially-invariant LinearCombinationKernel with unit weights.
Definition: PsfexPsf.cc:114
void write(lsst::afw::table::io::OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: PsfexPsf.cc:479
lsst::geom::Point2D getAveragePosition() const override
Return average position of stars; used as default position.
Definition: PsfexPsf.h:60
std::shared_ptr< lsst::afw::detection::Psf > clone() const override
Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x.
Definition: PsfexPsf.cc:104
virtual std::shared_ptr< lsst::afw::detection::Psf::Image > _doComputeImage(lsst::geom::Point2D const &position, lsst::afw::image::Color const &color, lsst::geom::Point2D const &center) const
Compute an image of the Psf at the specified position/colour, at pixel position in the output image.
Definition: PsfexPsf.cc:225
std::shared_ptr< afw::detection::Psf > resized(int width, int height) const override
Return a clone with specified kernel dimensions.
Definition: PsfexPsf.cc:109
bool isPersistable() const noexcept override
Is this object persistable?
Definition: PsfexPsf.h:69
std::string getPythonModule() const override
std::string getPersistenceName() const override
Low-level polynomials (including special polynomials) in C++.
Definition: Basis1d.h:26
A base class for image defects.
afw::table::PointKey< double > averagePosition
Definition: CoaddPsf.cc:349
table::Key< table::Array< int > > _size
Definition: PsfexPsf.cc:364
table::Key< table::Array< float > > _comp
Definition: PsfexPsf.cc:365
table::Key< float > _pixstep
Definition: PsfexPsf.cc:334
Key< int > psf
Definition: Exposure.cc:65