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.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2008-2014 LSST Corporation.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <http://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#include <cmath>
24
25#include "lsst/geom/Angle.h"
26#include "lsst/geom/Point.h"
29
30namespace lsst {
31namespace meas {
32namespace base {
33
35 : x(std::numeric_limits<CentroidElement>::quiet_NaN()),
36 y(std::numeric_limits<CentroidElement>::quiet_NaN()),
37 xErr(std::numeric_limits<ErrElement>::quiet_NaN()),
38 yErr(std::numeric_limits<ErrElement>::quiet_NaN()),
39 x_y_Cov(std::numeric_limits<ErrElement>::quiet_NaN()) {}
40
41Centroid const CentroidResult::getCentroid() const { return Centroid(x, y); }
42
44 x = centroid.getX();
45 y = centroid.getY();
46}
47
50 m << xErr * xErr, x_y_Cov, x_y_Cov, yErr * yErr;
51 return m;
52}
53
55 xErr = std::sqrt(matrix(0, 0));
56 yErr = std::sqrt(matrix(1, 1));
57 x_y_Cov = matrix(0, 1);
58}
59
61 xErr = _xErr;
62 yErr = _yErr;
63 x_y_Cov = 0.0;
64}
65
67 std::string const &doc, UncertaintyEnum uncertainty) {
69 r._centroid = afw::table::PointKey<CentroidElement>::addFields(schema, name, doc, "pixel");
70 if (uncertainty != NO_UNCERTAINTY) {
73 sigma[0] = schema.addField<ErrElement>(schema.join(name, "xErr"), "1-sigma uncertainty on x position",
74 "pixel");
75 sigma[1] = schema.addField<ErrElement>(schema.join(name, "yErr"), "1-sigma uncertainty on y position",
76 "pixel");
77 if (uncertainty == FULL_COVARIANCE) {
78 cov.push_back(schema.addField<ErrElement>(schema.join(name, "x_y_Cov"),
79 "uncertainty covariance in x and y", "pixel^2"));
80 }
82 }
83 return r;
84}
85
86namespace {
87
88std::vector<std::string> getNameVector() {
90 v.push_back("x");
91 v.push_back("y");
92 return v;
93}
94
95} // namespace
96
98 static std::vector<std::string> names = getNameVector(); // C++11 TODO: just use initializer list
99 try {
100 _centroidErr = afw::table::CovarianceMatrixKey<ErrElement, 2>(s, names);
102 }
103}
104
107 r.setCentroid(record.get(_centroid));
108 if (_centroidErr.isValid()) {
109 r.setCentroidErr(record.get(_centroidErr));
110 }
111 return r;
112}
113
115 record.set(_centroid, value.getCentroid());
116 if (_centroidErr.isValid()) {
117 record.set(_centroidErr, value.getCentroidErr());
118 }
119}
120
122 : BaseTransform{name} {
123 // Map the flag through to the output
124 mapper.addMapping(mapper.getInputSchema().find<afw::table::Flag>(name + "_flag").key);
125
126 // Add keys for the coordinates
127 auto &s = mapper.editOutputSchema();
128 _coordKey = afw::table::CoordKey::addFields(s, name, "ICRS coordinates");
129
130 // If the centroid has an error key we also include one on the celestial
131 // coordinates; otherwise, it isn't necessary. Note that if we provide for
132 // errors in celestial coordinates, we always need the full covariance.
133 if (CentroidResultKey(mapper.getInputSchema()[name]).getCentroidErr().isValid()) {
136 sigma[0] = s.addField<ErrElement>(s.join(name, "raErr"), "1-sigma uncertainty on RA", "rad");
137 sigma[1] = s.addField<ErrElement>(s.join(name, "decErr"), "1-sigma uncertainty on dec", "rad");
138 cov[0] = s.addField<ErrElement>(s.join(name, "ra_dec_Cov"), "Uncertainty covariance in RA and dec",
139 "rad^2");
141 }
142}
143
145 afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs,
146 afw::image::PhotoCalib const &photoCalib) const {
147 checkCatalogSize(inputCatalog, outputCatalog);
148 CentroidResultKey centroidResultKey(inputCatalog.getSchema()[_name]);
149
150 afw::table::SourceCatalog::const_iterator inSrc = inputCatalog.begin();
151 afw::table::BaseCatalog::iterator outSrc = outputCatalog.begin();
152
153 for (; inSrc != inputCatalog.end() && outSrc != outputCatalog.end(); ++inSrc, ++outSrc) {
154 CentroidResult centroidResult = centroidResultKey.get(*inSrc);
155
156 _coordKey.set(*outSrc, wcs.pixelToSky(centroidResult.getCentroid()));
157
158 if (centroidResultKey.getCentroidErr().isValid()) {
159 CentroidCov centroidCov = centroidResult.getCentroidErr();
160 if (!(std::isnan(centroidCov(0, 0)) || std::isnan(centroidCov(1, 1)))) {
161 auto transform = wcs.linearizePixelToSky(centroidResult.getCentroid(), geom::radians)
162 .getLinear()
163 .getMatrix();
164 _coordErrKey.set(*outSrc, (transform * centroidResult.getCentroidErr().cast<double>() *
165 transform.transpose())
166 .cast<ErrElement>());
167 }
168 }
169 }
170}
171
172// Add a key "flag_resetToPeak" if something is wrong with the centroid
173// Save a key to this algorithm's Centroid, as well as the general failure flag
174CentroidChecker::CentroidChecker(afw::table::Schema &schema, std::string const &name, bool doFootprintCheck,
175 double maxDistFromPeak)
176 : _doFootprintCheck(doFootprintCheck), _maxDistFromPeak(maxDistFromPeak) {
177 _resetKey = schema.addField<afw::table::Flag>(schema.join(name, "flag_resetToPeak"),
178 "set if CentroidChecker reset the centroid");
179 _failureKey = schema.find<afw::table::Flag>(schema.join(name, "flag")).key;
180 _xKey = schema.find<CentroidElement>(schema.join(name, "x")).key;
181 _yKey = schema.find<CentroidElement>(schema.join(name, "y")).key;
182
183 // We only check errors on the centroid if they exist: not all measurement
184 // algorithms provide them.
185 try {
186 _xErrKey = schema.find<ErrElement>(schema.join(name, "xErr")).key;
187 } catch (pex::exceptions::NotFoundError &err) {}
188 try {
189 _yErrKey = schema.find<ErrElement>(schema.join(name, "yErr")).key;
190 } catch (pex::exceptions::NotFoundError &err) {}
191 if (_xErrKey.isValid() || _yErrKey.isValid()) {
192 _badErrorKey = schema.addField<afw::table::Flag>(schema.join(name, "flag_badError"),
193 "Error on x and/or y position is NaN");
194 }
195}
196
198 CentroidElement x = record.get(_xKey);
199 CentroidElement y = record.get(_yKey);
200
201 // Check any errors specified on the centroid position are valid.
202 if ((_xErrKey.isValid() && std::isnan(record.get(_xErrKey))) ||
203 (_yErrKey.isValid() && std::isnan(record.get(_yErrKey)))) {
204 record.set(_badErrorKey, true);
205 record.set(_failureKey, true);
206 }
207
208 // Only proceed with checking if appropriately configured.
209 if (!_doFootprintCheck && _maxDistFromPeak < 0.0) {
210 return false;
211 }
212
213 // Check that the centroid has a footprint that we can validate; otherwise, give up.
215 if (!footprint) {
216 throw LSST_EXCEPT(pex::exceptions::RuntimeError, "No Footprint attached to record");
217 }
218 if (footprint->getPeaks().empty()) {
219 throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Footprint has no peaks; cannot verify centroid.");
220 }
221
222 // Set the centroid to the first footprint if the centroid is either more than
223 // _maxDistFromPeak pixels from the centroid, or if it is outside the footprint.
224 CentroidElement footX = footprint->getPeaks().front().getFx();
225 CentroidElement footY = footprint->getPeaks().front().getFy();
226 double distsq = (x - footX) * (x - footX) + (y - footY) * (y - footY);
227 if ((_doFootprintCheck && !footprint->contains(geom::Point2I(geom::Point2D(x, y)))) ||
228 ((_maxDistFromPeak > 0) && (distsq > _maxDistFromPeak * _maxDistFromPeak))) {
229 record.set(_xKey, footX);
230 record.set(_yKey, footY);
231 record.set(_failureKey, true);
232 record.set(_resetKey, true);
233 return true;
234 }
235 return false;
236}
237} // namespace base
238} // namespace meas
239} // namespace lsst
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
afw::table::Key< double > sigma
SchemaMapper * mapper
int y
Definition SpanSet.cc:48
int m
Definition SpanSet.cc:48
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
Field< T >::Value get(Key< T > const &key) const
Return the value of a field for the given key.
Definition BaseRecord.h:151
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition BaseRecord.h:164
iterator begin()
Iterator access.
Definition Catalog.h:400
static CoordKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc)
Add a pair of _ra, _dec fields to a Schema, and return a CoordKey that points to them.
void set(BaseRecord &record, lsst::geom::SpherePoint const &value) const override
Set an lsst::geom::SpherePoint in the given record.
void set(BaseRecord &record, Eigen::Matrix< T, N, N > const &value) const override
Set a covariance matrix in the given record (uses only the lower triangle of the given matrix)
bool isValid() const noexcept
Return True if all the constituent error Keys are valid.
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition Key.h:97
static PointKey addFields(Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them.
Definition aggregates.cc:36
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.
typename Base::const_iterator const_iterator
Record class that contains measurements made on a single exposure.
Definition Source.h:78
std::shared_ptr< Footprint > getFootprint() const
Definition Source.h:98
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
void checkCatalogSize(afw::table::BaseCatalog const &cat1, afw::table::BaseCatalog const &cat2) const
Ensure that catalogs have the same size.
Definition Transform.h:102
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.
virtual void set(afw::table::BaseRecord &record, CentroidResult const &value) const
Set a CentroidResult in the given record.
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.
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.
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
Reports attempts to access elements using an invalid key.
Definition Runtime.h:151
Reports errors that are due to events beyond the control of the program.
Definition Runtime.h:104
T isnan(T... args)
AngleUnit constexpr radians
constant with units of radians
Definition Angle.h:109
UncertaintyEnum
An enum used to specify how much uncertainty information measurement algorithms provide.
Definition constants.h:43
@ FULL_COVARIANCE
The full covariance matrix is provided.
Definition constants.h:46
@ NO_UNCERTAINTY
Algorithm provides no uncertainy information at all.
Definition constants.h:44
Eigen::Matrix< ErrElement, 2, 2, Eigen::DontAlign > CentroidCov
Definition constants.h:59
double CentroidElement
Definition constants.h:56
geom::Point< CentroidElement, 2 > Centroid
Definition constants.h:58
STL namespace.
T push_back(T... args)
T sqrt(T... args)
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,...
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
ErrElement xErr
standard deviation of x