LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
PsfCandidate.h
Go to the documentation of this file.
1// -*- LSST-C++ -*-
2#if !defined(LSST_MEAS_ALGORITHMS_PSFCANDIDATE_H)
3#define LSST_MEAS_ALGORITHMS_PSFCANDIDATE_H
4
5/*
6 * LSST Data Management System
7 * Copyright 2008, 2009, 2010 LSST Corporation.
8 *
9 * This product includes software developed by the
10 * LSST Project (http://www.lsst.org/).
11 *
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the LSST License Statement and
23 * the GNU General Public License along with this program. If not,
24 * see <http://www.lsstcorp.org/LegalNotices/>.
25 */
26
34#include <memory>
35#include <vector>
36
37#include "lsst/geom/Point.h"
43
44namespace lsst {
45namespace meas {
46namespace algorithms {
54template <typename PixelT>
56public:
60
62
70 parentExposure
71 )
72 : afw::math::SpatialCellImageCandidate(source->getX(), source->getY()),
73 _parentExposure(parentExposure),
74 _offsetImage(),
75 _source(source),
76 _image(nullptr),
77 _amplitude(0.0),
78 _var(1.0) {}
79
85 parentExposure,
86 double xCenter,
87 double yCenter
88 )
89 : afw::math::SpatialCellImageCandidate(xCenter, yCenter),
90 _parentExposure(parentExposure),
91 _offsetImage(),
92 _source(source),
93 _image(nullptr),
94 _amplitude(0.0),
95 _var(1.0) {}
96
98 virtual ~PsfCandidate(){};
99
105 double getCandidateRating() const { return _source->getPsfInstFlux(); }
106
109
111 double getAmplitude() const { return _amplitude; }
112
114 void setAmplitude(double amplitude) { _amplitude = amplitude; }
115
117 double getVar() const { return _var; }
118
120 void setVar(double var) { _var = var; }
121
123 std::shared_ptr<afw::image::MaskedImage<PixelT> const> getMaskedImage(int width, int height) const;
125 getOffsetImage(std::string const algorithm, unsigned int buffer) const;
126
128 static int getBorderWidth();
129
131 static void setBorderWidth(int border);
132
136 static void setPixelThreshold(float threshold);
137
139 static float getPixelThreshold();
140
142 static void setMaskBlends(bool doMaskBlends);
143
145 static bool getMaskBlends();
146
147private:
149 _parentExposure; // the %image that the Sources are found in
150
152 offsetImage(std::shared_ptr<afw::image::MaskedImage<PixelT>> img, std::string const algorithm, unsigned int buffer);
153
155 extractImage(unsigned int width, unsigned int height) const;
156
157 std::shared_ptr<afw::image::MaskedImage<PixelT>> mutable _offsetImage; // %image offset to put center on a pixel
158 std::shared_ptr<afw::table::SourceRecord> _source; // the Source itself
159
160 mutable std::shared_ptr<afw::image::MaskedImage<PixelT>> _image; // cutout image to return (cached)
161 double _amplitude; // best-fit amplitude of current PSF model
162 double _var; // variance to use when fitting this candidate
163 static int _border; // width of border of ignored pixels around _image
164 geom::Point2D _xyCenter;
165 static int _defaultWidth;
166 static float _pixelThreshold;
167 static bool _doMaskBlends;
168};
169
175template <typename PixelT>
177 const & source,
179 image
180 ) {
181 return std::make_shared<PsfCandidate<PixelT>>(source, image);
182}
183
184} // namespace algorithms
185} // namespace meas
186} // namespace lsst
187
188#endif
afw::table::Key< afw::table::Array< ImagePixelT > > image
A class to contain the data, WCS, and other information needed to describe an image of the sky.
Definition Exposure.h:72
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 stored in SpatialCells for spatial Psf fitting.
static float getPixelThreshold()
Get threshold for rejecting pixels unconnected with the central footprint.
std::shared_ptr< const PsfCandidate< PixelT > > ConstPtr
double getCandidateRating() const
Return Cell rating.
static bool getMaskBlends()
Get whether blends are masked.
PsfCandidate(std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure)
Construct a PsfCandidate from a specified source and image.
static void setBorderWidth(int border)
Set the number of pixels to ignore around the candidate image's edge.
double getVar() const
Return the variance in use when fitting this object.
static int getBorderWidth()
Return the number of pixels being ignored around the candidate image's edge.
static void setPixelThreshold(float threshold)
Set threshold for rejecting pixels unconnected with the central footprint.
void setVar(double var)
Set the variance to use when fitting this object.
std::shared_ptr< afw::image::MaskedImage< PixelT > const > getMaskedImage() const
Return the image at the position of the Source, without any sub-pixel shifts to put the centre of the...
void setAmplitude(double amplitude)
Set the best-fit amplitude.
afw::image::MaskedImage< PixelT > MaskedImageT
PsfCandidate(std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT > const > parentExposure, double xCenter, double yCenter)
Construct a PsfCandidate from a specified source, image and xyCenter.
double getAmplitude() const
Return the best-fit amplitude.
static void setMaskBlends(bool doMaskBlends)
Set whether blends are masked.
std::shared_ptr< PsfCandidate< PixelT > > Ptr
std::shared_ptr< afw::table::SourceRecord > getSource() const
Return the original Source.
std::shared_ptr< afw::image::MaskedImage< PixelT > > getOffsetImage(std::string const algorithm, unsigned int buffer) const
Return an offset version of the image of the source.
std::shared_ptr< PsfCandidate< PixelT > > makePsfCandidate(std::shared_ptr< afw::table::SourceRecord > const &source, std::shared_ptr< afw::image::Exposure< PixelT > > image)
Return a PsfCandidate of the right sort.