donutCatalogToAstropy#

lsst.ts.wep.task.donutCatalogToAstropy(donutCatalog, filterName, blendCentersX=None, blendCentersY=None, sortFilterIdx=0)#

Reformat afwCatalog into an astropy QTable sorted by flux with the brightest objects at the top.

Parameters:

  • donutCatalog (lsst.afw.table.SimpleCatalog or None) – lsst.afw.table.SimpleCatalog object returned by the ReferenceObjectLoader search over the detector footprint. If None then it will return an empty QTable. (the default is None.)

  • filterName (str or list of str) – Name of catalog flux filter(s). If donutCatalog is not None then this cannot be None. (the default is None.)

  • blendCentersX (list or None, optional) – X pixel position of centroids for blended objects. List should be the same length as the donutCatalog. If blendCentersY is not None then this cannot be None. (the default is None.)

  • blendCentersY (list or None, optional) – Y pixel position of centroids for blended objects. List should be the same length as the donutCatalog. If blendCentersX is not None then this cannot be None. (the default is None.)

  • sortFilterIdx (int, optional) – Index for which filter in filterName to sort the entire catalog by brightness. (the default is 0.)

Returns:

Complete catalog of reference sources in the pointing.

Return type:

astropy.table.QTable

Raises:

  • ValueError – Raised if filterName is None when donutCatalog is not None.

  • ValueError – Raised if blendCentersX and blendCentersY are not the same length.

  • ValueError – Raised if blendCentersX and blendCentersY are not both a list or are not both None.