A virtual base class to evaluate image background levels. More...

#include <Background.h>

Inheritance diagram for lsst::afw::math::Background:

Public Types
typedef float	InternalPixelT
	type used for any internal images, and returned by getApproximate More...

Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
virtual void	operator+= (float const delta)=0
	Add a constant level to a background. More...

virtual void	operator-= (float const delta)=0
	Subtract a constant level from a background. More...

template<typename PixelT >
boost::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 >
boost::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 >
boost::shared_ptr < lsst::afw::image::Image < PixelT > >	getImage (lsst::afw::geom::Box2I const &bbox, Interpolate::Style const interpStyle, UndersampleStyle const undersampleStyle=THROW_EXCEPTION) const

template<typename PixelT >
boost::shared_ptr < lsst::afw::image::Image < PixelT > >	getImage (lsst::afw::geom::Box2I const &bbox, std::string const &interpStyle, std::string const &undersampleStyle="THROW_EXCEPTION") const

template<typename PixelT >
boost::shared_ptr < lsst::afw::image::Image < PixelT > >	getImage () const
	Method to interpolate and return the background for entire image. More...

Interpolate::Style	getAsUsedInterpStyle () const

UndersampleStyle	getAsUsedUndersampleStyle () const

boost::shared_ptr < math::Approximate < InternalPixelT > >	getApproximate (ApproximateControl const &actrl, UndersampleStyle const undersampleStyle=THROW_EXCEPTION) const
	Method to return an approximation to the background. More...

geom::Box2I	getImageBBox () const

boost::shared_ptr < BackgroundControl >	getBackgroundControl ()

boost::shared_ptr < BackgroundControl const >	getBackgroundControl () const

Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)

	Citizen (Citizen const &)

	~Citizen ()

Citizen &	operator= (Citizen const &)

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Protected Member Functions
template<typename ImageT >
	Background (ImageT const &img, BackgroundControl const &bgCtrl)
	Constructor for Background. More...

	Background (geom::Box2I const imageBBox, int const nx, int const ny)

virtual	~Background ()
	dtor More...

Protected Attributes
geom::Box2I	_imgBBox
	size and origin of input image More...

boost::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...

Private Member Functions
	Background (Background const &)

Background &	operator= (Background const &)

void	_setCenOrigSize (int const width, int const height, int const nxSample, int const nySample)

Additional Inherited Members
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

A virtual base class to evaluate image background levels.

Definition at line 231 of file Background.h.

Member Typedef Documentation

typedef float lsst::afw::math::Background::InternalPixelT

type used for any internal images, and returned by getApproximate

Definition at line 240 of file Background.h.

Constructor & Destructor Documentation

template<typename ImageT >

lsst::afw::math::Background::Background	(	ImageT const &	img,
		BackgroundControl const &	bgCtrl
	)

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

Note: The old and deprecated API specified the interpolation style as part of the BackgroundControl object passed to this ctor. This is still supported, but the work isn't done until the getImage() method is called

Parameters

img	ImageT (or MaskedImage) whose properties we want
bgCtrl	Control how the Background is estimated

Definition at line 59 of file Background.cc.

                         :
     lsst::daf::base::Citizen(typeid(this)),
     _imgBBox(img.getBBox()),
     _bctrl(new BackgroundControl(bgCtrl)),
     _asUsedInterpStyle(Interpolate::UNKNOWN),
     _asUsedUndersampleStyle(THROW_EXCEPTION),
     _xcen(0),  _ycen(0), _xorig(0), _yorig(0), _xsize(0), _ysize(0)
 {
     if (_imgBBox.isEmpty()) {
         throw LSST_EXCEPT(ex::InvalidParameterError, "Image contains no pixels");
     }
 
     // Check that an int's large enough to hold the number of pixels
     if (_imgBBox.getWidth()*static_cast<double>(_imgBBox.getHeight()) > std::numeric_limits<int>::max()) {
         throw LSST_EXCEPT(lsst::pex::exceptions::OverflowError,
                           str(boost::format("Image %dx%d has more pixels than fit in an int (%d)")
                               % _imgBBox.getWidth() % _imgBBox.getHeight() % std::numeric_limits<int>::max()));
     }
 
     _setCenOrigSize(_imgBBox.getWidth(), _imgBBox.getHeight(), bgCtrl.getNxSample(), bgCtrl.getNySample());
 }

lsst::afw::math::Background::Background	(	geom::Box2I const	imageBBox,
		int const	nx,
		int const	ny
	)

explicitprotected

Create a Background without any values in it

Note: This ctor is mostly used to create a Background given its sample values, and that (in turn) is mostly used to implement persistence.

Parameters

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 90 of file Background.cc.

                         :
     lsst::daf::base::Citizen(typeid(this)),
     _imgBBox(imageBBox),
     _bctrl(new BackgroundControl(nx, ny)),
     _asUsedInterpStyle(Interpolate::UNKNOWN),
     _asUsedUndersampleStyle(THROW_EXCEPTION),
     _xcen(0),  _ycen(0), _xorig(0), _yorig(0), _xsize(0), _ysize(0)
 {
     if (_imgBBox.isEmpty()) {
         throw LSST_EXCEPT(ex::InvalidParameterError, "Image contains no pixels");
     }
 
     // Check that an int's large enough to hold the number of pixels
     if (_imgBBox.getWidth()*static_cast<double>(_imgBBox.getHeight()) > std::numeric_limits<int>::max()) {
         throw LSST_EXCEPT(lsst::pex::exceptions::OverflowError,
                           str(boost::format("Image %dx%d has more pixels than fit in an int (%d)")
                               % _imgBBox.getWidth() % _imgBBox.getHeight() % std::numeric_limits<int>::max()));
     }
 
     _setCenOrigSize(_imgBBox.getWidth(), _imgBBox.getHeight(), nx, ny);
 }

virtual lsst::afw::math::Background::~Background ( )

inlineprotectedvirtual

dtor

Definition at line 238 of file Background.h.

238 { }

lsst::afw::math::Background::Background ( Background const & )

private

Member Function Documentation

void lsst::afw::math::Background::_setCenOrigSize	(	int const	width,
		int const	height,
		int const	nxSample,
		int const	nySample
	)

private

Compute the centers, origins, and sizes of the patches used to compute image statistics when estimating the Background

Definition at line 121 of file Background.cc.

 {
     _xcen.resize( nxSample);  _ycen.resize(nySample);
     _xorig.resize(nxSample); _yorig.resize(nySample);
     _xsize.resize(nxSample), _ysize.resize(nySample);
 
     // Compute the centers and origins for the cells
     for (int iX = 0; iX < nxSample; ++iX) {
         const int endx = std::min(((iX+1)*width + nxSample/2)/nxSample, width);
         _xorig[iX] = (iX == 0) ? 0 : _xorig[iX-1] + _xsize[iX-1];
         _xsize[iX] = endx - _xorig[iX];
         _xcen [iX] = _xorig[iX] + (0.5 * _xsize[iX]) - 0.5;
     }
 
     for (int iY = 0; iY < nySample; ++iY) {
         const int endy = std::min(((iY+1)*height + nySample/2)/nySample, height);
         _yorig[iY] = (iY == 0) ? 0 : _yorig[iY-1] + _ysize[iY-1];
         _ysize[iY] = endy - _yorig[iY];
         _ycen [iY] = _yorig[iY] + (0.5 * _ysize[iY]) - 0.5;
     }
 }

boost::shared_ptr< math::Approximate<InternalPixelT> > lsst::afw::math::Background::getApproximate	(	ApproximateControl const &	actrl,
		UndersampleStyle const	undersampleStyle = `THROW_EXCEPTION`
	)		const

inline

Method to return an approximation to the background.

Parameters

actrl	Approximation style
undersampleStyle	Behaviour if there are too few points

Definition at line 314 of file Background.h.

                                                          {
         InternalPixelT disambiguate = 0;
         return _getApproximate(actrl, undersampleStyle, disambiguate);
     }

Interpolate::Style lsst::afw::math::Background::getAsUsedInterpStyle ( ) const

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 302 of file Background.h.

                                                   {
         return _asUsedInterpStyle;
     }

UndersampleStyle lsst::afw::math::Background::getAsUsedUndersampleStyle ( ) const

inline

Return the UndersampleStyle that we actually used in the last call to getImage()

Definition at line 308 of file Background.h.

                                                        {
         return _asUsedUndersampleStyle;
     }

boost::shared_ptr< BackgroundControl > lsst::afw::math::Background::getBackgroundControl ( )

inline

Definition at line 326 of file Background.h.

326 { return _bctrl; }

lsst::afw::math::Background::_bctrl

boost::shared_ptr< BackgroundControl > _bctrl

control info set by user.

Definition: Background.h:331

boost::shared_ptr< BackgroundControl const> lsst::afw::math::Background::getBackgroundControl ( ) const

inline

Definition at line 327 of file Background.h.

327 { return _bctrl; }

lsst::afw::math::Background::_bctrl

boost::shared_ptr< BackgroundControl > _bctrl

control info set by user.

Definition: Background.h:331

template<typename PixelT >

boost::shared_ptr< lsst::afw::image::Image<PixelT> > lsst::afw::math::Background::getImage	(	Interpolate::Style const	interpStyle,
		UndersampleStyle const	undersampleStyle = `THROW_EXCEPTION`
	)		const

inline

Method to interpolate and return the background for entire image.

Returns: A boost shared-pointer to an image containing the estimated background

Parameters

interpStyle	Style of the interpolation
undersampleStyle	Behaviour if there are too few points

Definition at line 252 of file Background.h.

                                                          {
         return getImage<PixelT>(_imgBBox, interpStyle, undersampleStyle);
     }

template<typename PixelT >

boost::shared_ptr< lsst::afw::image::Image<PixelT> > lsst::afw::math::Background::getImage	(	std::string const &	interpStyle,
		std::string const &	undersampleStyle = `"THROW_EXCEPTION"`
	)		const

inline

Method to interpolate and return the background for entire image.

Returns: A boost shared-pointer to an image containing the estimated background

Parameters

interpStyle	Style of the interpolation
undersampleStyle	Behaviour if there are too few points

Definition at line 264 of file Background.h.

                                                          {
         return getImage<PixelT>(math::stringToInterpStyle(interpStyle),
                                 stringToUndersampleStyle(undersampleStyle));
     }

template<typename PixelT >

boost::shared_ptr< lsst::afw::image::Image<PixelT> > lsst::afw::math::Background::getImage	(	lsst::afw::geom::Box2I const &	bbox,
		Interpolate::Style const	interpStyle,
		UndersampleStyle const	undersampleStyle = `THROW_EXCEPTION`
	)		const

inline

Parameters

bbox	Bounding box for sub-image
interpStyle	Style of the interpolation
undersampleStyle	Behaviour if there are too few points

Definition at line 272 of file Background.h.

                 {
         return _getImage(bbox, interpStyle, undersampleStyle, static_cast<PixelT>(0));
     }

template<typename PixelT >

boost::shared_ptr< lsst::afw::image::Image<PixelT> > lsst::afw::math::Background::getImage	(	lsst::afw::geom::Box2I const &	bbox,
		std::string const &	interpStyle,
		std::string const &	undersampleStyle = `"THROW_EXCEPTION"`
	)		const

inline

Parameters

bbox	Bounding box for sub-image
interpStyle	Style of the interpolation
undersampleStyle	Behaviour if there are too few points

Definition at line 280 of file Background.h.

                 {
         return _getImage(bbox, math::stringToInterpStyle(interpStyle),
                          stringToUndersampleStyle(undersampleStyle), static_cast<PixelT>(0));
     }

template<typename PixelT >

boost::shared_ptr< lsst::afw::image::Image<PixelT> > lsst::afw::math::Background::getImage ( ) const

inline

Method to interpolate and return the background for entire image.

Deprecated:: New code should specify the interpolation style in getImage, not the ctor

Definition at line 294 of file Background.h.

                                                     {
         return getImage<PixelT>(_bctrl->getInterpStyle(), _bctrl->getUndersampleStyle());
     }

geom::Box2I lsst::afw::math::Background::getImageBBox ( ) const

inline

Return the input image's (PARENT) bounding box

Definition at line 324 of file Background.h.

324 { return _imgBBox; }

lsst::afw::math::Background::_imgBBox

geom::Box2I _imgBBox

size and origin of input image

Definition: Background.h:330

virtual void lsst::afw::math::Background::operator+= ( float const delta )

pure virtual

Add a constant level to a background.

Implemented in lsst::afw::math::BackgroundMI.

virtual void lsst::afw::math::Background::operator-= ( float const delta )

pure virtual

Subtract a constant level from a background.

Implemented in lsst::afw::math::BackgroundMI.

Background& lsst::afw::math::Background::operator= ( Background const & )

private

Member Data Documentation

Interpolate::Style lsst::afw::math::Background::_asUsedInterpStyle

mutableprotected

the style we actually used

Definition at line 332 of file Background.h.

UndersampleStyle lsst::afw::math::Background::_asUsedUndersampleStyle

mutableprotected

the undersampleStyle we actually used

Definition at line 333 of file Background.h.

boost::shared_ptr< BackgroundControl > lsst::afw::math::Background::_bctrl

protected

control info set by user.

Definition at line 331 of file Background.h.

geom::Box2I lsst::afw::math::Background::_imgBBox

protected

size and origin of input image

Definition at line 330 of file Background.h.

std::vector<double> lsst::afw::math::Background::_xcen

protected

x center pix coords of sub images

Definition at line 335 of file Background.h.

std::vector<int> lsst::afw::math::Background::_xorig

protected

x origin pix coords of sub images

Definition at line 337 of file Background.h.

std::vector<int> lsst::afw::math::Background::_xsize

protected

x size of sub images

Definition at line 339 of file Background.h.

std::vector<double> lsst::afw::math::Background::_ycen

protected

y center ...

Definition at line 336 of file Background.h.

std::vector<int> lsst::afw::math::Background::_yorig

protected

y origin ...

Definition at line 338 of file Background.h.

std::vector<int> lsst::afw::math::Background::_ysize

protected

y size ...

Definition at line 340 of file Background.h.

The documentation for this class was generated from the following files:

/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/Background.h
/home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/math/Background.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation