ObservationSummaryStats

pydantic model lsst.images.ObservationSummaryStats

Various statistics obtained from a single observation.

Parameters:

data (Any)

Fields:

• astromOffsetMean (float)

• astromOffsetStd (float)

• butler_info (lsst.images.serialization._common.ButlerInfo | None)

• centroidDiffShapeletsVsSlotMedian (float)

• dec (float)

• decCorners (tuple[float, float, float, float])

• effTime (float)

• effTimePsfSigmaScale (float)

• effTimeSkyBgScale (float)

• effTimeZeroPointScale (float)

• expTime (float)

• indirect (list[Any])

• magLim (float)

• maxDistToNearestPsf (float)

• meanVar (float)

• metadata (dict[str, MetadataValue])

• min_read_version (int)

• nPsfStar (int)

• nShapeletsStar (int)

• pixelScale (float)

• psfAdaptiveIncludeThresholdMultiplier (float)

• psfAdaptiveThresholdValue (float)

• psfApCorrSigmaScaledDelta (float)

• psfApFluxDelta (float)

• psfArea (float)

• psfIxx (float)

• psfIxy (float)

• psfIyy (float)

• psfSigma (float)

• psfStarDeltaE1Median (float)

• psfStarDeltaE1Scatter (float)

• psfStarDeltaE2Median (float)

• psfStarDeltaE2Scatter (float)

• psfStarDeltaSizeMedian (float)

• psfStarDeltaSizeScatter (float)

• psfStarScaledDeltaSizeScatter (float)

• psfTE1e1 (float)

• psfTE1e2 (float)

• psfTE1ex (float)

• psfTE2e1 (float)

• psfTE2e2 (float)

• psfTE2ex (float)

• psfTE3e1 (float)

• psfTE3e2 (float)

• psfTE3ex (float)

• psfTE4e1 (float)

• psfTE4e2 (float)

• psfTE4ex (float)

• psfTraceRadiusDelta (float)

• ra (float)

• raCorners (tuple[float, float, float, float])

• refCatSourceDensity (float)

• schema_version (str)

• shapeletsCoeffs (tuple[float, ...])

• shapeletsIqScore (float)

• shapeletsOnlyIqScore (float)

• shapeletsStarEMedian (float)

• shapeletsStarUnNormalizedEMedian (float)

• skyBg (float)

• skyNoise (float)

• starComa1Median (float)

• starComa2Median (float)

• starE41Median (float)

• starE42Median (float)

• starEMedian (float)

• starKurtosisMedian (float)

• starTrefoil1Median (float)

• starTrefoil2Median (float)

• starUnNormalizedEMedian (float)

• zenithDistance (float)

• zeroPoint (float)

Validators:

• _check_and_normalize_schema_version » all fields

field astromOffsetMean: float = nan

Astrometry match offset mean.

Validated by:

• _check_and_normalize_schema_version

field astromOffsetStd: float = nan

Astrometry match offset stddev.

Validated by:

• _check_and_normalize_schema_version

field butler_info: ButlerInfo | None = None

Information about the butler dataset backed by this file.

Validated by:

• _check_and_normalize_schema_version

field centroidDiffShapeletsVsSlotMedian: float = nan

Median centroid difference (sqrt((slot_x - shapelet_x)**2 + (slot_y - shapelet_y)**2)) for sources used in the shapelet decomposition (pixels).

Validated by:

• _check_and_normalize_schema_version

field dec: float = nan

Bounding box center Declination (degrees).

Validated by:

• _check_and_normalize_schema_version

field decCorners: tuple[float, float, float, float] [Optional]

Declination of bounding box corners (degrees).

Validated by:

• _check_and_normalize_schema_version

field effTime: float = nan

Effective exposure time calculated from psfSigma, skyBg, and zeroPoint (seconds).

Validated by:

• _check_and_normalize_schema_version

field effTimePsfSigmaScale: float = nan

PSF scaling of the effective exposure time.

Validated by:

• _check_and_normalize_schema_version

field effTimeSkyBgScale: float = nan

Sky background scaling of the effective exposure time.

Validated by:

• _check_and_normalize_schema_version

field effTimeZeroPointScale: float = nan

Zeropoint scaling of the effective exposure time.

Validated by:

• _check_and_normalize_schema_version

field expTime: float = nan

Exposure time of the exposure (seconds).

Validated by:

• _check_and_normalize_schema_version

field indirect: list[Any] [Optional]

Serialized nested objects that may be saved or read more than once.

Validated by:

• _check_and_normalize_schema_version

field magLim: float = nan

Magnitude limit at fixed SNR (default SNR=5) calculated from psfSigma, skyBg, zeroPoint, and readNoise.

Validated by:

• _check_and_normalize_schema_version

field maxDistToNearestPsf: float = nan

Maximum distance of an unmasked pixel to its nearest model psf star (pixels).

Validated by:

• _check_and_normalize_schema_version

field meanVar: float = nan

Mean variance of the weight plane (ADU**2).

Validated by:

• _check_and_normalize_schema_version

field metadata: dict[str, MetadataValue] [Optional]

Additional unstructured metadata.

Validated by:

• _check_and_normalize_schema_version

field min_read_version: int = 1

Smallest reader major that can interpret this tree.

Validated by:

• _check_and_normalize_schema_version

field nPsfStar: int = 0

Number of stars used for psf model.

Validated by:

• _check_and_normalize_schema_version

field nShapeletsStar: int = 0

Number of sources used in the shapelet decomposition.

Validated by:

• _check_and_normalize_schema_version

field pixelScale: float = nan

Measured detector pixel scale (arcsec/pixel).

Validated by:

• _check_and_normalize_schema_version

field psfAdaptiveIncludeThresholdMultiplier: float = nan

Threshold multiplier used in the adaptive threshold detection pass for PSF modelling.

Validated by:

• _check_and_normalize_schema_version

field psfAdaptiveThresholdValue: float = nan

Threshold value used in the adaptive threshold detection pass for PSF modelling.

Validated by:

• _check_and_normalize_schema_version

field psfApCorrSigmaScaledDelta: float = nan

Delta (max - min) of the psf flux aperture correction factors scaled (divided) by the psfSigma evaluated on a grid of unmasked pixels.

Validated by:

• _check_and_normalize_schema_version

field psfApFluxDelta: float = nan

Delta (max - min) of the model psf aperture flux (with aperture radius of max(2, 3*psfSigma)) values evaluated on a grid of unmasked pixels.

Validated by:

• _check_and_normalize_schema_version

field psfArea: float = nan

PSF effective area (pixels**2).

Validated by:

• _check_and_normalize_schema_version

field psfIxx: float = nan

PSF shape Ixx (pixels**2).

Validated by:

• _check_and_normalize_schema_version

field psfIxy: float = nan

PSF shape Ixy (pixels**2).

Validated by:

• _check_and_normalize_schema_version

field psfIyy: float = nan

PSF shape Iyy (pixels**2).

Validated by:

• _check_and_normalize_schema_version

field psfSigma: float = nan

PSF determinant radius (pixels).

Validated by:

• _check_and_normalize_schema_version

field psfStarDeltaE1Median: float = nan

Psf stars median E1 residual (starE1 - psfE1).

Validated by:

• _check_and_normalize_schema_version

field psfStarDeltaE1Scatter: float = nan

Psf stars MAD E1 scatter (starE1 - psfE1).

Validated by:

• _check_and_normalize_schema_version

field psfStarDeltaE2Median: float = nan

Psf stars median E2 residual (starE2 - psfE2).

Validated by:

• _check_and_normalize_schema_version

field psfStarDeltaE2Scatter: float = nan

Psf stars MAD E2 scatter (starE2 - psfE2).

Validated by:

• _check_and_normalize_schema_version

field psfStarDeltaSizeMedian: float = nan

Psf stars median size residual (starSize - psfSize).

Validated by:

• _check_and_normalize_schema_version

field psfStarDeltaSizeScatter: float = nan

Psf stars MAD size scatter (starSize - psfSize).

Validated by:

• _check_and_normalize_schema_version

field psfStarScaledDeltaSizeScatter: float = nan

Psf stars MAD size scatter scaled by psfSize**2.

Validated by:

• _check_and_normalize_schema_version

field psfTE1e1: float = nan

Per-exposure TE1e1 ~ <de1 de1> of PSF residual ellipticity, averaged over theta [0,1] arcmin via treecorr KK correlation. Dimensionless; used to form the full-survey TE1 metric.

Validated by:

• _check_and_normalize_schema_version

field psfTE1e2: float = nan

Per-exposure TE1e2 ~ <de2 de2> of PSF residual ellipticity, averaged over theta [0,1] arcmin via treecorr KK correlation. Dimensionless; used to form the full-survey TE1 metric.

Validated by:

• _check_and_normalize_schema_version

field psfTE1ex: float = nan

Per-exposure TE1ex ~ <de1 de2> of PSF residual ellipticity, averaged over theta [0,1] arcmin via treecorr KK correlation. Dimensionless; used to form the full-survey TE1 metric.

Validated by:

• _check_and_normalize_schema_version

field psfTE2e1: float = nan

Per-exposure TE2e1 ~ <de1 de1> of PSF residual ellipticity, averaged over theta [5,100] arcmin via treecorr KK correlation. Dimensionless; used to form the full-survey TE2 metric.

Validated by:

• _check_and_normalize_schema_version

field psfTE2e2: float = nan

Per-exposure TE2e2 ~ <de2 de2> of PSF residual ellipticity, averaged over theta [5,100] arcmin via treecorr KK correlation. Dimensionless; used to form the full-survey TE2 metric.

Validated by:

• _check_and_normalize_schema_version

field psfTE2ex: float = nan

Per-exposure TE2ex ~ <de1 de2> of PSF residual ellipticity, averaged over theta [5,100] arcmin via treecorr KK correlation. Dimensionless; used to form the full-survey TE2 metric.

Validated by:

• _check_and_normalize_schema_version

field psfTE3e1: float = nan

Per-exposure median-over-CCDs of TE3e1 ~ <de1 de1> of PSF residual ellipticity, where each CCD uses theta within [0,5] arcmin bins. Dimensionless; downstream pipelines take the 85th percentile over images to evaluate TE3.

Validated by:

• _check_and_normalize_schema_version

field psfTE3e2: float = nan

Per-exposure median-over-CCDs of TE3e2 ~ <de2 de2> of PSF residual ellipticity, where each CCD uses theta within [0,5] arcmin bins. Dimensionless; downstream pipelines take the 85th percentile over images to evaluate TE3.

Validated by:

• _check_and_normalize_schema_version

field psfTE3ex: float = nan

Per-exposure median-over-CCDs of TE3ex ~ <de1 de2> of PSF residual ellipticity, where each CCD uses theta within [0,5] arcmin bins. Dimensionless; downstream pipelines take the 85th percentile over images to evaluate TE3.

Validated by:

• _check_and_normalize_schema_version

field psfTE4e1: float = nan

Per-exposure median-over-CCDs of TE4e1 ~ <de1 de1> of PSF residual ellipticity, where each CCD uses theta within [5,20] arcmin bins. Dimensionless; downstream pipelines take the 85th percentile over images to evaluate TE4.

Validated by:

• _check_and_normalize_schema_version

field psfTE4e2: float = nan

Per-exposure median-over-CCDs of TE4e2 ~ <de2 de2> of PSF residual ellipticity, where each CCD uses theta within [5,20] arcmin bins. Dimensionless; downstream pipelines take the 85th percentile over images to evaluate TE4.

Validated by:

• _check_and_normalize_schema_version

field psfTE4ex: float = nan

Per-exposure median-over-CCDs of TE4ex ~ <de1 de2> of PSF residual ellipticity, where each CCD uses theta within [5,20] arcmin bins. Dimensionless; downstream pipelines take the 85th percentile over images to evaluate TE4.

Validated by:

• _check_and_normalize_schema_version

field psfTraceRadiusDelta: float = nan

Delta (max - min) of the model psf trace radius values evaluated on a grid of unmasked pixels (pixels).

Validated by:

• _check_and_normalize_schema_version

field ra: float = nan

Bounding box center Right Ascension (degrees).

Validated by:

• _check_and_normalize_schema_version

field raCorners: tuple[float, float, float, float] [Optional]

Right Ascension of bounding box corners (degrees).

Validated by:

• _check_and_normalize_schema_version

field refCatSourceDensity: float = nan

Source density for the detector region as computed from the loaded reference catalog (number per degrees**2).

Validated by:

• _check_and_normalize_schema_version

field schema_version: str = '1.0.0'

Data-model schema version of this tree (major.minor.patch).

Validated by:

• _check_and_normalize_schema_version

field shapeletsCoeffs: tuple[float, ...] [Optional]

Coefficients from the PSF star shapelet decomposition.

Validated by:

• _check_and_normalize_schema_version

field shapeletsIqScore: float = nan

The dimensionless image quality score as determined from the shapelets decomposition that includes power from the median centroid offset between those used in the decomposition and those of the centroid slot in addition to non-atmospheric decomposition coefficients. The score spans the range [0.0, 1.0] with lower values indicating better image quality.

Validated by:

• _check_and_normalize_schema_version

field shapeletsOnlyIqScore: float = nan

The dimensionless image quality score as determined from the shapelets decomposition that includes power only from the non-atmospheric decomposition coefficients. The score spans the range [0.0, 1.0] with lower values indicating better image quality.

Validated by:

• _check_and_normalize_schema_version

field shapeletsStarEMedian: float = nan

Median ellipticity (sqrt(starE1**2.0 + starE2**2.0)) of the sources used in the shapelet decomposition.

Validated by:

• _check_and_normalize_schema_version

field shapeletsStarUnNormalizedEMedian: float = nan

Median un-normalized ellipticity (sqrt((starXX - starYY)**2.0 + (2.0*starXY)**2.0)) of the sources used in the shapelet decomposition (pixel**2).

Validated by:

• _check_and_normalize_schema_version

field skyBg: float = nan

Average sky background (ADU).

Validated by:

• _check_and_normalize_schema_version

field skyNoise: float = nan

Average sky noise (ADU).

Validated by:

• _check_and_normalize_schema_version

field starComa1Median: float = nan

Coma-like higher-order moment combination: median M30 + M12 of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starComa2Median: float = nan

Coma-like higher-order moment combination: median M21 + M03 of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starE41Median: float = nan

Fourth-order ellipticity-like higher-order moment combination: median M40 - M04 of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starE42Median: float = nan

Fourth-order ellipticity-like higher-order moment combination: median 2*(M31 + M13) of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starEMedian: float = nan

Median ellipticity (sqrt(starE1**2.0 + starE2**2.0)) of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starKurtosisMedian: float = nan

Kurtosis-like higher-order moment combination: median M40 + 2*M22 + M04 of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starTrefoil1Median: float = nan

Trefoil-like higher-order moment combination: median M30 - 3*M12 of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starTrefoil2Median: float = nan

Trefoil-like higher-order moment combination: median 3*M21 - M03 of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field starUnNormalizedEMedian: float = nan

Median un-normalized ellipticity (sqrt((starXX - starYY)**2.0 + (2.0*starXY)**2.0)) of the stars used in the PSF model.

Validated by:

• _check_and_normalize_schema_version

field zenithDistance: float = nan

Bounding box center zenith distance (degrees).

Validated by:

• _check_and_normalize_schema_version

field zeroPoint: float = nan

Mean zeropoint in detector (mag).

Validated by:

• _check_and_normalize_schema_version

PUBLIC_TYPE

alias of ObservationSummaryStats

deserialize(archive, **kwargs)

Extract this object from an archive.

Parameters:

• archive (InputArchive[Any]) – Archive to read from.

• **kwargs (Any) – Optional parameters. Not supported by this class.

Return type:

Self

deserialize_component(component, archive, **kwargs)

Return a component in-memory object that was serialized to this tree.

Parameters:

• component (str) – Name of the component to read.

• archive (InputArchive[Any]) – The input archive to read from.

• **kwargs (Any) – Additional keyword arguments specific to this type.

Raises:

• InvalidComponentError – Raise if component is not recognized.

• InvalidParameterError – Raised for unsupported **kwargs.

Return type:

Any

Notes

The default implementation for this method tries to get an attribute with the component’s name from self, and then:

• returns None if it is None;

• calls deserialize on that object if it is also an ArchiveTree;

• returns it directly otherwise.

If there is no such attribute, it raises InvalidComponentError.

**kwargs are forwarded to component deserialize methods, but are otherwise not checked. Subclasses are generally expected to implement this method to do that checking and handle any components for which the other will not work, and then delegate to super at the end.

classmethod from_legacy(exposure_summary_stats)

Return an ObservationSummaryStats from a legacy lsst.afw.image.ExposureSummaryStats.

Parameters:

exposure_summary_stats (TypeAliasType) – Legacy exposure summary statistics to convert.

Return type:

Self

Notes

Legacy fields that are empty (NaN) are dropped, so a legacy struct that carries fields unknown to this class is accepted as long as those fields are empty. A legacy field that holds a real value but is unknown here raises ValueError, since dropping it would lose data.

serialize(archive)

Write this object to an archive.

Parameters:

archive (OutputArchive[Any]) – Archive to write to.

Return type:

Self

to_legacy()

Convert to an lsst.afw.image.ExposureSummaryStats instance.

Return type:

TypeAliasType

Notes

Empty (NaN) fields are not passed to the legacy struct, so fields defined here that are unknown to the installed version of ExposureSummaryStats are dropped when empty. A field that holds a real value but is unknown to the legacy struct raises ValueError, since dropping it would lose data.

MIN_READ_VERSION: ClassVar[int] = 1

SCHEMA_NAME: ClassVar[str] = 'observation_summary_stats'

SCHEMA_URL_BASE: ClassVar[str] = 'https://images.lsst.io/schemas'

Base for this schema’s URL, as {SCHEMA_URL_BASE}/{name}-{version}.

External packages providing their own schemas should override this (once, on a shared intermediate base class) so their schema URLs are minted under a documentation site they control rather than images.lsst.io.

SCHEMA_VERSION: ClassVar[str] = '1.0.0.dev0'

property schema_url: str

Return the schema URL of this tree’s class.

Computed from SCHEMA_NAME and SCHEMA_VERSION ClassVars.