lsst.pipe.tasks g7ab1c79000+374aa26984
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask Class Reference
Inheritance diagram for lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask:

Public Member Functions

def run (self, exposure, sources, background)
 
def update_psf_stats (self, summary, psf, bbox, sources=None, mask=None, sources_columns=None)
 
def update_wcs_stats (self, summary, wcs, bbox, visitInfo)
 
def update_photo_calib_stats (self, summary, photo_calib)
 
def update_background_stats (self, summary, background)
 
def update_masked_image_stats (self, summary, masked_image)
 

Static Public Attributes

 ConfigClass = ComputeExposureSummaryStatsConfig
 

Detailed Description

Task to compute exposure summary statistics.

This task computes various quantities suitable for DPDD and other
downstream processing at the detector centers, including:
- psfSigma
- psfArea
- psfIxx
- psfIyy
- psfIxy
- ra
- decl
- zenithDistance
- zeroPoint
- skyBg
- skyNoise
- meanVar
- raCorners
- decCorners
- astromOffsetMean
- astromOffsetStd

These additional quantities are computed from the stars in the detector:
- psfStarDeltaE1Median
- psfStarDeltaE2Median
- psfStarDeltaE1Scatter
- psfStarDeltaE2Scatter
- psfStarDeltaSizeMedian
- psfStarDeltaSizeScatter
- psfStarScaledDeltaSizeScatter

Definition at line 74 of file computeExposureSummaryStats.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask.run (   self,
  exposure,
  sources,
  background 
)
Measure exposure statistics from the exposure, sources, and background.

Parameters
----------
exposure : `lsst.afw.image.ExposureF`
sources : `lsst.afw.table.SourceCatalog`
background : `lsst.afw.math.BackgroundList`

Returns
-------
summary : `lsst.afw.image.ExposureSummary`

Definition at line 109 of file computeExposureSummaryStats.py.

◆ update_background_stats()

def lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask.update_background_stats (   self,
  summary,
  background 
)
Compute summary-statistic fields that depend only on the
background model.

Parameters
----------
summary : `lsst.afw.image.ExposureSummaryStats`
    Summary object to update in-place.
background : `lsst.afw.math.BackgroundList` or `None`
    Background model.  If `None`, all fields that depend on the
    background will be reset (generally to NaN).

Notes
-----
This does not include fields that depend on the background-subtracted
masked image; when the background changes, it should generally be
applied to the image and `update_masked_image_stats` should be called
as well.

Definition at line 334 of file computeExposureSummaryStats.py.

◆ update_masked_image_stats()

def lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask.update_masked_image_stats (   self,
  summary,
  masked_image 
)
Compute summary-statistic fields that depend on the masked image
itself.

Parameters
----------
summary : `lsst.afw.image.ExposureSummaryStats`
    Summary object to update in-place.
masked_image : `lsst.afw.image.MaskedImage` or `None`
    Masked image.  If `None`, all fields that depend
    on the masked image will be reset (generally to NaN).

Definition at line 360 of file computeExposureSummaryStats.py.

◆ update_photo_calib_stats()

def lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask.update_photo_calib_stats (   self,
  summary,
  photo_calib 
)
Compute all summary-statistic fields that depend on the photometric
calibration model.

Parameters
----------
summary : `lsst.afw.image.ExposureSummaryStats`
    Summary object to update in-place.
photo_calib : `lsst.afw.image.PhotoCalib` or `None`
    Photometric calibration model.  If `None`, all fields that depend
    on the photometric calibration will be reset (generally to NaN).

Definition at line 317 of file computeExposureSummaryStats.py.

◆ update_psf_stats()

def lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask.update_psf_stats (   self,
  summary,
  psf,
  bbox,
  sources = None,
  mask = None,
  sources_columns = None 
)
Compute all summary-statistic fields that depend on the PSF model.

Parameters
----------
summary : `lsst.afw.image.ExposureSummaryStats`
    Summary object to update in-place.
psf : `lsst.afw.detection.Psf` or `None`
    Point spread function model.  If `None`, all fields that depend on
    the PSF will be reset (generally to NaN).
bbox : `lsst.geom.Box2I`
    Bounding box of the image for which summary stats are being
    computed.
sources : `lsst.afw.table.SourceCatalog`, optional
    Catalog for quantities that are computed from source table columns.
    If `None`, these quantities will be reset (generally to NaN).
mask : `lsst.afw.image.Mask`, optional
    Mask image that may be used to compute distance-to-nearest-star
    metrics.
sources_columns : `collections.abc.Set` [ `str` ], optional
    Set of all column names in ``sources``.  If provided, ``sources``
    may be any table type for which string indexes yield column arrays.
    If not provided, ``sources`` is assumed to be an
    `lsst.afw.table.SourceCatalog`.

Definition at line 149 of file computeExposureSummaryStats.py.

◆ update_wcs_stats()

def lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask.update_wcs_stats (   self,
  summary,
  wcs,
  bbox,
  visitInfo 
)
Compute all summary-statistic fields that depend on the WCS model.

Parameters
----------
summary : `lsst.afw.image.ExposureSummaryStats`
    Summary object to update in-place.
wcs : `lsst.afw.geom.SkyWcs` or `None`
    Astrometric calibration model.  If `None`, all fields that depend
    on the WCS will be reset (generally to NaN).
bbox : `lsst.geom.Box2I`
    Bounding box of the image for which summary stats are being
    computed.
visitInfo : `lsst.afw.image.VisitInfo`
    Observation information used in together with ``wcs`` to compute
    the zenith distance.

Definition at line 258 of file computeExposureSummaryStats.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask.ConfigClass = ComputeExposureSummaryStatsConfig
static

Definition at line 105 of file computeExposureSummaryStats.py.


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