read

lsst.images.json.read(cls: type[T], target: str | ParseResult | ResourcePath | Path | ArchiveTree, **kwargs: Any) → ReadResult

Read an object from a JSON file.

Parameters

target

File to read (convertible to lsst.resources.ResourcePath) or an serialization.ArchiveTree to finish deserializing. If the latter, its indirect list will be interpreted and then cleared.

**kwargs

Extra keyword arguments passed to cls.deserialize (e.g. bbox for image subset reads), matching the FITS and NDF backends.

Returns

ReadResult

A named tuple containing the deserialized object and any additional metadata or butler information saved alongside it.

Notes

Supported types must implement deserialize and _get_archive_tree_type (see Image for an example).