Loading [MathJax]/extensions/tex2jax.js
LSST Applications 28.0.0,g1653933729+a8ce1bb630,g1a997c3884+a8ce1bb630,g28da252d5a+5bd70b7e6d,g2bbee38e9b+638fca75ac,g2bc492864f+638fca75ac,g3156d2b45e+07302053f8,g347aa1857d+638fca75ac,g35bb328faa+a8ce1bb630,g3a166c0a6a+638fca75ac,g3e281a1b8c+7bbb0b2507,g4005a62e65+17cd334064,g414038480c+5b5cd4fff3,g41af890bb2+4ffae9de63,g4e1a3235cc+0f1912dca3,g6249c6f860+3c3976f90c,g80478fca09+46aba80bd6,g82479be7b0+77990446f6,g858d7b2824+78ba4d1ce1,g89c8672015+f667a5183b,g9125e01d80+a8ce1bb630,ga5288a1d22+2a6264e9ca,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc22bb204ba+78ba4d1ce1,gc28159a63d+638fca75ac,gcf0d15dbbd+32ddb6096f,gd6b7c0dfd1+3e339405e9,gda3e153d99+78ba4d1ce1,gda6a2b7d83+32ddb6096f,gdaeeff99f8+1711a396fd,gdd5a9049c5+b18c39e5e3,ge2409df99d+a5e4577cdc,ge33fd446bb+78ba4d1ce1,ge79ae78c31+638fca75ac,gf0baf85859+64e8883e75,gf5289d68f6+e1b046a8d7,gfa443fc69c+91d9ed1ecf,gfda6b12a05+8419469a56
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Background.h File Reference
#include <boost/preprocessor/seq.hpp>
#include <memory>
#include "lsst/pex/exceptions.h"
#include "lsst/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

namespace  lsst
 
namespace  lsst::afw
 
namespace  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.
 
template<typename ImageT >
std::shared_ptr< Backgroundlsst::afw::math::makeBackground (ImageT const &img, BackgroundControl const &bgCtrl)
 A convenience function that uses function overloading to make the correct type of Background.
 

Macro Definition Documentation

◆ LSST_makeBackground_getApproximate

#define LSST_makeBackground_getApproximate ( m,
v,
T )
Value:
virtual std::shared_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 395 of file Background.h.

395#define LSST_makeBackground_getApproximate(m, v, T) \
396 virtual std::shared_ptr<Approximate<T>> _getApproximate( \
397 ApproximateControl const& actrl, /* Approximation style */ \
398 UndersampleStyle const undersampleStyle = \
399 THROW_EXCEPTION, /* Behaviour if there are too few points */ \
400 T = 0 /* disambiguate */ \
401 ) const v;

◆ LSST_makeBackground_getApproximate_types

#define LSST_makeBackground_getApproximate_types   (Background::InternalPixelT)

Definition at line 385 of file Background.h.

◆ LSST_makeBackground_getImage

#define LSST_makeBackground_getImage ( m,
v,
T )
Value:
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;
AmpInfoBoxKey bbox
Definition Amplifier.cc:117
An integer coordinate rectangle.
Definition Box.h:55

Definition at line 386 of file Background.h.

386#define LSST_makeBackground_getImage(m, v, T) \
387 virtual std::shared_ptr<lsst::afw::image::Image<T>> _getImage( \
388 lsst::geom::Box2I const& bbox, \
389 Interpolate::Style const interpStyle, /* Style of the interpolation */ \
390 UndersampleStyle const undersampleStyle = \
391 THROW_EXCEPTION, /* Behaviour if there are too few points */ \
392 T = 0 /* disambiguate */ \
393 ) const v;

◆ LSST_makeBackground_getImage_types

#define LSST_makeBackground_getImage_types   (Background::InternalPixelT)

Definition at line 384 of file Background.h.