Inheritance diagram for lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask:

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

	runQuantum (self, butlerQC, inputRefs, outputRefs)

	run (self, *, camera, visit_summary_handle_dict, isolated_star_cat_handle_dict, isolated_star_source_handle_dict, lookup_table_handle)

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

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

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

Public Attributes
	fgcmLoadReferenceCatalog

Static Public Attributes
	ConfigClass = FgcmBuildFromIsolatedStarsConfig

bool	canMultiprocess = False

Protected Member Functions
	_make_all_star_obs_from_isolated_stars (self, isolated_star_cat_handle_dict, isolated_star_source_handle_dict, visit_cat, camera, calib_flux_aperture_radius=None, use_science_detectors=False, input_star_ids=None, return_observations=False)

	_density_downsample (self, fgcm_obj)

	_mark_reserve_stars (self, fgcm_obj)

	_associate_reference_stars (self, lookup_table_handle, visit_cat, fgcm_obj)

	_compute_delta_aper_summary_statistics (self, visit_cat, star_obs)

	_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 = "fgcmBuildFromIsolatedStars"

Detailed Description

Build star catalog for FGCM global calibration, using the isolated star catalogs.

Definition at line 185 of file fgcmBuildFromIsolatedStars.py.

Constructor & Destructor Documentation

◆ init()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask.__init__	(		self,
			initInputs = None,
		**	kwargs )

Definition at line 193 of file fgcmBuildFromIsolatedStars.py.

Member Function Documentation

◆ _associate_reference_stars()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask._associate_reference_stars	(	self,
		lookup_table_handle,
		visit_cat,
		fgcm_obj )

protected

Associate fgcm isolated stars with reference stars.

Parameters
----------
lookup_table_handle : `lsst.daf.butler.DeferredDatasetHandle`, optional
    Data reference to fgcm look-up table (used if matching reference stars).
visit_cat : `lsst.afw.table.ExposureCatalog`
    Catalog of per-visit data.
fgcm_obj : `astropy.table.Table`
    Catalog of per-star ids and positions

Returns
-------
ref_cat : `astropy.table.Table`
    Catalog of reference stars matched to fgcm stars.

Definition at line 800 of file fgcmBuildFromIsolatedStars.py.

◆ _compute_delta_aper_summary_statistics()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask._compute_delta_aper_summary_statistics	(	self,
		visit_cat,
		star_obs )

protected

Compute delta aperture summary statistics (per visit).

Parameters
----------
visit_cat : `lsst.afw.table.ExposureCatalog`
    Catalog of per-visit data.
star_obs : `astropy.table.Table`
    Catalog of individual star observations.

Definition at line 913 of file fgcmBuildFromIsolatedStars.py.

◆ _density_downsample()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask._density_downsample	(		self,
			fgcm_obj )

protected

Downsample stars according to density.

Parameters
----------
fgcm_obj : `astropy.table.Table`
    Catalog of per-star ids and positions.

Returns
-------
star_ids : `np.ndarray`
    Array of downsampled isolated star ids.

Definition at line 743 of file fgcmBuildFromIsolatedStars.py.

◆ _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.

◆ _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.

◆ _make_all_star_obs_from_isolated_stars()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask._make_all_star_obs_from_isolated_stars	(	self,
		isolated_star_cat_handle_dict,
		isolated_star_source_handle_dict,
		visit_cat,
		camera,
		calib_flux_aperture_radius = None,
		use_science_detectors = False,
		input_star_ids = None,
		return_observations = False )

protected

Make all the star observations from isolated star catalogs.

This is intended to be run in two passes. In the first pass, a limited
set of columns is read in (only what is required to select potential
"good stars") and the stars are returned. In the second pass, the full
set of columns is read and only stars that are in input_star_ids
are put into the aggregated tables.

Parameters
----------
isolated_star_cat_handle_dict : `dict` [`int`, `lsst.daf.butler.DeferredDatasetHandle`]
    Isolated star catalog dataset handles, with the tract as key.
isolated_star_source_handle_dict : `dict` [`int`, `lsst.daf.butler.DeferredDatasetHandle`]
    Isolated star source dataset handles, with the tract as key.
visit_cat : `lsst.afw.table.ExposureCatalog`
    Catalog of per-visit data.
camera : `lsst.afw.cameraGeom.Camera`
    The camera object.
calib_flux_aperture_radius : `float`, optional
    Radius for the calibration flux aperture.
use_science_detectors : `bool`, optional
    Only use science detectors?
input_star_ids : `np.ndarray`, optional
    Array of star IDs to use. Used for second pass and
    full load.
return_observations : `bool`, optional
    Return the observations? Should be False for first pass.

Returns
-------
fgcm_obj : `astropy.table.Table`
    Catalog of ids and positions for each star.
star_obs : `astropy.table.Table`
    Catalog of individual star observations if
    return_observations is True.

Definition at line 366 of file fgcmBuildFromIsolatedStars.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.

◆ _mark_reserve_stars()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask._mark_reserve_stars	(		self,
			fgcm_obj )

protected

Run the star reservation task to flag reserved stars.

Parameters
----------
fgcm_obj : `astropy.table.Table`
    Catalog of per-star ids and positions.

Definition at line 786 of file fgcmBuildFromIsolatedStars.py.

◆ fgcmMakeAllStarObservations()

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmMakeAllStarObservations	(	self,
		groupedHandles,
		visitCat,
		sourceSchema,
		camera,
		calibFluxApertureRadius = None )

inherited

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

◆ run()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask.run	(		self,
		*	,
			camera,
			visit_summary_handle_dict,
			isolated_star_cat_handle_dict,
			isolated_star_source_handle_dict,
			lookup_table_handle )

Run the fgcmBuildFromIsolatedStarsTask.

Parameters
----------
camera : `lsst.afw.cameraGeom.Camera`
    Camera object.
visit_summary_handle_dict : `dict` [`int`, [`lsst.daf.butler.DeferredDatasetHandle`]]
    Visit summary dataset handles, with the visit as key.
isolated_star_cat_handle_dict : `dict` [`int`, `lsst.daf.butler.DeferredDatasetHandle`]
    Isolated star catalog dataset handles, with the tract as key.
isolated_star_source_handle_dict : `dict` [`int`, `lsst.daf.butler.DeferredDatasetHandle`]
    Isolated star source dataset handles, with the tract as key.
lookup_table_handle : `lsst.daf.butler.DeferredDatasetHandle`
    Data reference to fgcm look-up table.

Returns
-------
struct : `lsst.pipe.base.struct`
    Catalogs for persistence, with attributes:

    ``fgcm_visit_catalog``
        Catalog of per-visit data (`lsst.afw.table.ExposureCatalog`).
    ``fgcm_star_observations``
        Catalog of individual star observations (`astropy.table.Table`).
    ``fgcm_star_ids``
        Catalog of per-star ids and positions (`astropy.table.Table`).
    ``fgcm_reference_stars``
        Catalog of reference stars matched to fgcm stars (`astropy.table.Table`).

Definition at line 257 of file fgcmBuildFromIsolatedStars.py.

◆ runQuantum()

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask.runQuantum	(	self,
		butlerQC,
		inputRefs,
		outputRefs )

Definition at line 197 of file fgcmBuildFromIsolatedStars.py.

Member Data Documentation

◆ _DefaultName

str lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask._DefaultName = "fgcmBuildFromIsolatedStars"

staticprotected

Definition at line 189 of file fgcmBuildFromIsolatedStars.py.

◆ canMultiprocess

bool lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask.canMultiprocess = False

static

Definition at line 191 of file fgcmBuildFromIsolatedStars.py.

◆ ConfigClass

lsst.fgcmcal.fgcmBuildFromIsolatedStars.FgcmBuildFromIsolatedStarsTask.ConfigClass = FgcmBuildFromIsolatedStarsConfig

static

Definition at line 188 of file fgcmBuildFromIsolatedStars.py.

◆ fgcmLoadReferenceCatalog

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsBaseTask.fgcmLoadReferenceCatalog

inherited

Definition at line 510 of file fgcmBuildStarsBase.py.

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

python/lsst/fgcmcal/fgcmBuildFromIsolatedStars.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _associate_reference_stars()

◆ _compute_delta_aper_summary_statistics()

◆ _density_downsample()

◆ _fillVisitCatalog()

◆ _getReferenceFilterNames()

◆ _make_all_star_obs_from_isolated_stars()

◆ _makeFgcmObjSchema()

◆ _makeFgcmObsSchema()

◆ _makeFgcmRefSchema()

◆ _makeFgcmVisitSchema()

◆ _makeSourceMapper()

◆ _mark_reserve_stars()

◆ fgcmMakeAllStarObservations()

◆ fgcmMakeVisitCatalog()

◆ fgcmMatchStars()

◆ run()

◆ runQuantum()

Member Data Documentation

◆ _DefaultName

◆ canMultiprocess

◆ ConfigClass

◆ fgcmLoadReferenceCatalog

◆ init()