lsst::meas::base::CentroidChecker Class Reference

#include <CentroidUtilities.h>

Public Member Functions
	CentroidChecker (afw::table::Schema &schema, std::string const &name, bool inside=true, double maxDistFromPeak=-1.0)
	Check source record for an centroid algorithm called name, noting if the centroid already set by the algorithm is outside the footprint attached to the record. More...
bool	operator() (afw::table::SourceRecord &record) const
	Set the centroid to the first footprint if the centroid is either more than _dist pixels from the footprint center, or if it is outside the footprint. More...

Detailed Description

Definition at line 190 of file CentroidUtilities.h.

Constructor & Destructor Documentation

CentroidChecker()

lsst::meas::base::CentroidChecker::CentroidChecker	(	afw::table::Schema &	schema,
		std::string const &	name,
		bool	inside = true,
		double	maxDistFromPeak = -1.0
	)

Check source record for an centroid algorithm called name, noting if the centroid already set by the algorithm is outside the footprint attached to the record.

If that is the case, we should: (1) set the general failure flag for the algorithm (2) set the algorithmName + "_flag_resetToPeak" flag (3) change the value of the centroid to the footprint Peak

Secondly, check to see if the centroid is more than "dist" pixels from the footprint peak, and similarly modify the centroi value to the peak in that case

Parameters

[in,out]	schema	Schema to which the flag_resetToPeak is to be added
[in]	name	The name of the algorithm we will be checking
[in]	doFootprintCheck	Check if centroid is within footprint
[in]	maxDistFromPeak	Check if centroid is more than dist from footprint peak

Definition at line 174 of file CentroidUtilities.cc.

        : _doFootprintCheck(doFootprintCheck), _maxDistFromPeak(maxDistFromPeak) {
    _resetKey = schema.addField<afw::table::Flag>(schema.join(name, "flag_resetToPeak"),
                                                  "set if CentroidChecker reset the centroid");
    _failureKey = schema.find<afw::table::Flag>(schema.join(name, "flag")).key;
    _xKey = schema.find<CentroidElement>(schema.join(name, "x")).key;
    _yKey = schema.find<CentroidElement>(schema.join(name, "y")).key;
}

Member Function Documentation

operator()()

bool lsst::meas::base::CentroidChecker::operator()

(

afw::table::SourceRecord &

record

)

const

Set the centroid to the first footprint if the centroid is either more than _dist pixels from the footprint center, or if it is outside the footprint.

Definition at line 186 of file CentroidUtilities.cc.

                                                                   {
    CentroidElement x = record.get(_xKey);
    CentroidElement y = record.get(_yKey);

    if (!_doFootprintCheck && _maxDistFromPeak < 0.0) {
        return false;
    }
    PTR(afw::detection::Footprint) footprint = record.getFootprint();
    if (!footprint) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "No Footprint attached to record");
    }
    if (footprint->getPeaks().empty()) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Footprint has no peaks; cannot verify centroid.");
    }
    CentroidElement footX = footprint->getPeaks().front().getFx();
    CentroidElement footY = footprint->getPeaks().front().getFy();
    double distsq = (x - footX) * (x - footX) + (y - footY) * (y - footY);
    if ((_doFootprintCheck && !footprint->contains(geom::Point2I(geom::Point2D(x, y)))) ||
        ((_maxDistFromPeak > 0) && (distsq > _maxDistFromPeak * _maxDistFromPeak))) {
        record.set(_xKey, footX);
        record.set(_yKey, footY);
        record.set(_failureKey, true);
        record.set(_resetKey, true);
        return true;
    }
    return false;
}

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/meas_base/18.1.0/include/lsst/meas/base/CentroidUtilities.h
• /j/snowflake/release/lsstsw/stack/Linux64/meas_base/18.1.0/src/CentroidUtilities.cc