read_starlink

lsst.images.ndf.read_starlink(cls: type[T], path: str | ParseResult | ResourcePath | Path) → T

Reconstruct an Image or MaskedImage from a schema-less Starlink NDF.

Files written by this package carry a /MORE/LSST/JSON tree and are read through the generic lsst.images.serialization.read / lsst.images.serialization.open. A Starlink-produced NDF has no such tree and therefore no schema, so it cannot go through that path; this function auto-detects a minimal recognised-component set (DATA_ARRAY, VARIANCE, QUALITY, MORE.FITS) instead. WCS is reconstructed when possible; other components are logged-and-dropped.

Parameters

cls

Expected return type; Image and MaskedImage are the only types the auto-detect path can produce.

path

File path or lsst.resources.ResourcePathExpression.

Returns

object

The deserialized cls instance.

Raises

ArchiveReadError

If the file has an LSST JSON tree (use the generic read instead) or no recognised DATA_ARRAY component.