lsst::afw::math::BackgroundControl Class Reference

Pass parameters to a Background object. More...

#include <Background.h>

Public Member Functions
	BackgroundControl (int const nxSample, int const nySample, StatisticsControl const sctrl=StatisticsControl(), Property const prop=MEANCLIP)
	BackgroundControl (int const nxSample, int const nySample, StatisticsControl const &sctrl, std::string const &prop)
	BackgroundControl (Interpolate::Style const style, int const nxSample=10, int const nySample=10, UndersampleStyle const undersampleStyle=THROW_EXCEPTION, StatisticsControl const sctrl=StatisticsControl(), Property const prop=MEANCLIP)
	BackgroundControl (std::string const &style, int const nxSample=10, int const nySample=10, std::string const &undersampleStyle="THROW_EXCEPTION", StatisticsControl const sctrl=StatisticsControl(), std::string const &prop="MEANCLIP")
virtual	~BackgroundControl ()
void	setNxSample (int nxSample)
void	setNySample (int nySample)
void	setInterpStyle (Interpolate::Style const style)
void	setInterpStyle (std::string const &style)
void	setUndersampleStyle (UndersampleStyle const undersampleStyle)
void	setUndersampleStyle (std::string const &undersampleStyle)
int	getNxSample () const
int	getNySample () const
Interpolate::Style	getInterpStyle () const
UndersampleStyle	getUndersampleStyle () const
boost::shared_ptr < StatisticsControl >	getStatisticsControl ()
boost::shared_ptr < StatisticsControl const >	getStatisticsControl () const
Property	getStatisticsProperty () const
void	setStatisticsProperty (Property prop)
void	setStatisticsProperty (std::string prop)

Private Attributes
Interpolate::Style	_style
int	_nxSample
int	_nySample
UndersampleStyle	_undersampleStyle
boost::shared_ptr < StatisticsControl >	_sctrl
Property	_prop

Detailed Description

Pass parameters to a Background object.

Examples:

spatialCellExample.cc.

Definition at line 62 of file Background.h.

Constructor & Destructor Documentation

lsst::afw::math::BackgroundControl::BackgroundControl ( int const  nxSample, int const  nySample, StatisticsControl const  sctrl = StatisticsControl(), Property const  prop = MEANCLIP  )

inline

Parameters

nxSample	Num. grid samples in x
nySample	Num. grid samples in y
sctrl	Configuration for Stats to be computed
prop	statistical property to use for grid points

Definition at line 64 of file Background.h.

        : _style(Interpolate::AKIMA_SPLINE),
          _nxSample(nxSample), _nySample(nySample),
          _undersampleStyle(THROW_EXCEPTION),
          _sctrl(new StatisticsControl(sctrl)),
          _prop(prop) {
        if (nxSample <= 0 || nySample <= 0) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              str(boost::format("You must specify at least one point, not %dx%d")
                                  % nxSample % nySample)
                             );
        }
    }

lsst::afw::math::BackgroundControl::BackgroundControl ( int const  nxSample, int const  nySample, StatisticsControl const &  sctrl, std::string const &  prop  )

inline

Overload constructor to handle string for statistical operator

Parameters

nxSample	num. grid samples in x
nySample	num. grid samples in y
sctrl	configuration for stats to be computed
prop	statistical property to use for grid points

Definition at line 86 of file Background.h.

        : _style(Interpolate::AKIMA_SPLINE),
          _nxSample(nxSample), _nySample(nySample),
          _undersampleStyle(THROW_EXCEPTION),
          _sctrl(new StatisticsControl(sctrl)),
          _prop(stringToStatisticsProperty(prop)) {
        if (nxSample <= 0 || nySample <= 0) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              str(boost::format("You must specify at least one point, not %dx%d")
                                  % nxSample % nySample)
                             );
        }
    }

lsst::afw::math::BackgroundControl::BackgroundControl ( Interpolate::Style const  style, int const  nxSample = 10, int const  nySample = 10, UndersampleStyle const  undersampleStyle = THROW_EXCEPTION, StatisticsControl const  sctrl = StatisticsControl(), Property const  prop = MEANCLIP  )

inline

Deprecated:

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

Parameters

style	Style of the interpolation
nxSample	Num. grid samples in x
nySample	Num. grid samples in y
undersampleStyle	Behaviour if there are too few points
sctrl	Configuration for Stats to be computed
prop	statistical property to use for grid points

Definition at line 108 of file Background.h.

        : _style(style),
          _nxSample(nxSample), _nySample(nySample),
          _undersampleStyle(undersampleStyle),
          _sctrl(new StatisticsControl(sctrl)),
          _prop(prop) {
        if (nxSample <= 0 || nySample <= 0) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              str(boost::format("You must specify at least one point, not %dx%d")
                                  % nxSample % nySample)
                             );
        }
    }

lsst::afw::math::BackgroundControl::BackgroundControl ( std::string const &  style, int const  nxSample = 10, int const  nySample = 10, std::string const &  undersampleStyle = "THROW_EXCEPTION", StatisticsControl const  sctrl = StatisticsControl(), std::string const &  prop = "MEANCLIP"  )

inline

Overload constructor to handle strings for both interp and undersample styles.

Deprecated:

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

Parameters

style	Style of the interpolation
nxSample	num. grid samples in x
nySample	num. grid samples in y
undersampleStyle	behaviour if there are too few points
sctrl	configuration for stats to be computed
prop	statistical property to use for grid points

Definition at line 134 of file Background.h.

        : _style(math::stringToInterpStyle(style)),
          _nxSample(nxSample), _nySample(nySample),
          _undersampleStyle(math::stringToUndersampleStyle(undersampleStyle)),
          _sctrl(new StatisticsControl(sctrl)),
          _prop(stringToStatisticsProperty(prop)) {
        if (nxSample <= 0 || nySample <= 0) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              str(boost::format("You must specify at least one point, not %dx%d")
                                  % nxSample % nySample)
                             );
        }
    }

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

inlinevirtual

Definition at line 155 of file Background.h.

{}

Member Function Documentation

Interpolate::Style lsst::afw::math::BackgroundControl::getInterpStyle ( ) const

inline

Definition at line 185 of file Background.h.

                                            {
        if (_style < 0 || _style >= Interpolate::NUM_STYLES) {
            throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                              str(boost::format("Style %d is invalid") % _style));

        }
        return _style;
    }

int lsst::afw::math::BackgroundControl::getNxSample ( ) const

inline

Definition at line 183 of file Background.h.

{ return _nxSample; }

int lsst::afw::math::BackgroundControl::getNySample ( ) const

inline

Definition at line 184 of file Background.h.

{ return _nySample; }

boost::shared_ptr< StatisticsControl > lsst::afw::math::BackgroundControl::getStatisticsControl ( )

inline

Definition at line 194 of file Background.h.

{ return _sctrl; }

boost::shared_ptr< StatisticsControl const> lsst::afw::math::BackgroundControl::getStatisticsControl ( ) const

inline

Definition at line 195 of file Background.h.

{ return _sctrl; }

Property lsst::afw::math::BackgroundControl::getStatisticsProperty ( ) const

inline

Definition at line 197 of file Background.h.

{ return _prop; }

UndersampleStyle lsst::afw::math::BackgroundControl::getUndersampleStyle ( ) const

inline

Definition at line 193 of file Background.h.

{ return _undersampleStyle; }

void lsst::afw::math::BackgroundControl::setInterpStyle ( Interpolate::Style const  style )

inline

Definition at line 171 of file Background.h.

{ _style = style; }

void lsst::afw::math::BackgroundControl::setInterpStyle ( std::string const &  style )

inline

Definition at line 173 of file Background.h.

{ _style = math::stringToInterpStyle(style); }

void lsst::afw::math::BackgroundControl::setNxSample ( int  nxSample )

inline

Definition at line 156 of file Background.h.

                                    {
        if (nxSample <= 0) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              str(boost::format("nxSample must be position, not %d") % nxSample));
        }
        _nxSample = nxSample;
    }

void lsst::afw::math::BackgroundControl::setNySample ( int  nySample )

inline

Definition at line 163 of file Background.h.

                                    {
        if (nySample <= 0) {
            throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                              str(boost::format("nySample must be position, not %d") % nySample));
        }
        _nySample = nySample;
    }

void lsst::afw::math::BackgroundControl::setStatisticsProperty ( Property  prop )

inline

Definition at line 198 of file Background.h.

{ _prop = prop; }

void lsst::afw::math::BackgroundControl::setStatisticsProperty ( std::string  prop )

inline

Definition at line 199 of file Background.h.

{ _prop = stringToStatisticsProperty(prop); }

void lsst::afw::math::BackgroundControl::setUndersampleStyle ( UndersampleStyle const  undersampleStyle )

inline

Definition at line 175 of file Background.h.

                                                                       {
        _undersampleStyle = undersampleStyle;
    }

void lsst::afw::math::BackgroundControl::setUndersampleStyle ( std::string const &  undersampleStyle )

inline

Definition at line 179 of file Background.h.

                                                                 {
        _undersampleStyle = math::stringToUndersampleStyle(undersampleStyle);
    }

Member Data Documentation

int lsst::afw::math::BackgroundControl::_nxSample

private

Definition at line 203 of file Background.h.

int lsst::afw::math::BackgroundControl::_nySample

private

Definition at line 204 of file Background.h.

Property lsst::afw::math::BackgroundControl::_prop

private

Definition at line 207 of file Background.h.

boost::shared_ptr< StatisticsControl > lsst::afw::math::BackgroundControl::_sctrl

private

Definition at line 206 of file Background.h.

Interpolate::Style lsst::afw::math::BackgroundControl::_style

private

Definition at line 202 of file Background.h.

UndersampleStyle lsst::afw::math::BackgroundControl::_undersampleStyle

private

Definition at line 205 of file Background.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/math/Background.h