DifferenceImageSerializationModel

pydantic model lsst.images.DifferenceImageSerializationModel

A Pydantic model used to represent a serialized DifferenceImage.

Parameters:

data (Any)

Fields:

• aperture_corrections (lsst.images.aperture_corrections.ApertureCorrectionMapSerializationModel)

• backgrounds (lsst.images._backgrounds.BackgroundMapSerializationModel)

• band (str)

• bounds (BoundsSerializationModel | None)

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

• detector (lsst.images.cameras.DetectorSerializationModel)

• image (lsst.images._image.ImageSerializationModel[TypeVar])

• indirect (list[Any])

• kernel (ConvolutionKernelSerializationModel | None)

• mask (lsst.images._mask.MaskSerializationModel[TypeVar])

• metadata (dict[str, MetadataValue])

• min_read_version (int)

• obs_info (astro_metadata_translator.observationInfo.ObservationInfo)

• photometric_scaling (FieldSerializationModel | None)

• psf (lsst.images.psfs._piff.PiffSerializationModel | lsst.images.psfs._legacy.PSFExSerializationModel | lsst.images.psfs._gaussian.GaussianPSFSerializationModel | Any)

• schema_version (str)

• sky_projection (lsst.images._transforms._sky_projection.SkyProjectionSerializationModel[TypeVar])

• summary_stats (lsst.images._observation_summary_stats.ObservationSummaryStats)

• templates (list[lsst.images._difference_image.DifferenceImageTemplateInfo] | None)

• variance (lsst.images._image.ImageSerializationModel[TypeVar])

Validators:

• _check_and_normalize_schema_version » all fields

field aperture_corrections: ApertureCorrectionMapSerializationModel [Optional]

Aperture corrections, keyed by flux algorithm.

Validated by:

• _check_and_normalize_schema_version

field backgrounds: BackgroundMapSerializationModel [Optional]

Background models associated with this image.

Validated by:

• _check_and_normalize_schema_version

field band: str [Required]

Short name of the bandpass filter.

Validated by:

• _check_and_normalize_schema_version

field bounds: BoundsSerializationModel | None = None

Pixel validity region, if different from the image bounding box.

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 detector: DetectorSerializationModel [Required]

Geometry and electronic information for the detector.

Validated by:

• _check_and_normalize_schema_version

field image: ImageSerializationModel[P] [Required]

The main data image.

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 kernel: ConvolutionKernelSerializationModel | None [Required]

The convolution kernel used to match the (warped) template to the science image.

Validated by:

• _check_and_normalize_schema_version

field mask: MaskSerializationModel[P] [Required]

Bitmask that annotates the main image’s pixels.

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 obs_info: ObservationInfo [Required]

Standardized description of visit metadata

Validated by:

• _check_and_normalize_schema_version

field photometric_scaling: FieldSerializationModel | None = None

Scaling that can be used to multiply a post-ISR image to yield calibrated pixel values.

Validated by:

• _check_and_normalize_schema_version

field psf: PiffSerializationModel | PSFExSerializationModel | GaussianPSFSerializationModel | Any [Required]

PSF model for the image.

Constraints:

• union_mode = left_to_right

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 sky_projection: SkyProjectionSerializationModel[P] [Required]

Projection that maps the pixel grid to the sky.

Validated by:

• _check_and_normalize_schema_version

field summary_stats: ObservationSummaryStats [Required]

Summary statistics for the observation.

Validated by:

• _check_and_normalize_schema_version

field templates: list[DifferenceImageTemplateInfo] | None [Required]

Information about the template coadds that went into this difference image

Validated by:

• _check_and_normalize_schema_version

field variance: ImageSerializationModel[P] [Required]

Per-pixel variance estimates for the main image.

Validated by:

• _check_and_normalize_schema_version

PUBLIC_TYPE

alias of DifferenceImage

deserialize(archive, *, bbox=None, **kwargs)

Deserialize an image from an input archive.

Parameters:

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

• bbox (Box | None, default: None) – Bounding box of a subimage to read instead.

• **kwargs (Any) – Unsupported keyword arguments are accepted only to provide better error messages (raising serialization.InvalidParameterError).

Return type:

DifferenceImage

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.

MIN_READ_VERSION: ClassVar[int] = 1

SCHEMA_NAME: ClassVar[str] = 'difference_image'

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 bbox: Box

The bounding box of the image.

property schema_url: str

Return the schema URL of this tree’s class.

Computed from SCHEMA_NAME and SCHEMA_VERSION ClassVars.