A measurement algorithm that estimates instFlux using an elliptical Gaussian weight. More...

#include <GaussianFlux.h>

Inheritance diagram for lsst::meas::base::GaussianFluxAlgorithm:

Public Types
typedef GaussianFluxControl	Control
	A typedef to the Control object for this algorithm, defined above. More...

Public Member Functions
	GaussianFluxAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema)

virtual void	measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
	Called to measure a single child source in an 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::geom::SkyWcs 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::geom::SkyWcs 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 Public Member Functions
static FlagDefinitionList const &	getFlagDefinitions ()

Static Public Attributes
static FlagDefinition const	FAILURE = flagDefinitions.addFailureFlag()

Protected Attributes
std::string	_logName

Detailed Description

A measurement algorithm that estimates instFlux using an elliptical Gaussian weight.

This algorithm computes instFlux as the dot product of an elliptical Gaussian weight function with the image. The size and ellipticity of the weight function are determined using the SdssShape algorithm, or retreived from a named field.

Definition at line 62 of file GaussianFlux.h.

Member Typedef Documentation

◆ Control

typedef GaussianFluxControl lsst::meas::base::GaussianFluxAlgorithm::Control

A typedef to the Control object for this algorithm, defined above.

The control object contains the configuration parameters for this algorithm.

Definition at line 70 of file GaussianFlux.h.

Constructor & Destructor Documentation

◆ GaussianFluxAlgorithm()

lsst::meas::base::GaussianFluxAlgorithm::GaussianFluxAlgorithm	(	Control const &	ctrl,
		std::string const &	name,
		afw::table::Schema &	schema
	)

Definition at line 44 of file GaussianFlux.cc.

         : _ctrl(ctrl),
           _instFluxResultKey(FluxResultKey::addFields(schema, name, "instFlux from Gaussian Flux algorithm")),
           _centroidExtractor(schema, name),
           _shapeExtractor(schema, name) {
     _flagHandler = FlagHandler::addFields(schema, name, getFlagDefinitions());
 }

Member Function Documentation

◆ fail()

void lsst::meas::base::GaussianFluxAlgorithm::fail	(	afw::table::SourceRecord &	measRecord,
		MeasurementError *	error = `nullptr`
	)		const

virtual

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 65 of file GaussianFlux.cc.

                                                                                                 {
     _flagHandler.handleFailure(measRecord, error);
 }

◆ getFlagDefinitions()

FlagDefinitionList const & lsst::meas::base::GaussianFluxAlgorithm::getFlagDefinitions ( )

static

Definition at line 42 of file GaussianFlux.cc.

42 { return flagDefinitions; }

◆ getLogName()

std::string lsst::meas::base::BaseAlgorithm::getLogName ( ) const

inlineinherited

Definition at line 66 of file Algorithm.h.

66 { return _logName; }

lsst::meas::base::BaseAlgorithm::_logName

std::string _logName

Definition: Algorithm.h:69

◆ measure()

void lsst::meas::base::GaussianFluxAlgorithm::measure	(	afw::table::SourceRecord &	measRecord,
		afw::image::Exposure< float > const &	exposure
	)		const

virtual

Called to measure a single child source in an image.

Before this method is called, all neighbors will be replaced with noise, using the outputs of the deblender. Outputs should be saved in the given SourceRecord, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

Implements lsst::meas::base::SingleFrameAlgorithm.

Definition at line 53 of file GaussianFlux.cc.

                                                                                    {
     geom::Point2D centroid = _centroidExtractor(measRecord, _flagHandler);
     afw::geom::ellipses::Quadrupole shape = _shapeExtractor(measRecord, _flagHandler);
  
     FluxResult result =
             SdssShapeAlgorithm::computeFixedMomentsFlux(exposure.getMaskedImage(), shape, centroid);
  
     measRecord.set(_instFluxResultKey, result);
     _flagHandler.setValue(measRecord, FAILURE.number, false);
 }

◆ measureForced()

virtual void lsst::meas::base::SimpleAlgorithm::measureForced	(	afw::table::SourceRecord &	measRecord,
		afw::image::Exposure< float > const &	exposure,
		afw::table::SourceRecord const &	refRecord,
		afw::geom::SkyWcs const &	refWcs
	)		const

inlinevirtualinherited

Called to measure a single child source in an image.

Before this method is called, all neighbors will be replaced with noise, using the outputs of the deblender. Outputs should be saved in the given SourceRecord, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

Implements lsst::meas::base::ForcedAlgorithm.

Reimplemented in lsst::meas::extensions::photometryKron::KronFluxAlgorithm.

Definition at line 172 of file Algorithm.h.

                                                                   {
         measure(measRecord, exposure);
     }

◆ 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 31 of file Algorithm.cc.

                                                                                    {
     throw LSST_EXCEPT(pex::exceptions::LogicError, "measureN not implemented for this algorithm");
 }

◆ 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::geom::SkyWcs 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 179 of file Algorithm.h.

                                                                    {
         measureN(measCat, exposure);
     }

Member Data Documentation

◆ _logName

std::string lsst::meas::base::BaseAlgorithm::_logName

protectedinherited

Definition at line 69 of file Algorithm.h.

◆ FAILURE

FlagDefinition const lsst::meas::base::GaussianFluxAlgorithm::FAILURE = flagDefinitions.addFailureFlag()