LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
A 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 More... | |
Public Member Functions | |
template<typename ImageT > | |
BackgroundMI (ImageT const &img, BackgroundControl const &bgCtrl) | |
Constructor for BackgroundMI. More... | |
BackgroundMI (lsst::geom::Box2I const imageDimensions, image::MaskedImage< InternalPixelT > const &statsImage) | |
Recreate a BackgroundMI from the statsImage and the original Image's BBox. More... | |
BackgroundMI (BackgroundMI const &)=delete | |
BackgroundMI (BackgroundMI &&)=delete | |
BackgroundMI & | operator= (BackgroundMI const &)=delete |
BackgroundMI & | operator= (BackgroundMI &&)=delete |
~BackgroundMI () override=default | |
BackgroundMI & | operator+= (float const delta) override |
Add a scalar to the Background (equivalent to adding a constant to the original image) More... | |
BackgroundMI & | operator-= (float const delta) override |
Subtract a scalar from the Background (equivalent to subtracting a constant from the original image) More... | |
lsst::afw::image::MaskedImage< InternalPixelT > | getStatsImage () const |
Return the image of statistical quantities extracted from the image. 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 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 class to evaluate image background levels.
Break an image up into nx*ny sub-images and use a statistical to estimate the background levels in each square. Then use a user-specified or algorithm to estimate background at a given pixel coordinate.
Methods are available to return the background at a point (inefficiently), or an entire background image. BackgroundControl contains a public StatisticsControl member to allow user control of how the backgrounds are computed.
math::BackgroundControl bctrl(7, 7); // number of sub-image squares in {x,y}-dimensions bctrl.sctrl.setNumSigmaClip(5.0); // use 5-sigma clipping for the sub-image means std::shared_ptr<math::Background> backobj = math::makeBackground(img, bctrl); // get a whole background image Image<PixelT> back = backobj->getImage<PixelT>(math::Interpolate::NATURAL_SPLINE);
there is also
// get the background at a pixel at i_x,i_y double someValue = backobj.getPixel(math::Interpolate::LINEAR, i_x, i_y);
Definition at line 434 of file Background.h.
|
inherited |
type used for any internal images, and returned by getApproximate
Definition at line 262 of file Background.h.
|
explicit |
Constructor for BackgroundMI.
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 BackgroundMI is estimated |
defaultValue = 10 statsImage = afwMath.cast_BackgroundMI(bkgd).getStatsImage() sim = statsImage.getImage().getArray() sim[np.isnan(sim)] = defaultValue # replace NaN by defaultValue bkgdImage = bkgd.getImageF(afwMath.Interpolate.NATURAL_SPLINE, afwMath.REDUCE_INTERP_ORDER)There is a ticket (#2825) to allow getImage to specify a default value to use when interpolation fails
Definition at line 80 of file BackgroundMI.cc.
|
explicit |
Recreate a BackgroundMI from the statsImage and the original Image's BBox.
imageDimensions | unbinned Image's BBox |
statsImage | Internal stats image |
Definition at line 107 of file BackgroundMI.cc.
|
delete |
|
delete |
|
overridedefault |
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
Return the UndersampleStyle that we actually used in the last call to getImage()
Definition at line 341 of file Background.h.
|
inlineinherited |
Definition at line 359 of file Background.h.
|
inlineinherited |
Definition at line 360 of file Background.h.
|
inlineinherited |
Method to interpolate and return the background for entire image.
Definition at line 329 of file Background.h.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inlineinherited |
|
inline |
Return the image of statistical quantities extracted from the image.
Definition at line 490 of file Background.h.
|
overridevirtual |
Add a scalar to the Background (equivalent to adding a constant to the original image)
delta | Value to add |
Implements lsst::afw::math::Background.
Definition at line 169 of file BackgroundMI.cc.
|
overridevirtual |
Subtract a scalar from the Background (equivalent to subtracting a constant from the original image)
delta | Value to subtract |
Implements lsst::afw::math::Background.
Definition at line 174 of file BackgroundMI.cc.
|
delete |
|
delete |
|
mutableprotectedinherited |
the style we actually used
Definition at line 365 of file Background.h.
|
mutableprotectedinherited |
the undersampleStyle we actually used
Definition at line 366 of file Background.h.
|
protectedinherited |
control info set by user.
Definition at line 364 of file Background.h.
|
protectedinherited |
size and origin of input image
Definition at line 363 of file Background.h.
|
protectedinherited |
x center pix coords of sub images
Definition at line 368 of file Background.h.
|
protectedinherited |
x origin pix coords of sub images
Definition at line 370 of file Background.h.
|
protectedinherited |
x size of sub images
Definition at line 372 of file Background.h.
|
protectedinherited |
y center ...
Definition at line 369 of file Background.h.
|
protectedinherited |
y origin ...
Definition at line 371 of file Background.h.
|
protectedinherited |
y size ...
Definition at line 373 of file Background.h.