lsst.ip.diffim g24bb6cda20+1f3dbd605c
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected 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 lsst::meas::base::SimpleAlgorithm lsst::meas::base::SingleFrameAlgorithm lsst::meas::base::ForcedAlgorithm lsst::meas::base::BaseAlgorithm lsst::meas::base::BaseAlgorithm

Public Types

typedef meas::base::CentroidResultKey ResultKey
 Tuple type that holds the keys that define a standard centroid algorithm.
 
typedef DipoleCentroidControl Control
 

Public Member Functions

 NaiveDipoleCentroid (Control const &ctrl, std::string const &name, afw::table::Schema &schema)
 
ResultKey constgetCenterKeys () const
 Return the standard centroid keys registered by this algorithm.
 
ResultKey constgetPositiveKeys () const
 
ResultKey constgetNegativeKeys () 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.
 
void mergeCentroids (afw::table::SourceRecord &source, double posValue, double negValue) const
 
void fail (afw::table::SourceRecord &measRecord, meas::base::MeasurementError *error=NULL) const
 
void measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::geom::SkyWcs const &refWcs) const override
 
void measureNForced (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure, afw::table::SourceCatalog const &refRecord, afw::geom::SkyWcs const &refWcs) const override
 
virtual void measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const
 
std::string getLogName () const
 

Static Public Member Functions

static meas::base::FlagDefinitionList constgetFlagDefinitions ()
 

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

 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.
 

Protected Attributes

ResultKey _centerKeys
 
ResultKey _positiveKeys
 
ResultKey _negativeKeys
 
std::string _logName
 

Detailed Description

Intermediate base class for algorithms that compute a centroid.

Definition at line 243 of file DipoleAlgorithms.h.

Member Typedef Documentation

◆ Control

Definition at line 88 of file DipoleAlgorithms.h.

◆ 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

◆ NaiveDipoleCentroid() [1/2]

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

Definition at line 144 of file DipoleAlgorithms.cc.

◆ NaiveDipoleCentroid() [2/2]

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

◆ fail()

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

Implements lsst::meas::base::SimpleAlgorithm.

Definition at line 210 of file DipoleAlgorithms.cc.

◆ getCenterKeys()

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.

◆ getFlagDefinitions()

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

Definition at line 77 of file DipoleAlgorithms.cc.

◆ getNegativeKeys()

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

Definition at line 257 of file DipoleAlgorithms.h.

◆ getPositiveKeys()

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

Definition at line 256 of file DipoleAlgorithms.h.

◆ measure()

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

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

Implements lsst::meas::base::SimpleAlgorithm.

Definition at line 155 of file DipoleAlgorithms.cc.

◆ mergeCentroids()

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

Definition at line 183 of file DipoleAlgorithms.cc.

Member Data Documentation

◆ _centerKeys

ResultKey lsst::ip::diffim::DipoleCentroidAlgorithm::_centerKeys
protectedinherited

Definition at line 107 of file DipoleAlgorithms.h.

◆ _negativeKeys

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

Definition at line 109 of file DipoleAlgorithms.h.

◆ _positiveKeys

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

Definition at line 108 of file DipoleAlgorithms.h.

◆ FAILURE

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

Definition at line 83 of file DipoleAlgorithms.h.

◆ NEG_FLAG

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

Definition at line 85 of file DipoleAlgorithms.h.

◆ POS_FLAG

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

Definition at line 84 of file DipoleAlgorithms.h.


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