lsst.meas.astrom gf1cff7945b+37e0927acf
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Static Protected Attributes | List of all members
lsst.meas.astrom.directMatch.DirectMatchTask Class Reference
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.

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.

◆ 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.

◆ 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.

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: