LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
A virtual base class to evaluate image background levels. More...
#include <Background.h>
Public Types | |
using | InternalPixelT = float |
type used for any internal images, and returned by getApproximate | |
Public Member Functions | |
Background (Background const &)=delete | |
Background (Background &&)=delete | |
virtual | ~Background ()=default |
dtor | |
Background & | operator= (Background const &)=delete |
Background & | operator= (Background &&)=delete |
virtual Background & | operator+= (float const delta)=0 |
Add a constant level to a background. | |
virtual Background & | operator-= (float const delta)=0 |
Subtract a constant level from a background. | |
template<typename PixelT > | |
std::shared_ptr< lsst::afw::image::Image< PixelT > > | getImage (Interpolate::Style const interpStyle, UndersampleStyle const undersampleStyle=THROW_EXCEPTION) const |
Method to interpolate and return the background for entire image. | |
template<typename PixelT > | |
std::shared_ptr< lsst::afw::image::Image< PixelT > > | getImage (std::string const &interpStyle, std::string const &undersampleStyle="THROW_EXCEPTION") const |
Method to interpolate and return the background for entire image. | |
template<typename PixelT > | |
std::shared_ptr< lsst::afw::image::Image< PixelT > > | getImage (lsst::geom::Box2I const &bbox, Interpolate::Style const interpStyle, UndersampleStyle const undersampleStyle=THROW_EXCEPTION) const |
template<typename PixelT > | |
std::shared_ptr< lsst::afw::image::Image< PixelT > > | getImage (lsst::geom::Box2I const &bbox, std::string const &interpStyle, std::string const &undersampleStyle="THROW_EXCEPTION") const |
template<typename PixelT > | |
std::shared_ptr< lsst::afw::image::Image< PixelT > > | getImage () const |
Method to interpolate and return the background for entire image. | |
Interpolate::Style | getAsUsedInterpStyle () const |
Return the Interpolate::Style that we actually used in the last call to getImage() | |
UndersampleStyle | getAsUsedUndersampleStyle () const |
Return the UndersampleStyle that we actually used in the last call to getImage() | |
std::shared_ptr< math::Approximate< InternalPixelT > > | getApproximate (ApproximateControl const &actrl, UndersampleStyle const undersampleStyle=THROW_EXCEPTION) const |
Method to return an approximation to the background. | |
lsst::geom::Box2I | getImageBBox () const |
Return the input image's (PARENT) bounding box. | |
std::shared_ptr< BackgroundControl > | getBackgroundControl () |
std::shared_ptr< BackgroundControl const > | getBackgroundControl () const |
Protected Member Functions | |
template<typename ImageT > | |
Background (ImageT const &img, BackgroundControl const &bgCtrl) | |
Constructor for Background. | |
Background (lsst::geom::Box2I const imageBBox, int const nx, int const ny) | |
Create a Background without any values in it. | |
Protected Attributes | |
lsst::geom::Box2I | _imgBBox |
size and origin of input image | |
std::shared_ptr< BackgroundControl > | _bctrl |
control info set by user. | |
Interpolate::Style | _asUsedInterpStyle |
the style we actually used | |
UndersampleStyle | _asUsedUndersampleStyle |
the undersampleStyle we actually used | |
std::vector< double > | _xcen |
x center pix coords of sub images | |
std::vector< double > | _ycen |
y center ... | |
std::vector< int > | _xorig |
x origin pix coords of sub images | |
std::vector< int > | _yorig |
y origin ... | |
std::vector< int > | _xsize |
x size of sub images | |
std::vector< int > | _ysize |
y size ... | |
A virtual base class to evaluate image background levels.
Definition at line 235 of file Background.h.
using lsst::afw::math::Background::InternalPixelT = float |
type used for any internal images, and returned by getApproximate
Definition at line 262 of file Background.h.
|
explicitprotected |
Constructor for Background.
Estimate the statistical properties of the Image in a grid of cells; we'll later call getImage() to interpolate those values, creating an image the same size as the original
img | ImageT (or MaskedImage) whose properties we want |
bgCtrl | Control how the Background is estimated |
Definition at line 44 of file Background.cc.
|
explicitprotected |
Create a Background without any values in it.
imageBBox | Bounding box for image to be created by getImage() |
nx | Number of samples in x-direction |
ny | Number of samples in y-direction |
Definition at line 69 of file Background.cc.
|
delete |
|
delete |
|
virtualdefault |
dtor
|
inline |
Method to return an approximation to the background.
actrl | Approximation style |
undersampleStyle | Behaviour if there are too few points |
Definition at line 348 of file Background.h.
|
inline |
Return the Interpolate::Style that we actually used in the last call to getImage()
N.b. Interpolate can fallback to a lower order if there aren't enough samples
Definition at line 337 of file Background.h.
|
inline |
Return the UndersampleStyle that we actually used in the last call to getImage()
Definition at line 341 of file Background.h.
|
inline |
Definition at line 359 of file Background.h.
|
inline |
Definition at line 360 of file Background.h.
|
inline |
Method to interpolate and return the background for entire image.
Definition at line 329 of file Background.h.
|
inline |
Method to interpolate and return the background for entire image.
interpStyle | Style of the interpolation |
undersampleStyle | Behaviour if there are too few points |
Definition at line 283 of file Background.h.
|
inline |
bbox | Bounding box for sub-image |
interpStyle | Style of the interpolation |
undersampleStyle | Behaviour if there are too few points |
Definition at line 307 of file Background.h.
|
inline |
bbox | Bounding box for sub-image |
interpStyle | Style of the interpolation |
undersampleStyle | Behaviour if there are too few points |
Definition at line 318 of file Background.h.
|
inline |
Method to interpolate and return the background for entire image.
interpStyle | Style of the interpolation |
undersampleStyle | Behaviour if there are too few points |
Definition at line 296 of file Background.h.
|
inline |
|
pure virtual |
Add a constant level to a background.
Implemented in lsst::afw::math::BackgroundMI.
|
pure virtual |
Subtract a constant level from a background.
Implemented in lsst::afw::math::BackgroundMI.
|
delete |
|
delete |
|
mutableprotected |
the style we actually used
Definition at line 365 of file Background.h.
|
mutableprotected |
the undersampleStyle we actually used
Definition at line 366 of file Background.h.
|
protected |
control info set by user.
Definition at line 364 of file Background.h.
|
protected |
size and origin of input image
Definition at line 363 of file Background.h.
|
protected |
x center pix coords of sub images
Definition at line 368 of file Background.h.
|
protected |
x origin pix coords of sub images
Definition at line 370 of file Background.h.
|
protected |
x size of sub images
Definition at line 372 of file Background.h.
|
protected |
y center ...
Definition at line 369 of file Background.h.
|
protected |
y origin ...
Definition at line 371 of file Background.h.
|
protected |
y size ...
Definition at line 373 of file Background.h.