lsst.meas.base
20.0.0-3-g750bffe+f5427621ce
|
Go to the documentation of this file.
24 #ifndef LSST_MEAS_BASE_ApertureFlux_h_INCLUDED
25 #define LSST_MEAS_BASE_ApertureFlux_h_INCLUDED
32 #include "lsst/pex/config.h"
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.");
62 "Warping kernel used to shift Sinc photometry coefficients to different center positions");
106 template <
typename T>
110 template <
typename T>
126 template <
typename T>
130 template <
typename T>
148 template <
typename T>
152 template <
typename T>
219 bool getFlag(
unsigned int index)
const {
return _flags[index]; }
227 void setFlag(
unsigned int index,
bool value =
true) { _flags[index] = value; }
230 void unsetFlag(
unsigned int index) { _flags[index] =
false; }
269 #endif // !LSST_MEAS_BASE_ApertureFlux_h_INCLUDED
void unsetFlag(unsigned int index)
Clear (i.e. set to false) the flag associated with the given bit.
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
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...
bool getFlag(std::string const &name) const
Return the flag value associated with the given flag name.
A reusable result struct for instFlux measurements.
static FlagDefinition const APERTURE_TRUNCATED
void setFlag(unsigned int index, bool value=true)
Set the flag value associated with the given bit.
virtual void measure(afw::table::SourceRecord &record, afw::image::Exposure< float > const &exposure) const =0
Measure the configured apertures on the given image.
Exception to be thrown when a measurement algorithm experiences a known failure mode.
static unsigned int const N_FLAGS
A Result struct for running an aperture flux algorithm with a single radius.
A FunctorKey for FluxResult.
FlagHandler const & getFlagHandler(int index) const
std::string shiftKernel
"Warping kernel used to shift Sinc photometry coefficients to different center positions" ;
static FlagDefinition const FAILURE
vector-type utility class to build a collection of FlagDefinitions
double maxSincRadius
"Maximum radius (in pixels) for which the sinc algorithm should be used instead of the " "faster naiv...
Utility class for handling flag fields that indicate the failure modes of an algorithm.
void copyResultToRecord(Result const &result, afw::table::SourceRecord &record, int index) const
ApertureFluxResult Result
Result object returned by static methods.
static std::string makeFieldPrefix(std::string const &name, double radius)
Construct an appropriate prefix for table fields.
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 FlagDefinitionList const & getFlagDefinitions()
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
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.
std::vector< double > radii
"Radius (in pixels) of apertures." ;
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.
ApertureFluxControl Control
Base class for multiple-aperture photometry algorithms.
bool getFlag(unsigned int index) const
Return the flag value associated with the given bit.
Configuration object for multiple-aperture flux algorithms.
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.
SafeCentroidExtractor _centroidExtractor
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 ~ApertureFluxAlgorithm()
static FlagDefinition const SINC_COEFFS_TRUNCATED