lsst.meas.algorithms.subtractBackground Namespace Reference

Classes
class	SubtractBackgroundConfig
class	SubtractBackgroundTask

Functions
	backgroundFlatContext (maskedImage, doApply, backgroundToPhotometricRatio=None)

Function Documentation

backgroundFlatContext()

lsst.meas.algorithms.subtractBackground.backgroundFlatContext	(		maskedImage,
			doApply,
			backgroundToPhotometricRatio = None )

Context manager to convert from photometric-flattened to background-
flattened image.

Parameters
----------
maskedImage : `lsst.afw.image.MaskedImage`
    Masked image (image + mask + variance) to convert from a
    photometrically flat image to an image suitable for background
    subtraction.
doApply : `bool`
    Apply the conversion? If False, this context manager will not
    do anything.
backgroundToPhotometricRatio : `lsst.afw.image.Image`, optional
    Image to multiply a photometrically-flattened image by to obtain a
    background-flattened image.
    Only used if ``doApply`` is ``True``.

Yields
------
maskedImage : `lsst.afw.image.MaskedImage`
    Masked image converted into an image suitable for background
    subtraction.

Raises
------
RuntimeError if doApply is True and no ratio is supplied.
ValueError if the ratio is not an `lsst.afw.image.Image`.

Definition at line 41 of file subtractBackground.py.

def backgroundFlatContext(maskedImage, doApply, backgroundToPhotometricRatio=None):
    """Context manager to convert from photometric-flattened to background-
    flattened image.
 
    Parameters
    ----------
    maskedImage : `lsst.afw.image.MaskedImage`
        Masked image (image + mask + variance) to convert from a
        photometrically flat image to an image suitable for background
        subtraction.
    doApply : `bool`
        Apply the conversion? If False, this context manager will not
        do anything.
    backgroundToPhotometricRatio : `lsst.afw.image.Image`, optional
        Image to multiply a photometrically-flattened image by to obtain a
        background-flattened image.
        Only used if ``doApply`` is ``True``.
 
    Yields
    ------
    maskedImage : `lsst.afw.image.MaskedImage`
        Masked image converted into an image suitable for background
        subtraction.
 
    Raises
    ------
    RuntimeError if doApply is True and no ratio is supplied.
    ValueError if the ratio is not an `lsst.afw.image.Image`.
    """
    if doApply:
        if backgroundToPhotometricRatio is None:
            raise RuntimeError("backgroundFlatContext called with doApply=True, "
                               "but without a backgroundToPhotometricRatio")
        if not isinstance(backgroundToPhotometricRatio, afwImage.Image):
            raise ValueError("The backgroundToPhotometricRatio must be an lsst.afw.image.Image")
 
        maskedImage *= backgroundToPhotometricRatio
 
    try:
        yield maskedImage
    finally:
        if doApply:
            maskedImage /= backgroundToPhotometricRatio