lsst.ip.diffim  13.0-22-g3839dbb+18
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
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:
lsst::ip::diffim::NaiveDipoleCentroid

Public Types

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
 

Static Public Member Functions

static
meas::base::FlagDefinitionList
const & 
getFlagDefinitions ()
 

Static Public Attributes

static
meas::base::FlagDefinition
const 
FAILURE = dipoleCentroidFlagDefinitions.addFailureFlag("general failure flag, set if anything went wrong")
 
static
meas::base::FlagDefinition
const 
POS_FLAG = dipoleCentroidFlagDefinitions.add("pos_flag", "failure flag for positive, set if anything went wrong")
 
static
meas::base::FlagDefinition
const 
NEG_FLAG = dipoleCentroidFlagDefinitions.add("neg_flag", "failure flag for negative, set if anything went wrong")
 

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
 
ResultKey _centerKeys
 
ResultKey _positiveKeys
 
ResultKey _negativeKeys
 

Detailed Description

Intermediate base class for algorithms that compute a centroid.

Definition at line 80 of file DipoleAlgorithms.h.

Member Typedef Documentation

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.

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 151 of file DipoleAlgorithms.h.

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 165 of file DipoleAlgorithms.h.

Member Function Documentation

meas::base::FlagDefinitionList const & lsst::ip::diffim::DipoleCentroidAlgorithm::getFlagDefinitions ( )
static

Definition at line 78 of file DipoleAlgorithms.cc.

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

Definition at line 97 of file DipoleAlgorithms.h.

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.

Member Data Documentation

ResultKey lsst::ip::diffim::DipoleCentroidAlgorithm::_centerKeys
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.

meas::base::FlagDefinition const lsst::ip::diffim::DipoleCentroidAlgorithm::FAILURE = dipoleCentroidFlagDefinitions.addFailureFlag("general failure flag, set if anything went wrong")
static

Definition at line 83 of file DipoleAlgorithms.h.

meas::base::FlagDefinition const lsst::ip::diffim::DipoleCentroidAlgorithm::NEG_FLAG = dipoleCentroidFlagDefinitions.add("neg_flag", "failure flag for negative, set if anything went wrong")
static

Definition at line 85 of file DipoleAlgorithms.h.

meas::base::FlagDefinition const lsst::ip::diffim::DipoleCentroidAlgorithm::POS_FLAG = dipoleCentroidFlagDefinitions.add("pos_flag", "failure flag for positive, set if anything went wrong")
static

Definition at line 84 of file DipoleAlgorithms.h.


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