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

#include <DipoleAlgorithms.h>

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

Public Types
typedef meas::base::CentroidResultKey	ResultKey
	Tuple type that holds the keys that define a standard centroid algorithm. More...

typedef DipoleCentroidControl	Control

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
	Handle an exception thrown by the current algorithm by setting flags in the given record. More...

virtual void	measureForced (afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure, afw::table::SourceRecord const &refRecord, afw::geom::SkyWcs const &refWcs) const
	Called to measure a single child source in an image. More...

virtual void	measureNForced (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure, afw::table::SourceCatalog const &refRecord, afw::geom::SkyWcs const &refWcs) const
	Called to simultaneously measure all children in a deblend family, in a single image. More...

virtual void	measureN (afw::table::SourceCatalog const &measCat, afw::image::Exposure< float > const &exposure) const
	Called to simultaneously measure all children in a deblend family, in a single image. More...

std::string	getLogName () 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
	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 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

typedef DipoleCentroidControl lsst::ip::diffim::DipoleCentroidAlgorithm::Control

inherited

Definition at line 88 of file DipoleAlgorithms.h.

◆ ResultKey

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

◆ NaiveDipoleCentroid() [1/2]

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

Definition at line 145 of file DipoleAlgorithms.cc.

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

◆ 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

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 211 of file DipoleAlgorithms.cc.

                                                                        {
     _flagHandler.handleFailure(measRecord, error);
 }

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

255 { return _centerKeys; }

◆ getFlagDefinitions()

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

staticinherited

Definition at line 78 of file DipoleAlgorithms.cc.

                                                                                {
     return dipoleCentroidFlagDefinitions;
 }

◆ getLogName()

std::string lsst::meas::base::BaseAlgorithm::getLogName ( ) const

inlineinherited

Definition at line 66 of file Algorithm.h.

66 { return _logName; }

◆ getNegativeKeys()

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

inline

Definition at line 257 of file DipoleAlgorithms.h.

257 { return _negativeKeys; }

◆ getPositiveKeys()

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

inline

Definition at line 256 of file DipoleAlgorithms.h.

256 { return _positiveKeys; }

◆ 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::SingleFrameAlgorithm.

Definition at line 156 of file DipoleAlgorithms.cc.

         {
     afw::detection::PeakCatalog const& peaks = source.getFootprint()->getPeaks();
  
     int posInd = 0;
     double posValue = peaks[posInd].getPeakValue(), negValue = 0;
     if (posValue < 0.) { /* All peaks are negative so use the *most* negative value */
        posInd = peaks.size() - 1;
        posValue = peaks[posInd].getPeakValue();
     }
     naiveCentroid(source, exposure, peaks[posInd].getI(),
                  (posValue >= 0 ? getPositiveKeys() : getNegativeKeys()));
  
     if (posValue > 0. && posInd == 0 && peaks.size() > 1) { /* See if there's also a negative peak */
        int negInd = peaks.size() - 1;
        negValue = peaks[negInd].getPeakValue();
        if (posValue > 0. && negValue < 0.) {
           naiveCentroid(source, exposure, peaks[negInd].getI(),
                         (negValue >= 0 ? getPositiveKeys() : getNegativeKeys()));
        }
     }
  
     mergeCentroids(source, posValue, negValue);
  
 }

◆ measureForced()

virtual void lsst::meas::base::SimpleAlgorithm::measureForced	(	afw::table::SourceRecord &	measRecord,
		afw::image::Exposure< float > const &	exposure,
		afw::table::SourceRecord const &	refRecord,
		afw::geom::SkyWcs const &	refWcs
	)		const

inlinevirtualinherited

Called to measure a single child source in an image.

Before this method is called, all neighbors will be replaced with noise, using the outputs of the deblender. Outputs should be saved in the given SourceRecord, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

Implements lsst::meas::base::ForcedAlgorithm.

Reimplemented in lsst::meas::extensions::photometryKron::KronFluxAlgorithm.

Definition at line 172 of file Algorithm.h.

                                                                   {
         measure(measRecord, exposure);
     }

◆ measureN()

void lsst::meas::base::SingleFrameAlgorithm::measureN	(	afw::table::SourceCatalog const &	measCat,
		afw::image::Exposure< float > const &	exposure
	)		const

virtualinherited

Called to simultaneously measure all children in a deblend family, in a single image.

Outputs should be saved in the given SourceCatalog, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

The default implementation simply throws an exception, indicating that simultaneous measurement is not supported.

Definition at line 31 of file Algorithm.cc.

                                                                                    {
     throw LSST_EXCEPT(pex::exceptions::LogicError, "measureN not implemented for this algorithm");
 }

◆ measureNForced()

virtual void lsst::meas::base::SimpleAlgorithm::measureNForced	(	afw::table::SourceCatalog const &	measCat,
		afw::image::Exposure< float > const &	exposure,
		afw::table::SourceCatalog const &	refRecord,
		afw::geom::SkyWcs const &	refWcs
	)		const

inlinevirtualinherited

Called to simultaneously measure all children in a deblend family, in a single image.

Outputs should be saved in the given SourceCatalog, which can also be used to obtain centroid (see SafeCentroidExtractor) and shape (see SafeShapeExtractor) information.

The default implementation simply throws an exception, indicating that simultaneous measurement is not supported.

Reimplemented from lsst::meas::base::ForcedAlgorithm.

Definition at line 179 of file Algorithm.h.

                                                                    {
         measureN(measCat, exposure);
     }

◆ mergeCentroids()

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

Definition at line 184 of file DipoleAlgorithms.cc.

                                                                                  {
  
    double pos_x, pos_y, pos_f;
    double neg_x, neg_y, neg_f;
  
     pos_x = source.get(getPositiveKeys().getX());
     pos_y = source.get(getPositiveKeys().getY());
     pos_f = posValue;
  
     neg_x = source.get(getNegativeKeys().getX());
     neg_y = source.get(getNegativeKeys().getY());
     neg_f = -negValue;
  
     if(std::isfinite(pos_x) && std::isfinite(pos_y) &&
        std::isfinite(neg_x) && std::isfinite(neg_y)) {
        source.set(getCenterKeys().getX(), (pos_x * pos_f + neg_x * neg_f) / (pos_f + neg_f));
        source.set(getCenterKeys().getY(), (pos_y * pos_f + neg_y * neg_f) / (pos_f + neg_f));
     } else if (std::isfinite(pos_x) && std::isfinite(pos_y)) {
         source.set(getCenterKeys().getX(), pos_x);
         source.set(getCenterKeys().getY(), pos_y);
     } else {
         source.set(getCenterKeys().getX(), neg_x);
         source.set(getCenterKeys().getY(), neg_y);
     }
 }

Member Data Documentation

◆ _centerKeys

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

protectedinherited

Definition at line 107 of file DipoleAlgorithms.h.

◆ _logName

std::string lsst::meas::base::BaseAlgorithm::_logName

protectedinherited

Definition at line 69 of file Algorithm.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:

/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/ip_diffim/20.0.0-9-g4aef684+e18322736b/include/lsst/ip/diffim/DipoleAlgorithms.h
/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/ip_diffim/20.0.0-9-g4aef684+e18322736b/src/DipoleAlgorithms.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Control

◆ ResultKey

Constructor & Destructor Documentation

◆ NaiveDipoleCentroid() [1/2]

◆ NaiveDipoleCentroid() [2/2]

Member Function Documentation

◆ fail()

◆ getCenterKeys()

◆ getFlagDefinitions()

◆ getLogName()

◆ getNegativeKeys()

◆ getPositiveKeys()

◆ measure()

◆ measureForced()

◆ measureN()

◆ measureNForced()

◆ mergeCentroids()

Member Data Documentation

◆ _centerKeys

◆ _logName

◆ _negativeKeys

◆ _positiveKeys

◆ FAILURE

◆ NEG_FLAG

◆ POS_FLAG