lsst.meas.extensions.psfex  21.0.0-3-g357aad2+8d7fc2e904
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  virtual ~PsfexPsf();
52 
54  virtual PTR(lsst::afw::detection::Psf) clone() const;
55 
57  virtual PTR(afw::detection::Psf) resized(int width, int height) const;
58 
60  virtual lsst::geom::Point2D getAveragePosition() const { return _averagePosition; }
61 
67 
69  virtual bool isPersistable() const noexcept override { return true; }
70 
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 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;
97 
100  lsst::geom::Point2D const & position,
101  lsst::afw::image::Color const& color
102  ) const;
103 
106  lsst::geom::Point2D const & position,
107  lsst::afw::image::Color const & color
108  ) const;
109 
113  lsst::geom::Box2I _doComputeBBox(
114  lsst::geom::Point2D const & position,
115  lsst::geom::Point2D const & center
116  ) const;
117 
119  virtual std::string getPersistenceName() const;
121  virtual std::string getPythonModule() const;
122 };
123 
124 }}}}
125 
126 #endif // !LSST_MEAS_EXTENSIONS_PSFEX_PSFEX_H
table::Key< table::Array< int > > _size
Definition: PsfexPsf.cc:364
table::PointKey< double > averagePosition
Definition: PsfexPsf.cc:333
table::Key< table::Array< float > > _comp
Definition: PsfexPsf.cc:365
table::Key< float > _pixstep
Definition: PsfexPsf.cc:334
#define PTR(...)
Represent a PSF as a linear combination of PSFEX (== Karhunen-Loeve) basis functions.
Definition: PsfexPsf.h:40
virtual boost::shared_ptr< lsst::afw::detection::Psf::Image > doComputeImage(lsst::geom::Point2D const &position, lsst::afw::image::Color const &color) const
Compute an image of the Psf at the specified position/colour, at pixel position in the output image.
Definition: PsfexPsf.cc:184
boost::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
virtual lsst::geom::Point2D getAveragePosition() const
Return average position of stars; used as default position.
Definition: PsfexPsf.h:60
virtual boost::shared_ptr< afw::detection::Psf > resized(int width, int height) const
Return a clone with specified kernel dimensions.
Definition: PsfexPsf.cc:109
virtual boost::shared_ptr< lsst::afw::detection::Psf::Image > doComputeKernelImage(lsst::geom::Point2D const &position, lsst::afw::image::Color const &color) const
Compute an image of the Psf at the specified position/colour, at pixel (0.0, 0.0) in the output image...
Definition: PsfexPsf.cc:190
virtual lsst::geom::Box2I doComputeBBox(lsst::geom::Point2D const &position, lsst::afw::image::Color const &color) const
Compute the bbox of the kernel image at the specified position/color.
Definition: PsfexPsf.cc:196
virtual std::string getPythonModule() const
The python module name (for use in table persistence)
Definition: PsfexPsf.cc:475
virtual std::string getPersistenceName() const
Name used in table persistence.
Definition: PsfexPsf.cc:477
virtual boost::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
void write(lsst::afw::table::io::OutputArchiveHandle &handle) const
Definition: PsfexPsf.cc:479
virtual bool isPersistable() const noexcept override
Is this object persistable?
Definition: PsfexPsf.h:69
virtual boost::shared_ptr< lsst::afw::detection::Psf > clone() const
Polymorphic deep copy; should usually be unnecessary as Psfs are immutable.x.
Definition: PsfexPsf.cc:104