lsst.fgcmcal g3845412f31+36bd37a136
Loading...
Searching...
No Matches
lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig:
lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections

Public Member Functions

 setDefaults (self)
 
 getSpatialBoundsConnections (self)
 

Static Public Attributes

 referenceCCD
 
 instFluxField
 
 minPerBand
 
 matchRadius
 
 isolationRadius
 
 densityCutNside
 
 densityCutMaxPerPixel
 
 randomSeed
 
 matchNside
 
 coarseNside
 
 physicalFilterMap
 
 requiredBands
 
 primaryBands
 
 doApplyWcsJacobian
 
 doModelErrorsWithBackground
 
 psfCandidateName
 
 doSubtractLocalBackground
 
 localBackgroundFluxField
 
 sourceSelector
 
 apertureInnerInstFluxField
 
 apertureOuterInstFluxField
 
 doReferenceMatches
 
 fgcmLoadReferenceCatalog
 
 nVisitsPerCheckpoint
 
 camera
 
 fgcmLookUpTable
 
 sourceSchema
 
 refCat
 
 sourceTable_visit
 
 visitSummary
 
 fgcmVisitCatalog
 
 fgcmStarObservations
 
 fgcmStarIds
 
 fgcmStarIndices
 
 fgcmReferenceStars
 

Detailed Description

Config for FgcmBuildStarsTableTask

Definition at line 154 of file fgcmBuildStarsTable.py.

Member Function Documentation

◆ getSpatialBoundsConnections()

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.getSpatialBoundsConnections ( self)
inherited

Definition at line 150 of file fgcmBuildStarsTable.py.

◆ setDefaults()

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

Member Data Documentation

◆ apertureInnerInstFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.apertureInnerInstFluxField
staticinherited
Initial value:
= pexConfig.Field(
doc=("Full name of instFlux field that contains inner aperture "
"flux for aperture correction proxy"),
dtype=str,
default='base_CircularApertureFlux_12_0_instFlux'
)

Definition at line 143 of file fgcmBuildStarsBase.py.

◆ apertureOuterInstFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.apertureOuterInstFluxField
staticinherited
Initial value:
= pexConfig.Field(
doc=("Full name of instFlux field that contains outer aperture "
"flux for aperture correction proxy"),
dtype=str,
default='base_CircularApertureFlux_17_0_instFlux'
)

Definition at line 149 of file fgcmBuildStarsBase.py.

◆ camera

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConnections.camera
staticinherited
Initial value:
= connectionTypes.PrerequisiteInput(
doc="Camera instrument",
name="camera",
storageClass="Camera",
dimensions=("instrument",),
isCalibration=True,
)

Definition at line 53 of file fgcmBuildStarsTable.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 90 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 74 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 69 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 113 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 118 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 155 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 128 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 160 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 61 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 133 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 119 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 126 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 112 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 105 of file fgcmBuildStarsTable.py.

◆ instFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.instFluxField
staticinherited
Initial value:
= pexConfig.Field(
doc=("Faull name of the source instFlux field to use, including 'instFlux'. "
"The associated flag will be implicitly included in badFlags"),
dtype=str,
default='slot_CalibFlux_instFlux',
)

Definition at line 48 of file fgcmBuildStarsBase.py.

◆ isolationRadius

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.isolationRadius
staticinherited
Initial value:
= pexConfig.Field(
doc="Isolation radius (arcseconds)",
dtype=float,
default=2.0,
)

Definition at line 64 of file fgcmBuildStarsBase.py.

◆ localBackgroundFluxField

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.localBackgroundFluxField
staticinherited
Initial value:
= pexConfig.Field(
doc="Full name of the local background instFlux field to use.",
dtype=str,
default='base_LocalBackground_instFlux'
)

Definition at line 134 of file fgcmBuildStarsBase.py.

◆ matchNside

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.matchNside
staticinherited
Initial value:
= pexConfig.Field(
doc="Healpix Nside for matching",
dtype=int,
default=4096,
)

Definition at line 85 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 59 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 54 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 164 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 95 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 106 of file fgcmBuildStarsBase.py.

◆ psfCandidateName

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.psfCandidateName
staticinherited
Initial value:
= pexConfig.Field(
doc="Name of field with psf candidate flag for propagation",
dtype=str,
default="calib_psf_candidate"
)

Definition at line 123 of file fgcmBuildStarsBase.py.

◆ randomSeed

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.randomSeed
staticinherited
Initial value:
= pexConfig.Field(
doc="Random seed for high density down-sampling.",
dtype=int,
default=123456,
optional=True,
)

Definition at line 79 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 76 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 158 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 101 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 70 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 139 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 85 of file fgcmBuildStarsTable.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 94 of file fgcmBuildStarsTable.py.


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