lsst.ip.diffim  13.0-17-gc2cefa3
 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::DipoleFluxAlgorithm Class Reference

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

#include <DipoleAlgorithms.h>

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

Public Types

typedef DipoleFluxControl Control
 A typedef to the Control object for this algorithm, defined above. More...
 
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
 

Static Public Member Functions

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

Static Public Attributes

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

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
 
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

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

The control object contains the configuration parameters for this algorithm.

Definition at line 125 of file DipoleAlgorithms.h.

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

Definition at line 131 of file DipoleAlgorithms.h.

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

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

Member Function Documentation

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

Definition at line 66 of file DipoleAlgorithms.cc.

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

Definition at line 134 of file DipoleAlgorithms.h.

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

Return the standard flux keys registered by this algorithm.

Definition at line 133 of file DipoleAlgorithms.h.

Member Data Documentation

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

Definition at line 143 of file DipoleAlgorithms.h.

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

Definition at line 145 of file DipoleAlgorithms.h.

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

Definition at line 144 of file DipoleAlgorithms.h.

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

Definition at line 148 of file DipoleAlgorithms.h.

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

Definition at line 147 of file DipoleAlgorithms.h.

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

Definition at line 118 of file DipoleAlgorithms.h.

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

Definition at line 120 of file DipoleAlgorithms.h.

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

Definition at line 119 of file DipoleAlgorithms.h.


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