lsst::afw::detection::FootprintMergeList Class Reference

List of Merged Footprints. More...

#include <FootprintMerge.h>

Public Member Functions
	FootprintMergeList (afw::table::Schema &sourceSchema, std::vector< std::string > const &filterList, afw::table::Schema const &initialPeakSchema)
	Initialize the merge with a custom initial peak schema.
	FootprintMergeList (afw::table::Schema &sourceSchema, std::vector< std::string > const &filterList)
	Initialize the merge with the default peak schema.
	~FootprintMergeList ()
	FootprintMergeList (FootprintMergeList const &)
	FootprintMergeList (FootprintMergeList &&)
FootprintMergeList &	operator= (FootprintMergeList const &)
FootprintMergeList &	operator= (FootprintMergeList &&)
afw::table::Schema	getPeakSchema () const
	Return the schema for PeakRecords in the merged footprints.
void	addCatalog (std::shared_ptr< afw::table::SourceTable > sourceTable, afw::table::SourceCatalog const &inputCat, std::string const &filter, float minNewPeakDist=-1., bool doMerge=true, float maxSamePeakDist=-1.)
	Add objects from a SourceCatalog in the specified filter.
void	clearCatalog ()
	Clear entries in the current vector.
void	getFinalSources (afw::table::SourceCatalog &outputCat)
	Get SourceCatalog with entries that contain the final Footprint and SourceRecord for each entry.

Friends
class	FootprintMerge

Detailed Description

List of Merged Footprints.

Stores a vector of FootprintMerges and SourceRecords that contain the union of different footprints and which filters it was detected in. Individual Footprints from a SourceCatalog can be added to the vector (note that any SourceRecords with parent!=0 will be skipped). If a Footprint overlaps an existing FootprintMerge, the Footprint will be added to it. If not, then a new FootprintMerge will be created and added to the vector.

The search algorithm uses a brute force approach over the current list. This should be fine if we are operating on smallish number of objects, such as at the tract level.

Definition at line 56 of file FootprintMerge.h.

Constructor & Destructor Documentation

FootprintMergeList() [1/4]

lsst::afw::detection::FootprintMergeList::FootprintMergeList	(	afw::table::Schema &	sourceSchema,
		std::vector< std::string > const &	filterList,
		afw::table::Schema const &	initialPeakSchema )

Initialize the merge with a custom initial peak schema.

Parameters

[in,out]	sourceSchema	Input schema for SourceRecords to be merged, modified on return to include 'merge_footprint_<filter>' Flag fields that will indicate the origin of the source.
[in]	filterList	Sequence of filter names to be used in Flag fields.
[in]	initialPeakSchema	Input schema of PeakRecords in Footprints to be merged.

The output schema for PeakRecords will include additional 'merge_peak_<filter>' Flag fields that indicate the origin of peaks. This can be accessed by getPeakSchema().

Definition at line 205 of file FootprintMerge.cc.

        : _peakSchemaMapper(initialPeakSchema) {
    _initialize(sourceSchema, filterList);
}

FootprintMergeList() [2/4]

lsst::afw::detection::FootprintMergeList::FootprintMergeList	(	afw::table::Schema &	sourceSchema,
		std::vector< std::string > const &	filterList )

Initialize the merge with the default peak schema.

Parameters

[in,out]	sourceSchema	Input schema for SourceRecords to be merged, modified on return to include 'merge_footprint_<filter>' Flag fields that will indicate the origin of the source.
[in]	filterList	Sequence of filter names to be used in Flag fields.

The output schema for PeakRecords will include additional 'merge_peak_<filter>' Flag fields that indicate the origin of peaks. This can be accessed by getPeakSchema().

Definition at line 212 of file FootprintMerge.cc.

        : _peakSchemaMapper(PeakTable::makeMinimalSchema()) {
    _initialize(sourceSchema, filterList);
}

~FootprintMergeList()

lsst::afw::detection::FootprintMergeList::~FootprintMergeList ( )

default

FootprintMergeList() [3/4]

lsst::afw::detection::FootprintMergeList::FootprintMergeList ( FootprintMergeList const & )

default

FootprintMergeList() [4/4]

lsst::afw::detection::FootprintMergeList::FootprintMergeList ( FootprintMergeList && )

default

Member Function Documentation

addCatalog()

void lsst::afw::detection::FootprintMergeList::addCatalog	(	std::shared_ptr< afw::table::SourceTable >	sourceTable,
		afw::table::SourceCatalog const &	inputCat,
		std::string const &	filter,
		float	minNewPeakDist = -1.,
		bool	doMerge = true,
		float	maxSamePeakDist = -1. )

Add objects from a SourceCatalog in the specified filter.

Iterate over all objects that have not been deblendend and search for an overlapping FootprintMerge in _mergeList. If it overlaps, then it will be added to it, otherwise it will create a new one. If minNewPeakDist < 0, then new peaks will not be added to existing footprints. If minNewPeakDist >= 0, then new peaks will be added that are farther away than minNewPeakDist to the nearest existing peak.

The SourceTable is used to create new SourceRecords that store the filter information.

Definition at line 241 of file FootprintMerge.cc.

                                                                                               {
    FilterMap::const_iterator keyIter = _filterMap.find(filter);
    if (keyIter == _filterMap.end()) {
        throw LSST_EXCEPT(pex::exceptions::LogicError,
                          (boost::format("Filter %s not in original list") % filter).str());
    }
 
    // If list is empty or merging not requested, don't check for any matches, just add all the objects
    bool checkForMatches = !_mergeList.empty() && doMerge;
 
    for (afw::table::SourceCatalog::const_iterator srcIter = inputCat.begin(); srcIter != inputCat.end();
         ++srcIter) {
        // Only consider unblended objects
        if (srcIter->getParent() != 0) continue;
 
        std::shared_ptr<Footprint> foot = srcIter->getFootprint();
 
        // Empty pointer to account for the first match in the catalog.  If there is more than one
        // match, subsequent matches will be merged with this one
        std::shared_ptr<FootprintMerge> first = std::shared_ptr<FootprintMerge>();
 
        if (checkForMatches) {
            FootprintMergeVec::iterator iter = _mergeList.begin();
            while (iter != _mergeList.end()) {
                // Grow by one pixel to allow for touching
                lsst::geom::Box2I box((**iter).getBBox());
                box.grow(lsst::geom::Extent2I(1, 1));
                if (box.overlaps(foot->getBBox()) && (**iter).overlaps(*foot)) {
                    if (!first) {
                        first = *iter;
                        // Spatially extend existing FootprintMerge in order to connect subsequent,
                        // now-overlapping FootprintMerges. If a subsequent FootprintMerge overlaps with
                        // the new footprint, it's now guaranteed to overlap with this first FootprintMerge.
                        // Hold off adding foot's lower-priority footprints and peaks until the
                        // higher-priority existing peaks are merged into this first FootprintMerge.
                        first->addSpans(foot);
                    } else {
                        // Add existing merged Footprint to first
                        first->add(**iter, _filterMap, minNewPeakDist, maxSamePeakDist);
                        iter = _mergeList.erase(iter);
                        continue;
                    }
                }
                ++iter;
            } // while mergeList
        } //     if checkForMatches
 
        if (first) {
            // Now merge footprint including peaks into the newly-connected, higher-priority FootprintMerge
            first->add(foot, _peakSchemaMapper, keyIter->second, minNewPeakDist, maxSamePeakDist);
        } else {
           // Footprint did not overlap with any existing FootprintMerges. Add to MergeList
            _mergeList.push_back(std::make_shared<FootprintMerge>(foot, sourceTable, _peakTable,
                                                                  _peakSchemaMapper, keyIter->second));
        }
    }
}

clearCatalog()

void lsst::afw::detection::FootprintMergeList::clearCatalog ( )

inline

Clear entries in the current vector.

Definition at line 113 of file FootprintMerge.h.

{ _mergeList.clear(); }

getFinalSources()

void lsst::afw::detection::FootprintMergeList::getFinalSources

(

afw::table::SourceCatalog &

outputCat

)

Get SourceCatalog with entries that contain the final Footprint and SourceRecord for each entry.

The resulting Footprints will be normalized, meaning that there peaks are sorted, and areas are calculated.

Definition at line 301 of file FootprintMerge.cc.

                                                                         {
    // Now set the merged footprint as the footprint of the SourceRecord
    for (auto const &iter : _mergeList) {
        outputCat.push_back((*iter).getSource());
    }
}

getPeakSchema()

afw::table::Schema lsst::afw::detection::FootprintMergeList::getPeakSchema ( ) const

inline

Return the schema for PeakRecords in the merged footprints.

Definition at line 93 of file FootprintMerge.h.

{ return _peakTable->getSchema(); }

operator=() [1/2]

FootprintMergeList & lsst::afw::detection::FootprintMergeList::operator= ( FootprintMergeList && )

default

operator=() [2/2]

FootprintMergeList & lsst::afw::detection::FootprintMergeList::operator= ( FootprintMergeList const & )

default

Friends And Related Symbol Documentation

FootprintMerge

friend class FootprintMerge

friend

Definition at line 134 of file FootprintMerge.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/detection/FootprintMerge.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/src/detection/FootprintMerge.cc