LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
A virtual base class to evaluate image background levels. More...
#include <Background.h>
Public Types | |
typedef float | InternalPixelT |
type used for any internal images, and returned by getApproximate More... | |
Public Member Functions | |
Background (Background const &)=delete | |
Background (Background &&)=delete | |
Background & | operator= (Background const &)=delete |
Background & | operator= (Background &&)=delete |
virtual Background & | operator+= (float const delta)=0 |
Add a constant level to a background. More... | |
virtual Background & | operator-= (float const delta)=0 |
Subtract a constant level from a background. More... | |
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. More... | |
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. More... | |
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. More... | |
Interpolate::Style | getAsUsedInterpStyle () const |
Return the Interpolate::Style that we actually used in the last call to getImage() More... | |
UndersampleStyle | getAsUsedUndersampleStyle () const |
Return the UndersampleStyle that we actually used in the last call to getImage() More... | |
std::shared_ptr< math::Approximate< InternalPixelT > > | getApproximate (ApproximateControl const &actrl, UndersampleStyle const undersampleStyle=THROW_EXCEPTION) const |
Method to return an approximation to the background. More... | |
lsst::geom::Box2I | getImageBBox () const |
Return the input image's (PARENT) bounding box. More... | |
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. More... | |
Background (lsst::geom::Box2I const imageBBox, int const nx, int const ny) | |
Create a Background without any values in it. More... | |
virtual | ~Background ()=default |
dtor More... | |
Protected Attributes | |
lsst::geom::Box2I | _imgBBox |
size and origin of input image More... | |
std::shared_ptr< BackgroundControl > | _bctrl |
control info set by user. More... | |
Interpolate::Style | _asUsedInterpStyle |
the style we actually used More... | |
UndersampleStyle | _asUsedUndersampleStyle |
the undersampleStyle we actually used More... | |
std::vector< double > | _xcen |
x center pix coords of sub images More... | |
std::vector< double > | _ycen |
y center ... More... | |
std::vector< int > | _xorig |
x origin pix coords of sub images More... | |
std::vector< int > | _yorig |
y origin ... More... | |
std::vector< int > | _xsize |
x size of sub images More... | |
std::vector< int > | _ysize |
y size ... More... | |
A virtual base class to evaluate image background levels.
Definition at line 260 of file Background.h.
typedef float lsst::afw::math::Background::InternalPixelT |
type used for any internal images, and returned by getApproximate
Definition at line 293 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.
|
protectedvirtualdefault |
dtor
|
delete |
|
delete |
|
inline |
Method to return an approximation to the background.
actrl | Approximation style |
undersampleStyle | Behaviour if there are too few points |
Definition at line 381 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 370 of file Background.h.
|
inline |
Return the UndersampleStyle that we actually used in the last call to getImage()
Definition at line 374 of file Background.h.
|
inline |
Definition at line 392 of file Background.h.
|
inline |
Definition at line 393 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 312 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 325 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 336 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 347 of file Background.h.
|
inline |
Method to interpolate and return the background for entire image.
Definition at line 362 of file Background.h.
|
inline |
Return the input image's (PARENT) bounding box.
Definition at line 390 of file Background.h.
|
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 398 of file Background.h.
|
mutableprotected |
the undersampleStyle we actually used
Definition at line 399 of file Background.h.
|
protected |
control info set by user.
Definition at line 397 of file Background.h.
|
protected |
size and origin of input image
Definition at line 396 of file Background.h.
|
protected |
x center pix coords of sub images
Definition at line 401 of file Background.h.
|
protected |
x origin pix coords of sub images
Definition at line 403 of file Background.h.
|
protected |
x size of sub images
Definition at line 405 of file Background.h.
|
protected |
y center ...
Definition at line 402 of file Background.h.
|
protected |
y origin ...
Definition at line 404 of file Background.h.
|
protected |
y size ...
Definition at line 406 of file Background.h.