LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
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"
34 #include "lsst/afw/table/arrays.h"
41 
42 namespace lsst {
43 namespace meas {
44 namespace base {
45 
50 public:
52 
53  LSST_CONTROL_FIELD(radii, std::vector<double>, "Radius (in pixels) of apertures.");
54 
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 
62  "Warping kernel used to shift Sinc photometry coefficients to different center positions");
63 };
64 
65 struct ApertureFluxResult;
66 
81 public:
82  // Structures and routines to manage flaghandler
83  static FlagDefinitionList const& getFlagDefinitions();
84  static unsigned int const N_FLAGS = 3;
85  static FlagDefinition const FAILURE;
88 
90 
93 
95 
106  template <typename T>
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>
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>
150  Control const& ctrl = Control());
151 
152  template <typename T>
154  afw::geom::ellipses::Ellipse const& ellipse, Control const& ctrl = Control());
156 
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 
193 protected:
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 
198  Control const _ctrl;
200 
201 private:
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 
232 private:
234 };
235 
243 public:
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 
260 private:
261  std::vector<MagResultKey> _magKeys;
262  Control _ctrl;
263 };
264 
265 } // namespace base
266 } // namespace meas
267 } // namespace lsst
268 
269 #endif // !LSST_MEAS_BASE_ApertureFlux_h_INCLUDED
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::meas::base::ApertureFluxResult::unsetFlag
void unsetFlag(unsigned int index)
Clear (i.e. set to false) the flag associated with the given bit.
Definition: ApertureFlux.h:230
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::SimpleAlgorithm
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
std::bitset< ApertureFluxAlgorithm::N_FLAGS >
lsst::meas::base::ApertureFluxAlgorithm::computeFlux
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...
Definition: ApertureFlux.cc:223
lsst::meas::base::FlagDefinition::number
std::size_t number
Definition: FlagHandler.h:54
std::string
STL class.
lsst::meas::base::ApertureFluxResult::getFlag
bool getFlag(std::string const &name) const
Return the flag value associated with the given flag name.
Definition: ApertureFlux.h:222
CentroidUtilities.h
lsst::meas::base::FluxResult
A reusable result struct for instFlux measurements.
Definition: FluxUtilities.h:41
lsst::log.log.logContinued.error
def error(fmt, *args)
Definition: logContinued.py:213
lsst::meas::base::ApertureFluxAlgorithm::APERTURE_TRUNCATED
static FlagDefinition const APERTURE_TRUNCATED
Definition: ApertureFlux.h:86
lsst::afw::table::SourceRecord
Record class that contains measurements made on a single exposure.
Definition: Source.h:80
lsst::meas::base::ApertureFluxTransform
Measurement transformation for aperture fluxes.
Definition: ApertureFlux.h:242
lsst::meas::base::ApertureFluxResult::setFlag
void setFlag(unsigned int index, bool value=true)
Set the flag value associated with the given bit.
Definition: ApertureFlux.h:227
lsst::afw::image::Exposure< float >
wcs
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:71
std::vector< double >
lsst::meas::base::ApertureFluxTransform::Control
ApertureFluxControl Control
Definition: ApertureFlux.h:244
FluxUtilities.h
lsst::meas::base::ApertureFluxAlgorithm::measure
virtual void measure(afw::table::SourceRecord &record, afw::image::Exposure< float > const &exposure) const =0
Measure the configured apertures on the given image.
lsst::meas::base::MeasurementError
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
lsst::meas::base::ApertureFluxTransform::operator()
virtual void operator()(afw::table::SourceCatalog const &inputCatalog, afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs, afw::image::PhotoCalib const &photoCalib) const
Definition: ApertureFlux.cc:279
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::meas::base::ApertureFluxAlgorithm::N_FLAGS
static unsigned int const N_FLAGS
Definition: ApertureFlux.h:84
InputUtilities.h
lsst::meas::base::SafeCentroidExtractor
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
Definition: InputUtilities.h:39
lsst::afw::geom::SkyWcs
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition: SkyWcs.h:117
lsst.pipe.tasks.processCcdWithFakes.radius
radius
Definition: processCcdWithFakes.py:345
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::meas::base::ApertureFluxResult
A Result struct for running an aperture flux algorithm with a single radius.
Definition: ApertureFlux.h:217
lsst::meas::base::FluxResultKey
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:59
lsst::meas::base::ApertureFluxAlgorithm::getFlagHandler
FlagHandler const & getFlagHandler(int index) const
Definition: ApertureFlux.h:196
lsst::meas::base::ApertureFluxControl::shiftKernel
std::string shiftKernel
"Warping kernel used to shift Sinc photometry coefficients to different center positions" ;
Definition: ApertureFlux.h:62
lsst::meas::base::ApertureFluxAlgorithm::FAILURE
static FlagDefinition const FAILURE
Definition: ApertureFlux.h:85
lsst::meas::base::FlagDefinitionList
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
lsst::afw::image::MaskedImage
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
lsst::meas::base::ApertureFluxControl::maxSincRadius
double maxSincRadius
"Maximum radius (in pixels) for which the sinc algorithm should be used instead of the " "faster naiv...
Definition: ApertureFlux.h:58
lsst::meas::base::FlagHandler
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
lsst::meas::base::ApertureFluxAlgorithm::copyResultToRecord
void copyResultToRecord(Result const &result, afw::table::SourceRecord &record, int index) const
Definition: ApertureFlux.cc:96
lsst::afw::table._source.SourceCatalog
Definition: _source.py:32
lsst::afw::table::SchemaMapper
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
lsst::meas::base::ApertureFluxAlgorithm::Result
ApertureFluxResult Result
Result object returned by static methods.
Definition: ApertureFlux.h:92
lsst::afw::image::PhotoCalib
The photometric calibration of an exposure.
Definition: PhotoCalib.h:114
LSST_CONTROL_FIELD
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:43
Algorithm.h
result
py::object result
Definition: _schema.cc:429
lsst::meas::base::ApertureFluxAlgorithm::makeFieldPrefix
static std::string makeFieldPrefix(std::string const &name, double radius)
Construct an appropriate prefix for table fields.
Definition: ApertureFlux.cc:57
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::geom::ellipses::Ellipse
An ellipse defined by an arbitrary BaseCore and a center point.
Definition: Ellipse.h:51
lsst::meas::base::ApertureFluxAlgorithm::computeSincFlux
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.
Definition: ApertureFlux.cc:146
lsst::meas::base::ApertureFluxAlgorithm::getFlagDefinitions
static FlagDefinitionList const & getFlagDefinitions()
Definition: ApertureFlux.cc:49
photoCalib
Key< int > photoCalib
Definition: Exposure.cc:67
lsst::meas::base::FlagDefinition
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40
lsst::meas::base::ApertureFluxTransform::ApertureFluxTransform
ApertureFluxTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
Definition: ApertureFlux.cc:256
arrays.h
Transform.h
lsst::meas::base::ApertureFluxAlgorithm::ApertureFluxAlgorithm
ApertureFluxAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema, daf::base::PropertySet &metadata)
Construct the algorithm and add its fields to the given Schema.
Definition: ApertureFlux.cc:71
lsst::meas::base::ApertureFluxControl::radii
std::vector< double > radii
"Radius (in pixels) of apertures." ;
Definition: ApertureFlux.h:53
FlagHandler.h
lsst::daf::base::PropertySet
Class for storing generic metadata.
Definition: PropertySet.h:67
lsst::meas::base::ApertureFluxAlgorithm::fail
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
lsst::meas::base::ApertureFluxAlgorithm::Control
ApertureFluxControl Control
Definition: ApertureFlux.h:89
mapper
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
config.h
lsst::meas::base::ApertureFluxAlgorithm
Base class for multiple-aperture photometry algorithms.
Definition: ApertureFlux.h:80
lsst::meas::base::ApertureFluxResult::getFlag
bool getFlag(unsigned int index) const
Return the flag value associated with the given bit.
Definition: ApertureFlux.h:219
lsst::meas::base::ApertureFluxControl::ApertureFluxControl
ApertureFluxControl()
Definition: ApertureFlux.cc:51
lsst::meas::base::ApertureFluxControl
Configuration object for multiple-aperture flux algorithms.
Definition: ApertureFlux.h:49
lsst::meas::base::FlagDefinitionList::getDefinition
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.
Definition: FlagHandler.h:83
lsst::afw::image::Image
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
lsst::meas::base::BaseTransform
Abstract base class for all C++ measurement transformations.
Definition: Transform.h:86
lsst::meas::base::ApertureFluxAlgorithm::_ctrl
Control const _ctrl
Definition: ApertureFlux.h:198
Exposure.h
lsst::afw::table::CatalogT< BaseRecord >
lsst::meas::base::ApertureFluxAlgorithm::_centroidExtractor
SafeCentroidExtractor _centroidExtractor
Definition: ApertureFlux.h:199
prefix
std::string prefix
Definition: SchemaMapper.cc:79
lsst::meas::base::ApertureFluxAlgorithm::computeNaiveFlux
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.
Definition: ApertureFlux.cc:176
lsst::meas::base::ApertureFluxAlgorithm::~ApertureFluxAlgorithm
virtual ~ApertureFluxAlgorithm()
Definition: ApertureFlux.h:163
lsst::meas::base::ApertureFluxAlgorithm::SINC_COEFFS_TRUNCATED
static FlagDefinition const SINC_COEFFS_TRUNCATED
Definition: ApertureFlux.h:87