lsst.meas.astrom  16.0-21-gdae7b8c+3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.astrom.directMatch.DirectMatchTask Class Reference
Inheritance diagram for lsst.meas.astrom.directMatch.DirectMatchTask:

Public Member Functions

def __init__ (self, butler=None, refObjLoader=None, kwargs)
 
def setRefObjLoader (self, refObjLoader)
 
def run (self, catalog, filterName=None, epoch=None)
 
def calculateCircle (self, catalog)
 

Public Attributes

 refObjLoader
 

Static Public Attributes

 ConfigClass = DirectMatchConfig
 

Detailed Description

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

Parameters
----------
butler : `lsst.daf.persistence.Butler`
    Data butler containing the relevant reference catalog data.
refObjLoader : `lsst.meas.algorithms.LoadReferenceObjectsTask` or `None`
    For loading reference objects
**kwargs :
    Other keyword arguments required for instantiating a Task (e.g., 'config')

Definition at line 27 of file directMatch.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 42 of file directMatch.py.

Member Function Documentation

◆ calculateCircle()

def 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 116 of file directMatch.py.

◆ run()

def 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 71 of file directMatch.py.

◆ setRefObjLoader()

def lsst.meas.astrom.directMatch.DirectMatchTask.setRefObjLoader (   self,
  refObjLoader 
)
Sets the reference object loader for the task

Parameters
----------
refObjLoader : `lsst.meas.algorithms.LoadReferenceObjectsTask` or
       `lsst.meas.algorithms.ReferenceObjectLoader`
    An instance of a reference object loader task or class. A task can be  used as a subtask
    and is generally used in gen2 middleware. The class is designed to be used with gen3
    middleware and is initialized outside the normal task framework.

Definition at line 58 of file directMatch.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 39 of file directMatch.py.

◆ refObjLoader

lsst.meas.astrom.directMatch.DirectMatchTask.refObjLoader

Definition at line 51 of file directMatch.py.


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