LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
KernelCandidate.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
11
12#ifndef LSST_IP_DIFFIM_KERNELCANDIDATE_H
13#define LSST_IP_DIFFIM_KERNELCANDIDATE_H
14
15#include <memory>
16#include "Eigen/Core"
17
18#include "lsst/afw/math.h"
19#include "lsst/afw/image.h"
22#include "lsst/daf/base.h"
23
24namespace lsst {
25namespace ip {
26namespace diffim {
27
28
38 template <typename _PixelT>
40 public:
42 typedef _PixelT PixelT; // _after_ afw::math::Kernel::Pixel
43 public:
48
50 ORIG = 0,
51 PCA = 1,
53 };
54
64 KernelCandidate(float const xCenter,
65 float const yCenter,
66 MaskedImagePtr const& templateMaskedImage,
67 MaskedImagePtr const& scienceMaskedImage,
68 daf::base::PropertySet const& ps);
69
79 KernelCandidate(SourcePtr const& source,
80 MaskedImagePtr const& templateMaskedImage,
81 MaskedImagePtr const& scienceMaskedImage,
82 daf::base::PropertySet const& ps);
84 virtual ~KernelCandidate() {};
85
91 double getCandidateRating() const { return _coreFlux; }
95 SourcePtr getSource() const { return _source; }
99 MaskedImagePtr getTemplateMaskedImage() {return _templateMaskedImage;}
100 MaskedImagePtr getScienceMaskedImage() {return _scienceMaskedImage;}
101
107 double getBackground(CandidateSwitch cand) const;
108 double getKsum(CandidateSwitch cand) const;
110 std::shared_ptr<ImageT const> getImage() const; // For SpatialCellImageCandidate
112
117
125 double background
126 );
127
128 bool isInitialized() const {return _isInitialized;}
129
130
150
164
165 /*
166 * @note This method uses an estimate of the variance which is the
167 * straight difference of the 2 images. If requested in the PropertySet
168 * ("iterateSingleKernel"), the kernel will be rebuilt using the
169 * variance of the difference image resulting from this first
170 * approximate step. This is particularly useful when convolving a
171 * single-depth science image; the variance (and thus resulting kernel)
172 * generally converges after 1 iteration. If
173 * "constantVarianceWeighting" is requested in the PropertySet, no iterations
174 * will be performed even if requested.
175 */
176
177 void build(
178 afw::math::KernelList const& basisList
179 );
180 void build(
181 afw::math::KernelList const& basisList,
182 Eigen::MatrixXd const& hMat
183 );
184
185 private:
186 MaskedImagePtr _templateMaskedImage;
187 MaskedImagePtr _scienceMaskedImage;
188 VariancePtr _varianceEstimate;
190 SourcePtr _source;
191 double _coreFlux;
192 bool _isInitialized;
193 bool _useRegularization;
194 bool _fitForBackground;
195
196 /* best single raw kernel */
198
199 /* with Pca basis */
201
202 void _buildKernelSolution(afw::math::KernelList const& basisList,
203 Eigen::MatrixXd const& hMat);
204 };
205
206
218 template <typename PixelT>
220 makeKernelCandidate(float const xCenter,
221 float const yCenter,
222 std::shared_ptr<afw::image::MaskedImage<PixelT> > const& templateMaskedImage,
223 std::shared_ptr<afw::image::MaskedImage<PixelT> > const& scienceMaskedImage,
224 daf::base::PropertySet const& ps){
225
227 templateMaskedImage,
228 scienceMaskedImage,
229 ps));
230 }
231
243 template <typename PixelT>
246 std::shared_ptr<afw::image::MaskedImage<PixelT> > const& templateMaskedImage,
247 std::shared_ptr<afw::image::MaskedImage<PixelT> > const& scienceMaskedImage,
248 daf::base::PropertySet const& ps){
249
251 templateMaskedImage,
252 scienceMaskedImage,
253 ps));
254 }
255
256
257}}} // end of namespace lsst::ip::diffim
258
259#endif
Declaration of classes to store the solution for convolution kernels.
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74
Base class for candidate objects in a SpatialCell that are able to return an Image of some sort (e....
Class for storing generic metadata.
Definition PropertySet.h:67
std::shared_ptr< PropertySet > Ptr
Definition PropertySet.h:70
Class stored in SpatialCells for spatial Kernel fitting.
std::shared_ptr< ImageT const > getImage() const
std::shared_ptr< afw::image::MaskedImage< PixelT > > MaskedImagePtr
std::shared_ptr< afw::image::Image< afw::image::VariancePixel > > VariancePtr
virtual ~KernelCandidate()
Destructor.
afw::image::Image< afw::math::Kernel::Pixel > ImageT
afw::image::MaskedImage< PixelT > getDifferenceImage(CandidateSwitch cand)
Calculate associated difference image using internal solutions.
double getCandidateRating() const
Return Candidate rating.
std::shared_ptr< KernelCandidate > Ptr
MaskedImagePtr getTemplateMaskedImage()
Return pointers to the image pixels used in kernel determination.
double getBackground(CandidateSwitch cand) const
double getKsum(CandidateSwitch cand) const
std::shared_ptr< afw::table::SourceRecord > SourcePtr
std::shared_ptr< StaticKernelSolution< PixelT > > getKernelSolution(CandidateSwitch cand) const
std::shared_ptr< afw::math::Kernel > getKernel(CandidateSwitch cand) const
Return results of kernel solution.
KernelCandidate(float const xCenter, float const yCenter, MaskedImagePtr const &templateMaskedImage, MaskedImagePtr const &scienceMaskedImage, daf::base::PropertySet const &ps)
Constructor.
SourcePtr getSource() const
Return the original source.
std::shared_ptr< ImageT > getKernelImage(CandidateSwitch cand) const
void build(afw::math::KernelList const &basisList)
Core functionality of KernelCandidate, to build and fill a KernelSolution.
std::vector< std::shared_ptr< Kernel > > KernelList
Definition Kernel.h:462
std::shared_ptr< KernelCandidate< PixelT > > makeKernelCandidate(float const xCenter, float const yCenter, std::shared_ptr< afw::image::MaskedImage< PixelT > > const &templateMaskedImage, std::shared_ptr< afw::image::MaskedImage< PixelT > > const &scienceMaskedImage, daf::base::PropertySet const &ps)
Return a KernelCandidate pointer of the right sort.