lsst.fgcmcal g487adcacf7+8ef789b877
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask:
lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask

Public Member Functions

 __init__ (self, initInputs=None, **kwargs)
 
 fgcmMakeAllStarObservations (self, groupedHandles, visitCat, sourceSchema, camera, calibFluxApertureRadius=None)
 
 fgcmMakeVisitCatalog (self, camera, groupedHandles)
 
 fgcmMatchStars (self, visitCat, obsCat, lutHandle=None)
 

Public Attributes

 fgcmLoadReferenceCatalog
 

Protected Member Functions

 _fillVisitCatalog (self, visitCat, groupedHandles)
 
 _makeSourceMapper (self, sourceSchema)
 
 _makeFgcmVisitSchema (self, nCcd)
 
 _makeFgcmObjSchema (self)
 
 _makeFgcmObsSchema (self)
 
 _makeFgcmRefSchema (self, nReferenceBands)
 
 _getReferenceFilterNames (self, visitCat, stdFilterDict, stdLambdaDict)
 

Detailed Description

Base task to build stars for FGCM global calibration

Definition at line 187 of file fgcmBuildStarsBase.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.__init__ ( self,
initInputs = None,
** kwargs )

Member Function Documentation

◆ _fillVisitCatalog()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._fillVisitCatalog ( self,
visitCat,
groupedHandles )
protected
Fill the visit catalog with visit metadata

Parameters
----------
visitCat : `afw.table.BaseCatalog`
    Visit catalog.  See _makeFgcmVisitSchema() for schema definition.
groupedHandles : `dict` [`list` [`lsst.daf.butler.DeferredDatasetHandle`]]
    Dataset handles, grouped by visit.

Definition at line 268 of file fgcmBuildStarsBase.py.

◆ _getReferenceFilterNames()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._getReferenceFilterNames ( self,
visitCat,
stdFilterDict,
stdLambdaDict )
protected
Get the reference filter names, in wavelength order, from the visitCat and
information from the look-up-table.

Parameters
----------
visitCat: `afw.table.BaseCatalog`
   Catalog with visit data for FGCM
stdFilterDict: `dict`
   Mapping of filterName to stdFilterName from LUT
stdLambdaDict: `dict`
   Mapping of stdFilterName to stdLambda from LUT

Returns
-------
referenceFilterNames: `list`
   Wavelength-ordered list of reference filter names

Definition at line 631 of file fgcmBuildStarsBase.py.

◆ _makeFgcmObjSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmObjSchema ( self)
protected
Make a schema for the objIndexCat from fgcmMakeStars

Returns
-------
schema: `afwTable.Schema`

Definition at line 574 of file fgcmBuildStarsBase.py.

◆ _makeFgcmObsSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmObsSchema ( self)
protected
Make a schema for the obsIndexCat from fgcmMakeStars

Returns
-------
schema: `afwTable.Schema`

Definition at line 594 of file fgcmBuildStarsBase.py.

◆ _makeFgcmRefSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmRefSchema ( self,
nReferenceBands )
protected
Make a schema for the referenceCat from fgcmMakeStars

Parameters
----------
nReferenceBands: `int`
   Number of reference bands

Returns
-------
schema: `afwTable.Schema`

Definition at line 608 of file fgcmBuildStarsBase.py.

◆ _makeFgcmVisitSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmVisitSchema ( self,
nCcd )
protected
Make a schema for an fgcmVisitCatalog

Parameters
----------
nCcd: `int`
   Number of CCDs in the camera

Returns
-------
schema: `afwTable.Schema`

Definition at line 538 of file fgcmBuildStarsBase.py.

◆ _makeSourceMapper()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeSourceMapper ( self,
sourceSchema )
protected
Make a schema mapper for fgcm sources

Parameters
----------
sourceSchema: `afwTable.Schema`
   Default source schema from the butler

Returns
-------
sourceMapper: `afwTable.schemaMapper`
   Mapper to the FGCM source schema

Definition at line 338 of file fgcmBuildStarsBase.py.

◆ fgcmMakeAllStarObservations()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMakeAllStarObservations ( self,
groupedHandles,
visitCat,
sourceSchema,
camera,
calibFluxApertureRadius = None )
Compile all good star observations from visits in visitCat.

Parameters
----------
groupedHandles : `dict` [`list` [`lsst.daf.butler.DeferredDatasetHandle`]]
    Dataset handles, 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.
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 in lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.

Definition at line 198 of file fgcmBuildStarsBase.py.

◆ fgcmMakeVisitCatalog()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMakeVisitCatalog ( self,
camera,
groupedHandles )
Make a visit catalog with all the keys from each visit

Parameters
----------
camera: `lsst.afw.cameraGeom.Camera`
   Camera from the butler
groupedHandles: `dict` [`list` [`lsst.daf.butler.DeferredDatasetHandle`]]
    Dataset handles, grouped by visit.

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

Definition at line 232 of file fgcmBuildStarsBase.py.

◆ fgcmMatchStars()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMatchStars ( self,
visitCat,
obsCat,
lutHandle = None )
Use FGCM code to match observations into unique stars.

Parameters
----------
visitCat: `afw.table.BaseCatalog`
   Catalog with visit data for fgcm
obsCat: `afw.table.BaseCatalog`
   Full catalog of star observations for fgcm
lutHandle: `lsst.daf.butler.DeferredDatasetHandle`, optional
   Data reference to fgcm look-up table (used if matching reference stars).

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 392 of file fgcmBuildStarsBase.py.

Member Data Documentation

◆ fgcmLoadReferenceCatalog

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmLoadReferenceCatalog

Definition at line 487 of file fgcmBuildStarsBase.py.


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