LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Private Attributes | List of all members
lsst::meas::base::GaussianFluxAlgorithm Class Reference

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

#include <GaussianFlux.h>

Inheritance diagram for lsst::meas::base::GaussianFluxAlgorithm:
lsst::meas::base::SimpleAlgorithm lsst::meas::base::SingleFrameAlgorithm lsst::meas::base::ForcedAlgorithm lsst::meas::base::BaseAlgorithm lsst::meas::base::BaseAlgorithm

Public Types

enum  { FAILURE =FlagHandler::FAILURE, N_FLAGS }
 
typedef GaussianFluxControl Control
 

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
 
virtual void fail (afw::table::SourceRecord &measRecord, MeasurementError *error=NULL) const
 
- Public Member Functions inherited from lsst::meas::base::SimpleAlgorithm
virtual void measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::image::Wcs const &refWcs) const
 
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
 
- Public Member Functions inherited from lsst::meas::base::SingleFrameAlgorithm
virtual void measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const
 
- Public Member Functions inherited from lsst::meas::base::BaseAlgorithm
virtual ~BaseAlgorithm ()
 

Private Attributes

Control _ctrl
 
FluxResultKey _fluxResultKey
 
FlagHandler _flagHandler
 
SafeCentroidExtractor _centroidExtractor
 
SafeShapeExtractor _shapeExtractor
 

Detailed Description

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

This algorithm computes flux 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

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 72 of file GaussianFlux.h.

Member Enumeration Documentation

anonymous enum
Enumerator
FAILURE 
N_FLAGS 

Definition at line 65 of file GaussianFlux.h.

65  {
66  FAILURE=FlagHandler::FAILURE,
67  N_FLAGS
68  };

Constructor & Destructor Documentation

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

Definition at line 37 of file GaussianFlux.cc.

41  : _ctrl(ctrl),
42  _fluxResultKey(
43  FluxResultKey::addFields(schema, name, "flux from Gaussian Flux algorithm")
44  ),
45  _centroidExtractor(schema, name),
46  _shapeExtractor(schema, name)
47 {
48  static boost::array<FlagDefinition,N_FLAGS> const flagDefs = {{
49  {"flag", "general failure flag, set if anything went wrong"}
50  }};
51  _flagHandler = FlagHandler::addFields(schema, name, flagDefs.begin(), flagDefs.end());
52 }
name
table::Key< std::string > name
Definition: ApCorrMap.cc:71
schema
afw::table::Schema schema
Definition: GaussianPsf.cc:41
lsst::meas::base::FluxResultKey::addFields
static FluxResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc)
Definition: FluxUtilities.cc:35
lsst::meas::base::GaussianFluxAlgorithm::_centroidExtractor
SafeCentroidExtractor _centroidExtractor
Definition: GaussianFlux.h:91
lsst::meas::base::FlagHandler::addFields
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinition const *begin, FlagDefinition const *end)
Definition: FlagHandler.cc:28

Member Function Documentation

void lsst::meas::base::GaussianFluxAlgorithm::fail ( afw::table::SourceRecord &  measRecord,
MeasurementError *  error = NULL 
) 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 70 of file GaussianFlux.cc.

70  {
71  _flagHandler.handleFailure(measRecord, error);
72 }
lsst.log.log.error
def error
Definition: log.py:108
lsst::meas::base::FlagHandler::handleFailure
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=NULL) const
Definition: FlagHandler.cc:59
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 54 of file GaussianFlux.cc.

57  {
58  afw::geom::Point2D centroid = _centroidExtractor(measRecord, _flagHandler);
59  afw::geom::ellipses::Quadrupole shape = _shapeExtractor(measRecord, _flagHandler);
60 
61  FluxResult result = SdssShapeAlgorithm::computeFixedMomentsFlux(
62  exposure.getMaskedImage(), shape, centroid
63  );
64 
65  measRecord.set(_fluxResultKey, result);
66  _flagHandler.setValue(measRecord, FAILURE, false);
67 }
lsst::meas::base::SdssShapeAlgorithm::computeFixedMomentsFlux
static FluxResult computeFixedMomentsFlux(ImageT const &image, afw::geom::ellipses::Quadrupole const &shape, afw::geom::Point2D const &position)
Definition: SdssShape.cc:813
lsst::afw::geom::Point2D
Point< double, 2 > Point2D
Definition: Point.h:286
lsst::meas::base::FlagHandler::setValue
void setValue(afw::table::BaseRecord &record, int i, bool value) const
Definition: FlagHandler.h:72
lsst::meas::base::GaussianFluxAlgorithm::_centroidExtractor
SafeCentroidExtractor _centroidExtractor
Definition: GaussianFlux.h:91

Member Data Documentation

SafeCentroidExtractor lsst::meas::base::GaussianFluxAlgorithm::_centroidExtractor
private

Definition at line 91 of file GaussianFlux.h.

Control lsst::meas::base::GaussianFluxAlgorithm::_ctrl
private

Definition at line 88 of file GaussianFlux.h.

FlagHandler lsst::meas::base::GaussianFluxAlgorithm::_flagHandler
private

Definition at line 90 of file GaussianFlux.h.

FluxResultKey lsst::meas::base::GaussianFluxAlgorithm::_fluxResultKey
private

Definition at line 89 of file GaussianFlux.h.

SafeShapeExtractor lsst::meas::base::GaussianFluxAlgorithm::_shapeExtractor
private

Definition at line 92 of file GaussianFlux.h.

The documentation for this class was generated from the following files:
Generated on Thu Sep 24 2015 02:29:39 for LSSTApplications by   doxygen 1.8.5