Inheritance diagram for lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask:

Public Member Functions
	__init__ (self, initInputs=None, **kwargs)

	runQuantum (self, butlerQC, inputRefs, outputRefs)

	fgcmMakeAllStarObservations (self, groupedHandles, visitCat, sourceSchema, camera, calibFluxApertureRadius=None)

	fgcmMakeVisitCatalog (self, camera, groupedHandles, useScienceDetectors=False)

	fgcmMatchStars (self, visitCat, obsCat, lutHandle=None)

Public Attributes
	sourceSchema = initInputs["sourceSchema"].schema

	fgcmLoadReferenceCatalog

Static Public Attributes
	ConfigClass = FgcmBuildStarsTableConfig

bool	canMultiprocess = False

Protected Member Functions
	_groupHandles (self, sourceTableHandleDict, visitSummaryHandleDict)

	_get_sourceTable_visit_columns (self, inColumns)

	_fillVisitCatalog (self, visitCat, groupedHandles, defaultPixelScale)

	_makeSourceMapper (self, sourceSchema)

	_makeFgcmVisitSchema (self, nCcd)

	_makeFgcmObjSchema (self)

	_makeFgcmObsSchema (self)

	_makeFgcmRefSchema (self, nReferenceBands)

	_getReferenceFilterNames (self, visitCat, stdFilterDict, stdLambdaDict)

Static Protected Attributes
str	_DefaultName = "fgcmBuildStarsTable"

Detailed Description

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

Definition at line 209 of file fgcmBuildStarsTable.py.

Constructor & Destructor Documentation

◆ init()

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.__init__	(		self,
			initInputs = None,
		**	kwargs )

Definition at line 218 of file fgcmBuildStarsTable.py.

Member Function Documentation

◆ _fillVisitCatalog()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._fillVisitCatalog	(	self,
		visitCat,
		groupedHandles,
		defaultPixelScale )

protectedinherited

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.
defaultPixelScale : `float`
    Default pixel scale to use if not in visit summary (arcsecond/pixel).

Definition at line 273 of file fgcmBuildStarsBase.py.

◆ _get_sourceTable_visit_columns()

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask._get_sourceTable_visit_columns	(		self,
			inColumns )

protected

Get the sourceTable_visit columns from the config.

Parameters
----------
inColumns : `list`
    List of columns available in the sourceTable_visit

Returns
-------
columns : `list`
    List of columns to read from sourceTable_visit.

Definition at line 460 of file fgcmBuildStarsTable.py.

◆ _getReferenceFilterNames()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._getReferenceFilterNames	(	self,
		visitCat,
		stdFilterDict,
		stdLambdaDict )

protectedinherited

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

◆ _groupHandles()

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask._groupHandles	(	self,
		sourceTableHandleDict,
		visitSummaryHandleDict )

protected

Group sourceTable and visitSummary handles.

Parameters
----------
sourceTableHandleDict : `dict` [`int`, `str`]
    Dict of source tables, keyed by visit.
visitSummaryHandleDict : `dict` [int, `str`]
    Dict of visit summary catalogs, keyed by visit.

Returns
-------
groupedHandles : `dict` [`int`, `list`]
    Dictionary with sorted visit keys, and `list`s with
    `lsst.daf.butler.DeferredDataSetHandle`.  The first
    item in the list will be the visitSummary ref, and
    the second will be the source table ref.

Definition at line 293 of file fgcmBuildStarsTable.py.

◆ _makeFgcmObjSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmObjSchema ( self )

protectedinherited

Make a schema for the objIndexCat from fgcmMakeStars

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

Definition at line 600 of file fgcmBuildStarsBase.py.

◆ _makeFgcmObsSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmObsSchema ( self )

protectedinherited

Make a schema for the obsIndexCat from fgcmMakeStars

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

Definition at line 620 of file fgcmBuildStarsBase.py.

◆ _makeFgcmRefSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmRefSchema	(		self,
			nReferenceBands )

protectedinherited

Make a schema for the referenceCat from fgcmMakeStars

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

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

Definition at line 634 of file fgcmBuildStarsBase.py.

◆ _makeFgcmVisitSchema()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeFgcmVisitSchema	(		self,
			nCcd )

protectedinherited

Make a schema for an fgcmVisitCatalog

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

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

Definition at line 561 of file fgcmBuildStarsBase.py.

◆ _makeSourceMapper()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask._makeSourceMapper	(		self,
			sourceSchema )

protectedinherited

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

◆ fgcmMakeAllStarObservations()

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.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 from lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.

Definition at line 320 of file fgcmBuildStarsTable.py.

◆ fgcmMakeVisitCatalog()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMakeVisitCatalog	(	self,
		camera,
		groupedHandles,
		useScienceDetectors = False )

inherited

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.
useScienceDetectors : `bool`, optional
    Limit to science detectors?

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

Definition at line 233 of file fgcmBuildStarsBase.py.

◆ fgcmMatchStars()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMatchStars	(	self,
		visitCat,
		obsCat,
		lutHandle = None )

inherited

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

◆ runQuantum()

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.runQuantum	(	self,
		butlerQC,
		inputRefs,
		outputRefs )

Definition at line 223 of file fgcmBuildStarsTable.py.

Member Data Documentation

◆ _DefaultName

str lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask._DefaultName = "fgcmBuildStarsTable"

staticprotected

Definition at line 214 of file fgcmBuildStarsTable.py.

◆ canMultiprocess

bool lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.canMultiprocess = False

static

Definition at line 216 of file fgcmBuildStarsTable.py.

◆ ConfigClass

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.ConfigClass = FgcmBuildStarsTableConfig

static

Definition at line 213 of file fgcmBuildStarsTable.py.

◆ fgcmLoadReferenceCatalog

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmLoadReferenceCatalog

inherited

Definition at line 510 of file fgcmBuildStarsBase.py.

◆ sourceSchema

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableTask.sourceSchema = initInputs["sourceSchema"].schema

Definition at line 221 of file fgcmBuildStarsTable.py.

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

python/lsst/fgcmcal/fgcmBuildStarsTable.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _fillVisitCatalog()

◆ _get_sourceTable_visit_columns()

◆ _getReferenceFilterNames()

◆ _groupHandles()

◆ _makeFgcmObjSchema()

◆ _makeFgcmObsSchema()

◆ _makeFgcmRefSchema()

◆ _makeFgcmVisitSchema()

◆ _makeSourceMapper()

◆ fgcmMakeAllStarObservations()

◆ fgcmMakeVisitCatalog()

◆ fgcmMatchStars()

◆ runQuantum()

Member Data Documentation

◆ _DefaultName

◆ canMultiprocess

◆ ConfigClass

◆ fgcmLoadReferenceCatalog

◆ sourceSchema

◆ init()