LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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. 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

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.

148  : DipoleCentroidAlgorithm(ctrl, name, schema, "unweighted first moment centroid"),
149  _ctrl(ctrl)
150 { }
table::Key< std::string > name
Definition: Amplifier.cc:116
table::Schema schema
Definition: python.h:134
DipoleCentroidAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema, std::string const &doc)

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

211  {
212  _flagHandler.handleFailure(measRecord, error);
213 }
void handleFailure(afw::table::BaseRecord &record, MeasurementError const *error=nullptr) const
Handle an expected or unexpected Exception thrown by a measurement algorithm.
Definition: FlagHandler.cc:76

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

77  {
78  return dipoleCentroidFlagDefinitions;
79 }

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

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

Definition at line 155 of file DipoleAlgorithms.cc.

158  {
159  afw::detection::PeakCatalog const& peaks = source.getFootprint()->getPeaks();
160 
161  int posInd = 0;
162  double posValue = peaks[posInd].getPeakValue(), negValue = 0;
163  if (posValue < 0.) { /* All peaks are negative so use the *most* negative value */
164  posInd = peaks.size() - 1;
165  posValue = peaks[posInd].getPeakValue();
166  }
167  naiveCentroid(source, exposure, peaks[posInd].getI(),
168  (posValue >= 0 ? getPositiveKeys() : getNegativeKeys()));
169 
170  if (posValue > 0. && posInd == 0 && peaks.size() > 1) { /* See if there's also a negative peak */
171  int negInd = peaks.size() - 1;
172  negValue = peaks[negInd].getPeakValue();
173  if (posValue > 0. && negValue < 0.) {
174  naiveCentroid(source, exposure, peaks[negInd].getI(),
175  (negValue >= 0 ? getPositiveKeys() : getNegativeKeys()));
176  }
177  }
178 
179  mergeCentroids(source, posValue, negValue);
180 
181 }
ResultKey const & getNegativeKeys() const
ResultKey const & getPositiveKeys() const
void mergeCentroids(afw::table::SourceRecord &source, double posValue, double negValue) const
const char * source()
Source function that allows astChannel to source from a Stream.
Definition: Stream.h:224
afw::table::CatalogT< PeakRecord > PeakCatalog
Definition: Peak.h:244

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

175  {
176  measure(measRecord, exposure);
177  }
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const =0
Called to measure a single child source in an image.

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

32  {
33  throw LSST_EXCEPT(pex::exceptions::LogicError, "measureN not implemented for this algorithm");
34 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48

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

182  {
183  measureN(measCat, exposure);
184  }
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.
Definition: Algorithm.cc:31

◆ mergeCentroids()

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

Definition at line 183 of file DipoleAlgorithms.cc.

184  {
185 
186  double pos_x, pos_y, pos_f;
187  double neg_x, neg_y, neg_f;
188 
189  pos_x = source.get(getPositiveKeys().getX());
190  pos_y = source.get(getPositiveKeys().getY());
191  pos_f = posValue;
192 
193  neg_x = source.get(getNegativeKeys().getX());
194  neg_y = source.get(getNegativeKeys().getY());
195  neg_f = -negValue;
196 
197  if(std::isfinite(pos_x) && std::isfinite(pos_y) &&
198  std::isfinite(neg_x) && std::isfinite(neg_y)) {
199  source.set(getCenterKeys().getX(), (pos_x * pos_f + neg_x * neg_f) / (pos_f + neg_f));
200  source.set(getCenterKeys().getY(), (pos_y * pos_f + neg_y * neg_f) / (pos_f + neg_f));
201  } else if (std::isfinite(pos_x) && std::isfinite(pos_y)) {
202  source.set(getCenterKeys().getX(), pos_x);
203  source.set(getCenterKeys().getY(), pos_y);
204  } else {
205  source.set(getCenterKeys().getX(), neg_x);
206  source.set(getCenterKeys().getY(), neg_y);
207  }
208 }
ResultKey const & getCenterKeys() const
Return the standard centroid keys registered by this algorithm.
T isfinite(T... args)

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: