lsst.pipe.tasks.calibrateImage.CalibrateImageConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.calibrateImage.CalibrateImageConfig:
Public Member Functions | |
| setDefaults (self) | |
| validate (self) | |
Detailed Description
Definition at line 275 of file calibrateImage.py.
Member Function Documentation
◆ setDefaults()
| lsst.pipe.tasks.calibrateImage.CalibrateImageConfig.setDefaults | ( | self | ) |
Definition at line 557 of file calibrateImage.py.
◆ validate()
| lsst.pipe.tasks.calibrateImage.CalibrateImageConfig.validate | ( | self | ) |
Definition at line 663 of file calibrateImage.py.
Member Data Documentation
◆ applied_photo_calib
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc=(
"Photometric calibration that was applied to exposure's pixels. "
"This connection is disabled when do_calibrate_pixels=False, or "
"when output_image_type='future'."
),
name="initial_photoCalib_detector",
storageClass="PhotoCalib",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 188 of file calibrateImage.py.
◆ astrometry
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.astrom.AstrometryTask,
doc="Task to perform astrometric calibration to fit a WCS.",
)
Definition at line 429 of file calibrateImage.py.
◆ astrometry_matches
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Source to reference catalog matches from the astrometry solver.",
name="initial_astrometry_match_detector",
storageClass="Catalog",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 235 of file calibrateImage.py.
◆ astrometry_ref_cat
|
staticinherited |
Initial value:
= connectionTypes.PrerequisiteInput(
doc="Reference catalog to use for astrometric calibration.",
name="gaia_dr3_20230707",
storageClass="SimpleCatalog",
dimensions=("skypix",),
deferLoad=True,
multiple=True,
)
Definition at line 111 of file calibrateImage.py.
◆ astrometry_ref_loader
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=lsst.meas.algorithms.LoadReferenceObjectsConfig,
doc="Configuration of reference object loader for astrometric fit.",
)
Definition at line 433 of file calibrateImage.py.
◆ background
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Background models estimated during calibration task; calibrated to be in nJy units "
"if do_calibrate_pixels is True. This connection is disabled when output_image_type='future'.",
name="initial_pvi_background",
storageClass="Background",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 198 of file calibrateImage.py.
◆ background_flat
|
staticinherited |
Initial value:
= connectionTypes.PrerequisiteInput(
name="flat",
doc="Flat calibration frame used for background correction.",
storageClass="ExposureF",
dimensions=["instrument", "detector", "physical_filter"],
isCalibration=True,
)
Definition at line 143 of file calibrateImage.py.
◆ background_stats_flux_column
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
default="base_CircularApertureFlux_12_0_flux",
doc="Column used to generate post-subtracted background stats."
)
Definition at line 530 of file calibrateImage.py.
◆ background_stats_ignored_pixel_masks
|
static |
Initial value:
= pexConfig.ListField(
dtype=str,
default=["SAT", "SUSPECT", "SPIKE"],
doc="Pixel mask flags to ignore when calculating post-sky-subtraction "
"background statistics. These are added to those ignored by the "
"meas.algorithms.SubtractBackgroundConfig algorithm."
)
Definition at line 488 of file calibrateImage.py.
◆ background_to_photometric_ratio
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Ratio of a background-flattened image to a photometric-flattened image. Only persisted "
"if do_illumination_correction is True.",
name="background_to_photometric_ratio",
storageClass="Image",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 205 of file calibrateImage.py.
◆ camera_model
|
staticinherited |
Initial value:
= connectionTypes.PrerequisiteInput(
doc="Camera distortion model to use for astrometric calibration.",
name="astrometry_camera",
storageClass="Camera",
dimensions=("instrument", "physical_filter"),
isCalibration=True,
minimum=0, # Can fall back on WCS already attached to exposure.
)
Definition at line 127 of file calibrateImage.py.
◆ compute_shapelet_decomposition
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ComputeRoughPsfShapeletsTask,
doc="Task to compute a rough shapelet expansion of the PSF from a set "
"of high S/N detections.",
)
Definition at line 299 of file calibrateImage.py.
◆ compute_summary_stats
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=computeExposureSummaryStats.ComputeExposureSummaryStatsTask,
doc="Task to to compute summary statistics on the calibrated exposure."
)
Definition at line 457 of file calibrateImage.py.
◆ diffractionSpikeMask
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=diffractionSpikeMask.DiffractionSpikeMaskTask,
doc="Task to identify and mask the diffraction spikes of bright stars.",
)
Definition at line 452 of file calibrateImage.py.
◆ do_adaptive_threshold_detection
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Implement the adaptive detection thresholding approach?",
)
Definition at line 321 of file calibrateImage.py.
◆ do_calibrate_pixels
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc=(
"If True, apply the photometric calibration to the image pixels "
"and background model, and attach an identity PhotoCalib to "
"the output image to reflect this. If False`, leave the image "
"and background uncalibrated and attach the PhotoCalib that maps "
"them to physical units."
)
)
Definition at line 470 of file calibrateImage.py.
◆ do_compute_shapelet_decomposition
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Compute a rough shapelet expansion of the PSF stars?",
)
Definition at line 304 of file calibrateImage.py.
◆ do_downsample_footprints
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="Downsample footprints prior to deblending to optimize speed?",
)
Definition at line 387 of file calibrateImage.py.
◆ do_illumination_correction
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If True, apply the illumination correction. This assumes that the "
"input image has already been flat-fielded such that it is suitable "
"for background subtraction.",
)
Definition at line 462 of file calibrateImage.py.
◆ do_include_astrometric_errors
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="If True, include astrometric errors in the output catalog.",
)
Definition at line 482 of file calibrateImage.py.
◆ do_remeasure_star_background
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=True,
doc="Do iterative star background measurement (ignored if do_adaptive_threshold_detection is False).",
)
Definition at line 326 of file calibrateImage.py.
◆ doMaskDiffractionSpikes
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If True, load the photometric reference catalog again but select "
"only bright stars. Use the bright star catalog to set the SPIKE "
"mask for regions likely contaminated by diffraction spikes.",
)
Definition at line 445 of file calibrateImage.py.
◆ downsample_max_footprints
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
default=1000,
doc="Maximum number of non-sky-source footprints to use if do_downsample_footprints is True,",
)
Definition at line 392 of file calibrateImage.py.
◆ exposure
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Photometrically calibrated, background-subtracted exposure with fitted calibrations and "
"summary statistics. To recover the original exposure, first add the background, and then, "
"if do_calibrate_pixels=True, divide by the applied photometric calibration.",
name="initial_pvi",
storageClass="ExposureF",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 167 of file calibrateImage.py.
◆ exposures
|
staticinherited |
Initial value:
= connectionTypes.Input(
doc="Exposure (or two snaps) to be calibrated, and detected and measured on.",
name="postISRCCD",
storageClass="Exposure",
multiple=True, # to handle 1 exposure or 2 snaps
dimensions=["instrument", "exposure", "detector"],
)
Definition at line 135 of file calibrateImage.py.
◆ id_generator
|
static |
Definition at line 286 of file calibrateImage.py.
◆ illumination_correction
|
staticinherited |
Initial value:
= connectionTypes.PrerequisiteInput(
name="illuminationCorrection",
doc="Illumination correction frame.",
storageClass="Exposure",
dimensions=["instrument", "detector", "physical_filter"],
isCalibration=True,
)
Definition at line 150 of file calibrateImage.py.
◆ initial_stars_schema
|
staticinherited |
Initial value:
= connectionTypes.InitOutput(
doc="Schema of the output initial stars catalog.",
name="initial_stars_schema",
storageClass="SourceCatalog",
)
Definition at line 159 of file calibrateImage.py.
◆ install_simple_psf
|
static |
Initial value:
= pexConfig.ConfigurableField(
doc="Task to install a simple PSF model into the input exposure to use "
"when detecting bright sources for PSF estimation.",
)
Definition at line 294 of file calibrateImage.py.
◆ instrumental_unit
|
static |
Initial value:
= pexConfig.Field(
dtype=str,
default="electron",
doc="Units of the input postISRCCD pixels, used for the output photometric_scaling and, if"
" do_calibrate_pixels=False, the output image."
" Used only when output_image_type='future'.",
)
Definition at line 535 of file calibrateImage.py.
◆ mask
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="The mask plane of the calibrated exposure, written as a separate "
"output so that it can be passed to downstream tasks even if the "
"exposure is removed to save storage.",
name="preliminary_visit_mask",
storageClass="Mask",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 214 of file calibrateImage.py.
◆ measure_aperture_correction
|
static |
Initial value:
= pexConfig.ConfigurableField(
doc="Task to compute the aperture correction from the bright stars."
)
Definition at line 351 of file calibrateImage.py.
◆ optional_outputs
|
static |
Initial value:
= pexConfig.ListField(
doc="Which optional outputs to save (as their connection name)?",
dtype=str,
# TODO: note somewhere to disable this for benchmarking, but should
# we always have it on for production runs?
default=["psf_stars", "psf_stars_footprints", "astrometry_matches", "photometry_matches", "mask"],
optional=False
)
Definition at line 276 of file calibrateImage.py.
◆ output_image_type
|
static |
Initial value:
= pexConfig.ChoiceField[str](
"Which image type to use for the output visit image."
" In 'future' mode the background and the applied photometric"
" calibration are components of the image instead of being written as"
" their own datasets. 'future' only takes effect in a repository"
" where initial_pvi is freshly registered with the VisitImage storage"
" class, because the registered storage class wins on write.",
allowed={
"legacy": "Write as a lsst.afw.image.Exposure.",
"future": "Write as a lsst.images.VisitImage.",
},
optional=False,
default="legacy",
)
Definition at line 542 of file calibrateImage.py.
◆ photometry
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=photoCal.PhotoCalTask,
doc="Task to perform photometric calibration to fit a PhotoCalib.",
)
Definition at line 437 of file calibrateImage.py.
◆ photometry_matches
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Source to reference catalog matches from the photometry solver.",
name="initial_photometry_match_detector",
storageClass="Catalog",
dimensions=("instrument", "visit", "detector"),
)
Definition at line 241 of file calibrateImage.py.
◆ photometry_ref_cat
|
staticinherited |
Initial value:
= connectionTypes.PrerequisiteInput(
doc="Reference catalog to use for photometric calibration.",
name="ps1_pv3_3pi_20170110",
storageClass="SimpleCatalog",
dimensions=("skypix",),
deferLoad=True,
multiple=True
)
Definition at line 119 of file calibrateImage.py.
◆ photometry_ref_loader
|
static |
Initial value:
= pexConfig.ConfigField(
dtype=lsst.meas.algorithms.LoadReferenceObjectsConfig,
doc="Configuration of reference object loader for photometric fit.",
)
Definition at line 441 of file calibrateImage.py.
◆ psf_adaptive_threshold_detection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=AdaptiveThresholdDetectionTask,
doc="Task to adaptively detect sources for PSF determination.",
)
Definition at line 331 of file calibrateImage.py.
◆ psf_detection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.algorithms.SourceDetectionTask,
doc="Task to detect sources for PSF determination."
)
Definition at line 317 of file calibrateImage.py.
◆ psf_measure_psf
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=measurePsf.MeasurePsfTask,
doc="Task to measure the psf on bright sources."
)
Definition at line 339 of file calibrateImage.py.
◆ psf_normalized_calibration_flux
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.algorithms.NormalizedCalibrationFluxTask,
doc="Task to normalize the calibration flux (e.g. compensated tophats) "
"for the bright stars used for psf estimation.",
)
Definition at line 343 of file calibrateImage.py.
◆ psf_repair
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=repair.RepairTask,
doc="Task to repair cosmic rays on the exposure before PSF determination.",
)
Definition at line 309 of file calibrateImage.py.
◆ psf_source_measurement
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.base.SingleFrameMeasurementTask,
doc="Task to measure sources to be used for psf estimation."
)
Definition at line 335 of file calibrateImage.py.
◆ psf_stars
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Catalog of bright unresolved sources detected on the exposure used for PSF determination.",
name="initial_psf_stars_detector",
storageClass="ArrowAstropy",
dimensions=["instrument", "visit", "detector"],
)
Definition at line 229 of file calibrateImage.py.
◆ psf_stars_footprints
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Catalog of bright unresolved sources detected on the exposure used for PSF determination; "
"includes source footprints.",
name="initial_psf_stars_footprints_detector",
storageClass="SourceCatalog",
dimensions=["instrument", "visit", "detector"],
)
Definition at line 222 of file calibrateImage.py.
◆ psf_subtract_background
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.algorithms.SubtractBackgroundTask,
doc="Task to perform initial background subtraction, before first detection pass.",
)
Definition at line 313 of file calibrateImage.py.
◆ run_sattle
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If True, the sattle service will populate a cache for later use "
"in ip_diffim.detectAndMeasure alert verification."
)
Definition at line 496 of file calibrateImage.py.
◆ sattle_historical
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If re-running a pipeline that requires sattle, this should be set "
"to True. This will populate sattle's cache with the historic data "
"closest in time to the exposure.",
)
Definition at line 503 of file calibrateImage.py.
◆ snap_combine
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=snapCombine.SnapCombineTask,
doc="Task to combine two snaps to make one exposure.",
)
Definition at line 288 of file calibrateImage.py.
◆ star_apply_aperture_correction
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.base.ApplyApCorrTask,
doc="Task to apply aperture corrections to the selected stars."
)
Definition at line 410 of file calibrateImage.py.
◆ star_background
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.algorithms.SubtractBackgroundTask,
doc="Task to perform final background subtraction, just before photoCal.",
)
Definition at line 357 of file calibrateImage.py.
◆ star_background_min_footprints
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
default=3,
doc="Minimum number of footprints in the detection mask for star_background measurement. "
"This number will get adjusted to the fraction config.star_background_peak_fraction "
"of the detected peaks if that number is larger. If the number of footprints is less "
"than the minimum, the detection threshold is iteratively increased until the "
"threshold is met.",
)
Definition at line 361 of file calibrateImage.py.
◆ star_background_peak_fraction
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
default=0.01,
doc="The minimum number of footprints in the detection mask for star_background measurement. "
"gets set to the maximum of this fraction of the detected peaks and the value set in "
"config.star_background_min_footprints. If the number of footprints is less than the "
"current minimum set, the detection threshold is iteratively increased until the "
"threshold is met.",
)
Definition at line 370 of file calibrateImage.py.
◆ star_catalog_calculation
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.base.CatalogCalculationTask,
doc="Task to compute extendedness values on the star catalog, "
"for the star selector to remove extended sources."
)
Definition at line 414 of file calibrateImage.py.
◆ star_deblend
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.deblender.SourceDeblendTask,
doc="Split blended sources into their components."
)
Definition at line 397 of file calibrateImage.py.
◆ star_detection
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.algorithms.SourceDetectionTask,
doc="Task to detect stars to return in the output catalog."
)
Definition at line 379 of file calibrateImage.py.
◆ star_measurement
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.base.SingleFrameMeasurementTask,
doc="Task to measure stars to return in the output catalog."
)
Definition at line 401 of file calibrateImage.py.
◆ star_normalized_calibration_flux
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.algorithms.NormalizedCalibrationFluxTask,
doc="Task to apply the normalization for calibration fluxes (e.g. compensated tophats) "
"for the final output star catalog.",
)
Definition at line 405 of file calibrateImage.py.
◆ star_selector
|
static |
Initial value:
= lsst.meas.algorithms.sourceSelectorRegistry.makeField(
default="science",
doc="Task to select reliable stars to use for calibration."
)
Definition at line 423 of file calibrateImage.py.
◆ star_set_primary_flags
|
static |
Initial value:
= pexConfig.ConfigurableField(
doc="Task to add isPrimary to the catalog."
)
Definition at line 419 of file calibrateImage.py.
◆ star_sky_sources
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=lsst.meas.algorithms.SkyObjectsTask,
doc="Task to generate sky sources ('empty' regions where there are no detections).",
)
Definition at line 383 of file calibrateImage.py.
◆ stars
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Catalog of unresolved sources detected on the calibrated exposure.",
name="initial_stars_detector",
storageClass="ArrowAstropy",
dimensions=["instrument", "visit", "detector"],
)
Definition at line 175 of file calibrateImage.py.
◆ stars_footprints
|
staticinherited |
Initial value:
= connectionTypes.Output(
doc="Catalog of unresolved sources detected on the calibrated exposure; "
"includes source footprints.",
name="initial_stars_footprints_detector",
storageClass="SourceCatalog",
dimensions=["instrument", "visit", "detector"],
)
Definition at line 181 of file calibrateImage.py.
◆ useButlerCamera
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If True, use a camera distortion model generated elsewhere in "
"the pipeline combined with the telescope boresight as a starting "
"point for fitting the WCS, instead of using the WCS attached to "
"the exposure, which is generated from the boresight and the "
"camera model from the obs_* package."
)
Definition at line 520 of file calibrateImage.py.
◆ useButlerExposureRegion
|
static |
Initial value:
= pexConfig.Field(
dtype=bool,
default=False,
doc="If True, use the exposure region stored in the butler as the "
"region for reference catalog trimming. If False, the reference loader "
"trimming will be set by the loader (typically from a padded version of "
"the detector's bounding box + current WCS)."
)
Definition at line 511 of file calibrateImage.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/calibrateImage.py
Generated on for lsst.pipe.tasks by
1.18.0