lsst.jointcal.jointcal.JointcalConfig Class Reference
Inheritance diagram for lsst.jointcal.jointcal.JointcalConfig:
Public Member Functions | |
| validate (self) | |
| setDefaults (self) | |
| getSpatialBoundsConnections (self) | |
Public Attributes | |
| outputs | |
Detailed Description
Configuration for JointcalTask
Definition at line 197 of file jointcal.py.
Member Function Documentation
◆ getSpatialBoundsConnections()
|
inherited |
Definition at line 193 of file jointcal.py.
193 def getSpatialBoundsConnections(self):
194 return ("inputVisitSummary",)
195
196
◆ setDefaults()
| lsst.jointcal.jointcal.JointcalConfig.setDefaults | ( | self | ) |
Definition at line 426 of file jointcal.py.
426 def setDefaults(self):
427 # Use only primary stars.
428 self.sourceSelector["science"].doRequirePrimary = True
429 # Use only stars because aperture fluxes of galaxies are biased and depend on seeing.
430 self.sourceSelector["science"].doUnresolved = True
431 self.sourceSelector["science"].unresolved.name = "sizeExtendedness"
432 # with dependable signal to noise ratio.
433 self.sourceSelector["science"].doSignalToNoise = True
434 # Min SNR must be > 0 because jointcal cannot handle negative fluxes,
435 # and S/N > 10 to use sources that are not too faint, and thus better measured.
436 self.sourceSelector["science"].signalToNoise.minimum = 10.
437 # Base SNR selection on `sourceFluxType` because that is the flux that jointcal fits.
438 self.sourceSelector["science"].signalToNoise.fluxField = f"{self.sourceFluxType}_instFlux"
439 self.sourceSelector["science"].signalToNoise.errField = f"{self.sourceFluxType}_instFluxErr"
440 # Do not trust blended sources" aperture fluxes which also depend on seeing.
441 self.sourceSelector["science"].doIsolated = True
442 self.sourceSelector["science"].isolated.parentName = "parentSourceId"
443 self.sourceSelector["science"].isolated.nChildName = "deblend_nChild"
444 # Do not trust either flux or centroid measurements with flags,
445 # chosen from the usual QA flags for stars)
446 self.sourceSelector["science"].doFlags = True
447 badFlags = ["pixelFlags_edge",
448 "pixelFlags_saturated",
449 "pixelFlags_interpolatedCenter",
450 "pixelFlags_interpolated",
451 "pixelFlags_crCenter",
452 "pixelFlags_bad",
453 "hsmPsfMoments_flag",
454 f"{self.sourceFluxType}_flag",
455 ]
456 self.sourceSelector["science"].flags.bad = badFlags
457 self.sourceSelector["science"].doRequireFiniteRaDec = True
458 self.sourceSelector["science"].requireFiniteRaDec.raColName = "ra"
459 self.sourceSelector["science"].requireFiniteRaDec.decColName = "dec"
460
461 # Use Gaia-DR2 with proper motions for astrometry; phot_g_mean is the
462 # primary Gaia band, but is not like any normal photometric band.
463 self.astrometryRefObjLoader.requireProperMotion = True
464 self.astrometryRefObjLoader.anyFilterMapsToThis = "phot_g_mean"
465
466
◆ validate()
| lsst.jointcal.jointcal.JointcalConfig.validate | ( | self | ) |
Definition at line 416 of file jointcal.py.
416 def validate(self):
417 super().validate()
418 if self.doPhotometry and self.applyColorTerms and len(self.colorterms.data) == 0:
419 msg = "applyColorTerms=True requires the `colorterms` field be set to a ColortermLibrary."
420 raise pexConfig.FieldValidationError(JointcalConfig.colorterms, self, msg)
421 if self.doAstrometry and not self.doPhotometry and self.applyColorTerms:
422 msg = ("Only doing astrometry, but Colorterms are not applied for astrometry;"
423 "applyColorTerms=True will be ignored.")
424 logging.getLogger("lsst.jointcal").warning(msg)
425
Member Data Documentation
◆ 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 248 of file jointcal.py.
◆ applyColorTerms
|
static |
Initial value:
= pexConfig.Field(
doc="Apply photometric color terms to reference stars?"
"Requires that colorterms be set to a ColortermLibrary",
dtype=bool,
default=False
)
Definition at line 294 of file jointcal.py.
◆ 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 259 of file jointcal.py.
◆ 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 315 of file jointcal.py.
◆ 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 274 of file jointcal.py.
◆ astrometryOutlierRelativeTolerance
|
static |
Initial value:
= pexConfig.Field(
doc=("Convergence tolerance for outlier rejection threshold when fitting astrometry. Iterations will "
"stop when the fractional change in the chi2 cut level is below this value. If tolerance is set "
"to zero, iterations will continue until there are no more outliers. We suggest a value of 0.002"
"as a balance between a shorter minimization runtime and achieving a final fitted model that is"
"close to the solution found when removing all outliers."),
dtype=float,
default=0,
)
Definition at line 326 of file jointcal.py.
◆ astrometryRefCat
|
staticinherited |
Initial value:
= pipeBase.connectionTypes.PrerequisiteInput(
doc="The astrometry reference catalog to match to loaded input catalog sources.",
name="gaia_dr2_20200414",
storageClass="SimpleCatalog",
dimensions=("skypix",),
deferLoad=True,
multiple=True,
)
Definition at line 88 of file jointcal.py.
◆ astrometryReferenceErr
|
static |
Initial value:
= pexConfig.Field(
doc=("Uncertainty on reference catalog coordinates [mas] to use in place of the `coord_*Err` fields. "
"If None, then raise an exception if the reference catalog is missing coordinate errors. "
"If specified, overrides any existing `coord_*Err` values."),
dtype=float,
default=None,
optional=True
)
Definition at line 365 of file jointcal.py.
◆ astrometryReferenceSelector
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ReferenceSourceSelectorTask,
doc="How to down-select the loaded astrometry reference catalog.",
)
Definition at line 357 of file jointcal.py.
◆ astrometryRefObjLoader
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=LoadReferenceObjectsConfig,
doc="Reference object loader for astrometric fit",
)
Definition at line 345 of file jointcal.py.
◆ astrometrySimpleOrder
|
static |
Initial value:
= pexConfig.Field(
doc="Polynomial order for fitting the simple astrometry model.",
dtype=int,
default=3,
)
Definition at line 254 of file jointcal.py.
◆ 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 264 of file jointcal.py.
◆ colorterms
|
static |
Initial value:
= pexConfig.ConfigField(
doc="Library of photometric reference catalog name to color term dict.",
dtype=ColortermLibrary,
)
Definition at line 300 of file jointcal.py.
◆ debugOutputPath
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
default=".",
doc=("Path to write debug output files to. Used by "
"`writeInitialModel`, `writeChi2Files*`, `writeInitMatrix`.")
)
Definition at line 404 of file jointcal.py.
◆ detailedProfile
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Output separate profiling information for different parts of jointcal, e.g. data read, fitting"
)
Definition at line 410 of file jointcal.py.
◆ dimensions
|
staticinherited |
Definition at line 133 of file jointcal.py.
◆ doAstrometry
|
static |
Initial value:
= pexConfig.Field(
doc="Fit astrometry and write the fitted result.",
dtype=bool,
default=True
)
Definition at line 201 of file jointcal.py.
◆ doc
|
staticinherited |
Definition at line 130 of file jointcal.py.
◆ doPhotometry
|
static |
Initial value:
= pexConfig.Field(
doc="Fit photometry and write the fitted result.",
dtype=bool,
default=True
)
Definition at line 206 of file jointcal.py.
◆ inputCamera
|
staticinherited |
Initial value:
= pipeBase.connectionTypes.PrerequisiteInput(
doc="The camera instrument that took these observations.",
name="camera",
storageClass="Camera",
dimensions=("instrument",),
isCalibration=True,
)
Definition at line 63 of file jointcal.py.
◆ inputSourceTableVisit
|
staticinherited |
Initial value:
= pipeBase.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 70 of file jointcal.py.
◆ inputVisitSummary
|
staticinherited |
Initial value:
= pipeBase.connectionTypes.Input(
doc=("Per-visit consolidated exposure metadata built from calexps. "
"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 78 of file jointcal.py.
◆ matchCut
|
static |
Initial value:
= pexConfig.Field(
doc="Matching radius between fitted and reference stars (arcseconds)",
dtype=float,
default=3.0,
)
Definition at line 228 of file jointcal.py.
◆ maxAstrometrySteps
|
static |
Initial value:
= pexConfig.Field(
doc="Maximum number of minimize iterations to take when fitting astrometry.",
dtype=int,
default=20,
)
Definition at line 340 of file jointcal.py.
◆ maxPhotometrySteps
|
static |
Initial value:
= pexConfig.Field(
doc="Maximum number of minimize iterations to take when fitting photometry.",
dtype=int,
default=20,
)
Definition at line 335 of file jointcal.py.
◆ minMeasuredStarsPerCcd
|
static |
Initial value:
= pexConfig.Field(
doc="Minimum number of measuredStars per ccdImage before printing warnings",
dtype=int,
default=100,
)
Definition at line 238 of file jointcal.py.
◆ 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 233 of file jointcal.py.
◆ minRefStarsPerCcd
|
static |
Initial value:
= pexConfig.Field(
doc="Minimum number of measuredStars per ccdImage before printing warnings",
dtype=int,
default=30,
)
Definition at line 243 of file jointcal.py.
◆ name
|
staticinherited |
Definition at line 131 of file jointcal.py.
◆ outlierRejectSigma
|
static |
Initial value:
= pexConfig.Field(
doc="How many sigma to reject outliers at during minimization.",
dtype=float,
default=5.0,
)
Definition at line 321 of file jointcal.py.
◆ outputPhotoCalib
|
staticinherited |
Initial value:
= pipeBase.connectionTypes.Output(
doc=("Per-tract, per-visit photometric calibrations derived from the fitted model."
" These catalogs only contain entries for detectors with an output, and use"
" the detector id for the catalog id, sorted on id for fast lookups of a detector."),
name="jointcalPhotoCalibCatalog",
storageClass="ExposureCatalog",
dimensions=("instrument", "visit", "skymap", "tract"),
multiple=True
)
Definition at line 114 of file jointcal.py.
◆ outputs
|
inherited |
Definition at line 183 of file jointcal.py.
◆ outputWcs
|
staticinherited |
Initial value:
= pipeBase.connectionTypes.Output(
doc=("Per-tract, per-visit world coordinate systems derived from the fitted model."
" These catalogs only contain entries for detectors with an output, and use"
" the detector id for the catalog id, sorted on id for fast lookups of a detector."),
name="jointcalSkyWcsCatalog",
storageClass="ExposureCatalog",
dimensions=("instrument", "visit", "skymap", "tract"),
multiple=True
)
Definition at line 105 of file jointcal.py.
◆ 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 309 of file jointcal.py.
◆ 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 221 of file jointcal.py.
◆ 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 281 of file jointcal.py.
◆ photometryRefCat
|
staticinherited |
Initial value:
= pipeBase.connectionTypes.PrerequisiteInput(
doc="The photometry reference catalog to match to loaded input catalog sources.",
name="ps1_pv3_3pi_20170110",
storageClass="SimpleCatalog",
dimensions=("skypix",),
deferLoad=True,
multiple=True,
)
Definition at line 96 of file jointcal.py.
◆ photometryReferenceSelector
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ReferenceSourceSelectorTask,
doc="How to down-select the loaded photometry reference catalog.",
)
Definition at line 361 of file jointcal.py.
◆ photometryRefObjLoader
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=LoadReferenceObjectsConfig,
doc="Reference object loader for photometric fit",
)
Definition at line 349 of file jointcal.py.
◆ 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 304 of file jointcal.py.
◆ 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 216 of file jointcal.py.
◆ 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='apFlux_12_0'
)
Definition at line 211 of file jointcal.py.
◆ sourceSelector
|
static |
Initial value:
= sourceSelectorRegistry.makeField(
doc="How to select sources for cross-matching",
default="science"
)
Definition at line 353 of file jointcal.py.
◆ storageClass
|
staticinherited |
Definition at line 132 of file jointcal.py.
◆ useInputWcs
|
static |
Initial value:
= pexConfig.Field(
doc="Use the input calexp WCSs to initialize a SimpleAstrometryModel.",
dtype=bool,
default=True,
)
Definition at line 269 of file jointcal.py.
◆ writeChi2FilesInitialFinal
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Write .csv files containing the contributions to chi2 for the initialization and final fit. "
"Output files will be written to `config.debugOutputPath` and will "
"be of the form `astrometry_[initial|final]_chi2-TRACT-FILTER."),
default=False
)
Definition at line 383 of file jointcal.py.
◆ writeChi2FilesOuterLoop
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Write .csv files containing the contributions to chi2 for the outer fit loop. "
"Output files will be written to `config.debugOutputPath` and will "
"be of the form `astrometry_init-NN_chi2-TRACT-FILTER`."),
default=False
)
Definition at line 390 of file jointcal.py.
◆ writeInitialModel
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Write the pre-initialization model to text files, for debugging. "
"Output files will be written to `config.debugOutputPath` and will be "
"of the form `initial_astrometry_model-TRACT_FILTER.txt`."),
default=False
)
Definition at line 397 of file jointcal.py.
◆ writeInitMatrix
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Write the pre/post-initialization Hessian and gradient to text files, for debugging. "
"Output files will be written to `config.debugOutputPath` and will "
"be of the form 'astrometry_[pre|post]init-TRACT-FILTER-mat.txt'. "
"Note that these files are the dense versions of the matrix, and so may be very large."),
default=False
)
Definition at line 375 of file jointcal.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/jointcal/g29ae962dfc+058d1915d8/python/lsst/jointcal/jointcal.py
Generated on Mon Oct 27 2025 07:01:44 for LSST Applications by
1.13.2