ApertureCorrectionMapSerializationModel

pydantic model lsst.images.aperture_corrections.ApertureCorrectionMapSerializationModel

Serialization model for aperture correction maps.

Notes

The in-memory aperture correction map type is just a dict from str to BaseField, so the serialize and deserialize methods are defined here.

Parameters:

data (Any)

Fields:

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

• fields (dict[str, FieldSerializationModel])

• indirect (list[Any])

• metadata (dict[str, MetadataValue])

• min_read_version (int)

• schema_version (str)

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 fields: dict[str, FieldSerializationModel] [Optional]

Mapping from flux algorithm name to the aperture correction field for that algorithm.

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

PUBLIC_TYPE

alias of dict

deserialize(archive, **kwargs)

Read an aperture correction map from an archive.

Parameters:

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

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

Return type:

TypeAliasType

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.

static serialize(map, archive)

Write an aperture correction map to an archive.

Parameters:

• map (TypeAliasType) – Aperture correction map to serialize.

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

Return type:

ApertureCorrectionMapSerializationModel

MIN_READ_VERSION: ClassVar[int] = 1

SCHEMA_NAME: ClassVar[str] = 'aperture_correction_map'

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.