Class ScaledApertureFluxAlgorithm

Inheritance Relationships

Base Type

Class Documentation

class ScaledApertureFluxAlgorithm : public lsst::meas::base::SimpleAlgorithm

Measure the instFlux in an aperture scaled to the PSF.

This algorithm performs a sinc aperture instFlux measurement where they size of the aperture is determined by multiplying the FWHM of the PSF by the scaling factor specified in the algorithm configuration.

Public Types

typedef ScaledApertureFluxControl Control
typedef ApertureFluxResult Result

Public Functions

ScaledApertureFluxAlgorithm(Control const &control, std::string const &name, afw::table::Schema &schema)
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure<float> const &exposure) const

Measure the scaled aperture instFlux on the given image.

Python plugins will delegate to this method.

Parameters

  • [inout] record: Record used to save outputs and retrieve positions.

  • [in] exposure: Image to be measured.

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.

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.