lsst.afw  21.0.0-44-ge87b71154+532d44eec1
Functions
lsst.afw.image.image._fitsIoWithOptions Namespace Reference

Functions

def imageReadFitsWithOptions (cls, source, options)
 
def imageWriteFitsWithOptions (self, dest, options)
 
def exposureWriteFitsWithOptions (self, dest, options)
 

Function Documentation

◆ exposureWriteFitsWithOptions()

def 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 : `lsst.daf.base.PropertySet`
    Write options. The items "image", "mask" and "variance" are read.
    Each must be an `lsst.daf.base.PropertySet` with data for
    ``lsst.afw.fits.ImageWriteOptions``.

Definition at line 112 of file _fitsIoWithOptions.py.

◆ imageReadFitsWithOptions()

def 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 36 of file _fitsIoWithOptions.py.

◆ imageWriteFitsWithOptions()

def lsst.afw.image.image._fitsIoWithOptions.imageWriteFitsWithOptions (   self,
  dest,
  options 
)
Write an Image or Mask to FITS, with options

Parameters
----------
dest : `str`
    Fits file path to which to write the image or mask.
options : `lsst.daf.base.PropertySet
    Write options. The item "image" is read. It must contain an
    `lsst.daf.base.PropertySet` with data for
    ``lsst.afw.fits.ImageWriteOptions``.

Definition at line 88 of file _fitsIoWithOptions.py.