lsst.pipe.tasks g95921f966b+d83dc58ecd
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Attributes | List of all members
lsst.pipe.tasks.calibrateImage.CalibrateImageTask Class Reference
Inheritance diagram for lsst.pipe.tasks.calibrateImage.CalibrateImageTask:

Public Member Functions

 __init__ (self, initial_stars_schema=None, **kwargs)
 
 runQuantum (self, butlerQC, inputRefs, outputRefs)
 
 run (self, *exposures, id_generator=None, result=None)
 

Public Attributes

 psf_schema
 
 psf_fields
 
 initial_stars_schema
 

Static Public Attributes

 ConfigClass = CalibrateImageConfig
 

Protected Member Functions

 _handle_snaps (self, exposure)
 
 _compute_psf (self, exposure, id_generator)
 
 _measure_aperture_correction (self, exposure, bright_sources)
 
 _find_stars (self, exposure, background, id_generator)
 
 _match_psf_stars (self, psf_stars, stars)
 
 _fit_astrometry (self, exposure, stars)
 
 _fit_photometry (self, exposure, stars)
 
 _summarize (self, exposure, stars, background)
 

Static Protected Attributes

str _DefaultName = "calibrateImage"
 

Detailed Description

Compute the PSF, aperture corrections, astrometric and photometric
calibrations, and summary statistics for a single science exposure, and
produce a catalog of brighter stars that were used to calibrate it.

Parameters
----------
initial_stars_schema : `lsst.afw.table.Schema`
    Schema of the initial_stars output catalog.

Definition at line 347 of file calibrateImage.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask.__init__ ( self,
initial_stars_schema = None,
** kwargs )

Definition at line 360 of file calibrateImage.py.

Member Function Documentation

◆ _compute_psf()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._compute_psf ( self,
exposure,
id_generator )
protected
Find bright sources detected on an exposure and fit a PSF model to
them, repairing likely cosmic rays before detection.

Repair, detect, measure, and compute PSF twice, to ensure the PSF
model does not include contributions from cosmic rays.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to detect and measure bright stars on.
id_generator : `lsst.meas.base.IdGenerator`, optional
    Object that generates source IDs and provides random seeds.

Returns
-------
sources : `lsst.afw.table.SourceCatalog`
    Catalog of detected bright sources.
background : `lsst.afw.math.BackgroundList`
    Background that was fit to the exposure during detection.
cell_set : `lsst.afw.math.SpatialCellSet`
    PSF candidates returned by the psf determiner.

Definition at line 575 of file calibrateImage.py.

◆ _find_stars()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._find_stars ( self,
exposure,
background,
id_generator )
protected
Detect stars on an exposure that has a PSF model, and measure their
PSF, circular aperture, compensated gaussian fluxes.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to set the ApCorrMap on.
background : `lsst.afw.math.BackgroundList`
    Background that was fit to the exposure during detection;
    modified in-place during subsequent detection.
id_generator : `lsst.meas.base.IdGenerator`
    Object that generates source IDs and provides random seeds.

Returns
-------
stars : `SourceCatalog`
    Sources that are very likely to be stars, with a limited set of
    measurements performed on them.

Definition at line 668 of file calibrateImage.py.

◆ _fit_astrometry()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._fit_astrometry ( self,
exposure,
stars )
protected
Fit an astrometric model to the data and return the reference
matches used in the fit, and the fitted WCS.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure that is being fit, to get PSF and other metadata from.
    Modified to add the fitted skyWcs.
stars : `SourceCatalog`
    Good stars selected for use in calibration, with RA/Dec coordinates
    computed from the pixel positions and fitted WCS.

Returns
-------
matches : `list` [`lsst.afw.table.ReferenceMatch`]
    Reference/stars matches used in the fit.

Definition at line 776 of file calibrateImage.py.

◆ _fit_photometry()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._fit_photometry ( self,
exposure,
stars )
protected
Fit a photometric model to the data and return the reference
matches used in the fit, and the fitted PhotoCalib.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure that is being fit, to get PSF and other metadata from.
    Modified to be in nanojanksy units, with an assigned photoCalib
    identically 1.
stars : `lsst.afw.table.SourceCatalog`
    Good stars selected for use in calibration.

Returns
-------
calibrated_stars : `lsst.afw.table.SourceCatalog`
    Star catalog with flux/magnitude columns computed from the fitted
    photoCalib.
matches : `list` [`lsst.afw.table.ReferenceMatch`]
    Reference/stars matches used in the fit.
photoCalib : `lsst.afw.image.PhotoCalib`
    Photometric calibration that was fit to the star catalog.

Definition at line 797 of file calibrateImage.py.

◆ _handle_snaps()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._handle_snaps ( self,
exposure )
protected
Combine two snaps into one exposure, or return a single exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure` or `list` [`lsst.afw.image.Exposure]`
    One or two exposures to combine as snaps.

Returns
-------
exposure : `lsst.afw.image.Exposure`
    A single exposure to continue processing.

Raises
------
RuntimeError
    Raised if input does not contain either 1 or 2 exposures.

Definition at line 545 of file calibrateImage.py.

◆ _match_psf_stars()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._match_psf_stars ( self,
psf_stars,
stars )
protected
Match calibration stars to psf stars, to identify which were psf
candidates, and which were used or reserved during psf measurement.

Parameters
----------
psf_stars : `lsst.afw.table.SourceCatalog`
    PSF candidate stars that were sent to the psf determiner. Used to
    populate psf-related flag fields.
stars : `lsst.afw.table.SourceCatalog`
    Stars that will be used for calibration; psf-related fields will
    be updated in-place.

Notes
-----
This code was adapted from CalibrateTask.copyIcSourceFields().

Definition at line 716 of file calibrateImage.py.

◆ _measure_aperture_correction()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._measure_aperture_correction ( self,
exposure,
bright_sources )
protected
Measure and set the ApCorrMap on the Exposure, using
previously-measured bright sources.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure to set the ApCorrMap on.
bright_sources : `lsst.afw.table.SourceCatalog`
    Catalog of detected bright sources; modified to include columns
    necessary for point source determination for the aperture correction
    calculation.

Definition at line 652 of file calibrateImage.py.

◆ _summarize()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask._summarize ( self,
exposure,
stars,
background )
protected
Compute summary statistics on the exposure and update in-place the
calibrations attached to it.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure that was calibrated, to get PSF and other metadata from.
    Modified to contain the computed summary statistics.
stars : `SourceCatalog`
    Good stars selected used in calibration.
background : `lsst.afw.math.BackgroundList`
    Background that was fit to the exposure during detection of the
    above stars.

Definition at line 830 of file calibrateImage.py.

◆ run()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask.run ( self,
* exposures,
id_generator = None,
result = None )
Find stars and perform psf measurement, then do a deeper detection
and measurement and calibrate astrometry and photometry from that.

Parameters
----------
exposures : `lsst.afw.image.Exposure` or `list` [`lsst.afw.image.Exposure`]
    Post-ISR exposure(s), with an initial WCS, VisitInfo, and Filter.
    Modified in-place during processing if only one is passed.
    If two exposures are passed, treat them as snaps and combine
    before doing further processing.
id_generator : `lsst.meas.base.IdGenerator`, optional
    Object that generates source IDs and provides random seeds.
result : `lsst.pipe.base.Struct`, optional
    Result struct that is modified to allow saving of partial outputs
    for some failure conditions. If the task completes successfully,
    this is also returned.

Returns
-------
result : `lsst.pipe.base.Struct`
    Results as a struct with attributes:

    ``exposure``
        Calibrated exposure, with pixels in nJy units.
        (`lsst.afw.image.Exposure`)
    ``stars``
        Stars that were used to calibrate the exposure, with
        calibrated fluxes and magnitudes.
        (`astropy.table.Table`)
    ``stars_footprints``
        Footprints of stars that were used to calibrate the exposure.
        (`lsst.afw.table.SourceCatalog`)
    ``psf_stars``
        Stars that were used to determine the image PSF.
        (`astropy.table.Table`)
    ``psf_stars_footprints``
        Footprints of stars that were used to determine the image PSF.
        (`lsst.afw.table.SourceCatalog`)
    ``background``
        Background that was fit to the exposure when detecting
        ``stars``. (`lsst.afw.math.BackgroundList`)
    ``applied_photo_calib``
        Photometric calibration that was fit to the star catalog and
        applied to the exposure. (`lsst.afw.image.PhotoCalib`)
    ``astrometry_matches``
        Reference catalog stars matches used in the astrometric fit.
        (`list` [`lsst.afw.table.ReferenceMatch`] or `lsst.afw.table.BaseCatalog`)
    ``photometry_matches``
        Reference catalog stars matches used in the photometric fit.
        (`list` [`lsst.afw.table.ReferenceMatch`] or `lsst.afw.table.BaseCatalog`)

Definition at line 454 of file calibrateImage.py.

◆ runQuantum()

lsst.pipe.tasks.calibrateImage.CalibrateImageTask.runQuantum ( self,
butlerQC,
inputRefs,
outputRefs )

Definition at line 408 of file calibrateImage.py.

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.calibrateImage.CalibrateImageTask._DefaultName = "calibrateImage"
staticprotected

Definition at line 357 of file calibrateImage.py.

◆ ConfigClass

lsst.pipe.tasks.calibrateImage.CalibrateImageTask.ConfigClass = CalibrateImageConfig
static

Definition at line 358 of file calibrateImage.py.

◆ initial_stars_schema

lsst.pipe.tasks.calibrateImage.CalibrateImageTask.initial_stars_schema

Definition at line 406 of file calibrateImage.py.

◆ psf_fields

lsst.pipe.tasks.calibrateImage.CalibrateImageTask.psf_fields

Definition at line 382 of file calibrateImage.py.

◆ psf_schema

lsst.pipe.tasks.calibrateImage.CalibrateImageTask.psf_schema

Definition at line 369 of file calibrateImage.py.


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