lsst.fgcmcal  19.0.0-20-g3336a1e+6
Public Member Functions | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask:

Public Member Functions

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

Static Public Attributes

 ConfigClass = FgcmBuildStarsConfig
 
 RunnerClass = FgcmBuildStarsRunner
 

Detailed Description

Build stars for the FGCM global calibration

Definition at line 313 of file fgcmBuildStars.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.__init__ (   self,
  butler = None,
**  kwargs 
)
Instantiate an `FgcmBuildStarsTask`.

Parameters
----------
butler : `lsst.daf.persistence.Butler`

Definition at line 322 of file fgcmBuildStars.py.

Member Function Documentation

◆ fgcmMakeAllStarObservations()

def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.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.  Default is None.
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 (possibly incomplete) observation catalog

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

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

Definition at line 665 of file fgcmBuildStars.py.

◆ fgcmMakeVisitCatalog()

def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.fgcmMakeVisitCatalog (   self,
  camera,
  groupedDataRefs,
  visitCatDataRef = None,
  inVisitCat = None 
)
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 443 of file fgcmBuildStars.py.

◆ fgcmMatchStars()

def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.fgcmMatchStars (   self,
  butler,
  visitCat,
  obsCat 
)
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 888 of file fgcmBuildStars.py.

◆ findAndGroupDataRefs()

def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.findAndGroupDataRefs (   self,
  butler,
  dataRefs 
)
Find and group dataRefs (by visit).  If dataRefs is an empty list,
this will look for all source catalogs in a given repo.

Parameters
----------
butler: `lsst.daf.persistence.Butler`
dataRefs: `list` of `lsst.daf.persistence.ButlerDataRef`
   Data references for the input visits.
   If this is an empty list, all visits with src catalogs in
   the repository are used.

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

Definition at line 573 of file fgcmBuildStars.py.

◆ runDataRef()

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

Parameters
----------
butler:  `lsst.daf.persistence.Butler`
dataRefs: `list` of `lsst.daf.persistence.ButlerDataRef`
   Data references for the input visits.
   If this is an empty list, all visits with src catalogs in
   the repository are used.
   Only one individual dataRef from a visit need be specified
   and the code will find the other source catalogs from
   each visit.

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 350 of file fgcmBuildStars.py.

Member Data Documentation

◆ ConfigClass

lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.ConfigClass = FgcmBuildStarsConfig
static

Definition at line 318 of file fgcmBuildStars.py.

◆ RunnerClass

lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.RunnerClass = FgcmBuildStarsRunner
static

Definition at line 319 of file fgcmBuildStars.py.


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