Background.h File Reference

#include <boost/preprocessor/seq.hpp>
#include "boost/shared_ptr.hpp"
#include "lsst/daf/base/Citizen.h"
#include "lsst/pex/exceptions.h"
#include "lsst/afw/geom/Box.h"
#include "lsst/afw/math/Statistics.h"
#include "lsst/afw/math/Interpolate.h"
#include "lsst/afw/math/Approximate.h"

Go to the source code of this file.

Classes
class	lsst.afw.math::BackgroundControl
	Pass parameters to a Background object. More...
class	lsst.afw.math::Background
	A virtual base class to evaluate image background levels. More...
class	lsst.afw.math::BackgroundMI
	A class to evaluate image background levels. More...

Namespaces
	lsst
	< multiple inclusion guard macro
	lsst.afw
	lsst.afw.math

Macros
#define	LSST_makeBackground_getImage_types   (Background::InternalPixelT)
#define	LSST_makeBackground_getApproximate_types   (Background::InternalPixelT)
#define	LSST_makeBackground_getImage(m, v, T)
#define	LSST_makeBackground_getApproximate(m, v, T)

Enumerations
enum	lsst.afw.math::UndersampleStyle { lsst.afw.math::THROW_EXCEPTION, lsst.afw.math::REDUCE_INTERP_ORDER, lsst.afw.math::INCREASE_NXNYSAMPLE }

Functions
UndersampleStyle	lsst.afw.math::stringToUndersampleStyle (std::string const &style)
	Conversion function to switch a string to an UndersampleStyle. More...
template<typename ImageT >
boost::shared_ptr< Background >	lsst.afw.math::makeBackground (ImageT const &img, BackgroundControl const &bgCtrl)
	A convenience function that uses function overloading to make the correct type of Background. More...

Macro Definition Documentation

#define LSST_makeBackground_getApproximate	(		m,
			v,
			T
	)

Value:

virtual PTR(Approximate<T>) _getApproximate( \
        ApproximateControl const& actrl,                          /* Approximation style */ \
        UndersampleStyle const undersampleStyle=THROW_EXCEPTION,  /* Behaviour if there are too few points */\
        T = 0                                                     /* disambiguate */ \
                                                      ) const v;

Definition at line 362 of file Background.h.

#define LSST_makeBackground_getApproximate_types   (Background::InternalPixelT)

Definition at line 353 of file Background.h.

#define LSST_makeBackground_getImage	(		m,
			v,
			T
	)

Value:

virtual PTR(lsst::afw::image::Image<T>) _getImage( \
        lsst::afw::geom::Box2I const& bbox, \
        Interpolate::Style const interpStyle,                     /* Style of the interpolation */ \
        UndersampleStyle const undersampleStyle=THROW_EXCEPTION,  /* Behaviour if there are too few points */\
        T = 0                                                     /* disambiguate */ \
                                                     ) const v;

Definition at line 354 of file Background.h.

#define LSST_makeBackground_getImage_types   (Background::InternalPixelT)

Definition at line 352 of file Background.h.