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

List of Merged Footprints. More...

#include <FootprintMerge.h>

Classes
struct	KeyTuple

Public Member Functions
	FootprintMergeList (afw::table::Schema &sourceSchema, std::vector< std::string > const &filterList, afw::table::Schema const &initialPeakSchema)
	FootprintMergeList (afw::table::Schema &sourceSchema, std::vector< std::string > const &filterList)
afw::table::Schema	getPeakSchema () const
	Return the schema for PeakRecords in the merged footprints. More...
void	addCatalog (boost::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. More...
void	clearCatalog ()
	Clear entries in the current vector. More...
void	getFinalSources (afw::table::SourceCatalog &outputCat, bool doNorm=true)
	Get SourceCatalog with entries that contain the final Footprint and SourceRecord for each entry. More...

Private Types
typedef afw::table::Key < afw::table::Flag >	FlagKey
typedef std::vector < boost::shared_ptr < FootprintMerge > >	FootprintMergeVec
typedef std::map< std::string, KeyTuple >	FilterMap

Private Member Functions
void	_initialize (afw::table::Schema &sourceSchema, std::vector< std::string > const &filterList)

Private Attributes
FootprintMergeVec	_mergeList
FilterMap	_filterMap
afw::table::SchemaMapper	_peakSchemaMapper
boost::shared_ptr< PeakTable >	_peakTable

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 54 of file FootprintMerge.h.

Member Typedef Documentation

typedef std::map<std::string,KeyTuple> lsst::afw::detection::FootprintMergeList::FilterMap

private

Definition at line 138 of file FootprintMerge.h.

typedef afw::table::Key<afw::table::Flag> lsst::afw::detection::FootprintMergeList::FlagKey

private

Definition at line 130 of file FootprintMerge.h.

typedef std::vector<boost::shared_ptr< FootprintMerge > > lsst::afw::detection::FootprintMergeList::FootprintMergeVec

private

Definition at line 137 of file FootprintMerge.h.

Constructor & Destructor Documentation

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 215 of file FootprintMerge.cc.

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

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.
[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 223 of file FootprintMerge.cc.

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

Member Function Documentation

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

private

Definition at line 230 of file FootprintMerge.cc.

  {
    _peakSchemaMapper.addMinimalSchema(_peakSchemaMapper.getInputSchema(), true);
    // Add Flags for the filters
    for (
        std::vector<std::string>::const_iterator iter=filterList.begin();
        iter != filterList.end();
        ++iter
    ) {
        KeyTuple & keys = _filterMap[*iter];
        keys.footprint = sourceSchema.addField<afw::table::Flag>(
            "merge_footprint_" + *iter,
            "Detection footprint overlapped with a detection from filter " + *iter
        );
        keys.peak = _peakSchemaMapper.editOutputSchema().addField<afw::table::Flag>(
            "merge_peak_" + *iter,
            "Peak detected in filter " + *iter
        );
    }
    _peakTable = PeakTable::make(_peakSchemaMapper.getOutputSchema());
}

void lsst::afw::detection::FootprintMergeList::addCatalog	(	boost::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 254 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 don't check for any matches, just add all the objects
    bool checkForMatches = (_mergeList.size() > 0);

    for (afw::table::SourceCatalog::const_iterator srcIter = inputCat.begin(); srcIter != inputCat.end();
         ++srcIter) {

        // Only consider unblended objects
        if (srcIter->getParent() != 0) continue;

        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
        PTR(FootprintMerge) first = PTR(FootprintMerge)();

        if (checkForMatches) {
            FootprintMergeVec::iterator iter = _mergeList.begin();
            while (iter != _mergeList.end()) {
                // Grow by one pixel to allow for touching
                geom::Box2I box((**iter).getBBox());
                box.grow(geom::Extent2I(1,1));
                if (box.overlaps(foot->getBBox()) && (**iter).overlaps(*foot)) {
                    if (!first) {
                        first = *iter;
                        // Add Footprint to existing merge and set flag for this band
                        if (doMerge) {
                            first->add(foot, _peakSchemaMapper, keyIter->second, minNewPeakDist,
                                       maxSamePeakDist);
                        }
                    } else {
                        // Add merged Footprint to first
                        if (doMerge) {
                            first->add(**iter, _filterMap, minNewPeakDist, maxSamePeakDist);
                            iter = _mergeList.erase(iter);
                            continue;
                        }
                    }
                }
                ++iter;
            }
        }

        if (!first) {
            _mergeList.push_back(
                boost::make_shared<FootprintMerge>(
                    foot, sourceTable, _peakTable, _peakSchemaMapper, keyIter->second
                )
            );
        }
    }
}

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

inline

Clear entries in the current vector.

Definition at line 118 of file FootprintMerge.h.

{ _mergeList.clear(); }

void lsst::afw::detection::FootprintMergeList::getFinalSources	(	afw::table::SourceCatalog &	outputCat,
		bool	doNorm = true
	)

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 320 of file FootprintMerge.cc.

{
    // Now set the merged footprint as the footprint of the SourceRecord
    for (FootprintMergeVec::iterator iter = _mergeList.begin(); iter != _mergeList.end(); ++iter)  {
        if (doNorm) (**iter).getMergedFootprint()->normalize();
        outputCat.push_back((**iter).getSource());
    }
}

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

Friends And Related Function Documentation

friend class FootprintMerge

friend

Definition at line 140 of file FootprintMerge.h.

Member Data Documentation

FilterMap lsst::afw::detection::FootprintMergeList::_filterMap

private

Definition at line 148 of file FootprintMerge.h.

FootprintMergeVec lsst::afw::detection::FootprintMergeList::_mergeList

private

Definition at line 147 of file FootprintMerge.h.

afw::table::SchemaMapper lsst::afw::detection::FootprintMergeList::_peakSchemaMapper

private

Definition at line 149 of file FootprintMerge.h.

boost::shared_ptr< PeakTable > lsst::afw::detection::FootprintMergeList::_peakTable

private

Definition at line 150 of file FootprintMerge.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/detection/FootprintMerge.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/detection/FootprintMerge.cc