Intermediate base class for algorithms that compute a flux. More...

#include <DipoleAlgorithms.h>

Inheritance diagram for lsst::ip::diffim::DipoleFluxAlgorithm:

Public Types
enum	{ FAILURE =meas::base::FlagHandler::FAILURE, POS_FAILURE, NEG_FAILURE, N_FLAGS }

typedef DipoleFluxControl	Control

typedef meas::base::FluxResultKey	ResultKey

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

ResultKey const &	getPositiveKeys () const
	Return the standard flux keys registered by this algorithm. More...

ResultKey const &	getNegativeKeys () 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	measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const =0

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 void	fail (afw::table::SourceRecord &measRecord, MeasurementError *error=NULL) const =0

virtual	~BaseAlgorithm ()

Protected Member Functions
	DipoleFluxAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema, std::string const &doc, ResultKey const &positiveKeys, ResultKey const &negativeKeys)
	Initialize with a manually-constructed result key. More...

Protected Attributes
Control	_ctrl

meas::base::FluxResultKey	_fluxResultKey

meas::base::FlagHandler	_flagHandler

meas::base::SafeCentroidExtractor	_centroidExtractor

ResultKey	_positiveKeys

ResultKey	_negativeKeys

Detailed Description

Intermediate base class for algorithms that compute a flux.

Definition at line 115 of file DipoleAlgorithms.h.

Member Typedef Documentation

typedef DipoleFluxControl lsst::ip::diffim::DipoleFluxAlgorithm::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 126 of file DipoleAlgorithms.h.

typedef meas::base::FluxResultKey lsst::ip::diffim::DipoleFluxAlgorithm::ResultKey

Definition at line 132 of file DipoleAlgorithms.h.

Member Enumeration Documentation

anonymous enum

Enumerator
FAILURE
POS_FAILURE
NEG_FAILURE
N_FLAGS

Definition at line 117 of file DipoleAlgorithms.h.

          {
         FAILURE=meas::base::FlagHandler::FAILURE,
         POS_FAILURE,
         NEG_FAILURE,
         N_FLAGS
     };

Constructor & Destructor Documentation

lsst::ip::diffim::DipoleFluxAlgorithm::DipoleFluxAlgorithm	(	Control const &	ctrl,
		std::string const &	name,
		afw::table::Schema &	schema,
		std::string const &	doc
	)

inline

Definition at line 209 of file DipoleAlgorithms.h.

       :
     _ctrl(ctrl),
     _centroidExtractor(schema, name, false)
 {
     static boost::array<meas::base::FlagDefinition,N_FLAGS> const flagDefs = {{
         {"flag", "general failure flag, set if anything went wrong"},
         {"pos_flag", "failure flag for positive, set if anything went wrong"},
         {"neg_flag", "failure flag for negative, set if anything went wrong"}
     }};
     _flagHandler = meas::base::FlagHandler::addFields(schema, name, flagDefs.begin(), flagDefs.end());
     meas::base::FluxResultKey::addFields(schema, name+"_pos", doc+": positive lobe");
     meas::base::FluxResultKey::addFields(schema, name+"_neg", doc+": negative lobe");
     _positiveKeys = ResultKey(schema[name+"_pos"]);
     _negativeKeys = ResultKey(schema[name+"_neg"]);
 }

lsst::ip::diffim::DipoleFluxAlgorithm::DipoleFluxAlgorithm	(	Control const &	ctrl,
		std::string const &	name,
		afw::table::Schema &	schema,
		std::string const &	doc,
		ResultKey const &	positiveKeys,
		ResultKey const &	negativeKeys
	)

inlineprotected

Initialize with a manually-constructed result key.

Definition at line 190 of file DipoleAlgorithms.h.

       :
     _ctrl(ctrl),
     _centroidExtractor(schema, name, false)
 {
     static boost::array<meas::base::FlagDefinition,N_FLAGS> const flagDefs = {{
         {"flag", "general failure flag, set if anything went wrong"},
         {"pos_flag", "failure flag for positive, set if anything went wrong"},
         {"neg_flag", "failure flag for negative, set if anything went wrong"}
     }};
     _flagHandler = meas::base::FlagHandler::addFields(schema, name, flagDefs.begin(), flagDefs.end());
     meas::base::FluxResultKey::addFields(schema, name+"_pos", doc+": positive lobe");
     meas::base::FluxResultKey::addFields(schema, name+"_neg", doc+": negative lobe");
     _positiveKeys = ResultKey(positiveKeys);
     _negativeKeys = ResultKey(negativeKeys);
 }

Member Function Documentation

ResultKey const& lsst::ip::diffim::DipoleFluxAlgorithm::getNegativeKeys ( ) const

inline

Definition at line 135 of file DipoleAlgorithms.h.

135 { return _negativeKeys; }

lsst::ip::diffim::DipoleFluxAlgorithm::_negativeKeys

ResultKey _negativeKeys

Definition: DipoleAlgorithms.h:150

ResultKey const& lsst::ip::diffim::DipoleFluxAlgorithm::getPositiveKeys ( ) const

inline

Return the standard flux keys registered by this algorithm.

Definition at line 134 of file DipoleAlgorithms.h.

134 { return _positiveKeys; }

lsst::ip::diffim::DipoleFluxAlgorithm::_positiveKeys

ResultKey _positiveKeys

Definition: DipoleAlgorithms.h:149

Member Data Documentation

meas::base::SafeCentroidExtractor lsst::ip::diffim::DipoleFluxAlgorithm::_centroidExtractor

protected

Definition at line 147 of file DipoleAlgorithms.h.

Control lsst::ip::diffim::DipoleFluxAlgorithm::_ctrl

protected

Definition at line 144 of file DipoleAlgorithms.h.

meas::base::FlagHandler lsst::ip::diffim::DipoleFluxAlgorithm::_flagHandler

protected

Definition at line 146 of file DipoleAlgorithms.h.

meas::base::FluxResultKey lsst::ip::diffim::DipoleFluxAlgorithm::_fluxResultKey

protected

Definition at line 145 of file DipoleAlgorithms.h.

ResultKey lsst::ip::diffim::DipoleFluxAlgorithm::_negativeKeys

protected

Definition at line 150 of file DipoleAlgorithms.h.

ResultKey lsst::ip::diffim::DipoleFluxAlgorithm::_positiveKeys

protected

Definition at line 149 of file DipoleAlgorithms.h.

The documentation for this class was generated from the following file:

/home/lsstsw/stack/Linux64/ip_diffim/11.0+1/include/lsst/ip/diffim/DipoleAlgorithms.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation