|
LSST Applications g013ef56533+63812263fb,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+fde7a7a78c,g210f2d0738+db0c280453,g262e1987ae+abed931625,g29ae962dfc+058d1915d8,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+64337f1634,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+d9e514a434,g64539dfbff+db0c280453,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g7382096ae9+36d16ea71a,g74acd417e5+c70e70fbf6,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+1b779678e3,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+9583a964dd,g98a1a72a9c+028271c396,g98df359435+530b675b85,gb8cb2b794d+4e54f68785,gbf99507273+8c5ae1fdc5,gc2a301910b+db0c280453,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+c70e70fbf6,ge410e46f29+f459a6810c,ge41e95a9f2+db0c280453,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
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 236 of file Background.h.
| using lsst::afw::math::Background::InternalPixelT = float |
type used for any internal images, and returned by getApproximate
Definition at line 263 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 349 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 338 of file Background.h.
|
inline |
Return the UndersampleStyle that we actually used in the last call to getImage()
Definition at line 342 of file Background.h.
|
inline |
Definition at line 360 of file Background.h.
|
inline |
Definition at line 361 of file Background.h.
|
inline |
Method to interpolate and return the background for entire image.
Definition at line 330 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 284 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 308 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 319 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 297 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 366 of file Background.h.
|
mutableprotected |
the undersampleStyle we actually used
Definition at line 367 of file Background.h.
|
protected |
control info set by user.
Definition at line 365 of file Background.h.
|
protected |
size and origin of input image
Definition at line 364 of file Background.h.
|
protected |
x center pix coords of sub images
Definition at line 369 of file Background.h.
|
protected |
x origin pix coords of sub images
Definition at line 371 of file Background.h.
|
protected |
x size of sub images
Definition at line 373 of file Background.h.
|
protected |
y center ...
Definition at line 370 of file Background.h.
|
protected |
y origin ...
Definition at line 372 of file Background.h.
|
protected |
y size ...
Definition at line 374 of file Background.h.