CellCoaddFitsReader

class lsst.cell_coadds.CellCoaddFitsReader(filename: str)

Bases: object

A reader class to read from a FITS file and produce cell-based coadds.

This reader class has read methods that can either return a single component without reading the entire file (e.g., readBBox, readWcs) and read methods that return a full coadd (e.g., readAsMultipleCellCoadd, readAsExplodedCellCoadd, readAsStitchedCoadd).

Parameters:

filenamestr

The name of the FITS file to read.

Attributes Summary

MAXIMUM_FILE_FORMAT_VERSIONS
MINIMUM_FILE_FORMAT_VERSIONS

Methods Summary

isCompatibleWith(written_version, /)	Check if the serialization version is compatible with the reader.
readAsMultipleCellCoadd()	Read the FITS file as a MultipleCellCoadd object.
readWcs()	Read the WCS information from the FITS file.

Attributes Documentation

MAXIMUM_FILE_FORMAT_VERSIONS = ('1.0',)

MINIMUM_FILE_FORMAT_VERSIONS = ('0.1',)

Methods Documentation

classmethod isCompatibleWith(written_version: str, /) → bool

Check if the serialization version is compatible with the reader.

This is a convenience method to ask if the current version of this class can read a file, based on the VERSION in its header.

Parameters:

written_version: `str`

The VERSION of the file to be read.

Returns:

compatiblebool

Whether the reader can read a file whose VERSION is written_version.

Notes

This accepts the other version as a positional argument only.

readAsMultipleCellCoadd() → MultipleCellCoadd

Read the FITS file as a MultipleCellCoadd object.

Raises:

IncompatibleError

Raised if the version of this module that wrote the file is incompatible with this module that is reading it in.

readWcs() → SkyWcs

Read the WCS information from the FITS file.

Returns:

wcsSkyWcs

The WCS information read from the FITS file.