ImageSerializationModel

pydantic model lsst.images.ImageSerializationModel

Pydantic model used to represent the serialized form of an Image.

Parameters:

data (Any)

Fields:

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

• data (lsst.images.serialization._asdf_utils.ArrayReferenceQuantityModel | lsst.images.serialization._asdf_utils.ArrayReferenceModel | lsst.images.serialization._asdf_utils.InlineArrayModel | lsst.images.serialization._asdf_utils.InlineArrayQuantityModel)

• indirect (list[Any])

• metadata (dict[str, MetadataValue])

• min_read_version (int)

• schema_version (str)

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

• yx0 (list[int])

Validators:

• _check_and_normalize_schema_version » all fields

field butler_info: ButlerInfo | None = None

Information about the butler dataset backed by this file.

Validated by:

• _check_and_normalize_schema_version

field data: ArrayReferenceQuantityModel | ArrayReferenceModel | InlineArrayModel | InlineArrayQuantityModel [Required]

Reference to pixel data.

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 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 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] | None = None

Projection that maps the logical pixel grid onto the sky.

Validated by:

• _check_and_normalize_schema_version

field yx0: list[int] [Required]

Coordinate of the first pixels in the array, ordered (y, x).

Validated by:

• _check_and_normalize_schema_version

PUBLIC_TYPE

alias of Image

deserialize(archive, *, bbox=None, strip_header=<function no_header_updates>, **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.

• strip_header (Callable[[Header], None], default: <function no_header_updates at 0x7f27576196c0>) – A callable that strips out any FITS header cards added by the update_header argument in the corresponding call to Image.serialize.

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

Return type:

Image

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] = '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'

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.