LSSTApplications  20.0.0
LSSTDataManagementBasePackage
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 {
31 namespace meas {
32 namespace base {
33 
36  : _ctrl(ctrl),
37  _instFluxResultKey(
38  FluxResultKey::addFields(schema, name, "instFlux derived from PSF-scaled aperture")),
39  _centroidExtractor(schema, name) {
41 }
42 
44  afw::image::Exposure<float> const& exposure) const {
45  geom::Point2D const center = _centroidExtractor(measRecord, _flagHandler);
46  double const radius = exposure.getPsf()->computeShape(center).getDeterminantRadius();
47  double const fwhm = 2.0 * std::sqrt(2.0 * std::log(2)) * radius;
48  double const size = _ctrl.scale * fwhm;
49  afw::geom::ellipses::Axes const axes(size, size);
50 
51  // ApertureFluxAlgorithm::computeSincFlux requires an ApertureFluxControl as an
52  // argument. All that it uses it for is to read the type of warping kernel.
53  ApertureFluxControl apCtrl;
54  apCtrl.shiftKernel = _ctrl.shiftKernel;
55 
57  exposure.getMaskedImage(), afw::geom::ellipses::Ellipse(axes, center), apCtrl);
58  measRecord.set(_instFluxResultKey, result);
59 
62  if (result.getFlag(iter.number)) {
63  _flagHandler.setValue(measRecord, iter.number, true);
64  }
65  }
66 }
67 
69  _flagHandler.handleFailure(measRecord, error);
70 }
71 
78  mapper.getInputSchema().find<afw::table::Flag>(name + "_" + flagName).key;
79  if (key.isValid()) {
80  mapper.addMapping(key);
81  }
82  }
83 }
84 
85 } // namespace base
86 } // namespace meas
87 } // namespace lsst
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::afw::image::Exposure::getPsf
std::shared_ptr< lsst::afw::detection::Psf const > getPsf() const
Return the Exposure's Psf object.
Definition: Exposure.h:307
std::string
STL class.
Psf.h
lsst::log.log.logContinued.error
def error(fmt, *args)
Definition: logContinued.py:210
lsst::meas::base::FlagHandler::handleFailure
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:76
lsst::afw::table::SourceRecord
Record class that contains measurements made on a single exposure.
Definition: Source.h:80
lsst::afw::image::Exposure< float >
lsst::meas::base::ScaledApertureFluxAlgorithm::fail
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.
Definition: ScaledApertureFlux.cc:68
base
Definition: __init__.py:1
lsst::meas::base::ScaledApertureFluxAlgorithm::ScaledApertureFluxAlgorithm
ScaledApertureFluxAlgorithm(Control const &control, std::string const &name, afw::table::Schema &schema)
Definition: ScaledApertureFlux.cc:34
lsst::meas::base::ScaledApertureFluxControl
Definition: ScaledApertureFlux.h:40
lsst::meas::base::MeasurementError
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
lsst::afw::table::Schema
Defines the fields and offsets for a table.
Definition: Schema.h:50
lsst::afw::geom::ellipses::Axes
An ellipse core for the semimajor/semiminor axis and position angle parametrization (a,...
Definition: Axes.h:47
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::geom::ellipses::BaseCore::getDeterminantRadius
double getDeterminantRadius() const
Return the radius defined as the 4th root of the determinant of the quadrupole matrix.
Definition: BaseCore.cc:118
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::afw::image::Exposure::getMaskedImage
MaskedImageT getMaskedImage()
Return the MaskedImage.
Definition: Exposure.h:228
lsst::meas::base::ApertureFluxControl::shiftKernel
std::string shiftKernel
"Warping kernel used to shift Sinc photometry coefficients to different center positions" ;
Definition: ApertureFlux.h:62
std::sqrt
T sqrt(T... args)
ScaledApertureFlux.h
lsst::meas::base::ScaledApertureFluxTransform::ScaledApertureFluxTransform
ScaledApertureFluxTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
Definition: ScaledApertureFlux.cc:72
lsst::meas::base::FlagHandler::setValue
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:262
ApertureFlux.h
lsst::meas::base::ScaledApertureFluxControl::scale
double scale
"Scaling factor of PSF FWHM for aperture radius." ;
Definition: ScaledApertureFlux.h:45
std::log
T log(T... args)
lsst::afw::table::SchemaMapper
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
lsst::afw::table::Key< afw::table::Flag >
lsst::meas::base::FluxTransform
Base for instFlux measurement transformations.
Definition: FluxUtilities.h:187
result
py::object result
Definition: _schema.cc:429
Source.h
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::FlagDefinitionList::size
std::size_t size() const
return the current size (number of defined elements) of the collection
Definition: FlagHandler.h:125
SincCoeffs.h
lsst::meas::base::ApertureFluxAlgorithm::getFlagDefinitions
static FlagDefinitionList const & getFlagDefinitions()
Definition: ApertureFlux.cc:49
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::ScaledApertureFluxControl::shiftKernel
std::string shiftKernel
"Warping kernel used to shift Sinc photometry coefficients to different center positions" ;
Definition: ScaledApertureFlux.h:44
lsst.pipe.tasks.insertFakes.radius
radius
Definition: insertFakes.py:288
key
Key< U > key
Definition: Schema.cc:281
lsst::geom::Point< double, 2 >
mapper
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
std::size_t
lsst::afw::table::BaseRecord::set
void set(Key< T > const &key, U const &value)
Set value of a field for the given key.
Definition: BaseRecord.h:164
lsst::meas::base::ApertureFluxControl
Configuration object for multiple-aperture flux algorithms.
Definition: ApertureFlux.h:49
lsst::afw::detection::Psf::computeShape
geom::ellipses::Quadrupole computeShape(lsst::geom::Point2D position=makeNullPoint(), image::Color color=image::Color()) const
Compute the ellipse corresponding to the second moments of the Psf.
Definition: Psf.cc:156
astshim.fitsChanContinued.iter
def iter(self)
Definition: fitsChanContinued.py:88
lsst::meas::base::FlagHandler::addFields
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
lsst::meas::base::ScaledApertureFluxAlgorithm::measure
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const override
Measure the scaled aperture instFlux on the given image.
Definition: ScaledApertureFlux.cc:43