#include <CircularApertureFlux.h>
|
| CircularApertureFluxAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema, daf::base::PropertySet &metadata) |
|
virtual void | measure (afw::table::SourceRecord &record, afw::image::Exposure< float > const &exposure) const |
| Measure the configured apertures on the given image. More...
|
|
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. More...
|
|
virtual void | measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::image::Wcs const &refWcs) const |
| Called to measure a single child source in an image. More...
|
|
virtual void | measureNForced (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure, afw::table::SourceCatalog const &refRecord, afw::image::Wcs const &refWcs) const |
| Called to simultaneously measure all children in a deblend family, in a single image. More...
|
|
virtual void | measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const |
| Called to simultaneously measure all children in a deblend family, in a single image. More...
|
|
std::string | getLogName () const |
|
|
static FlagDefinitionList const & | getFlagDefinitions () |
|
static std::string | makeFieldPrefix (std::string const &name, double radius) |
| Construct an appropriate prefix for table fields. More...
|
|
|
template<typename T > |
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. More...
|
|
template<typename T > |
static Result | computeSincFlux (afw::image::MaskedImage< 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. More...
|
|
|
template<typename T > |
static Result | computeNaiveFlux (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 naive photometry. More...
|
|
template<typename T > |
static Result | computeNaiveFlux (afw::image::MaskedImage< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control()) |
| Compute the flux (and optionally, uncertanties) within an aperture using naive photometry. More...
|
|
|
template<typename T > |
static Result | computeFlux (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 the algorithm determined by its size and the maxSincRadius control parameter. More...
|
|
template<typename T > |
static Result | computeFlux (afw::image::MaskedImage< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control()) |
| Compute the flux (and optionally, uncertanties) within an aperture using the algorithm determined by its size and the maxSincRadius control parameter. More...
|
|
Definition at line 38 of file CircularApertureFlux.h.
◆ Control
◆ Result
Result object returned by static methods.
Definition at line 96 of file ApertureFlux.h.
◆ CircularApertureFluxAlgorithm()
lsst::meas::base::CircularApertureFluxAlgorithm::CircularApertureFluxAlgorithm |
( |
Control const & |
ctrl, |
|
|
std::string const & |
name, |
|
|
afw::table::Schema & |
schema, |
|
|
daf::base::PropertySet & |
metadata |
|
) |
| |
◆ computeFlux() [1/2]
Compute the flux (and optionally, uncertanties) within an aperture using the algorithm determined by its size and the maxSincRadius control parameter.
This method delegates to computeSincFlux is the minor axis of the aperture is smaller than ctrl.maxSincRadius, and delegates to computeNaiveFlux otherwise.
- Parameters
-
[in] | image | Image or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as fluxes. |
[in] | ellipse | Ellipse that defines the outer boundary of the aperture. |
[in] | ctrl | Control object. |
Definition at line 260 of file ApertureFlux.cc.
◆ computeFlux() [2/2]
Compute the flux (and optionally, uncertanties) within an aperture using the algorithm determined by its size and the maxSincRadius control parameter.
This method delegates to computeSincFlux is the minor axis of the aperture is smaller than ctrl.maxSincRadius, and delegates to computeNaiveFlux otherwise.
- Parameters
-
[in] | image | Image or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as fluxes. |
[in] | ellipse | Ellipse that defines the outer boundary of the aperture. |
[in] | ctrl | Control object. |
Definition at line 271 of file ApertureFlux.cc.
◆ computeNaiveFlux() [1/2]
Compute the flux (and optionally, uncertanties) within an aperture using naive photometry.
The naive algorithm just counts the flux in pixels whose centers lie within the aperture, ignoring the effects of sub-pixel aperture boundaries.
- Parameters
-
[in] | image | Image or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as fluxes. |
[in] | ellipse | Ellipse that defines the outer boundary of the aperture. |
Definition at line 196 of file ApertureFlux.cc.
◆ computeNaiveFlux() [2/2]
Compute the flux (and optionally, uncertanties) within an aperture using naive photometry.
The naive algorithm just counts the flux in pixels whose centers lie within the aperture, ignoring the effects of sub-pixel aperture boundaries.
- Parameters
-
[in] | image | Image or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as fluxes. |
[in] | ellipse | Ellipse that defines the outer boundary of the aperture. |
Definition at line 224 of file ApertureFlux.cc.
◆ computeSincFlux() [1/2]
Compute the flux (and optionally, uncertanties) within an aperture using Sinc photometry.
The Sinc algorithm is slower than a naive aperture, but more accurate, in that it correctly handles sub-pixel aperture boundaries on well-sampled data. This improved accuracy is most important for smaller apertures.
- Parameters
-
[in] | image | Image or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as fluxes. |
[in] | ellipse | Ellipse that defines the outer boundary of the aperture. |
[in] | ctrl | Control object. |
Definition at line 162 of file ApertureFlux.cc.
◆ computeSincFlux() [2/2]
Compute the flux (and optionally, uncertanties) within an aperture using Sinc photometry.
The Sinc algorithm is slower than a naive aperture, but more accurate, in that it correctly handles sub-pixel aperture boundaries on well-sampled data. This improved accuracy is most important for smaller apertures.
- Parameters
-
[in] | image | Image or MaskedImage to be measured. If a MaskedImage is provided, uncertainties will be returned as well as fluxes. |
[in] | ellipse | Ellipse that defines the outer boundary of the aperture. |
[in] | ctrl | Control object. |
Definition at line 177 of file ApertureFlux.cc.
◆ copyResultToRecord()
void lsst::meas::base::ApertureFluxAlgorithm::copyResultToRecord |
( |
Result const & |
result, |
|
|
afw::table::SourceRecord & |
record, |
|
|
int |
index |
|
) |
| const |
|
protectedinherited |
Return the flag definitions which apply to aperture flux measurements.
Definition at line 105 of file ApertureFlux.cc.
◆ fail()
void lsst::meas::base::ApertureFluxAlgorithm::fail |
( |
afw::table::SourceRecord & |
measRecord, |
|
|
MeasurementError * |
error = nullptr |
|
) |
| const |
|
virtualinherited |
Handle an exception thrown by the current algorithm by setting flags in the given record.
fail() is called by the measurement framework when an exception is allowed to propagate out of one the algorithm's measure() methods. It should generally set both a general failure flag for the algorithm as well as a specific flag indicating the error condition, if possible. To aid in this, if the exception was an instance of MeasurementError, it will be passed in, carrying information about what flag to set.
An algorithm can also to chose to set flags within its own measure() methods, and then just return, rather than throw an exception. However, fail() should be implemented even when all known failure modes do not throw exceptions, to ensure that unexpected exceptions thrown in lower-level code are properly handled.
Implements lsst::meas::base::BaseAlgorithm.
Definition at line 96 of file ApertureFlux.cc.
◆ getFlagDefinitions()
FlagDefinitionList const & lsst::meas::base::ApertureFluxAlgorithm::getFlagDefinitions |
( |
| ) |
|
|
staticinherited |
◆ getFlagHandler()
FlagHandler const& lsst::meas::base::ApertureFluxAlgorithm::getFlagHandler |
( |
int |
index | ) |
const |
|
inlineprotectedinherited |
◆ getLogName()
std::string lsst::meas::base::BaseAlgorithm::getLogName |
( |
| ) |
const |
|
inlineinherited |
◆ makeFieldPrefix()
std::string lsst::meas::base::ApertureFluxAlgorithm::makeFieldPrefix |
( |
std::string const & |
name, |
|
|
double |
radius |
|
) |
| |
|
staticinherited |
Construct an appropriate prefix for table fields.
Given a plugin name (e.g. base_CircularApertureFlux) and an aperture radius (e.g. 12 pixels) return an appropriate prefix for table fields to contain the measurement results (e.g. base_CircularApertureFlux_12_0). Table fields can then be created named <prefix>_flux, <prefix>_fluxErr, etc.
- Parameters
-
[in] | pluginName | Name of measurement plugin. |
[in] | radius | Aperture radius (pixels). |
- Returns
- Table field name prefix.
Definition at line 59 of file ApertureFlux.cc.
◆ measure()
void lsst::meas::base::CircularApertureFluxAlgorithm::measure |
( |
afw::table::SourceRecord & |
record, |
|
|
afw::image::Exposure< float > const & |
exposure |
|
) |
| const |
|
virtual |
◆ measureForced()
virtual void lsst::meas::base::SimpleAlgorithm::measureForced |
( |
afw::table::SourceRecord & |
measRecord, |
|
|
afw::image::Exposure< float > const & |
exposure, |
|
|
afw::table::SourceRecord const & |
refRecord, |
|
|
afw::image::Wcs const & |
refWcs |
|
) |
| const |
|
inlinevirtualinherited |
◆ measureN()
void lsst::meas::base::SingleFrameAlgorithm::measureN |
( |
afw::table::SourceCatalog const & |
measCat, |
|
|
afw::image::Exposure< float > const & |
exposure |
|
) |
| const |
|
virtualinherited |
Called to simultaneously measure all children in a deblend family, in a single image.
Outputs should be saved in the given SourceCatalog, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.
The default implementation simply throws an exception, indicating that simultaneous measurement is not supported.
Definition at line 29 of file Algorithm.cc.
◆ measureNForced()
virtual void lsst::meas::base::SimpleAlgorithm::measureNForced |
( |
afw::table::SourceCatalog const & |
measCat, |
|
|
afw::image::Exposure< float > const & |
exposure, |
|
|
afw::table::SourceCatalog const & |
refRecord, |
|
|
afw::image::Wcs const & |
refWcs |
|
) |
| const |
|
inlinevirtualinherited |
Called to simultaneously measure all children in a deblend family, in a single image.
Outputs should be saved in the given SourceCatalog, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.
The default implementation simply throws an exception, indicating that simultaneous measurement is not supported.
Reimplemented from lsst::meas::base::ForcedAlgorithm.
Definition at line 196 of file Algorithm.h.
◆ _centroidExtractor
◆ _ctrl
Control const lsst::meas::base::ApertureFluxAlgorithm::_ctrl |
|
protectedinherited |
◆ _logName
std::string lsst::meas::base::BaseAlgorithm::_logName |
|
protectedinherited |
◆ APERTURE_TRUNCATED
FlagDefinition const lsst::meas::base::ApertureFluxAlgorithm::APERTURE_TRUNCATED = flagDefinitions.add("flag_apertureTruncated", "aperture did not fit within measurement image") |
|
staticinherited |
◆ FAILURE
FlagDefinition const lsst::meas::base::ApertureFluxAlgorithm::FAILURE = flagDefinitions.addFailureFlag() |
|
staticinherited |
◆ N_FLAGS
unsigned int const lsst::meas::base::ApertureFluxAlgorithm::N_FLAGS = 3 |
|
staticinherited |
◆ SINC_COEFFS_TRUNCATED
FlagDefinition const lsst::meas::base::ApertureFluxAlgorithm::SINC_COEFFS_TRUNCATED = flagDefinitions.add("flag_sincCoeffsTruncated", "full sinc coefficient image did not fit within measurement image") |
|
staticinherited |
The documentation for this class was generated from the following files: