LSSTApplications  20.0.0
LSSTDataManagementBasePackage
PixelFitRegion.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2015-2016 LSST/AURA
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 #ifndef LSST_MEAS_MODELFIT_PixelFitRegion_h_INCLUDED
25 #define LSST_MEAS_MODELFIT_PixelFitRegion_h_INCLUDED
26 
27 #include "lsst/pex/config.h"
29 #include "lsst/geom/Point.h"
30 #include "lsst/afw/image/Mask.h"
32 #include "lsst/afw/geom/ellipses.h"
33 
34 namespace lsst { namespace meas { namespace modelfit {
35 
36 
38 
40  nKronRadii(1.5),
41  nPsfSigmaMin(4.0),
42  nPsfSigmaGrow(2.0),
43  nFitRadiiMin(1.0),
44  nFitRadiiMax(3.0),
45  maxArea(100000),
47  {
48  badMaskPlanes.push_back("EDGE");
49  badMaskPlanes.push_back("SAT");
50  badMaskPlanes.push_back("BAD");
51  badMaskPlanes.push_back("NO_DATA");
52  }
53 
55  nKronRadii, double,
56  "Use this multiple of the Kron ellipse to set the fit region (for the final fit region, "
57  "subject to the nFitRadiiMin and nFitRadiiMax constraints)."
58  );
59 
61  nPsfSigmaMin, double,
62  "If the Kron radius is less than this multiple of the PSF width, ignore it and fall back "
63  "to a PSF-oriented ellipse scaled to match the area of the footprint or this radius "
64  "(whichever is larger)."
65  );
66 
68  nPsfSigmaGrow, double,
69  "Grow the initial fit ellipses by this factor before comparing with the Kron/Footprint region"
70  );
71 
73  nFitRadiiMin, double,
74  "Use this multiple of the initial fit ellipse then grow by the PSF width "
75  "to determine the minimum final fit region size."
76  );
77 
79  nFitRadiiMax, double,
80  "Use this multiple of the initial fit ellipse then grow by the PSF width "
81  "to determine the maximum final fit region size."
82  );
83 
85  maxArea, int,
86  "Abort if the fit region grows beyond this many pixels."
87  );
88 
91  "Mask planes that indicate pixels that should be ignored in the fit."
92  );
93 
95  maxBadPixelFraction, double,
96  "Maximum fraction of pixels that may be ignored due to masks; "
97  "more than this and we don't even try."
98  );
99 
100 };
101 
102 
104 public:
105 
107  PixelFitRegionControl const & ctrl,
109  afw::geom::ellipses::Quadrupole const & psfMoments,
110  Scalar kronRadius,
111  int footprintArea
112  );
113 
115  PixelFitRegionControl const & ctrl,
117  );
118 
120  afw::geom::ellipses::Quadrupole const & deconvolved,
121  afw::geom::ellipses::Quadrupole const & psfMoments
122  );
123 
124  void applyMask(afw::image::Mask<> const & mask, geom::Point2D const & center);
125 
130  bool maxArea;
134 
135 private:
136  PixelFitRegionControl _ctrl;
137  afw::image::MaskPixel _badPixelMask;
138 };
139 
140 
141 }}} // lsst::meas::modelfit
142 
143 #endif // !LSST_MEAS_MODELFIT_PixelFitRegion_h_INCLUDED
lsst::meas::modelfit::PixelFitRegionControl::maxArea
int maxArea
"Abort if the fit region grows beyond this many pixels." ;
Definition: PixelFitRegion.h:87
moments
VectorQ moments
Definition: simpleShape.cc:151
lsst::meas::modelfit::PixelFitRegion::usedMaxEllipse
bool usedMaxEllipse
Definition: PixelFitRegion.h:133
lsst::meas::modelfit::PixelFitRegionControl::PixelFitRegionControl
PixelFitRegionControl()
Definition: PixelFitRegion.h:39
lsst::afw::image::Mask
Represent a 2-dimensional array of bitmask pixels.
Definition: Mask.h:77
lsst::meas::modelfit::PixelFitRegion::ellipse
afw::geom::ellipses::Quadrupole ellipse
Definition: PixelFitRegion.h:126
std::vector< std::string >
lsst::meas::modelfit::PixelFitRegion::PixelFitRegion
PixelFitRegion(PixelFitRegionControl const &ctrl, afw::geom::ellipses::Quadrupole const &ellipse)
lsst::meas::modelfit::PixelFitRegionControl::badMaskPlanes
std::vector< std::string > badMaskPlanes
"Mask planes that indicate pixels that should be ignored in the fit." ;
Definition: PixelFitRegion.h:92
lsst::meas::modelfit::Scalar
double Scalar
Typedefs to be used for probability and parameter values.
Definition: common.h:44
ellipses.h
lsst::meas::modelfit::PixelFitRegion::footprint
boost::shared_ptr< afw::detection::Footprint > footprint
Definition: PixelFitRegion.h:127
lsst::meas::modelfit::PixelFitRegionControl::nPsfSigmaMin
double nPsfSigmaMin
"If the Kron radius is less than this multiple of the PSF width, ignore it and fall back " "to a PSF-...
Definition: PixelFitRegion.h:65
mask
afw::table::Key< afw::table::Array< MaskPixelT > > mask
Definition: HeavyFootprint.cc:217
std::vector::push_back
T push_back(T... args)
lsst::meas::modelfit::PixelFitRegion::maxBadPixelFraction
bool maxBadPixelFraction
Definition: PixelFitRegion.h:131
lsst::meas::modelfit::PixelFitRegionControl::maxBadPixelFraction
double maxBadPixelFraction
"Maximum fraction of pixels that may be ignored due to masks; " "more than this and we don't even try...
Definition: PixelFitRegion.h:98
lsst::meas::modelfit::PixelFitRegion
Definition: PixelFitRegion.h:103
lsst::meas::modelfit::PixelFitRegion::PixelFitRegion
PixelFitRegion(PixelFitRegionControl const &ctrl, afw::geom::ellipses::Quadrupole const &moments, afw::geom::ellipses::Quadrupole const &psfMoments, Scalar kronRadius, int footprintArea)
Footprint.h
std::int32_t
LSST_CONTROL_FIELD
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
lsst::meas::modelfit::PixelFitRegionControl::nFitRadiiMax
double nFitRadiiMax
"Use this multiple of the initial fit ellipse then grow by the PSF width " "to determine the maximum ...
Definition: PixelFitRegion.h:82
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::modelfit::PixelFitRegionControl::nPsfSigmaGrow
double nPsfSigmaGrow
"Grow the initial fit ellipses by this factor before comparing with the Kron/Footprint region" ;
Definition: PixelFitRegion.h:70
lsst::afw::geom::ellipses::Quadrupole
An ellipse core with quadrupole moments as parameters.
Definition: Quadrupole.h:47
lsst::meas::modelfit::PixelFitRegion::applyMask
void applyMask(afw::image::Mask<> const &mask, geom::Point2D const &center)
Mask.h
common.h
lsst::meas::modelfit::PixelFitRegionControl::nFitRadiiMin
double nFitRadiiMin
"Use this multiple of the initial fit ellipse then grow by the PSF width " "to determine the minimum ...
Definition: PixelFitRegion.h:76
lsst::meas::modelfit::PixelFitRegionControl::nKronRadii
double nKronRadii
"Use this multiple of the Kron ellipse to set the fit region (for the final fit region,...
Definition: PixelFitRegion.h:58
PTR
#define PTR(...)
Definition: base.h:41
lsst::geom::Point< double, 2 >
lsst::meas::modelfit::PixelFitRegionControl
Definition: PixelFitRegion.h:37
lsst::meas::modelfit::PixelFitRegion::usedFootprintArea
bool usedFootprintArea
Definition: PixelFitRegion.h:128
lsst::meas::modelfit::PixelFitRegion::usedMinEllipse
bool usedMinEllipse
Definition: PixelFitRegion.h:132
config.h
Point.h
lsst::afw::detection::Footprint
Class to describe the properties of a detected object from an image.
Definition: Footprint.h:63
lsst::meas::modelfit::PixelFitRegion::applyEllipse
bool applyEllipse(afw::geom::ellipses::Quadrupole const &deconvolved, afw::geom::ellipses::Quadrupole const &psfMoments)
lsst::meas::modelfit::PixelFitRegion::maxArea
bool maxArea
Definition: PixelFitRegion.h:130
lsst::meas::modelfit::PixelFitRegion::usedPsfArea
bool usedPsfArea
Definition: PixelFitRegion.h:129