lsst::ip::diffim::DipoleCentroidAlgorithm Class Reference

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

#include <DipoleAlgorithms.h>

Inheritance diagram for lsst::ip::diffim::DipoleCentroidAlgorithm:

Public Types
enum	{ FAILURE =meas::base::FlagHandler::FAILURE, POS_FAILURE, NEG_FAILURE, N_FLAGS }
typedef DipoleCentroidControl	Control
typedef meas::base::CentroidResultKey	ResultKey

Public Member Functions
	DipoleCentroidAlgorithm (Control const &ctrl, std::string const &name, afw::table::Schema &schema, std::string const &doc)
ResultKey const &	getPositiveKeys () const
	Return the standard centroid 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
	DipoleCentroidAlgorithm (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 key tuple. 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 centroid.

Definition at line 79 of file DipoleAlgorithms.h.

Member Typedef Documentation

typedef DipoleCentroidControl lsst::ip::diffim::DipoleCentroidAlgorithm::Control

Definition at line 88 of file DipoleAlgorithms.h.

typedef meas::base::CentroidResultKey lsst::ip::diffim::DipoleCentroidAlgorithm::ResultKey

Definition at line 93 of file DipoleAlgorithms.h.

Member Enumeration Documentation

anonymous enum

Enumerator
FAILURE
POS_FAILURE
NEG_FAILURE
N_FLAGS

Definition at line 81 of file DipoleAlgorithms.h.

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

Constructor & Destructor Documentation

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

inline

Definition at line 153 of file DipoleAlgorithms.h.

      :
    _ctrl(ctrl),
    _centroidExtractor(schema, name, true)
{
    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::CentroidResultKey::addFields(schema, name+"_pos", doc+": positive lobe", meas::base::SIGMA_ONLY);
    meas::base::CentroidResultKey::addFields(schema, name+"_neg", doc+": negative lobe", meas::base::SIGMA_ONLY);
    _positiveKeys = ResultKey(schema[name+"_pos"]);
    _negativeKeys = ResultKey(schema[name+"_neg"]);
}

lsst::ip::diffim::DipoleCentroidAlgorithm::DipoleCentroidAlgorithm ( 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 key tuple.

Definition at line 171 of file DipoleAlgorithms.h.

      :
    _ctrl(ctrl),
    _centroidExtractor(schema, name, true)
{
    meas::base::CentroidResultKey::addFields(schema, name+"_pos", doc + ": positive lobe", meas::base::SIGMA_ONLY);
    meas::base::CentroidResultKey::addFields(schema, name+"_neg", doc + ": negative lobe", meas::base::SIGMA_ONLY);
    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());
    _positiveKeys = ResultKey(schema[name+"_pos"]);
    _negativeKeys = ResultKey(schema[name+"_neg"]);
}

Member Function Documentation

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

inline

Definition at line 97 of file DipoleAlgorithms.h.

{ return _negativeKeys; }

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

inline

Return the standard centroid keys registered by this algorithm.

Definition at line 96 of file DipoleAlgorithms.h.

{ return _positiveKeys; }

Member Data Documentation

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

protected

Definition at line 107 of file DipoleAlgorithms.h.

Control lsst::ip::diffim::DipoleCentroidAlgorithm::_ctrl

protected

Definition at line 104 of file DipoleAlgorithms.h.

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

protected

Definition at line 106 of file DipoleAlgorithms.h.

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

protected

Definition at line 105 of file DipoleAlgorithms.h.

ResultKey lsst::ip::diffim::DipoleCentroidAlgorithm::_negativeKeys

protected

Definition at line 109 of file DipoleAlgorithms.h.

ResultKey lsst::ip::diffim::DipoleCentroidAlgorithm::_positiveKeys

protected

Definition at line 108 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