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)

	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 447 of file drpAssociationPipe.py.

    def _addDiaObjectCoords(self, objects, sources):
        obj = objects[['ra', 'dec']].rename(columns={"ra": "coord_ra", "dec": "coord_dec"})
        df = pd.merge(sources.reset_index(), obj, left_on='diaObjectId', right_index=True,
                      how='inner').set_index('diaSourceId')
        return df
 

◆ _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 341 of file drpAssociationPipe.py.

    def _stackCatalogs(self, catalogs, remove_columns=None, empty=None):
        """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.
        """
        if catalogs:
            sourceHistory = tb.vstack(catalogs)
            if remove_columns is not None:
                sourceHistory.remove_columns(remove_columns)
            return sourceHistory
        else:
            return empty
 

◆ _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 453 of file drpAssociationPipe.py.

    def _trimToPatch(self, cat, patchBox, wcs, innerTractSkyRegion=None):
        """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.
        """
        isInPatch = np.zeros(len(cat), dtype=bool)
 
        for idx, row in cat.reset_index().iterrows():
            spPoint = geom.SpherePoint(row["ra"], row["dec"], geom.degrees)
            pxCoord = wcs.skyToPixel(spPoint)
            ra_rad = np.deg2rad(row["ra"])
            dec_rad = np.deg2rad(row["dec"])
            isInPatch[idx] = patchBox.contains(pxCoord)
 
            if innerTractSkyRegion is not None:
                isInPatch[idx] &= innerTractSkyRegion.contains(ra_rad, dec_rad)
 
        return isInPatch
 

◆ 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 488 of file drpAssociationPipe.py.

    def 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.
        """
        toDrop = diaSources['diaObjectId'].isin(droppedDiaObjectIds)
 
        # Keep only rows that do NOT match
        return diaSources.loc[~toDrop].copy()
 
 

◆ 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 510 of file drpAssociationPipe.py.

def 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)
    """
    dataDict = {}
 
    if useVisitDetector:
        for dataRef in dataRefList:
            dataDict[(dataRef.dataId["visit"], dataRef.dataId["detector"])] = dataRef
    else:
        for dataRef in dataRefList:
            dataDict[dataRef.dataId["visit"]] = dataRef
    return dataDict

◆ 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 364 of file drpAssociationPipe.py.

                                  ):
        """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`).
        """
        # Get the exposure metadata from the detector's row in the visitSummary table.
        ssoAssocResult = self.solarSystemAssociator.run(
            diaCat,
            ssCat,
            visitInfo=visitSummary.find(detector).visitInfo,
            bbox=visitSummary.find(detector).getBBox(),
            wcs=visitSummary.find(detector).wcs,
        )
 
        ssInTractPatch = self._trimToPatch(ssoAssocResult.associatedSsSources.to_pandas(),
                                           patchBbox,
                                           patchWcs,
                                           innerTractSkyRegion=innerTractSkyRegion)
        associatedSsSources = ssoAssocResult.associatedSsSources[ssInTractPatch].copy()
        assocDiaSrcIds = set(associatedSsSources['diaSourceId'])
        diaSrcMask = [diaId in assocDiaSrcIds for diaId in ssoAssocResult.ssoAssocDiaSources['diaSourceId']]
        associatedSsDiaSources = ssoAssocResult.ssoAssocDiaSources[np.array(diaSrcMask)]
 
        ssObjInTractPatch = self._trimToPatch(ssoAssocResult.unassociatedSsObjects.to_pandas(),
                                              patchBbox,
                                              patchWcs,
                                              innerTractSkyRegion=innerTractSkyRegion)
        unassociatedSsObjects = ssoAssocResult.unassociatedSsObjects[ssObjInTractPatch].copy()
        # Update the table of Solar System objects that were not found with the
        # visit and detector where they were predicted.
        if len(unassociatedSsObjects) > 0:
            unassociatedSsObjects['visit'] = visit
            unassociatedSsObjects['detector'] = detector
 
        return pipeBase.Struct(
            associatedSsSources=associatedSsSources,
            associatedSsDiaSources=associatedSsDiaSources,
            unassociatedSsObjects=unassociatedSsObjects,
            unassociatedDiaSources=ssoAssocResult.unAssocDiaSources
        )
 

Variable Documentation

◆ assocDiaSources

lsst.pipe.tasks.drpAssociationPipe.assocDiaSources

Initial value:

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

2 assocResult.assocDiaSources)

Definition at line 326 of file drpAssociationPipe.py.

◆ assocDiaSourceTable

lsst.pipe.tasks.drpAssociationPipe.assocDiaSourceTable

Definition at line 336 of file drpAssociationPipe.py.

◆ associatedSsSources

lsst.pipe.tasks.drpAssociationPipe.associatedSsSources

Definition at line 337 of file drpAssociationPipe.py.

◆ assocResult

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

Definition at line 313 of file drpAssociationPipe.py.

◆ diaCat

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

Definition at line 264 of file drpAssociationPipe.py.

◆ diaInPatch

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

Definition at line 272 of file drpAssociationPipe.py.

◆ diaObjects

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

Definition at line 321 of file drpAssociationPipe.py.

◆ diaObjectTable

lsst.pipe.tasks.drpAssociationPipe.diaObjectTable

Definition at line 335 of file drpAssociationPipe.py.

◆ diaSourceHistoryCat

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

Definition at line 291 of file drpAssociationPipe.py.

◆ diaSourceTable

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

Definition at line 310 of file drpAssociationPipe.py.

◆ drop

lsst.pipe.tasks.drpAssociationPipe.drop

Definition at line 311 of file drpAssociationPipe.py.

◆ nDiaSrc

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

Definition at line 274 of file drpAssociationPipe.py.

◆ nSsObj

lsst.pipe.tasks.drpAssociationPipe.nSsObj

Definition at line 266 of file drpAssociationPipe.py.

◆ nSsObjTotal

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

Definition at line 296 of file drpAssociationPipe.py.

◆ nSsSrc

lsst.pipe.tasks.drpAssociationPipe.nSsSrc

Definition at line 266 of file drpAssociationPipe.py.

◆ nSsSrcTotal

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

Definition at line 294 of file drpAssociationPipe.py.

◆ objectsInTractPatch

lsst.pipe.tasks.drpAssociationPipe.objectsInTractPatch

Initial value:

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

Definition at line 317 of file drpAssociationPipe.py.

◆ ssSourceHistoryCat

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

Definition at line 293 of file drpAssociationPipe.py.

◆ unassociatedSsObjectHistoryCat

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

Definition at line 295 of file drpAssociationPipe.py.

◆ unassociatedSsObjects

lsst.pipe.tasks.drpAssociationPipe.unassociatedSsObjects

Definition at line 338 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

◆ ssSourceHistoryCat

◆ unassociatedSsObjectHistoryCat

◆ unassociatedSsObjects