lsst.meas.base g91d91042f5+e9c6a7b735
Loading...
Searching...
No Matches
ApertureFlux.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008-2016 AURA/LSST.
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_ApertureFlux_h_INCLUDED
25#define LSST_MEAS_BASE_ApertureFlux_h_INCLUDED
26
27#include <array>
28#include <string>
29#include <vector>
30#include <bitset>
31
32#include "lsst/pex/config.h"
41
42namespace lsst {
43namespace meas {
44namespace base {
45
50public:
52
53 LSST_CONTROL_FIELD(radii, std::vector<double>, "Radius (in pixels) of apertures.");
54
55 LSST_CONTROL_FIELD(
56 maxSincRadius, double,
57 "Maximum radius (in pixels) for which the sinc algorithm should be used instead of the "
58 "faster naive algorithm. For elliptical apertures, this is the minor axis radius.");
59
60 LSST_CONTROL_FIELD(
62 "Warping kernel used to shift Sinc photometry coefficients to different center positions");
63};
64
66
81public:
82 // Structures and routines to manage flaghandler
84 static unsigned int const N_FLAGS = 3;
85 static FlagDefinition const FAILURE;
88
90
93
95
106 template <typename T>
107 static Result computeSincFlux(afw::image::Image<T> const& image,
108 afw::geom::ellipses::Ellipse const& ellipse,
109 Control const& ctrl = Control());
110 template <typename T>
112 afw::geom::ellipses::Ellipse const& ellipse,
113 Control const& ctrl = Control());
115
117
126 template <typename T>
127 static Result computeNaiveFlux(afw::image::Image<T> const& image,
128 afw::geom::ellipses::Ellipse const& ellipse,
129 Control const& ctrl = Control());
130 template <typename T>
132 afw::geom::ellipses::Ellipse const& ellipse,
133 Control const& ctrl = Control());
135
137
148 template <typename T>
149 static Result computeFlux(afw::image::Image<T> const& image, afw::geom::ellipses::Ellipse const& ellipse,
150 Control const& ctrl = Control());
151
152 template <typename T>
154 afw::geom::ellipses::Ellipse const& ellipse, Control const& ctrl = Control());
156
160 explicit ApertureFluxAlgorithm(Control const& ctrl, std::string const& name, afw::table::Schema& schema,
161 daf::base::PropertySet& metadata);
162
164
173 virtual void measure(afw::table::SourceRecord& record,
174 afw::image::Exposure<float> const& exposure) const = 0;
175
177 virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const;
178
191 static std::string makeFieldPrefix(std::string const& name, double radius);
192
193protected:
194 void copyResultToRecord(Result const& result, afw::table::SourceRecord& record, int index) const;
195
196 FlagHandler const& getFlagHandler(int index) const { return _keys[index].flags; }
197
200
201private:
202 struct Keys {
203 FluxResultKey instFluxKey;
204 FlagHandler flags;
205
206 Keys(afw::table::Schema& schema, std::string const& prefix, std::string const& doc, bool isSinc);
207 };
208
209 std::vector<Keys> _keys;
210};
211
219 bool getFlag(unsigned int index) const { return _flags[index]; }
220
222 bool getFlag(std::string const& name) const {
224 }
225
227 void setFlag(unsigned int index, bool value = true) { _flags[index] = value; }
228
230 void unsetFlag(unsigned int index) { _flags[index] = false; }
231
232private:
234};
235
243public:
245 ApertureFluxTransform(Control const& ctrl, std::string const& name, afw::table::SchemaMapper& mapper);
246
247 /*
248 * @brief Perform transformation from inputCatalog to outputCatalog.
249 *
250 * @param[in] inputCatalog Source of data to be transformed
251 * @param[in,out] outputCatalog Container for transformed results
252 * @param[in] wcs World coordinate system under which transformation will take place
253 * @param[in] photoCalib Photometric calibration under which transformation will take place
254 * @throws LengthError Catalog sizes do not match
255 */
256 virtual void operator()(afw::table::SourceCatalog const& inputCatalog,
257 afw::table::BaseCatalog& outputCatalog, afw::geom::SkyWcs const& wcs,
258 afw::image::PhotoCalib const& photoCalib) const;
259
260private:
262 Control _ctrl;
263};
264
265} // namespace base
266} // namespace meas
267} // namespace lsst
268
269#endif // !LSST_MEAS_BASE_ApertureFlux_h_INCLUDED
table::Key< std::string > name
std::string prefix
This defines the base of measurement transformations.
Base class for multiple-aperture photometry algorithms.
Definition: ApertureFlux.h:80
SafeCentroidExtractor _centroidExtractor
Definition: ApertureFlux.h:199
void copyResultToRecord(Result const &result, afw::table::SourceRecord &record, int index) const
Definition: ApertureFlux.cc:96
static FlagDefinitionList const & getFlagDefinitions()
Definition: ApertureFlux.cc:49
static FlagDefinition const FAILURE
Definition: ApertureFlux.h:85
static unsigned int const N_FLAGS
Definition: ApertureFlux.h:84
static FlagDefinition const SINC_COEFFS_TRUNCATED
Definition: ApertureFlux.h:87
static std::string makeFieldPrefix(std::string const &name, double radius)
Construct an appropriate prefix for table fields.
Definition: ApertureFlux.cc:57
static Result computeSincFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using Sinc photometry.
static Result computeFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using the algorithm determined...
static FlagDefinition const APERTURE_TRUNCATED
Definition: ApertureFlux.h:86
ApertureFluxResult Result
Result object returned by static methods.
Definition: ApertureFlux.h:92
FlagHandler const & getFlagHandler(int index) const
Definition: ApertureFlux.h:196
static Result computeNaiveFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using naive photometry.
virtual void measure(afw::table::SourceRecord &record, afw::image::Exposure< float > const &exposure) const =0
Measure the configured apertures on the given image.
virtual void fail(afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
Definition: ApertureFlux.cc:87
Configuration object for multiple-aperture flux algorithms.
Definition: ApertureFlux.h:49
std::string shiftKernel
"Warping kernel used to shift Sinc photometry coefficients to different center positions" ;
Definition: ApertureFlux.h:62
double maxSincRadius
"Maximum radius (in pixels) for which the sinc algorithm should be used instead of the " "faster naiv...
Definition: ApertureFlux.h:58
std::vector< double > radii
"Radius (in pixels) of apertures." ;
Definition: ApertureFlux.h:53
Measurement transformation for aperture fluxes.
Definition: ApertureFlux.h:242
virtual void operator()(afw::table::SourceCatalog const &inputCatalog, afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs, afw::image::PhotoCalib const &photoCalib) const
Abstract base class for all C++ measurement transformations.
Definition: Transform.h:86
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.
Definition: FlagHandler.h:83
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:59
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
A Result struct for running an aperture flux algorithm with a single radius.
Definition: ApertureFlux.h:217
bool getFlag(std::string const &name) const
Return the flag value associated with the given flag name.
Definition: ApertureFlux.h:222
bool getFlag(unsigned int index) const
Return the flag value associated with the given bit.
Definition: ApertureFlux.h:219
void setFlag(unsigned int index, bool value=true)
Set the flag value associated with the given bit.
Definition: ApertureFlux.h:227
void unsetFlag(unsigned int index)
Clear (i.e. set to false) the flag associated with the given bit.
Definition: ApertureFlux.h:230
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40
A reusable result struct for instFlux measurements.
Definition: FluxUtilities.h:41
table::Schema schema