Inheritance diagram for lsst.meas.astrom.directMatch.DirectMatchTask:

Public Member Functions
	__init__ (self, refObjLoader=None, **kwargs)

	setRefObjLoader (self, refObjLoader)

	run (self, catalog, filterName=None, epoch=None)

	calculateCircle (self, catalog)

Public Attributes
	refObjLoader

Static Public Attributes
	ConfigClass = DirectMatchConfig

Static Protected Attributes
str	_DefaultName = "directMatch"

Detailed Description

Simple, brute force matching of a source catalog to a reference catalog.

Parameters
----------
butler : `None`
    Compatibility parameter. Should not be used.
refObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader` or `None`
    A reference object loader object; gen3 pipeline tasks will pass `None`
    and call `setRefObjLoader` in `runQuantum`.
**kwargs
    Other keyword arguments required for instantiating a Task (such as
    ``config``).

Definition at line 30 of file directMatch.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.astrom.directMatch.DirectMatchTask.__init__	(		self,
			refObjLoader = None,
		**	kwargs )

Definition at line 47 of file directMatch.py.

    def __init__(self, refObjLoader=None, **kwargs):
        Task.__init__(self, **kwargs)
        self.refObjLoader = refObjLoader
        self.makeSubtask("sourceSelection")
        self.makeSubtask("referenceSelection")
 

Member Function Documentation

◆ calculateCircle()

lsst.meas.astrom.directMatch.DirectMatchTask.calculateCircle	(		self,
			catalog )

Calculate a circle enclosing the catalog.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Catalog to encircle.

Returns
-------
result : `lsst.pipe.base.Struct`
    Result struct with components:

    ``center``
        ICRS center coordinate (`lsst.afw.geom.SpherePoint`).
    ``radius``
        Radius of the circle (`lsst.geom.Angle`).

Definition at line 110 of file directMatch.py.

    def calculateCircle(self, catalog):
        """Calculate a circle enclosing the catalog.
 
        Parameters
        ----------
        catalog : `lsst.afw.table.SourceCatalog`
            Catalog to encircle.
 
        Returns
        -------
        result : `lsst.pipe.base.Struct`
            Result struct with components:
 
            ``center``
                ICRS center coordinate (`lsst.afw.geom.SpherePoint`).
            ``radius``
                Radius of the circle (`lsst.geom.Angle`).
        """
        coordList = [src.getCoord() for src in catalog]
        center = averageSpherePoint(coordList)
        radius = max(center.separation(coord) for coord in coordList)
        return Struct(center=center, radius=radius + self.config.matchRadius*arcseconds)

◆ run()

lsst.meas.astrom.directMatch.DirectMatchTask.run	(	self,
		catalog,
		filterName = None,
		epoch = None )

Load reference objects and match to them.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Catalog to match.
filterName : `str`
    Name of filter loading fluxes.
epoch : `astropy.time.Time` or `None`
    Epoch to which to correct proper motion and parallax, or `None` to
    not apply such corrections.

Returns
-------
result : `lsst.pipe.base.Struct`
    Result struct with components:

    ``matches``
        Matched sources with associated reference
        (`lsst.afw.table.SourceMatchVector`).
    ``matchMeta``
        Match metadata (`lsst.meas.astrom.MatchMetadata`).

Definition at line 63 of file directMatch.py.

    def run(self, catalog, filterName=None, epoch=None):
        """Load reference objects and match to them.
 
        Parameters
        ----------
        catalog : `lsst.afw.table.SourceCatalog`
            Catalog to match.
        filterName : `str`
            Name of filter loading fluxes.
        epoch : `astropy.time.Time` or `None`
            Epoch to which to correct proper motion and parallax, or `None` to
            not apply such corrections.
 
        Returns
        -------
        result : `lsst.pipe.base.Struct`
            Result struct with components:
 
            ``matches``
                Matched sources with associated reference
                (`lsst.afw.table.SourceMatchVector`).
            ``matchMeta``
                Match metadata (`lsst.meas.astrom.MatchMetadata`).
        """
        if self.refObjLoader is None:
            raise RuntimeError("Running matcher task with no refObjLoader set in __ini__ or setRefObjLoader")
        circle = self.calculateCircle(catalog)
        matchMeta = self.refObjLoader.getMetadataCircle(circle.center, circle.radius, filterName, epoch=epoch)
        emptyResult = Struct(matches=[], matchMeta=matchMeta)
        sourceSelection = self.sourceSelection.run(catalog)
        if len(sourceSelection.sourceCat) == 0:
            self.log.warning("No objects selected from %d objects in source catalog", len(catalog))
            return emptyResult
        refData = self.refObjLoader.loadSkyCircle(circle.center, circle.radius, filterName, epoch=epoch)
        refCat = refData.refCat
        refSelection = self.referenceSelection.run(refCat)
        if len(refSelection.sourceCat) == 0:
            self.log.warning("No objects selected from %d objects in reference catalog", len(refCat))
            return emptyResult
        matches = afwTable.matchRaDec(refSelection.sourceCat, sourceSelection.sourceCat,
                                      self.config.matchRadius*arcseconds)
        self.log.info("Matched %d from %d/%d input and %d/%d reference sources",
                      len(matches), len(sourceSelection.sourceCat), len(catalog),
                      len(refSelection.sourceCat), len(refCat))
        return Struct(matches=matches, matchMeta=matchMeta, refCat=refCat, sourceSelection=sourceSelection,
                      refSelection=refSelection)
 

◆ setRefObjLoader()

lsst.meas.astrom.directMatch.DirectMatchTask.setRefObjLoader	(		self,
			refObjLoader )

Set the reference object loader for the task.

Parameters
----------
refObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`
    An instance of a reference object loader.

Definition at line 53 of file directMatch.py.

    def setRefObjLoader(self, refObjLoader):
        """Set the reference object loader for the task.
 
        Parameters
        ----------
        refObjLoader : `lsst.meas.algorithms.ReferenceObjectLoader`
            An instance of a reference object loader.
        """
        self.refObjLoader = refObjLoader
 

Member Data Documentation

◆ _DefaultName

str lsst.meas.astrom.directMatch.DirectMatchTask._DefaultName = "directMatch"

staticprotected

Definition at line 45 of file directMatch.py.

◆ ConfigClass

lsst.meas.astrom.directMatch.DirectMatchTask.ConfigClass = DirectMatchConfig

static

Definition at line 44 of file directMatch.py.

◆ refObjLoader

lsst.meas.astrom.directMatch.DirectMatchTask.refObjLoader

Definition at line 49 of file directMatch.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_astrom/gf1cff7945b+21ad69e7e1/python/lsst/meas/astrom/directMatch.py

Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Attributes