lsst.pipe.drivers.background Namespace Reference

Classes
class	BackgroundConfig
class	FocalPlaneBackground
class	FocalPlaneBackgroundConfig
class	SkyMeasurementConfig
class	SkyMeasurementTask
class	SkyStatsConfig

Functions
def	robustMean (array, rej=3.0)
def	interpolate1D (method, xSample, ySample, xInterp)
def	interpolateBadPixels (array, isBad, interpolationStyle)

Function Documentation

interpolate1D()

def lsst.pipe.drivers.background.interpolate1D	(		method,
			xSample,
			ySample,
			xInterp
	)

Interpolate in one dimension

Interpolates the curve provided by `xSample` and `ySample` at
the positions of `xInterp`. Automatically backs off the
interpolation method to achieve successful interpolation.

Parameters
----------
method : `lsst.afw.math.Interpolate.Style`
    Interpolation method to use.
xSample : `numpy.ndarray`
    Vector of ordinates.
ySample : `numpy.ndarray`
    Vector of coordinates.
xInterp : `numpy.ndarray`
    Vector of ordinates to which to interpolate.

Returns
-------
yInterp : `numpy.ndarray`
    Vector of interpolated coordinates.

Definition at line 366 of file background.py.

interpolateBadPixels()

def lsst.pipe.drivers.background.interpolateBadPixels	(		array,
			isBad,
			interpolationStyle
	)

Interpolate bad pixels in an image array

The bad pixels are modified in the array.

Parameters
----------
array : `numpy.ndarray`
    Image array with bad pixels.
isBad : `numpy.ndarray` of type `bool`
    Boolean array indicating which pixels are bad.
interpolationStyle : `str`
    Style for interpolation (see `lsst.afw.math.Background`);
    supported values are CONSTANT, LINEAR, NATURAL_SPLINE,
    AKIMA_SPLINE.

Definition at line 405 of file background.py.

robustMean()

def lsst.pipe.drivers.background.robustMean	(		array,
			rej = 3.0
	)

Measure a robust mean of an array

Parameters
----------
array : `numpy.ndarray`
    Array for which to measure the mean.
rej : `float`
    k-sigma rejection threshold.

Returns
-------
mean : `array.dtype`
    Robust mean of `array`.

Definition at line 15 of file background.py.