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

#include <DipoleAlgorithms.h>

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

Public Types
enum	{ FAILURE =meas::base::FlagHandler::FAILURE, POS_FLAGS, NEG_FLAGS, N_FLAGS }

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
enum	{ FAILURE =meas::base::FlagHandler::FAILURE, POS_FAILURE, NEG_FAILURE, N_FLAGS }

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 &	getPositiveKeys () const
	Return the standard centroid keys registered by this algorithm. More...

ResultKey const &	getNegativeKeys () const

void	measure (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) 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

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	measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const

Public Member Functions inherited from lsst::meas::base::BaseAlgorithm
virtual	~BaseAlgorithm ()

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

meas::base::SafeCentroidExtractor	_centroidExtractor

Additional Inherited Members
Protected Attributes inherited from lsst::ip::diffim::DipoleCentroidAlgorithm
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 264 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 279 of file DipoleAlgorithms.h.

Member Enumeration Documentation

anonymous enum

Enumerator
FAILURE
POS_FLAGS
NEG_FLAGS
N_FLAGS

Definition at line 266 of file DipoleAlgorithms.h.

          {
         FAILURE=meas::base::FlagHandler::FAILURE,
         POS_FLAGS,
         NEG_FLAGS,
         N_FLAGS
     };

Constructor & Destructor Documentation

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

Definition at line 123 of file DipoleAlgorithms.cc.

   : DipoleCentroidAlgorithm(ctrl, name, schema, "unweighted first moment centroid"),
     _ctrl(ctrl),
     _centroidExtractor(schema, name)
 {
 }

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

virtual

Handle an exception thrown by the current algorithm by setting flags in the given record.

fail() is called by the measurement framework when an exception is allowed to propagate out of one the algorithm's measure() methods. It should generally set both a general failure flag for the algorithm as well as a specific flag indicating the error condition, if possible. To aid in this, if the exception was an instance of MeasurementError, it will be passed in, carrying information about what flag to set.

An algorithm can also to chose to set flags within its own measure() methods, and then just return, rather than throw an exception. However, fail() should be implemented even when all known failure modes do not throw exceptions, to ensure that unexpected exceptions thrown in lower-level code are properly handled.

Implements lsst::meas::base::BaseAlgorithm.

Definition at line 152 of file DipoleAlgorithms.cc.

                                                                        {
     _flagHandler.handleFailure(measRecord, error);
 }

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

inline

Definition at line 283 of file DipoleAlgorithms.h.

283 { return _negativeKeys; }

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

ResultKey _negativeKeys

Definition: DipoleAlgorithms.h:109

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

inline

Return the standard centroid keys registered by this algorithm.

Definition at line 282 of file DipoleAlgorithms.h.

282 { return _positiveKeys; }

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

ResultKey _positiveKeys

Definition: DipoleAlgorithms.h:108

void lsst::ip::diffim::NaiveDipoleCentroid::measure	(	afw::table::SourceRecord &	source,
		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::SingleFrameAlgorithm.

Definition at line 136 of file DipoleAlgorithms.cc.

         {
     afw::detection::PeakCatalog const& peaks = source.getFootprint()->getPeaks();
 
     naiveCentroid(source, exposure, peaks[0].getI(), (peaks[0].getPeakValue() >= 0 ?
                                                        getPositiveKeys() :
                                                        getNegativeKeys()));
     if (peaks.size() > 1) {
         naiveCentroid(source, exposure, peaks[1].getI(), (peaks[1].getPeakValue() >= 0 ?
                                                            getPositiveKeys() :
                                                            getNegativeKeys()));
     }
 }

Member Data Documentation

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

private

Definition at line 305 of file DipoleAlgorithms.h.

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

private

Definition at line 302 of file DipoleAlgorithms.h.

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

private

Definition at line 304 of file DipoleAlgorithms.h.

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

private

Definition at line 303 of file DipoleAlgorithms.h.

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

/home/lsstsw/stack/Linux64/ip_diffim/11.0+1/include/lsst/ip/diffim/DipoleAlgorithms.h
/home/lsstsw/stack/Linux64/ip_diffim/11.0+1/src/DipoleAlgorithms.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation