Functions
	imageReadFitsWithOptions (cls, source, options)

	imageWriteFitsWithOptions (self, dest, options, item="image")

	exposureWriteFitsWithOptions (self, dest, options)

Variables
	_LOG = logging.getLogger("lsst.afw.image")

Function Documentation

◆ exposureWriteFitsWithOptions()

lsst.afw.image._image._fitsIoWithOptions.exposureWriteFitsWithOptions	(	self,
		dest,
		options )

Write an Exposure or MaskedImage to FITS, with options

Parameters
----------
dest : `str`
    Fits file path to which to write the exposure or masked image.
options : `~collections.abc.Mapping`
    Write options. The items "image", "mask" and "variance" are read.
    Each must contain a mapping with data for
    `lsst.afw.fits.CompressionOptions.from_mapping`, or `None` for no
    compression.

Definition at line 111 of file _fitsIoWithOptions.py.

◆ imageReadFitsWithOptions()

lsst.afw.image._image._fitsIoWithOptions.imageReadFitsWithOptions	(	cls,
		source,
		options )

Read an Image, Mask, MaskedImage or Exposure from  a FITS file,
with options.

Parameters
----------
source : `str`
    Fits file path from which to read image, mask, masked image
    or exposure.
options : `lsst.daf.base.PropertySet` or `dict`
    Read options:

    - llcX: bbox minimum x (int)
    - llcY: bbox minimum y (int, must be present if llcX is present)
    - width: bbox width (int, must be present if llcX is present)
    - height: bbox height (int, must be present if llcX is present)
    - imageOrigin: one of "LOCAL" or "PARENT" (has no effect unless
        a bbox is specified by llcX, etc.)

    Alternatively, a bounding box () can be passed on with the
    ``"bbox"'' (`lsst.geom.Box2I`) key.

Raises
------
RuntimeError
    If options contains an unknown value for "imageOrigin"
lsst.pex.exceptions.NotFoundError
    If options contains "llcX" and is missing any of
    "llcY", "width", or "height".

Definition at line 37 of file _fitsIoWithOptions.py.

◆ imageWriteFitsWithOptions()

lsst.afw.image._image._fitsIoWithOptions.imageWriteFitsWithOptions	(	self,
		dest,
		options,
		item = "image" )

Write an Image or Mask to FITS, with options

Parameters
----------
dest : `str`
    Fits file path to which to write the image or mask.
options : `~collections.abc.Mapping`
    Write options. The item ``item`` is accessed (which defaults to
    "image"). It must contain a mapping with data for
    `lsst.afw.fits.CompressionOptions.from_mapping`, or `None` for no
    compression.
item : `str`, optional
    Item to read from the ``options`` parameter.

Definition at line 89 of file _fitsIoWithOptions.py.

Variable Documentation

◆ _LOG

lsst.afw.image._image._fitsIoWithOptions._LOG = logging.getLogger("lsst.afw.image")

protected

Definition at line 29 of file _fitsIoWithOptions.py.