LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
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:
101  static CentroidResultKey addFields(afw::table::Schema& schema, std::string const& name,
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:
208  CentroidChecker(afw::table::Schema& schema, std::string const& name, bool inside = true,
209  double maxDistFromPeak = -1.0);
210 
215  bool operator()(afw::table::SourceRecord& record) const;
216 
217 private:
218  bool _doFootprintCheck;
219  double _maxDistFromPeak;
224 };
225 } // namespace base
226 } // namespace meas
227 } // namespace lsst
228 
229 #endif // !LSST_MEAS_BASE_CentroidUtilities_h_INCLUDED
Defines the fields and offsets for a table.
Definition: Schema.h:50
ErrElement yErr
standard deviation of y
Centroid const getCentroid() const
Return a Point object containing the measured x and y.
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition: SkyWcs.h:117
A proxy type for name lookups in a Schema.
Definition: Schema.h:360
geom::Point< CentroidElement > getPoint()
Return the 2D point type corresponding to this result.
The photometric calibration of an exposure.
Definition: PhotoCalib.h:116
UncertaintyEnum
An enum used to specify how much uncertainty information measurement algorithms provide.
Definition: constants.h:43
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
A coordinate class intended to represent absolute positions.
afw::table::PointKey< CentroidElement > getCentroid() const
Return a FunctorKey to just the centroid value.
A reusable struct for centroid measurements.
bool isValid() const
Return True if the centroid key is valid.
CentroidResult(CentroidElement x_, CentroidElement y_, CentroidCov const &matrix)
Constructor; initializes everything from values.
ErrElement xErr
standard deviation of x
STL namespace.
afw::table::CovarianceMatrixKey< ErrElement, 2 > getCentroidErr() const
Return a FunctorKey to just the uncertainty matrix.
CentroidElement x
x (column) coordinate of the measured position
afw::table::Key< CentroidElement > getY() const
Return a Key for the y coordinate.
void setCentroid(Centroid const &centroid)
Set the struct fields from the given Point object.
bool operator!=(CentroidResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
CentroidResultKey(afw::table::PointKey< CentroidElement > const &centroid, afw::table::CovarianceMatrixKey< ErrElement, 2 > const &centroidErr)
Construct from a pair of Keys.
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:71
float ErrElement
Definition: constants.h:55
STL class.
CentroidResult()
Constructor; initializes everything to NaN.
Eigen::Matrix< ErrElement, 2, 2, Eigen::DontAlign > CentroidCov
Definition: constants.h:59
A base class for image defects.
UnitVector3d centroid(VertexIterator const begin, VertexIterator const end)
ErrElement x_y_Cov
x,y term in the uncertainty convariance matrix
This defines the base of measurement transformations.
table::Schema schema
Definition: Camera.cc:161
solver_t * s
afw::table::Key< CentroidElement > getX() const
Return a Key for the x coordinate.
Base class for all records.
Definition: BaseRecord.h:31
CentroidResult(CentroidElement x_, CentroidElement y_, ErrElement xErr_, ErrElement yErr_)
Constructor; initializes everything from values.
Abstract base class for all C++ measurement transformations.
Definition: Transform.h:86
A FunctorKey for CentroidResult.
CentroidElement y
y (row) coordinate of the measured position
CentroidResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
ItemVariant const * other
Definition: Schema.cc:56
Record class that contains measurements made on a single exposure.
Definition: Source.h:82
double CentroidElement
Definition: constants.h:56
CentroidCov const getCentroidErr() const
Return the 2x2 symmetric covariance matrix, with rows and columns ordered (x, y)
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition: FunctorKey.h:74
Base for centroid measurement transformations.
Implementation of the Photometric Calibration class.
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
void setCentroidErr(CentroidCov const &matrix)
Set the struct uncertainty fields from the given matrix, with rows and columns ordered (x...
A FunctorKey used to get or set celestial coordinates from a pair of lsst::geom::Angle keys...
Definition: aggregates.h:210