lsst.jointcal  16.0-21-g96865c2+4
Public Member Functions | Static Public Attributes | List of all members
lsst.jointcal.jointcal.JointcalConfig Class Reference
Inheritance diagram for lsst.jointcal.jointcal.JointcalConfig:

Public Member Functions

def setDefaults (self)
 

Static Public Attributes

 doAstrometry
 
 doPhotometry
 
 coaddName
 
 positionErrorPedestal
 
 photometryErrorPedestal
 
 matchCut
 
 minMeasurements
 
 minMeasuredStarsPerCcd
 
 minRefStarsPerCcd
 
 allowLineSearch
 
 astrometrySimpleOrder
 
 astrometryChipOrder
 
 astrometryVisitOrder
 
 useInputWcs
 
 astrometryModel
 
 photometryModel
 
 photometryVisitOrder
 
 photometryDoRankUpdate
 
 astrometryDoRankUpdate
 
 outlierRejectSigma
 
 maxPhotometrySteps
 
 maxAstrometrySteps
 
 astrometryRefObjLoader
 
 photometryRefObjLoader
 
 sourceSelector
 
 writeInitMatrix
 
 writeChi2ContributionFiles
 
 sourceFluxType
 

Detailed Description

Config for JointcalTask

Definition at line 111 of file jointcal.py.

Member Function Documentation

◆ setDefaults()

def lsst.jointcal.jointcal.JointcalConfig.setDefaults (   self)

Definition at line 269 of file jointcal.py.

Member Data Documentation

◆ allowLineSearch

lsst.jointcal.jointcal.JointcalConfig.allowLineSearch
static
Initial value:
= pexConfig.Field(
doc="Allow a line search during minimization, if it is reasonable for the model"
" (models with a significant non-linear component, e.g. constrainedPhotometry).",
dtype=bool,
default=False
)

Definition at line 161 of file jointcal.py.

◆ astrometryChipOrder

lsst.jointcal.jointcal.JointcalConfig.astrometryChipOrder
static
Initial value:
= pexConfig.Field(
doc="Order of the per-chip transform for the constrained astrometry model.",
dtype=int,
default=1,
)

Definition at line 172 of file jointcal.py.

◆ astrometryDoRankUpdate

lsst.jointcal.jointcal.JointcalConfig.astrometryDoRankUpdate
static
Initial value:
= pexConfig.Field(
doc="Do the rank update step during minimization (should not change the astrometry fit). "
"Skipping this can help deal with models that are too non-linear.",
dtype=bool,
default=True,
)

Definition at line 218 of file jointcal.py.

◆ astrometryModel

lsst.jointcal.jointcal.JointcalConfig.astrometryModel
static
Initial value:
= pexConfig.ChoiceField(
doc="Type of model to fit to astrometry",
dtype=str,
default="constrained",
allowed={"simple": "One polynomial per ccd",
"constrained": "One polynomial per ccd, and one polynomial per visit"}
)

Definition at line 187 of file jointcal.py.

◆ astrometryRefObjLoader

lsst.jointcal.jointcal.JointcalConfig.astrometryRefObjLoader
static
Initial value:
= pexConfig.ConfigurableField(
target=LoadIndexedReferenceObjectsTask,
doc="Reference object loader for astrometric fit",
)

Definition at line 239 of file jointcal.py.

◆ astrometrySimpleOrder

lsst.jointcal.jointcal.JointcalConfig.astrometrySimpleOrder
static
Initial value:
= pexConfig.Field(
doc="Polynomial order for fitting the simple astrometry model.",
dtype=int,
default=3,
)

Definition at line 167 of file jointcal.py.

◆ astrometryVisitOrder

lsst.jointcal.jointcal.JointcalConfig.astrometryVisitOrder
static
Initial value:
= pexConfig.Field(
doc="Order of the per-visit transform for the constrained astrometry model.",
dtype=int,
default=5,
)

Definition at line 177 of file jointcal.py.

◆ coaddName

lsst.jointcal.jointcal.JointcalConfig.coaddName
static
Initial value:
= pexConfig.Field(
doc="Type of coadd, typically deep or goodSeeing",
dtype=str,
default="deep"
)

Definition at line 124 of file jointcal.py.

◆ doAstrometry

lsst.jointcal.jointcal.JointcalConfig.doAstrometry
static
Initial value:
= pexConfig.Field(
doc="Fit astrometry and write the fitted result.",
dtype=bool,
default=True
)

Definition at line 114 of file jointcal.py.

◆ doPhotometry

lsst.jointcal.jointcal.JointcalConfig.doPhotometry
static
Initial value:
= pexConfig.Field(
doc="Fit photometry and write the fitted result.",
dtype=bool,
default=True
)

Definition at line 119 of file jointcal.py.

◆ matchCut

lsst.jointcal.jointcal.JointcalConfig.matchCut
static
Initial value:
= pexConfig.Field(
doc="Matching radius between fitted and reference stars (arcseconds)",
dtype=float,
default=3.0,
)

Definition at line 141 of file jointcal.py.

◆ maxAstrometrySteps

lsst.jointcal.jointcal.JointcalConfig.maxAstrometrySteps
static
Initial value:
= pexConfig.Field(
doc="Maximum number of minimize iterations to take when fitting photometry.",
dtype=int,
default=20,
)

Definition at line 234 of file jointcal.py.

◆ maxPhotometrySteps

lsst.jointcal.jointcal.JointcalConfig.maxPhotometrySteps
static
Initial value:
= pexConfig.Field(
doc="Maximum number of minimize iterations to take when fitting photometry.",
dtype=int,
default=20,
)

Definition at line 229 of file jointcal.py.

◆ minMeasuredStarsPerCcd

lsst.jointcal.jointcal.JointcalConfig.minMeasuredStarsPerCcd
static
Initial value:
= pexConfig.Field(
doc="Minimum number of measuredStars per ccdImage before printing warnings",
dtype=int,
default=100,
)

Definition at line 151 of file jointcal.py.

◆ minMeasurements

lsst.jointcal.jointcal.JointcalConfig.minMeasurements
static
Initial value:
= pexConfig.Field(
doc="Minimum number of associated measured stars for a fitted star to be included in the fit",
dtype=int,
default=2,
)

Definition at line 146 of file jointcal.py.

◆ minRefStarsPerCcd

lsst.jointcal.jointcal.JointcalConfig.minRefStarsPerCcd
static
Initial value:
= pexConfig.Field(
doc="Minimum number of measuredStars per ccdImage before printing warnings",
dtype=int,
default=30,
)

Definition at line 156 of file jointcal.py.

◆ outlierRejectSigma

lsst.jointcal.jointcal.JointcalConfig.outlierRejectSigma
static
Initial value:
= pexConfig.Field(
doc="How many sigma to reject outliers at during minimization.",
dtype=float,
default=5.0,
)

Definition at line 224 of file jointcal.py.

◆ photometryDoRankUpdate

lsst.jointcal.jointcal.JointcalConfig.photometryDoRankUpdate
static
Initial value:
= pexConfig.Field(
doc="Do the rank update step during minimization. "
"Skipping this can help deal with models that are too non-linear.",
dtype=bool,
default=True,
)

Definition at line 212 of file jointcal.py.

◆ photometryErrorPedestal

lsst.jointcal.jointcal.JointcalConfig.photometryErrorPedestal
static
Initial value:
= pexConfig.Field(
doc="Systematic term to apply to the measured error on flux or magnitude as a "
"fraction of source flux or magnitude delta (e.g. 0.05 is 5% of flux or +50 millimag).",
dtype=float,
default=0.0,
)

Definition at line 134 of file jointcal.py.

◆ photometryModel

lsst.jointcal.jointcal.JointcalConfig.photometryModel
static
Initial value:
= pexConfig.ChoiceField(
doc="Type of model to fit to photometry",
dtype=str,
default="constrainedMagnitude",
allowed={"simpleFlux": "One constant zeropoint per ccd and visit, fitting in flux space.",
"constrainedFlux": "Constrained zeropoint per ccd, and one polynomial per visit,"
" fitting in flux space.",
"simpleMagnitude": "One constant zeropoint per ccd and visit,"
" fitting in magnitude space.",
"constrainedMagnitude": "Constrained zeropoint per ccd, and one polynomial per visit,"
" fitting in magnitude space.",
}
)

Definition at line 194 of file jointcal.py.

◆ photometryRefObjLoader

lsst.jointcal.jointcal.JointcalConfig.photometryRefObjLoader
static
Initial value:
= pexConfig.ConfigurableField(
target=LoadIndexedReferenceObjectsTask,
doc="Reference object loader for photometric fit",
)

Definition at line 243 of file jointcal.py.

◆ photometryVisitOrder

lsst.jointcal.jointcal.JointcalConfig.photometryVisitOrder
static
Initial value:
= pexConfig.Field(
doc="Order of the per-visit polynomial transform for the constrained photometry model.",
dtype=int,
default=7,
)

Definition at line 207 of file jointcal.py.

◆ positionErrorPedestal

lsst.jointcal.jointcal.JointcalConfig.positionErrorPedestal
static
Initial value:
= pexConfig.Field(
doc="Systematic term to apply to the measured position error (pixels)",
dtype=float,
default=0.02,
)

Definition at line 129 of file jointcal.py.

◆ sourceFluxType

lsst.jointcal.jointcal.JointcalConfig.sourceFluxType
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Source flux field to use in source selection and to get fluxes from the catalog.",
default='Calib'
)

Definition at line 263 of file jointcal.py.

◆ sourceSelector

lsst.jointcal.jointcal.JointcalConfig.sourceSelector
static
Initial value:
= sourceSelectorRegistry.makeField(
doc="How to select sources for cross-matching",
default="astrometry"
)

Definition at line 247 of file jointcal.py.

◆ useInputWcs

lsst.jointcal.jointcal.JointcalConfig.useInputWcs
static
Initial value:
= pexConfig.Field(
doc="Use the input calexp WCSs to initialize a SimpleAstrometryModel.",
dtype=bool,
default=True,
)

Definition at line 182 of file jointcal.py.

◆ writeChi2ContributionFiles

lsst.jointcal.jointcal.JointcalConfig.writeChi2ContributionFiles
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Write initial/final fit files containing the contributions to chi2.",
default=False
)

Definition at line 258 of file jointcal.py.

◆ writeInitMatrix

lsst.jointcal.jointcal.JointcalConfig.writeInitMatrix
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Write the pre/post-initialization Hessian and gradient to text files, for debugging."
"The output files will be of the form 'astrometry_preinit-mat.txt', in the current directory."
"Note that these files are the dense versions of the matrix, and so may be very large.",
default=False
)

Definition at line 251 of file jointcal.py.


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