lsst.afw.display._write_fits Namespace Reference

Functions
None	_add_wcs (str wcs_name, PropertyList ps, int x0=0, int y0=0)
None	writeFitsImage (str|int|io.BytesIO file, lsst.afw.image.Image|lsst.afw.image.Mask data, lsst.afw.geom.SkyWcs|None wcs=None, str title="", PropertySet|None metadata=None)

Variables
	_LOG = logging.getLogger(__name__)

Function Documentation

_add_wcs()

None lsst.afw.display._write_fits._add_wcs ( str wcs_name, PropertyList ps, int x0 = 0, int y0 = 0 )

protected

Definition at line 40 of file _write_fits.py.

writeFitsImage()

None lsst.afw.display._write_fits.writeFitsImage	(	str | int | io.BytesIO	file,
		lsst.afw.image.Image | lsst.afw.image.Mask	data,
		lsst.afw.geom.SkyWcs | None	wcs = None,
		str	title = "",
		PropertySet | None	metadata = None )

Write a simple FITS file with no extensions.

Parameters
----------
file : `str` or `int`
    Path to a file or a file descriptor.
data : `lsst.afw.Image` or `lsst.afw.Mask`
    Data to be displayed.
wcs : `lsst.afw.geom.SkyWcs` or `None`, optional
    WCS to be written to header to FITS file.
title : `str`, optional
    If defined, the value to be stored in the ``OBJECT`` header.
    Overrides any value found in ``metadata``.
metadata : `lsst.daf.base.PropertySet` or `None`, optional
    Additional information to be written to FITS header.

Definition at line 51 of file _write_fits.py.

Variable Documentation

_LOG

lsst.afw.display._write_fits._LOG = logging.getLogger(__name__)

protected

Definition at line 37 of file _write_fits.py.