lsst::meas::astrom::sip::MatchSrcToCatalogue Class Reference

Match a SourceSet of objects with known ra/dec with a SourceSet of objects with known xy positions Take a catalogue of objects with known positions, a catalogue of objects with known xy, and a wcs to convert one xy <--> ra/dec. More...

#include <MatchSrcToCatalogue.h>

Public Types
typedef std::shared_ptr< MatchSrcToCatalogue >	Ptr
typedef std::shared_ptr< MatchSrcToCatalogue const >	ConstPtr

Public Member Functions
	MatchSrcToCatalogue (afw::table::SimpleCatalog const &catSet, afw::table::SourceCatalog const &imgSet, std::shared_ptr< afw::geom::SkyWcs const > wcs, geom::Angle dist)
	Create a list of common objects from a catalogue and an image.
void	setDist (geom::Angle dist)
	Set a new value for the maximum allowed distance between two matching objects (in ra/dec space)
void	setWcs (std::shared_ptr< afw::geom::SkyWcs const > wcs)
	Set a different Wcs solution.
void	setCatSrcSet (afw::table::SimpleCatalog const &catSet)
void	setImgSrcSet (afw::table::SourceCatalog const &srcSet)
	sourceSet is a vector of pointers to Sources.
void	findMatches ()
afw::table::ReferenceMatchVector	getMatches ()

Detailed Description

Match a SourceSet of objects with known ra/dec with a SourceSet of objects with known xy positions Take a catalogue of objects with known positions, a catalogue of objects with known xy, and a wcs to convert one xy <--> ra/dec.

This class then finds the set of objects with common ra/dec.

The simplest usage is to create an object of this class, then access the corresponence sets with getMatchedImgSet() and getMatchedCatSet(). Creating the object automatically calculates the sets of corresponences for you. If you are unhappy with these matches, you can change one or more of your input arguments and redo the match with findMatches()

Using this class has the side effect of updating the coord field of the input SourceCatalog (which may be desirable).

Definition at line 57 of file MatchSrcToCatalogue.h.

Member Typedef Documentation

ConstPtr

typedef std::shared_ptr<MatchSrcToCatalogue const> lsst::meas::astrom::sip::MatchSrcToCatalogue::ConstPtr

Definition at line 60 of file MatchSrcToCatalogue.h.

Ptr

typedef std::shared_ptr<MatchSrcToCatalogue> lsst::meas::astrom::sip::MatchSrcToCatalogue::Ptr

Definition at line 59 of file MatchSrcToCatalogue.h.

Constructor & Destructor Documentation

MatchSrcToCatalogue()

lsst::meas::astrom::sip::MatchSrcToCatalogue::MatchSrcToCatalogue	(	afw::table::SimpleCatalog const &	catSet,
		afw::table::SourceCatalog const &	imgSet,
		std::shared_ptr< afw::geom::SkyWcs const >	wcs,
		geom::Angle	dist )

Create a list of common objects from a catalogue and an image.

Take a catSet, i.e a SimpleCatalog giving the true positions of objects in ra/dec space, and an imageSet, i.e. a SourceCatalog of the pixel positions of sources detected on a CCD image. Use the Wcs to calculate the ra/dec of the image source, and then find the subset of objects withcommon positions in the two sets. The returned list of matches is one-to-one, i.e no object in the catalogue is matched twice, and no object in the imageSet is matched twice.

Parameters

catSet	List of catalogue positions with known ra and dec
imgSet	List of image positions with known x and y
wcs	A Wcs object to convert from xy to radec
dist	How close to objects need to be in order to be considered the same

Definition at line 49 of file MatchSrcToCatalogue.cc.

                                                                                                 {
    setImgSrcSet(imgSet);
    setCatSrcSet(catSet);
    setDist(dist);
    setWcs(wcs);
}

Member Function Documentation

findMatches()

void lsst::meas::astrom::sip::MatchSrcToCatalogue::findMatches

(

)

Definition at line 74 of file MatchSrcToCatalogue.cc.

                                      {
    if (!_imgSet.getTable()->getCentroidSlot().isValid()) {
        throw LSST_EXCEPT(pex::exceptions::LogicError,
                          "SourceTable passed to MatchSrcToCatalogue does not have its centroid slot set.");
    }
 
    for (afw::table::SourceCatalog::const_iterator i = _imgSet.begin(); i != _imgSet.end(); ++i) {
        i->updateCoord(*_wcs);
    }
 
    _match = afw::table::matchRaDec(_catSet, _imgSet, _dist);
 
    _removeOneToMany();
    _removeManyToOne();
}

getMatches()

afw::table::ReferenceMatchVector lsst::meas::astrom::sip::MatchSrcToCatalogue::getMatches

(

)

Definition at line 139 of file MatchSrcToCatalogue.cc.

                                                             {
    findMatches();
    return _match;
}

setCatSrcSet()

void lsst::meas::astrom::sip::MatchSrcToCatalogue::setCatSrcSet

(

afw::table::SimpleCatalog const &

catSet

)

Definition at line 72 of file MatchSrcToCatalogue.cc.

{ _catSet = srcSet; }

setDist()

void lsst::meas::astrom::sip::MatchSrcToCatalogue::setDist

(

geom::Angle

dist

)

Set a new value for the maximum allowed distance between two matching objects (in ra/dec space)

Definition at line 59 of file MatchSrcToCatalogue.cc.

                                                {
    if (dist <= 0) {
        throw LSST_EXCEPT(pex::exceptions::InvalidParameterError, "Distance must be > 0");
    }
    _dist = dist;
}

setImgSrcSet()

void lsst::meas::astrom::sip::MatchSrcToCatalogue::setImgSrcSet

(

afw::table::SourceCatalog const &

srcSet

)

sourceSet is a vector of pointers to Sources.

Definition at line 70 of file MatchSrcToCatalogue.cc.

{ _imgSet = srcSet; }

setWcs()

void lsst::meas::astrom::sip::MatchSrcToCatalogue::setWcs

(

std::shared_ptr< afw::geom::SkyWcs const >

wcs

)

Set a different Wcs solution.

Definition at line 67 of file MatchSrcToCatalogue.cc.

{ _wcs = wcs; }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_astrom/gff1a9f87cc+0dd8ce4237/include/lsst/meas/astrom/sip/MatchSrcToCatalogue.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_astrom/gff1a9f87cc+0dd8ce4237/src/sip/MatchSrcToCatalogue.cc