lsst.meas.base  21.0.0-7-g04766d7+bcfafad371
CentroidUtilities.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008-2014 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 #ifndef LSST_MEAS_BASE_CentroidUtilities_h_INCLUDED
25 #define LSST_MEAS_BASE_CentroidUtilities_h_INCLUDED
26 
28 #include "lsst/geom/Point.h"
29 #include "lsst/afw/geom/SkyWcs.h"
33 
34 namespace lsst {
35 namespace meas {
36 namespace base {
37 
47 
50 
53  : x(x_),
54  y(y_),
55  xErr(std::sqrt(matrix(0, 0))),
56  yErr(std::sqrt(matrix(1, 1))),
57  x_y_Cov(matrix(0, 1)) {}
58 
61  : x(x_), y(y_), xErr(xErr_), yErr(yErr_), x_y_Cov(0.0) {}
62 
64  Centroid const getCentroid() const;
65 
67  void setCentroid(Centroid const& centroid);
68 
71 
73  CentroidCov const getCentroidErr() const;
74 
76  void setCentroidErr(CentroidCov const& matrix);
77 
79  void setCentroidErr(ErrElement _xErr, ErrElement _yErr);
80 };
81 
88 class CentroidResultKey : public afw::table::FunctorKey<CentroidResult> {
89 public:
102  std::string const& doc, UncertaintyEnum uncertainty);
103 
105  CentroidResultKey() : _centroid(), _centroidErr() {}
106 
110  : _centroid(centroid), _centroidErr(centroidErr) {}
111 
122 
124  virtual CentroidResult get(afw::table::BaseRecord const& record) const;
125 
127  virtual void set(afw::table::BaseRecord& record, CentroidResult const& value) const;
128 
130  bool operator==(CentroidResultKey const& other) const {
132  return _centroid == other._centroid && _centroidErr == other._centroidErr;
133  }
134  bool operator!=(CentroidResultKey const& other) const { return !(*this == other); }
136 
138  bool isValid() const { return _centroid.isValid() && _centroidErr.isValid(); }
139 
142 
145 
147  afw::table::Key<CentroidElement> getX() const { return _centroid.getX(); }
148 
150  afw::table::Key<CentroidElement> getY() const { return _centroid.getY(); }
151 
152 private:
155 };
156 
169 public:
171 
172  /*
173  * @brief Perform transformation from inputCatalog to outputCatalog.
174  *
175  * @param[in] inputCatalog Source of data to be transformed
176  * @param[in,out] outputCatalog Container for transformed results
177  * @param[in] wcs World coordinate system under which transformation will take place
178  * @param[in] photoCalib Photometric calibration under which transformation will take place
179  * @throws LengthError Catalog sizes do not match
180  */
181  virtual void operator()(afw::table::SourceCatalog const& inputCatalog,
182  afw::table::BaseCatalog& outputCatalog, afw::geom::SkyWcs const& wcs,
183  afw::image::PhotoCalib const& photoCalib) const;
184 
185 private:
186  afw::table::CoordKey _coordKey;
188 };
189 
191 public:
213  CentroidChecker(afw::table::Schema& schema, std::string const& name, bool inside = true,
214  double maxDistFromPeak = -1.0);
215 
222  bool operator()(afw::table::SourceRecord& record) const;
223 
224 private:
225  bool _doFootprintCheck;
226  double _maxDistFromPeak;
234 };
235 } // namespace base
236 } // namespace meas
237 } // namespace lsst
238 
239 #endif // !LSST_MEAS_BASE_CentroidUtilities_h_INCLUDED
table::Key< std::string > name
ItemVariant const * other
SchemaMapper * mapper
table::Key< table::Array< std::uint8_t > > wcs
This defines the base of measurement transformations.
Key< T > getX() const noexcept
bool isValid() const noexcept
Key< T > getY() const noexcept
Abstract base class for all C++ measurement transformations.
Definition: Transform.h:86
CentroidChecker(afw::table::Schema &schema, std::string const &name, bool inside=true, double maxDistFromPeak=-1.0)
Check source record produced by a centroid algorithm called "name".
bool operator()(afw::table::SourceRecord &record) const
Set the centroid to the first footprint if the centroid is either more than _dist pixels from the foo...
A FunctorKey for CentroidResult.
bool operator==(CentroidResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
afw::table::CovarianceMatrixKey< ErrElement, 2 > getCentroidErr() const
Return a FunctorKey to just the uncertainty matrix.
virtual void set(afw::table::BaseRecord &record, CentroidResult const &value) const
Set a CentroidResult in the given record.
bool operator!=(CentroidResultKey const &other) const
afw::table::Key< CentroidElement > getY() const
Return a Key for the y coordinate.
CentroidResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
afw::table::Key< CentroidElement > getX() const
Return a Key for the x coordinate.
afw::table::PointKey< CentroidElement > getCentroid() const
Return a FunctorKey to just the centroid value.
virtual CentroidResult get(afw::table::BaseRecord const &record) const
Get a CentroidResult from the given record.
bool isValid() const
Return True if the centroid key is valid.
CentroidResultKey(afw::table::PointKey< CentroidElement > const &centroid, afw::table::CovarianceMatrixKey< ErrElement, 2 > const &centroidErr)
Construct from a pair of Keys.
static CentroidResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, UncertaintyEnum uncertainty)
Add the appropriate fields to a Schema, and return a CentroidResultKey that manages them.
Base for centroid measurement transformations.
CentroidTransform(std::string const &name, afw::table::SchemaMapper &mapper)
virtual void operator()(afw::table::SourceCatalog const &inputCatalog, afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs, afw::image::PhotoCalib const &photoCalib) const
UncertaintyEnum
An enum used to specify how much uncertainty information measurement algorithms provide.
Definition: constants.h:43
float ErrElement
Definition: constants.h:55
Eigen::Matrix< ErrElement, 2, 2, Eigen::DontAlign > CentroidCov
Definition: constants.h:59
double CentroidElement
Definition: constants.h:56
STL namespace.
A reusable struct for centroid measurements.
CentroidElement y
y (row) coordinate of the measured position
Centroid const getCentroid() const
Return a Point object containing the measured x and y.
CentroidElement x
x (column) coordinate of the measured position
void setCentroidErr(CentroidCov const &matrix)
Set the struct uncertainty fields from the given matrix, with rows and columns ordered (x,...
CentroidResult(CentroidElement x_, CentroidElement y_, CentroidCov const &matrix)
Constructor; initializes everything from values.
CentroidCov const getCentroidErr() const
Return the 2x2 symmetric covariance matrix, with rows and columns ordered (x, y)
void setCentroid(Centroid const &centroid)
Set the struct fields from the given Point object.
ErrElement yErr
standard deviation of y
CentroidResult()
Constructor; initializes everything to NaN.
ErrElement x_y_Cov
x,y term in the uncertainty convariance matrix
CentroidResult(CentroidElement x_, CentroidElement y_, ErrElement xErr_, ErrElement yErr_)
Constructor; initializes everything from values.
ErrElement xErr
standard deviation of x
geom::Point< CentroidElement > getPoint()
Return the 2D point type corresponding to this result.
Key< int > photoCalib
table::Schema schema