LSST Applications 24.1.6,g063fba187b+56b85ce14a,g0f08755f38+df8a265115,g12f32b3c4e+891a09f10d,g1524ad2192+7a5d7b3fbd,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g28da252d5a+07cb1400be,g2bbee38e9b+ae03bbfc84,g2bc492864f+ae03bbfc84,g3156d2b45e+6e55a43351,g347aa1857d+ae03bbfc84,g35bb328faa+a8ce1bb630,g3a166c0a6a+ae03bbfc84,g3e281a1b8c+c5dd892a6c,g414038480c+6b9177ef31,g41af890bb2+8f257c4c0b,g781aacb6e4+a8ce1bb630,g7af13505b9+7137b3b17d,g80478fca09+6df6903293,g82479be7b0+091ce1d07f,g858d7b2824+df8a265115,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,g9726552aa6+414189b318,ga5288a1d22+4a2bca08d7,gacef1a1666+c9a8ff65f4,gb58c049af0+d64f4d3760,gbcfae0f0a0+de1d42d831,gc28159a63d+ae03bbfc84,gcf0d15dbbd+72117bf34e,gda6a2b7d83+72117bf34e,gdaeeff99f8+1711a396fd,ge500cccec5+c8c9c9af63,ge79ae78c31+ae03bbfc84,gf0baf85859+c1f95f4921,gfa517265be+df8a265115,gfa999e8aa5+17cd334064,gfb92a5be7c+df8a265115
LSST Data Management Base Package
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::DipoleCentroidAlgorithm Class Referenceabstract

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

#include <DipoleAlgorithms.h>

Inheritance diagram for 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 DipoleCentroidControl Control
 
typedef meas::base::CentroidResultKey ResultKey
 

Public Member Functions

 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.
 
ResultKey const & getNegativeKeys () 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
 Called to measure a single child source in an image.
 
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
 Called to simultaneously measure all children in a deblend family, in a single image.
 
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.
 
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.
 
virtual void fail (afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const =0
 Handle an exception thrown by the current algorithm by setting flags in the given record.
 
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

 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.
 

Protected Attributes

Control _ctrl
 
meas::base::FluxResultKey _fluxResultKey
 
meas::base::FlagHandler _flagHandler
 
ResultKey _centerKeys
 
ResultKey _positiveKeys
 
ResultKey _negativeKeys
 
std::string _logName
 

Detailed Description

Intermediate base class for algorithms that compute a centroid.

Definition at line 80 of file DipoleAlgorithms.h.

Member Typedef Documentation

◆ Control

Definition at line 88 of file DipoleAlgorithms.h.

◆ ResultKey

Definition at line 93 of file DipoleAlgorithms.h.

Constructor & Destructor Documentation

◆ DipoleCentroidAlgorithm() [1/2]

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

Definition at line 151 of file DipoleAlgorithms.h.

153 :
154 _ctrl(ctrl)
155{
158 meas::base::CentroidResultKey::addFields(schema, name+"_pos", doc+": positive lobe", meas::base::SIGMA_ONLY);
159 meas::base::CentroidResultKey::addFields(schema, name+"_neg", doc+": negative lobe", meas::base::SIGMA_ONLY);
161 _positiveKeys = ResultKey(schema[name+"_pos"]);
162 _negativeKeys = ResultKey(schema[name+"_neg"]);
163}
table::Schema schema
Definition python.h:134
meas::base::CentroidResultKey ResultKey
static meas::base::FlagDefinitionList const & getFlagDefinitions()
static CentroidResultKey addFields(afw::table::Schema &schema, std::string const &name, std::string const &doc, UncertaintyEnum uncertainty)
Add the appropriate fields to a Schema, and return a CentroidResultKey that manages them.
static FlagHandler addFields(afw::table::Schema &schema, std::string const &prefix, FlagDefinitionList const &flagDefs, FlagDefinitionList const &exclDefs=FlagDefinitionList::getEmptyList())
Add Flag fields to a schema, creating a FlagHandler object to manage them.
@ SIGMA_ONLY
Only the diagonal elements of the covariance matrix are provided.
Definition constants.h:45

◆ DipoleCentroidAlgorithm() [2/2]

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 )
inlineprotected

Initialize with a manually-constructed key tuple.

Definition at line 165 of file DipoleAlgorithms.h.

168 :
169 _ctrl(ctrl)
170{
173 meas::base::CentroidResultKey::addFields(schema, name+"_pos", doc + ": positive lobe", meas::base::SIGMA_ONLY);
174 meas::base::CentroidResultKey::addFields(schema, name+"_neg", doc + ": negative lobe", meas::base::SIGMA_ONLY);
176
177 _positiveKeys = ResultKey(schema[name+"_pos"]);
178 _negativeKeys = ResultKey(schema[name+"_neg"]);
179}

Member Function Documentation

◆ fail()

virtual void lsst::meas::base::BaseAlgorithm::fail ( afw::table::SourceRecord & measRecord,
MeasurementError * error = nullptr ) const
pure virtualinherited

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.

Implemented in lsst::meas::extensions::simpleShape::SimpleShape, lsst::meas::modelfit::DoubleShapeletPsfApproxAlgorithm, lsst::ip::diffim::PsfDipoleFlux, lsst::meas::extensions::photometryKron::KronFluxAlgorithm, lsst::meas::base::ApertureFluxAlgorithm, lsst::meas::base::BlendednessAlgorithm, lsst::meas::base::GaussianFluxAlgorithm, lsst::meas::base::LocalBackgroundAlgorithm, lsst::meas::base::NaiveCentroidAlgorithm, lsst::meas::base::PeakLikelihoodFluxAlgorithm, lsst::meas::base::PixelFlagsAlgorithm, lsst::meas::base::PsfFluxAlgorithm, lsst::meas::base::SdssCentroidAlgorithm, lsst::meas::base::SdssShapeAlgorithm, and lsst::meas::base::ScaledApertureFluxAlgorithm.

◆ getFlagDefinitions()

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

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::DipoleCentroidAlgorithm::getNegativeKeys ( ) const
inline

Definition at line 97 of file DipoleAlgorithms.h.

97{ return _negativeKeys; }

◆ getPositiveKeys()

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

Return the standard centroid keys registered by this algorithm.

Definition at line 96 of file DipoleAlgorithms.h.

96{ return _positiveKeys; }

◆ measure()

virtual void lsst::meas::base::SingleFrameAlgorithm::measure ( afw::table::SourceRecord & measRecord,
afw::image::Exposure< float > const & exposure ) const
pure virtualinherited

◆ measureForced()

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
inlineoverridevirtualinherited

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()

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
inlineoverridevirtualinherited

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

Member Data Documentation

◆ _centerKeys

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

Definition at line 107 of file DipoleAlgorithms.h.

◆ _ctrl

Control lsst::ip::diffim::DipoleCentroidAlgorithm::_ctrl
protected

Definition at line 104 of file DipoleAlgorithms.h.

◆ _flagHandler

meas::base::FlagHandler lsst::ip::diffim::DipoleCentroidAlgorithm::_flagHandler
protected

Definition at line 106 of file DipoleAlgorithms.h.

◆ _fluxResultKey

meas::base::FluxResultKey lsst::ip::diffim::DipoleCentroidAlgorithm::_fluxResultKey
protected

Definition at line 105 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
protected

Definition at line 109 of file DipoleAlgorithms.h.

◆ _positiveKeys

ResultKey lsst::ip::diffim::DipoleCentroidAlgorithm::_positiveKeys
protected

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")
static

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")
static

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")
static

Definition at line 84 of file DipoleAlgorithms.h.


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