lsst.fgcmcal  20.0.0-5-gfcebe35+10d506ecc7
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig Class Reference
Inheritance diagram for lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig:
lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase

Public Member Functions

def setDefaults (self)
 

Public Attributes

 instFluxField
 
 localBackgroundFluxField
 
 apertureInnerInstFluxField
 
 apertureOuterInstFluxField
 
 psfCandidateName
 

Static Public Attributes

 referenceCCD
 
 minPerBand
 
 matchRadius
 
 isolationRadius
 
 densityCutNside
 
 densityCutMaxPerPixel
 
 matchNside
 
 coarseNside
 
 filterMap
 
 requiredBands
 
 primaryBands
 
 visitDataRefName
 
 ccdDataRefName
 
 doApplyWcsJacobian
 
 doSubtractLocalBackground
 
 sourceSelector
 
 doReferenceMatches
 
 fgcmLoadReferenceCatalog
 
 nVisitsPerCheckpoint
 

Detailed Description

Config for FgcmBuildStarsTableTask

Definition at line 47 of file fgcmBuildStarsTable.py.

Member Function Documentation

◆ setDefaults()

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

Member Data Documentation

◆ apertureInnerInstFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.apertureInnerInstFluxField

Definition at line 65 of file fgcmBuildStarsTable.py.

◆ apertureOuterInstFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.apertureOuterInstFluxField

Definition at line 66 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 116 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 88 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 78 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 73 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 121 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 158 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 131 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 163 of file fgcmBuildStarsBase.py.

◆ filterMap

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.filterMap
staticinherited
Initial value:
= pexConfig.DictField(
doc="Mapping from 'filterName' to band.",
keytype=str,
itemtype=str,
default={},
)

Definition at line 93 of file fgcmBuildStarsBase.py.

◆ instFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.instFluxField

Definition at line 63 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 68 of file fgcmBuildStarsBase.py.

◆ localBackgroundFluxField

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.localBackgroundFluxField

Definition at line 64 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 83 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 63 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 58 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 167 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 104 of file fgcmBuildStarsBase.py.

◆ psfCandidateName

lsst.fgcmcal.fgcmBuildStarsTable.FgcmBuildStarsTableConfig.psfCandidateName

Definition at line 67 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 50 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 99 of file fgcmBuildStarsBase.py.

◆ sourceSelector

lsst.fgcmcal.fgcmBuildStarsBase.FgcmBuildStarsConfigBase.sourceSelector
staticinherited
Initial value:
= sourceSelectorRegistry.makeField(
doc="How to select sources",
default="science"
)

Definition at line 142 of file fgcmBuildStarsBase.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 111 of file fgcmBuildStarsBase.py.


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