lsst.afw  21.0.0-39-g68de21fec+f88c352dc9
Public Member Functions | Public Attributes | List of all members
lsst.afw.table.multiMatch.MultiMatch Class Reference

Public Member Functions

def __init__ (self, schema, dataIdFormat, coordField="coord", idField="id", radius=None, RecordClass=SourceRecord)
 
def makeRecord (self, inputRecord, dataId, objId)
 
def add (self, catalog, dataId)
 
def finish (self, removeAmbiguous=True)
 

Public Attributes

 radius
 
 mapper
 
 coordKey
 
 idKey
 
 dataIdKeys
 
 objectKey
 
 result
 
 reference
 
 ambiguous
 
 table
 
 nextObjId
 

Detailed Description

Initialize a multi-catalog match.

Parameters
----------
schema : `lsst.afw.table.Schema`
    Schema shared by all catalogs to be included in the match.
dataIdFormat : `dict`
    Set of name: type for all data ID keys (e.g. {"visit":int,
    "ccd":int}).
coordField : `str`, optional
    Prefix for _ra and _dec fields that contain the
    coordinates to use for the match.
idField : `str`, optional
    Name of the field in schema that contains unique object
    IDs.
radius : `lsst.geom.Angle`, optional
    Maximum separation for a match.  Defaults to 0.5 arcseconds.
RecordClass : `lsst.afw.table.BaseRecord`
    Type of record to expect in catalogs to be matched.

Definition at line 30 of file multiMatch.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.afw.table.multiMatch.MultiMatch.__init__ (   self,
  schema,
  dataIdFormat,
  coordField = "coord",
  idField = "id",
  radius = None,
  RecordClass = SourceRecord 
)

Definition at line 52 of file multiMatch.py.

Member Function Documentation

◆ add()

def lsst.afw.table.multiMatch.MultiMatch.add (   self,
  catalog,
  dataId 
)
Add a new catalog to the match, corresponding to the given data ID.
The new catalog is appended to the `self.result` and
`self.reference` catalogs.

Parameters
----------
catalog : `lsst.afw.table.base.Catalog`
    Catalog to be added to the match result.
dataId : `DataId` or `dict`
    Data id for the catalog to be added.

Definition at line 111 of file multiMatch.py.

◆ finish()

def lsst.afw.table.multiMatch.MultiMatch.finish (   self,
  removeAmbiguous = True 
)
Return the final match catalog, after sorting it by object, copying
it to ensure contiguousness, and optionally removing ambiguous
matches.

After calling finish(), the in-progress state of the matcher
is returned to the state it was just after construction, with
the exception of the object ID counter (which is not reset).

Parameters
----------
removeAmbiguous : `bool`, optional
    Should ambiguous matches be removed from the match
    catalog?  Defaults to True.

Returns
-------
result : `lsst.afw.table.base.Catalog`
    Final match catalog, sorted by object.

Definition at line 167 of file multiMatch.py.

◆ makeRecord()

def lsst.afw.table.multiMatch.MultiMatch.makeRecord (   self,
  inputRecord,
  dataId,
  objId 
)
Create a new result record from the given input record, using the
given data ID and object ID to fill in additional columns.

Parameters
----------
inputRecord : `lsst.afw.table.source.sourceRecord`
    Record to use as the reference for the new result.
dataId : `DataId` or `dict`
    Data id describing the data.
objId : `int`
    Object id of the object to be added.

Returns
-------
outputRecord : `lsst.afw.table.source.sourceRecord`
    Newly generated record.

Definition at line 87 of file multiMatch.py.

Member Data Documentation

◆ ambiguous

lsst.afw.table.multiMatch.MultiMatch.ambiguous

Definition at line 81 of file multiMatch.py.

◆ coordKey

lsst.afw.table.multiMatch.MultiMatch.coordKey

Definition at line 61 of file multiMatch.py.

◆ dataIdKeys

lsst.afw.table.multiMatch.MultiMatch.dataIdKeys

Definition at line 63 of file multiMatch.py.

◆ idKey

lsst.afw.table.multiMatch.MultiMatch.idKey

Definition at line 62 of file multiMatch.py.

◆ mapper

lsst.afw.table.multiMatch.MultiMatch.mapper

Definition at line 59 of file multiMatch.py.

◆ nextObjId

lsst.afw.table.multiMatch.MultiMatch.nextObjId

Definition at line 85 of file multiMatch.py.

◆ objectKey

lsst.afw.table.multiMatch.MultiMatch.objectKey

Definition at line 66 of file multiMatch.py.

◆ radius

lsst.afw.table.multiMatch.MultiMatch.radius

Definition at line 58 of file multiMatch.py.

◆ reference

lsst.afw.table.multiMatch.MultiMatch.reference

Definition at line 78 of file multiMatch.py.

◆ result

lsst.afw.table.multiMatch.MultiMatch.result

Definition at line 74 of file multiMatch.py.

◆ table

lsst.afw.table.multiMatch.MultiMatch.table

Definition at line 83 of file multiMatch.py.


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