lsst.meas.algorithms  22.0.1-21-g532228a4+83d12174ec
CoaddPsf.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_ALGORITHMS_COADDPSF_H)
25 #define LSST_MEAS_ALGORITHMS_COADDPSF_H
26 
27 #include <memory>
28 #include "lsst/base.h"
29 #include "lsst/pex/config.h"
31 #include "lsst/geom/Box.h"
32 #include "lsst/afw/geom/SkyWcs.h"
35 #include "lsst/afw/table/types.h"
37 
38 namespace lsst {
39 namespace meas {
40 namespace algorithms {
41 
43 public:
44  LSST_CONTROL_FIELD(warpingKernelName, std::string,
45  "Name of warping kernel; choices: lanczos3,lanczos4,lanczos5,bilinear,nearest");
46  LSST_CONTROL_FIELD(cacheSize, int, "Warping kernel cache size");
47 
48  explicit CoaddPsfControl(std::string _warpingKernelName = "lanczos3", int _cacheSize = 10000)
49  : warpingKernelName(_warpingKernelName), cacheSize(_cacheSize) {}
50 };
51 
58 class CoaddPsf : public afw::table::io::PersistableFacade<CoaddPsf>, public ImagePsf {
59 public:
75  explicit CoaddPsf(afw::table::ExposureCatalog const& catalog, afw::geom::SkyWcs const& coaddWcs,
76  std::string const& weightFieldName = "weight",
77  std::string const& warpingKernelName = "lanczos3", int cacheSize = 10000);
78 
94  CoaddPsfControl const& ctrl, std::string const& weightFieldName = "weight")
95  : CoaddPsf(catalog, coaddWcs, weightFieldName, ctrl.warpingKernelName, ctrl.cacheSize) {}
96 
97  explicit CoaddPsf(afw::table::ExposureCatalog const& catalog,
100  std::string const& warpingKernelName = "lanczos3",
101  int cacheSize = 10000
102  );
103 
106 
108  std::shared_ptr<afw::detection::Psf> resized(int width, int height) const override;
115  geom::Point2D getAveragePosition() const override { return _averagePosition; }
116 
118  afw::geom::SkyWcs getCoaddWcs() { return _coaddWcs; }
119 
121  int getComponentCount() const;
122 
131 
139  afw::geom::SkyWcs getWcs(int index);
140 
148  double getWeight(int index);
149 
157  afw::table::RecordId getId(int index);
158 
166  geom::Box2I getBBox(int index);
167 
176 
186  bool isPersistable() const noexcept override { return true; }
187 
188  // Factory used to read CoaddPsf from an InputArchive; defined only in the source file.
189  class Factory;
190 
191 protected:
193  doComputeKernelImage(geom::Point2D const& ccdXY, afw::image::Color const& color) const override;
194 
195  geom::Box2I doComputeBBox(geom::Point2D const& position, afw::image::Color const& color) const override;
196 
197  // See afw::table::io::Persistable::getPersistenceName
198  std::string getPersistenceName() const override;
199 
200  // See afw::table::io::Persistable::getPythonModule
201  std::string getPythonModule() const override;
202 
203  // See afw::table::io::Persistable::write
204  void write(OutputArchiveHandle& handle) const override;
205 
206 
207 private:
209  afw::geom::SkyWcs _coaddWcs;
210  afw::table::Key<double> _weightKey;
211  geom::Point2D _averagePosition;
212  std::string _warpingKernelName; // could be removed if we could get this from _warpingControl (#2949)
214 };
215 
216 } // namespace algorithms
217 } // namespace meas
218 } // namespace lsst
219 
220 #endif
afw::table::Key< int > coaddWcs
afw::table::Key< int > cacheSize
Definition: CoaddPsf.cc:348
afw::table::PointKey< double > averagePosition
Definition: CoaddPsf.cc:349
afw::table::Key< std::string > warpingKernelName
Definition: CoaddPsf.cc:350
io::OutputArchiveHandle OutputArchiveHandle
CoaddPsfControl(std::string _warpingKernelName="lanczos3", int _cacheSize=10000)
Definition: CoaddPsf.h:48
int cacheSize
"Warping kernel cache size" ;
Definition: CoaddPsf.h:46
std::string warpingKernelName
"Name of warping kernel; choices: lanczos3,lanczos4,lanczos5,bilinear,nearest" ;
Definition: CoaddPsf.h:45
CoaddPsf is the Psf derived to be used for non-PSF-matched Coadd images.
Definition: CoaddPsf.h:58
std::string getPersistenceName() const override
Definition: CoaddPsf.cc:425
std::shared_ptr< afw::detection::Psf > clone() const override
Polymorphic deep copy. Usually unnecessary, as Psfs are immutable.
Definition: CoaddPsf.cc:179
CoaddPsf(afw::table::ExposureCatalog const &catalog, afw::geom::SkyWcs const &coaddWcs, CoaddPsfControl const &ctrl, std::string const &weightFieldName="weight")
Constructor for CoaddPsf.
Definition: CoaddPsf.h:93
std::shared_ptr< afw::detection::Psf const > getPsf(int index)
Get the Psf of the component image at index.
Definition: CoaddPsf.cc:293
void write(OutputArchiveHandle &handle) const override
Definition: CoaddPsf.cc:429
std::string getPythonModule() const override
Definition: CoaddPsf.cc:427
double getWeight(int index)
Get the weight of the component image at index.
Definition: CoaddPsf.cc:314
bool isPersistable() const noexcept override
Return true if the CoaddPsf persistable (always true).
Definition: CoaddPsf.h:186
afw::table::RecordId getId(int index)
Get the exposure ID of the component image at index.
Definition: CoaddPsf.cc:321
geom::Box2I getBBox(int index)
Get the bounding box (in component image Pixel coordinates) of the component image at index.
Definition: CoaddPsf.cc:328
std::shared_ptr< afw::detection::Psf::Image > doComputeKernelImage(geom::Point2D const &ccdXY, afw::image::Color const &color) const override
Definition: CoaddPsf.cc:246
std::shared_ptr< afw::detection::Psf > resized(int width, int height) const override
Return a clone with specified kernel dimensions.
Definition: CoaddPsf.cc:181
afw::geom::SkyWcs getCoaddWcs()
Return the Wcs of the coadd (defines the coordinate system of the Psf).
Definition: CoaddPsf.h:118
std::shared_ptr< afw::geom::polygon::Polygon const > getValidPolygon(int index)
Get the validPolygon (in component image Pixel coordinates) of the component image at index.
Definition: CoaddPsf.cc:307
CoaddPsf(afw::table::ExposureCatalog const &catalog, afw::geom::SkyWcs const &coaddWcs, std::string const &weightFieldName="weight", std::string const &warpingKernelName="lanczos3", int cacheSize=10000)
Main constructors for CoaddPsf.
Definition: CoaddPsf.cc:141
geom::Box2I doComputeBBox(geom::Point2D const &position, afw::image::Color const &color) const override
Definition: CoaddPsf.cc:224
geom::Point2D getAveragePosition() const override
Return the average of the positions of the stars that went into this Psf.
Definition: CoaddPsf.h:115
int getComponentCount() const
Return the number of component Psfs in this CoaddPsf.
Definition: CoaddPsf.cc:291
afw::geom::SkyWcs getWcs(int index)
Get the Wcs of the component image at index.
Definition: CoaddPsf.cc:300
An intermediate base class for Psfs that use an image representation.
Definition: ImagePsf.h:40
Factory