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.

def 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``.
    """
    if options is not None:
        try:
            writeOptionDict = {name + "Options": ImageWriteOptions(options.getPropertySet(name))
                               for name in ("image", "mask", "variance")}
        except Exception as e:
            log = Log.getLogger("lsst.afw.image")
            log.warn("Could not parse options; writing with defaults: {}".format(e))
        else:
            self.writeFits(dest, **writeOptionDict)
            return
    self.writeFits(dest)

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.

def 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".
    """
    origin = ImageOrigin.PARENT
    bbox = lsst.geom.Box2I()
    if "bbox" in options:
        bbox = options["bbox"]
    elif "llcX" in options:
        llcX = int(options["llcX"])
        llcY = int(options["llcY"])
        width = int(options["width"])
        height = int(options["height"])
        bbox = lsst.geom.Box2I(lsst.geom.Point2I(llcX, llcY), lsst.geom.Extent2I(width, height))
        if "imageOrigin" in options:
            originStr = str(options["imageOrigin"])
            if (originStr == "LOCAL"):
                origin = ImageOrigin.LOCAL
            elif (originStr == "PARENT"):
                origin = ImageOrigin.PARENT
            else:
                raise RuntimeError("Unknown ImageOrigin type {}".format(originStr))
 
    return cls(source, bbox=bbox, origin=origin)
 
 

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.

def 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``.
    """
    if options is not None:
        try:
            writeOptions = ImageWriteOptions(options.getPropertySet("image"))
        except Exception as e:
            log = Log.getLogger("lsst.afw.image")
            log.warn("Could not parse options; writing with defaults: {}".format(e))
        else:
            self.writeFits(dest, writeOptions)
            return
    self.writeFits(dest)