lsst.meas.algorithms.measureApCorr Namespace Reference

Classes
class	FluxKeys
class	MeasureApCorrConfig
class	MeasureApCorrTask

Functions
def	plotApCorr (bbox, xx, yy, zzMeasure, field, title, doPause)

Function Documentation

plotApCorr()

def lsst.meas.algorithms.measureApCorr.plotApCorr	(		bbox,
			xx,
			yy,
			zzMeasure,
			field,
			title,
			doPause
	)

Plot aperture correction fit residuals

There are two subplots: residuals against x and y.

Intended for debugging.

Parameters
----------
bbox : `lsst.geom.Box2I`
    Bounding box (for bounds)
xx, yy : `numpy.ndarray`, (N)
    x and y coordinates
zzMeasure : `float`
    Measured value of the aperture correction
field : `lsst.afw.math.ChebyshevBoundedField`
    Fit aperture correction field
title : 'str'
    Title for plot
doPause : `bool`
    Pause to inspect the residuals plot? If
    False, there will be a 4 second delay to
    allow for inspection of the plot before
    closing it and moving on.

Definition at line 270 of file measureApCorr.py.

def plotApCorr(bbox, xx, yy, zzMeasure, field, title, doPause):
    """Plot aperture correction fit residuals
 
    There are two subplots: residuals against x and y.
 
    Intended for debugging.
 
    Parameters
    ----------
    bbox : `lsst.geom.Box2I`
        Bounding box (for bounds)
    xx, yy : `numpy.ndarray`, (N)
        x and y coordinates
    zzMeasure : `float`
        Measured value of the aperture correction
    field : `lsst.afw.math.ChebyshevBoundedField`
        Fit aperture correction field
    title : 'str'
        Title for plot
    doPause : `bool`
        Pause to inspect the residuals plot? If
        False, there will be a 4 second delay to
        allow for inspection of the plot before
        closing it and moving on.
    """
    import matplotlib.pyplot as plt
 
    zzFit = field.evaluate(xx, yy)
    residuals = zzMeasure - zzFit
 
    fig, axes = plt.subplots(2, 1)
 
    axes[0].scatter(xx, residuals, s=3, marker='o', lw=0, alpha=0.7)
    axes[1].scatter(yy, residuals, s=3, marker='o', lw=0, alpha=0.7)
    for ax in axes:
        ax.set_ylabel("ApCorr Fit Residual")
        ax.set_ylim(0.9*residuals.min(), 1.1*residuals.max())
    axes[0].set_xlabel("x")
    axes[0].set_xlim(bbox.getMinX(), bbox.getMaxX())
    axes[1].set_xlabel("y")
    axes[1].set_xlim(bbox.getMinY(), bbox.getMaxY())
    plt.suptitle(title)
 
    if not doPause:
        try:
            plt.pause(4)
            plt.close()
        except Exception:
            print("%s: plt.pause() failed. Please close plots when done." % __name__)
            plt.show()
    else:
        print("%s: Please close plots when done." % __name__)
        plt.show()