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
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"
33
34namespace lsst {
35namespace meas {
36namespace 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
88class CentroidResultKey : public afw::table::FunctorKey<CentroidResult> {
89public:
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
131 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
152private:
155};
156
169public:
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
185private:
186 afw::table::CoordKey _coordKey;
188};
189
191public:
214 CentroidChecker(afw::table::Schema& schema, std::string const& name, bool inside = true,
215 double maxDistFromPeak = -1.0);
216
223 bool operator()(afw::table::SourceRecord& record) const;
224
225private:
226 bool _doFootprintCheck;
227 double _maxDistFromPeak;
235};
236} // namespace base
237} // namespace meas
238} // namespace lsst
239
240#endif // !LSST_MEAS_BASE_CentroidUtilities_h_INCLUDED
Implementation of the Photometric Calibration class.
SchemaMapper * mapper
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition SkyWcs.h:117
The photometric calibration of an exposure.
Definition PhotoCalib.h:114
Tag types used to declare specialized field types.
Definition misc.h:31
Base class for all records.
Definition BaseRecord.h:31
A FunctorKey used to get or set celestial coordinates from a pair of lsst::geom::Angle keys.
Definition aggregates.h:292
bool isValid() const noexcept
Return True if all the constituent error Keys are valid.
Convenience base class that combines the OutputFunctorKey and InputFunctorKey.
Definition FunctorKey.h:74
Key< T > getY() const noexcept
Return the underlying y Key.
Definition aggregates.h:112
Key< T > getX() const noexcept
Return the underlying x Key.
Definition aggregates.h:109
bool isValid() const noexcept
Return True if both the x and y Keys are valid.
Definition aggregates.h:106
Defines the fields and offsets for a table.
Definition Schema.h:51
A mapping between the keys of two Schemas, used to copy data between them.
Record class that contains measurements made on a single exposure.
Definition Source.h:78
A proxy type for name lookups in a Schema.
Definition Schema.h:367
A coordinate class intended to represent absolute positions.
Definition Point.h:169
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.
afw::table::Key< CentroidElement > getX() const
Return a Key for the x coordinate.
bool operator==(CentroidResultKey const &other) const
Compare the FunctorKey for equality with another, using the underlying Keys.
afw::table::PointKey< CentroidElement > getCentroid() const
Return a FunctorKey to just the centroid value.
afw::table::Key< CentroidElement > getY() const
Return a Key for the y coordinate.
bool operator!=(CentroidResultKey const &other) const
afw::table::CovarianceMatrixKey< ErrElement, 2 > getCentroidErr() const
Return a FunctorKey to just the uncertainty matrix.
CentroidResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
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
daf::base::PropertySet * set
Definition fits.cc:931
This defines the base of measurement transformations.
UncertaintyEnum
An enum used to specify how much uncertainty information measurement algorithms provide.
Definition constants.h:43
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.
geom::Point< CentroidElement > getPoint()
Return the 2D point type corresponding to this result.
ErrElement xErr
standard deviation of x