Inheritance diagram for lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig:

Public Member Functions
def	setDefaults (self)

Public Attributes
	instFluxField

	localBackgroundFluxField

	apertureInnerInstFluxField

	apertureOuterInstFluxField

	psfCandidateName

Detailed Description

Config for FgcmBuildStarsTableTask

Definition at line 165 of file fgcmBuildStarsTable.py.

Member Function Documentation

◆ setDefaults()

def lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.setDefaults ( self )

Reimplemented from lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.

Definition at line 175 of file fgcmBuildStarsTable.py.

     def setDefaults(self):
         super().setDefaults()
  
         # The names here correspond to the post-transformed
         # sourceTable_visit catalogs, which differ from the raw src
         # catalogs.  Therefore, all field and flag names cannot
         # be derived from the base config class.
         self.instFluxField = 'apFlux_12_0_instFlux'
         self.localBackgroundFluxField = 'localBackground_instFlux'
         self.apertureInnerInstFluxField = 'apFlux_12_0_instFlux'
         self.apertureOuterInstFluxField = 'apFlux_17_0_instFlux'
         self.psfCandidateName = 'calib_psf_candidate'
  
         sourceSelector = self.sourceSelector["science"]
  
         fluxFlagName = self.instFluxField[0: -len('instFlux')] + 'flag'
  
         sourceSelector.flags.bad = ['pixelFlags_edge',
                                     'pixelFlags_interpolatedCenter',
                                     'pixelFlags_saturatedCenter',
                                     'pixelFlags_crCenter',
                                     'pixelFlags_bad',
                                     'pixelFlags_interpolated',
                                     'pixelFlags_saturated',
                                     'centroid_flag',
                                     fluxFlagName]
  
         if self.doSubtractLocalBackground:
             localBackgroundFlagName = self.localBackgroundFluxField[0: -len('instFlux')] + 'flag'
             sourceSelector.flags.bad.append(localBackgroundFlagName)
  
         sourceSelector.signalToNoise.fluxField = self.instFluxField
         sourceSelector.signalToNoise.errField = self.instFluxField + 'Err'
  
         sourceSelector.isolated.parentName = 'parentSourceId'
         sourceSelector.isolated.nChildName = 'deblend_nChild'
  
         sourceSelector.unresolved.name = 'extendedness'
  
  

Member Data Documentation

◆ apertureInnerInstFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.apertureInnerInstFluxField

Definition at line 184 of file fgcmBuildStarsTable.py.

◆ apertureOuterInstFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.apertureOuterInstFluxField

Definition at line 185 of file fgcmBuildStarsTable.py.

◆ background

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.background

staticinherited

Initial value:

=  connectionTypes.Input(
        doc="Calexp background model",
        name="calexpBackground",
        storageClass="Background",
        dimensions=("instrument", "visit", "detector"),
        deferLoad=True,
        multiple=True,
    )

Definition at line 107 of file fgcmBuildStarsTable.py.

◆ camera

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.camera

staticinherited

Initial value:

=  connectionTypes.PrerequisiteInput(
        doc="Camera instrument",
        name="camera",
        storageClass="Camera",
        dimensions=("instrument",),
        lookupFunction=lookupStaticCalibrations,
        isCalibration=True,
    )

Definition at line 54 of file fgcmBuildStarsTable.py.

◆ ccdDataRefName

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.ccdDataRefName

staticinherited

Initial value:

=  pexConfig.Field(
        doc="dataRef name for the 'ccd' field, usually 'ccd' or 'detector'.",
        dtype=str,
        default="ccd"
    )

Definition at line 127 of file fgcmBuildStarsBase.py.

◆ coarseNside

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.coarseNside

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Healpix coarse Nside for partitioning matches",
        dtype=int,
        default=8,
    )

Definition at line 96 of file fgcmBuildStarsBase.py.

◆ densityCutMaxPerPixel

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.densityCutMaxPerPixel

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Density cut number of stars per pixel",
        dtype=int,
        default=1000,
    )

Definition at line 80 of file fgcmBuildStarsBase.py.

◆ densityCutNside

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.densityCutNside

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Density cut healpix nside",
        dtype=int,
        default=128,
    )

Definition at line 75 of file fgcmBuildStarsBase.py.

◆ doApplyWcsJacobian

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doApplyWcsJacobian

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Apply the jacobian of the WCS to the star observations prior to fit?",
        dtype=bool,
        default=True
    )

Definition at line 132 of file fgcmBuildStarsBase.py.

◆ doModelErrorsWithBackground

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doModelErrorsWithBackground

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Model flux errors with background term?",
        dtype=bool,
        default=True
    )

Definition at line 137 of file fgcmBuildStarsBase.py.

◆ doReferenceMatches

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doReferenceMatches

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Match reference catalog as additional constraint on calibration",
        dtype=bool,
        default=True,
    )

Definition at line 174 of file fgcmBuildStarsBase.py.

◆ doSubtractLocalBackground

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.doSubtractLocalBackground

staticinherited

Initial value:

=  pexConfig.Field(
        doc=("Subtract the local background before performing calibration? "
             "This is only supported for circular aperture calibration fluxes."),
        dtype=bool,
        default=False
    )

Definition at line 147 of file fgcmBuildStarsBase.py.

◆ fgcmLoadReferenceCatalog

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.fgcmLoadReferenceCatalog

staticinherited

Initial value:

=  pexConfig.ConfigurableField(
        target=FgcmLoadReferenceCatalogTask,
        doc="FGCM reference object loader",
    )

Definition at line 179 of file fgcmBuildStarsBase.py.

◆ fgcmLookUpTable

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.fgcmLookUpTable

staticinherited

Initial value:

=  connectionTypes.PrerequisiteInput(
        doc=("Atmosphere + instrument look-up-table for FGCM throughput and "
             "chromatic corrections."),
        name="fgcmLookUpTable",
        storageClass="Catalog",
        dimensions=("instrument",),
        deferLoad=True,
    )

Definition at line 63 of file fgcmBuildStarsTable.py.

◆ fgcmReferenceStars

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.fgcmReferenceStars

staticinherited

Initial value:

=  connectionTypes.Output(
        doc="Catalog of fgcm-matched reference stars",
        name="fgcmReferenceStars",
        storageClass="Catalog",
        dimensions=("instrument",),
    )

Definition at line 144 of file fgcmBuildStarsTable.py.

◆ fgcmStarIds

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.fgcmStarIds

staticinherited

Initial value:

=  connectionTypes.Output(
        doc="Catalog of fgcm calibration star IDs",
        name="fgcmStarIds",
        storageClass="Catalog",
        dimensions=("instrument",),
    )

Definition at line 130 of file fgcmBuildStarsTable.py.

◆ fgcmStarIndices

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.fgcmStarIndices

staticinherited

Initial value:

=  connectionTypes.Output(
        doc="Catalog of fgcm calibration star indices",
        name="fgcmStarIndices",
        storageClass="Catalog",
        dimensions=("instrument",),
    )

Definition at line 137 of file fgcmBuildStarsTable.py.

◆ fgcmStarObservations

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.fgcmStarObservations

staticinherited

Initial value:

=  connectionTypes.Output(
        doc="Catalog of star observations for fgcm",
        name="fgcmStarObservations",
        storageClass="Catalog",
        dimensions=("instrument",),
    )

Definition at line 123 of file fgcmBuildStarsTable.py.

◆ fgcmVisitCatalog

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.fgcmVisitCatalog

staticinherited

Initial value:

=  connectionTypes.Output(
        doc="Catalog of visit information for fgcm",
        name="fgcmVisitCatalog",
        storageClass="Catalog",
        dimensions=("instrument",),
    )

Definition at line 116 of file fgcmBuildStarsTable.py.

◆ instFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.instFluxField

Definition at line 182 of file fgcmBuildStarsTable.py.

◆ isolationRadius

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.isolationRadius

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Isolation radius (arcseconds)",
        dtype=float,
        default=2.0,
    )

Definition at line 70 of file fgcmBuildStarsBase.py.

◆ localBackgroundFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.localBackgroundFluxField

Definition at line 183 of file fgcmBuildStarsTable.py.

◆ matchNside

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.matchNside

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Healpix Nside for matching",
        dtype=int,
        default=4096,
    )

Definition at line 91 of file fgcmBuildStarsBase.py.

◆ matchRadius

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.matchRadius

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Match radius (arcseconds)",
        dtype=float,
        default=1.0,
    )

Definition at line 65 of file fgcmBuildStarsBase.py.

◆ minPerBand

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.minPerBand

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Minimum observations per band",
        dtype=int,
        default=2,
    )

Definition at line 60 of file fgcmBuildStarsBase.py.

◆ nVisitsPerCheckpoint

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.nVisitsPerCheckpoint

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Number of visits read between checkpoints",
        dtype=int,
        default=500,
    )

Definition at line 183 of file fgcmBuildStarsBase.py.

◆ physicalFilterMap

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.physicalFilterMap

staticinherited

Initial value:

=  pexConfig.DictField(
        doc="Mapping from 'physicalFilter' to band.",
        keytype=str,
        itemtype=str,
        default={},
    )

Definition at line 104 of file fgcmBuildStarsBase.py.

◆ primaryBands

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.primaryBands

staticinherited

Initial value:

=  pexConfig.ListField(
        doc=("Bands for 'primary' star matches. "
             "A star must be observed in one of these bands to be considered "
             "as a calibration star."),
        dtype=str,
        default=None
    )

Definition at line 115 of file fgcmBuildStarsBase.py.

◆ psfCandidateName

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.psfCandidateName

Definition at line 186 of file fgcmBuildStarsTable.py.

◆ randomSeed

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.randomSeed

staticinherited

Initial value:

=  pexConfig.Field(
        doc="Random seed for high density down-sampling.",
        dtype=int,
        default=None,
        optional=True,
    )

Definition at line 85 of file fgcmBuildStarsBase.py.

◆ refCat

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.refCat

staticinherited

Initial value:

=  connectionTypes.PrerequisiteInput(
        doc="Reference catalog to use for photometric calibration",
        name="cal_ref_cat",
        storageClass="SimpleCatalog",
        dimensions=("skypix",),
        deferLoad=True,
        multiple=True,
    )

Definition at line 78 of file fgcmBuildStarsTable.py.

◆ referenceCCD

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.referenceCCD

static

Initial value:

=  pexConfig.Field(
        doc="Reference CCD for checking PSF and background",
        dtype=int,
        default=40,
    )

Definition at line 169 of file fgcmBuildStarsTable.py.

◆ requiredBands

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.requiredBands

staticinherited

Initial value:

=  pexConfig.ListField(
        doc="Bands required for each star",
        dtype=str,
        default=(),
    )

Definition at line 110 of file fgcmBuildStarsBase.py.

◆ sourceSchema

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.sourceSchema

staticinherited

Initial value:

=  connectionTypes.InitInput(
        doc="Schema for source catalogs",
        name="src_schema",
        storageClass="SourceCatalog",
    )

Definition at line 72 of file fgcmBuildStarsTable.py.

◆ sourceSelector

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.sourceSelector

staticinherited

Initial value:

=  sourceSelectorRegistry.makeField(
        doc="How to select sources",
        default="science"
    )

Definition at line 158 of file fgcmBuildStarsBase.py.

◆ sourceTable_visit

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.sourceTable_visit

staticinherited

Initial value:

=  connectionTypes.Input(
        doc="Source table in parquet format, per visit",
        name="sourceTable_visit",
        storageClass="DataFrame",
        dimensions=("instrument", "visit"),
        deferLoad=True,
        multiple=True,
    )

Definition at line 87 of file fgcmBuildStarsTable.py.

◆ visitDataRefName

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.visitDataRefName

staticinherited

Initial value:

=  pexConfig.Field(
        doc="dataRef name for the 'visit' field, usually 'visit'.",
        dtype=str,
        default="visit"
    )

Definition at line 122 of file fgcmBuildStarsBase.py.

◆ visitSummary

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.visitSummary

staticinherited

Initial value:

=  connectionTypes.Input(
        doc=("Per-visit consolidated exposure metadata.  These catalogs use "
             "detector id for the id and must be sorted for fast lookups of a "
             "detector."),
        name="visitSummary",
        storageClass="ExposureCatalog",
        dimensions=("instrument", "visit"),
        deferLoad=True,
        multiple=True,
    )

Definition at line 96 of file fgcmBuildStarsTable.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/fgcmcal/22.0.1-15-g6a90155+515f58c32b/python/lsst/fgcmcal/fgcmBuildStarsTable.py

Static Public Attributes
	referenceCCD

	minPerBand

	matchRadius

	isolationRadius

	densityCutNside

	densityCutMaxPerPixel

	randomSeed

	matchNside

	coarseNside

	physicalFilterMap

	requiredBands

	primaryBands

	visitDataRefName

	ccdDataRefName

	doApplyWcsJacobian

	doModelErrorsWithBackground

	doSubtractLocalBackground

	sourceSelector

	doReferenceMatches

	fgcmLoadReferenceCatalog

	nVisitsPerCheckpoint

	camera

	fgcmLookUpTable

	sourceSchema

	refCat

	sourceTable_visit

	visitSummary

	background

	fgcmVisitCatalog

	fgcmStarObservations

	fgcmStarIds

	fgcmStarIndices

	fgcmReferenceStars

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ setDefaults()

Member Data Documentation

◆ apertureInnerInstFluxField

◆ apertureOuterInstFluxField

◆ background

◆ camera

◆ ccdDataRefName

◆ coarseNside

◆ densityCutMaxPerPixel

◆ densityCutNside

◆ doApplyWcsJacobian

◆ doModelErrorsWithBackground

◆ doReferenceMatches

◆ doSubtractLocalBackground

◆ fgcmLoadReferenceCatalog

◆ fgcmLookUpTable

◆ fgcmReferenceStars

◆ fgcmStarIds

◆ fgcmStarIndices

◆ fgcmStarObservations

◆ fgcmVisitCatalog

◆ instFluxField

◆ isolationRadius

◆ localBackgroundFluxField

◆ matchNside

◆ matchRadius

◆ minPerBand

◆ nVisitsPerCheckpoint

◆ physicalFilterMap

◆ primaryBands

◆ psfCandidateName

◆ randomSeed

◆ refCat

◆ referenceCCD

◆ requiredBands

◆ sourceSchema

◆ sourceSelector

◆ sourceTable_visit

◆ visitDataRefName

◆ visitSummary