lsst.fgcmcal  20.0.0-6-g9a5b7a1+479f177d97
Public Member Functions | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask:
lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask

Public Member Functions

def findAndGroupDataRefs (self, butler, dataRefs)
 
def fgcmMakeAllStarObservations (self, groupedDataRefs, visitCat, calibFluxApertureRadius=None, visitCatDataRef=None, starObsDataRef=None, inStarObsCat=None)
 
def runDataRef (self, butler, dataRefs)
 
def fgcmMakeVisitCatalog (self, camera, groupedDataRefs, visitCatDataRef=None, inVisitCat=None)
 
def fgcmMatchStars (self, butler, visitCat, obsCat)
 

Static Public Attributes

 ConfigClass = FgcmBuildStarsTableConfig
 
 RunnerClass = FgcmBuildStarsRunner
 

Detailed Description

Build stars for the FGCM global calibration, using sourceTable_visit catalogs.

Definition at line 96 of file fgcmBuildStarsTable.py.

Member Function Documentation

◆ fgcmMakeAllStarObservations()

def lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.fgcmMakeAllStarObservations (   self,
  groupedDataRefs,
  visitCat,
  calibFluxApertureRadius = None,
  visitCatDataRef = None,
  starObsDataRef = None,
  inStarObsCat = None 
)
Compile all good star observations from visits in visitCat.  Checkpoint files
will be stored if both visitCatDataRef and starObsDataRef are not None.

Parameters
----------
groupedDataRefs: `dict` of `list`s
   Lists of `lsst.daf.persistence.ButlerDataRef`, grouped by visit.
visitCat: `afw.table.BaseCatalog`
   Catalog with visit data for FGCM
calibFluxApertureRadius: `float`, optional
   Aperture radius for calibration flux.
visitCatDataRef: `lsst.daf.persistence.ButlerDataRef`, optional
   Dataref to write visitCat for checkpoints
starObsDataRef: `lsst.daf.persistence.ButlerDataRef`, optional
   Dataref to write the star observation catalog for checkpoints.
inStarObsCat: `afw.table.BaseCatalog`
   Input observation catalog.  If this is incomplete, observations
   will be appended from when it was cut off.

Returns
-------
fgcmStarObservations: `afw.table.BaseCatalog`
   Full catalog of good observations.

Raises
------
RuntimeError: Raised if doSubtractLocalBackground is True and
   calibFluxApertureRadius is not set.

Reimplemented from lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.

Definition at line 153 of file fgcmBuildStarsTable.py.

◆ fgcmMakeVisitCatalog()

def lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMakeVisitCatalog (   self,
  camera,
  groupedDataRefs,
  visitCatDataRef = None,
  inVisitCat = None 
)
inherited
Make a visit catalog with all the keys from each visit

Parameters
----------
camera: `lsst.afw.cameraGeom.Camera`
   Camera from the butler
groupedDataRefs: `dict`
   Dictionary with visit keys, and `list`s of
   `lsst.daf.persistence.ButlerDataRef`
visitCatDataRef: `lsst.daf.persistence.ButlerDataRef`, optional
   Dataref to write visitCat for checkpoints
inVisitCat: `afw.table.BaseCatalog`
   Input (possibly incomplete) visit catalog

Returns
-------
visitCat: `afw.table.BaseCatalog`

Definition at line 425 of file fgcmBuildStarsBase.py.

◆ fgcmMatchStars()

def lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMatchStars (   self,
  butler,
  visitCat,
  obsCat 
)
inherited
Use FGCM code to match observations into unique stars.

Parameters
----------
butler: `lsst.daf.persistence.Butler`
visitCat: `afw.table.BaseCatalog`
   Catalog with visit data for fgcm
obsCat: `afw.table.BaseCatalog`
   Full catalog of star observations for fgcm

Returns
-------
fgcmStarIdCat: `afw.table.BaseCatalog`
   Catalog of unique star identifiers and index keys
fgcmStarIndicesCat: `afwTable.BaseCatalog`
   Catalog of unique star indices
fgcmRefCat: `afw.table.BaseCatalog`
   Catalog of matched reference stars.
   Will be None if `config.doReferenceMatches` is False.

Definition at line 610 of file fgcmBuildStarsBase.py.

◆ findAndGroupDataRefs()

def lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.findAndGroupDataRefs (   self,
  butler,
  dataRefs 
)
Find and group dataRefs (by visit).

Parameters
----------
butler: `lsst.daf.persistence.Butler`
dataRefs: `list` of `lsst.daf.persistence.ButlerDataRef`
   Data references for the input visits.

Returns
-------
groupedDataRefs: `dict` [`int`, `list`]
   Dictionary with visit keys, and `list`s of `lsst.daf.persistence.ButlerDataRef`

Reimplemented from lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.

Definition at line 112 of file fgcmBuildStarsTable.py.

◆ runDataRef()

def lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.runDataRef (   self,
  butler,
  dataRefs 
)
inherited
Cross-match and make star list for FGCM Input

Parameters
----------
butler:  `lsst.daf.persistence.Butler`
dataRefs: `list` of `lsst.daf.persistence.ButlerDataRef`
   Source data references for the input visits.

Raises
------
RuntimeErrror: Raised if `config.doReferenceMatches` is set and
   an fgcmLookUpTable is not available, or if computeFluxApertureRadius()
   fails if the calibFlux is not a CircularAperture flux.

Definition at line 279 of file fgcmBuildStarsBase.py.

Member Data Documentation

◆ ConfigClass

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.ConfigClass = FgcmBuildStarsTableConfig
static

Definition at line 100 of file fgcmBuildStarsTable.py.

◆ RunnerClass

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.RunnerClass = FgcmBuildStarsRunner
static

Definition at line 101 of file fgcmBuildStarsTable.py.


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