lsst.fgcmcal g9c3108eb99+ae3892c209
Public Member Functions | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask:
lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask

Public Member Functions

def fgcmMakeAllStarObservations (self, groupedDataRefs, visitCat, sourceSchema, camera, calibFluxApertureRadius=None, visitCatDataRef=None, starObsDataRef=None, inStarObsCat=None)
 

Static Public Attributes

 ConfigClass = FgcmBuildStarsConfig
 
 RunnerClass = FgcmBuildStarsRunner
 

Detailed Description

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

Definition at line 91 of file fgcmBuildStars.py.

Member Function Documentation

◆ fgcmMakeAllStarObservations()

def lsst.fgcmcal.fgcmBuildStars.FgcmBuildStarsTask.fgcmMakeAllStarObservations (   self,
  groupedDataRefs,
  visitCat,
  sourceSchema,
  camera,
  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` or
    `~lsst.daf.butler.DeferredDatasetHandle`, grouped by visit.
visitCat : `~afw.table.BaseCatalog`
    Catalog with visit data for FGCM
sourceSchema : `~lsst.afw.table.Schema`
    Schema for the input src catalogs.
camera : `~lsst.afw.cameraGeom.Camera`
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 180 of file fgcmBuildStars.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 95 of file fgcmBuildStars.py.

◆ RunnerClass

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

Definition at line 96 of file fgcmBuildStars.py.


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