Classes
class	DrpAssociationPipeConnections

Functions
	_stackCatalogs (self, catalogs, remove_columns=None, empty=None)

	runSolarSystemAssociation (self, diaCat, ssCat, visitSummary, patchBbox, patchWcs, innerTractSkyRegion, detector, visit)

	_addDiaObjectCoords (self, objects, sources)

	_trimToPatch (self, cat, patchBox, wcs, innerTractSkyRegion=None)

	dropDiaSourceByDiaObjectId (self, droppedDiaObjectIds, diaSources)

	prepareCatalogDict (dataRefList, useVisitDetector=True)

Variables
	diaCat = ssoAssocResult.unassociatedDiaSources

	nSsSrc

	nSsObj

	diaInPatch = self._trimToPatch(diaCat.to_pandas(), outerPatchBox, skyInfo.wcs)

	nDiaSrc = diaInPatch.sum()

	diaSourceHistoryCat = self._stackCatalogs(diaSourceHistory)

	ssDiaSourceHistoryCat = self._stackCatalogs(ssDiaSourceHistory)

	ssSourceHistoryCat = self._stackCatalogs(ssSourceHistory, remove_columns=['ra', 'dec'])

int	nSsSrcTotal = len(ssSourceHistoryCat) if ssSourceHistoryCat else 0

	unassociatedSsObjectHistoryCat = self._stackCatalogs(unassociatedSsObjectHistory)

int	nSsObjTotal = len(unassociatedSsObjectHistoryCat) if unassociatedSsObjectHistoryCat else 0

	diaSourceTable = diaSourceHistoryCat.to_pandas()

	drop

	assocResult = self.associator.run(diaSourceTable, idGenerator=idGenerator)

	objectsInTractPatch

	diaObjects = assocResult.diaObjects[objectsInTractPatch]

	assocDiaSources

	diaObjectTable

	assocDiaSourceTable

	associatedSsSources

	unassociatedSsObjects

Detailed Description

Pipeline for running DiaSource association in a DRP context.

Function Documentation

◆ _addDiaObjectCoords()

lsst.pipe.tasks.drpAssociationPipe._addDiaObjectCoords	(	self,
		objects,
		sources )

protected

Definition at line 483 of file drpAssociationPipe.py.

◆ _stackCatalogs()

lsst.pipe.tasks.drpAssociationPipe._stackCatalogs	(	self,
		catalogs,
		remove_columns = None,
		empty = None )

protected

Stack a list of catalogs.

Parameters
----------
catalogs : `list` of `astropy.table.Table`
    Input catalogs with the same columns to be combined.
remove_columns : `list` of `str` or None, optional
    List of column names to drop from the tables before stacking.

Returns
-------
`astropy.table.Table`
    The combined catalog.

Definition at line 377 of file drpAssociationPipe.py.

◆ _trimToPatch()

lsst.pipe.tasks.drpAssociationPipe._trimToPatch	(	self,
		cat,
		patchBox,
		wcs,
		innerTractSkyRegion = None )

protected

Create generator testing if a set of DiaSources are in the
patch/tract.

Parameters
----------
cat : `pandas.DataFrame`
    Catalog of DiaSources to test within patch/tract.
patchBox : `lsst.geom.Box2D`
    Bounding box of the patch.
wcs : `lsst.geom.SkyWcs`
    Wcs of the tract.
innerTractSkyRegion : `lsst.sphgeom.Box`, optional
    Region defining the inner non-overlapping part of a tract.

Returns
-------
isInPatch : `numpy.ndarray`, (N,)
    Booleans representing if the DiaSources are contained within the
    current patch and tract.

Definition at line 489 of file drpAssociationPipe.py.

◆ dropDiaSourceByDiaObjectId()

lsst.pipe.tasks.drpAssociationPipe.dropDiaSourceByDiaObjectId	(	self,
		droppedDiaObjectIds,
		diaSources )

Drop diaSources with diaObject IDs in the supplied list.

Parameters
----------
droppedDiaObjectIds : `pandas.DataFrame`
    DiaObjectIds to match and drop from the list of diaSources.
diaSources : `pandas.DataFrame`
    Catalog of diaSources to check and filter.

Returns
-------
filteredDiaSources : `pandas.DataFrame`
    The input diaSources with any rows matching the listed diaObjectIds
    removed.

Definition at line 524 of file drpAssociationPipe.py.

◆ prepareCatalogDict()

lsst.pipe.tasks.drpAssociationPipe.prepareCatalogDict	(		dataRefList,
			useVisitDetector = True )

Prepare lookup tables of the data references.

Parameters
----------
dataRefList : `list` of `lsst.daf.butler.DeferredDatasetHandle`
    The data references to make a lookup table for.
useVisitDetector : `bool`, optional
    Use both visit and detector in the dict key? If False, use only visit.

Returns
-------
`dict` of `lsst.daf.butler.DeferredDatasetHandle`
    Lookup table of the data references by visit (and optionally detector)

Definition at line 546 of file drpAssociationPipe.py.

◆ runSolarSystemAssociation()

lsst.pipe.tasks.drpAssociationPipe.runSolarSystemAssociation	(	self,
		diaCat,
		ssCat,
		visitSummary,
		patchBbox,
		patchWcs,
		innerTractSkyRegion,
		detector,
		visit )

Run Solar System object association and filter the results.

Parameters
----------
diaCat : `pandas.DataFrame`
    Catalog of detected diaSources on the image difference.
ssCat : `astropy.table.Table`
    Catalog of predicted coordinates of known Solar System objects.
visitSummary : `lsst.afw.table.ExposureCatalog`
    Table of calibration and metadata for all detectors in a visit.
patchBbox : `lsst.geom.Box2D`
    Bounding box of the patch.
patchWcs : `lsst.geom.SkyWcs`
    Wcs of the tract containing the patch.
innerTractSkyRegion : `lsst.sphgeom.Box`
    Region defining the inner non-overlapping part of a tract.
detector : `int`
    Detector number of the science exposure.
visit : `int`
    Visit number of the science exposure.

Returns
-------
ssoAssocResult : `lsst.pipe.base.Struct`
    Results struct with attributes:

    ``associatedSsSources``
        Table of DiaSources associated with Solar System objects.
        (`astropy.table.Table`)
    ``associatedSsDiaSources``
        Table of Solar System objects associated with DiaSources.
        (`astropy.table.Table`).
    ``unassociatedSsObjects``
        Table of Solar System objects in the patch not associated with
        any DiaSource (`astropy.table.Table`).
    ``unassociatedDiaSources``
        Table of DiaSources not associated with any Solar System object
        (`astropy.table.Table`).

Definition at line 400 of file drpAssociationPipe.py.

Variable Documentation

◆ assocDiaSources

lsst.pipe.tasks.drpAssociationPipe.assocDiaSources

Initial value:

1= self.dropDiaSourceByDiaObjectId(assocResult.diaObjects[~objectsInTractPatch].index,

2 assocResult.assocDiaSources)

Definition at line 357 of file drpAssociationPipe.py.

◆ assocDiaSourceTable

lsst.pipe.tasks.drpAssociationPipe.assocDiaSourceTable

Definition at line 372 of file drpAssociationPipe.py.

◆ associatedSsSources

lsst.pipe.tasks.drpAssociationPipe.associatedSsSources

Definition at line 373 of file drpAssociationPipe.py.

◆ assocResult

lsst.pipe.tasks.drpAssociationPipe.assocResult = self.associator.run(diaSourceTable, idGenerator=idGenerator)

Definition at line 344 of file drpAssociationPipe.py.

◆ diaCat

lsst.pipe.tasks.drpAssociationPipe.diaCat = ssoAssocResult.unassociatedDiaSources

Definition at line 292 of file drpAssociationPipe.py.

◆ diaInPatch

lsst.pipe.tasks.drpAssociationPipe.diaInPatch = self._trimToPatch(diaCat.to_pandas(), outerPatchBox, skyInfo.wcs)

Definition at line 300 of file drpAssociationPipe.py.

◆ diaObjects

lsst.pipe.tasks.drpAssociationPipe.diaObjects = assocResult.diaObjects[objectsInTractPatch]

Definition at line 352 of file drpAssociationPipe.py.

◆ diaObjectTable

lsst.pipe.tasks.drpAssociationPipe.diaObjectTable

Definition at line 371 of file drpAssociationPipe.py.

◆ diaSourceHistoryCat

lsst.pipe.tasks.drpAssociationPipe.diaSourceHistoryCat = self._stackCatalogs(diaSourceHistory)

Definition at line 321 of file drpAssociationPipe.py.

◆ diaSourceTable

lsst.pipe.tasks.drpAssociationPipe.diaSourceTable = diaSourceHistoryCat.to_pandas()

Definition at line 341 of file drpAssociationPipe.py.

◆ drop

lsst.pipe.tasks.drpAssociationPipe.drop

Definition at line 342 of file drpAssociationPipe.py.

◆ nDiaSrc

lsst.pipe.tasks.drpAssociationPipe.nDiaSrc = diaInPatch.sum()

Definition at line 302 of file drpAssociationPipe.py.

◆ nSsObj

lsst.pipe.tasks.drpAssociationPipe.nSsObj

Definition at line 294 of file drpAssociationPipe.py.

◆ nSsObjTotal

int lsst.pipe.tasks.drpAssociationPipe.nSsObjTotal = len(unassociatedSsObjectHistoryCat) if unassociatedSsObjectHistoryCat else 0

Definition at line 327 of file drpAssociationPipe.py.

◆ nSsSrc

lsst.pipe.tasks.drpAssociationPipe.nSsSrc

Definition at line 294 of file drpAssociationPipe.py.

◆ nSsSrcTotal

int lsst.pipe.tasks.drpAssociationPipe.nSsSrcTotal = len(ssSourceHistoryCat) if ssSourceHistoryCat else 0

Definition at line 325 of file drpAssociationPipe.py.

◆ objectsInTractPatch

lsst.pipe.tasks.drpAssociationPipe.objectsInTractPatch

Initial value:

=  self._trimToPatch(assocResult.diaObjects,
                                                innerPatchBox,
                                                skyInfo.wcs,
                                                innerTractSkyRegion=innerTractSkyRegion)

Definition at line 348 of file drpAssociationPipe.py.

◆ ssDiaSourceHistoryCat

lsst.pipe.tasks.drpAssociationPipe.ssDiaSourceHistoryCat = self._stackCatalogs(ssDiaSourceHistory)

Definition at line 322 of file drpAssociationPipe.py.

◆ ssSourceHistoryCat

lsst.pipe.tasks.drpAssociationPipe.ssSourceHistoryCat = self._stackCatalogs(ssSourceHistory, remove_columns=['ra', 'dec'])

Definition at line 324 of file drpAssociationPipe.py.

◆ unassociatedSsObjectHistoryCat

lsst.pipe.tasks.drpAssociationPipe.unassociatedSsObjectHistoryCat = self._stackCatalogs(unassociatedSsObjectHistory)

Definition at line 326 of file drpAssociationPipe.py.

◆ unassociatedSsObjects

lsst.pipe.tasks.drpAssociationPipe.unassociatedSsObjects

Definition at line 374 of file drpAssociationPipe.py.

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _addDiaObjectCoords()

◆ _stackCatalogs()

◆ _trimToPatch()

◆ dropDiaSourceByDiaObjectId()

◆ prepareCatalogDict()

◆ runSolarSystemAssociation()

Variable Documentation

◆ assocDiaSources

◆ assocDiaSourceTable

◆ associatedSsSources

◆ assocResult

◆ diaCat

◆ diaInPatch

◆ diaObjects

◆ diaObjectTable

◆ diaSourceHistoryCat

◆ diaSourceTable

◆ drop

◆ nDiaSrc

◆ nSsObj

◆ nSsObjTotal

◆ nSsSrc

◆ nSsSrcTotal

◆ objectsInTractPatch

◆ ssDiaSourceHistoryCat

◆ ssSourceHistoryCat

◆ unassociatedSsObjectHistoryCat

◆ unassociatedSsObjects