lsst.ip.diffim  13.0-19-g373a351+1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
lsst::ip::diffim::NaiveDipoleCentroid Class Reference

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

#include <DipoleAlgorithms.h>

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

Public Types

typedef
meas::base::CentroidResultKey 
ResultKey
 Tuple type that holds the keys that define a standard centroid algorithm. More...
 
- Public Types inherited from lsst::ip::diffim::DipoleCentroidAlgorithm
typedef DipoleCentroidControl Control
 
typedef
meas::base::CentroidResultKey 
ResultKey
 

Public Member Functions

 NaiveDipoleCentroid (Control const &ctrl, std::string const &name, afw::table::Schema &schema)
 
ResultKey const & getCenterKeys () const
 Return the standard centroid keys registered by this algorithm. More...
 
ResultKey const & getPositiveKeys () const
 
ResultKey const & getNegativeKeys () const
 
void measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
 Given an image and a pixel position, return a Centroid using a naive 3x3 weighted moment. More...
 
void mergeCentroids (afw::table::SourceRecord &source, double posValue, double negValue) const
 
void fail (afw::table::SourceRecord &measRecord, meas::base::MeasurementError *error=NULL) const
 
- Public Member Functions inherited from lsst::ip::diffim::DipoleCentroidAlgorithm
 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
 

Protected Member Functions

 NaiveDipoleCentroid (Control const &ctrl, std::string const &name, afw::table::Schema &schema, ResultKey const &positiveKeys, ResultKey const &negativeKeys)
 Initialize with a manually-constructed key tuple. More...
 
- Protected Member Functions inherited from 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)
 Initialize with a manually-constructed key tuple. More...
 

Private Attributes

Control _ctrl
 
meas::base::FluxResultKey _fluxResultKey
 
meas::base::FlagHandler _flagHandler
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst::ip::diffim::DipoleCentroidAlgorithm
static
meas::base::FlagDefinitionList
const & 
getFlagDefinitions ()
 
- Static Public Attributes inherited from lsst::ip::diffim::DipoleCentroidAlgorithm
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 Attributes inherited from lsst::ip::diffim::DipoleCentroidAlgorithm
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 243 of file DipoleAlgorithms.h.

Member Typedef Documentation

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

Tuple type that holds the keys that define a standard centroid algorithm.

Algorithms are encouraged to add additional flags as appropriate, but these are required.

Definition at line 252 of file DipoleAlgorithms.h.

Constructor & Destructor Documentation

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

Definition at line 145 of file DipoleAlgorithms.cc.

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

Initialize with a manually-constructed key tuple.

Member Function Documentation

void lsst::ip::diffim::NaiveDipoleCentroid::fail ( afw::table::SourceRecord &  measRecord,
meas::base::MeasurementError *  error = NULL 
) const

Definition at line 211 of file DipoleAlgorithms.cc.

ResultKey const& lsst::ip::diffim::NaiveDipoleCentroid::getCenterKeys ( ) const
inline

Return the standard centroid keys registered by this algorithm.

Definition at line 255 of file DipoleAlgorithms.h.

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

Definition at line 257 of file DipoleAlgorithms.h.

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

Definition at line 256 of file DipoleAlgorithms.h.

void lsst::ip::diffim::NaiveDipoleCentroid::measure ( afw::table::SourceRecord &  measRecord,
afw::image::Exposure< float > const &  exposure 
) const

Given an image and a pixel position, return a Centroid using a naive 3x3 weighted moment.

Definition at line 156 of file DipoleAlgorithms.cc.

void lsst::ip::diffim::NaiveDipoleCentroid::mergeCentroids ( afw::table::SourceRecord &  source,
double  posValue,
double  negValue 
) const

Definition at line 184 of file DipoleAlgorithms.cc.

Member Data Documentation

Control lsst::ip::diffim::NaiveDipoleCentroid::_ctrl
private

Definition at line 278 of file DipoleAlgorithms.h.

meas::base::FlagHandler lsst::ip::diffim::NaiveDipoleCentroid::_flagHandler
private

Definition at line 280 of file DipoleAlgorithms.h.

meas::base::FluxResultKey lsst::ip::diffim::NaiveDipoleCentroid::_fluxResultKey
private

Definition at line 279 of file DipoleAlgorithms.h.


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