lsst.meas.base  14.0-13-gd9a51ef+3
ScaledApertureFlux.cc
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 #include "lsst/afw/table/Source.h"
28 #include "lsst/afw/detection/Psf.h"
29 
30 namespace lsst { namespace meas { namespace base {
31 
33  Control const & ctrl,
34  std::string const & name,
35  afw::table::Schema & schema
36 ) : _ctrl(ctrl),
37  _fluxResultKey(
38  FluxResultKey::addFields(schema, name, "flux derived from PSF-scaled aperture")
39  ),
40  _centroidExtractor(schema, name)
41 {
42  _flagHandler = FlagHandler::addFields(schema, name,
44 }
45 
47  afw::table::SourceRecord & measRecord,
48  afw::image::Exposure<float> const & exposure
49 ) const {
50  afw::geom::Point2D const center = _centroidExtractor(measRecord, _flagHandler);
51  double const radius = exposure.getPsf()->computeShape(center).getDeterminantRadius();
52  double const fwhm = 2.0*std::sqrt(2.0*std::log(2))*radius;
53  double const size = _ctrl.scale*fwhm;
54  afw::geom::ellipses::Axes const axes(size, size);
55 
56  // ApertureFluxAlgorithm::computeSincFlux requires an ApertureFluxControl as an
57  // argument. All that it uses it for is to read the type of warping kernel.
58  ApertureFluxControl apCtrl;
59  apCtrl.shiftKernel = _ctrl.shiftKernel;
60 
62  afw::geom::ellipses::Ellipse(axes, center),
63  apCtrl);
64  measRecord.set(_fluxResultKey, result);
65 
68  if (result.getFlag(iter.number)) {
69  _flagHandler.setValue(measRecord, iter.number, true);
70  }
71  }
72 }
73 
75  MeasurementError * error) const {
76  _flagHandler.handleFailure(measRecord, error);
77 }
78 
80  Control const & ctrl,
81  std::string const & name,
83 ) :
84  FluxTransform{name, mapper}
85 {
88  afw::table::Key<afw::table::Flag> key = mapper.getInputSchema().find<afw::table::Flag>(name + "_" + flagName).key;
89  if (key.isValid()) {
90  mapper.addMapping(key);
91  }
92  }
93 }
94 
95 }}} // namespace lsst::meas::base
int iter
std::size_t size() const
return the current size (number of defined elements) of the collection
Definition: FlagHandler.h:133
bool getFlag(unsigned int index) const
Return the flag value associated with the given bit.
Definition: ApertureFlux.h:254
static FlagDefinitionList const & getFlagDefinitions()
Definition: ApertureFlux.cc:45
T log(T... args)
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:38
double scale
"Scaling factor of PSF FWHM for aperture radius." ;
void setValue(afw::table::BaseRecord &record, std::size_t i, bool value) const
Set the flag field corresponding to the given flag index.
Definition: FlagHandler.h:276
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
Base for flux measurement transformations.
string name
bool isValid() const
Configuration object for multiple-aperture flux algorithms.
Definition: ApertureFlux.h:43
STL class.
std::string shiftKernel
"Warping kernel used to shift Sinc photometry coefficients to different center positions" ; ...
MaskedImageT getMaskedImage()
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:56
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinitionList const &flagDefs, FlagDefinitionList const &exclDefs=FlagDefinitionList::getEmptyList())
Add Flag fields to a schema, creating a FlagHandler object to manage them.
Definition: FlagHandler.cc:37
std::shared_ptr< lsst::afw::detection::Psf > getPsf()
static Result computeSincFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the flux (and optionally, uncertanties) within an aperture using Sinc photometry.
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=nullptr) const
Handle an expected or unexpected Exception thrown by a measurement algorithm.
Definition: FlagHandler.cc:93
ScaledApertureFluxAlgorithm(Control const &control, std::string const &name, afw::table::Schema &schema)
void set(Key< T > const &key, U const &value)
ScaledApertureFluxTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
T sqrt(T... args)
virtual void fail(afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const override
Handle an exception thrown by the current algorithm by setting flags in the given record...
std::string shiftKernel
"Warping kernel used to shift Sinc photometry coefficients to different center positions" ; ...
Definition: ApertureFlux.h:62
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const override
Measure the scaled aperture flux on the given image.
A Result struct for running an aperture flux algorithm with a single radius.
Definition: ApertureFlux.h:251