Public Member Functions
	__init__ (self, schema, dataIdFormat, coordField="coord", idField="id", radius=None, RecordClass=SourceRecord)

	makeRecord (self, inputRecord, dataId, objId)

	add (self, catalog, dataId)

	finish (self, removeAmbiguous=True)

Public Attributes
	radius = radius

	mapper = SchemaMapper(schema)

	coordKey = CoordKey(schema[coordField])

	idKey = schema.find(idField).key

dict	dataIdKeys = {}

	objectKey

	result = None

	reference = None

	ambiguous = set()

	table = RecordClass.Table.make(self.mapper.getOutputSchema())

int	nextObjId = 1

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()

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()

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()

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()

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 = set()

Definition at line 81 of file multiMatch.py.

◆ coordKey

lsst.afw.table.multiMatch.MultiMatch.coordKey = CoordKey(schema[coordField])

Definition at line 61 of file multiMatch.py.

◆ dataIdKeys

dict lsst.afw.table.multiMatch.MultiMatch.dataIdKeys = {}

Definition at line 63 of file multiMatch.py.

◆ idKey

lsst.afw.table.multiMatch.MultiMatch.idKey = schema.find(idField).key

Definition at line 62 of file multiMatch.py.

◆ mapper

lsst.afw.table.multiMatch.MultiMatch.mapper = SchemaMapper(schema)

Definition at line 59 of file multiMatch.py.

◆ nextObjId

int lsst.afw.table.multiMatch.MultiMatch.nextObjId = 1

Definition at line 85 of file multiMatch.py.

◆ objectKey

lsst.afw.table.multiMatch.MultiMatch.objectKey

Initial value:

= outSchema.addField(

"object", type=numpy.int64, doc="Unique ID for joined sources")

Definition at line 66 of file multiMatch.py.

◆ radius

lsst.afw.table.multiMatch.MultiMatch.radius = radius

Definition at line 58 of file multiMatch.py.

◆ reference

lsst.afw.table.multiMatch.MultiMatch.reference = None

Definition at line 78 of file multiMatch.py.

◆ result

lsst.afw.table.multiMatch.MultiMatch.result = None

Definition at line 74 of file multiMatch.py.

◆ table

lsst.afw.table.multiMatch.MultiMatch.table = RecordClass.Table.make(self.mapper.getOutputSchema())

Definition at line 83 of file multiMatch.py.

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

python/lsst/afw/table/multiMatch.py

Public Member Functions

Public Attributes