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, ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
	BackgroundControl (int const nxSample, int const nySample, StatisticsControl const &sctrl, std::string const &prop, ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
	Overload constructor to handle string for statistical operator. More...
	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, ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
	Overload constructor to provide interp style. More...
	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", ApproximateControl const actrl=ApproximateControl(ApproximateControl::UNKNOWN, 1))
	Overload constructor to handle strings for both interp and undersample styles. More...
	BackgroundControl (BackgroundControl const &)=default
	BackgroundControl (BackgroundControl &&)=default
BackgroundControl &	operator= (BackgroundControl const &)=default
BackgroundControl &	operator= (BackgroundControl &&)=default
virtual	~BackgroundControl ()=default
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
std::shared_ptr< StatisticsControl >	getStatisticsControl ()
std::shared_ptr< StatisticsControl const >	getStatisticsControl () const
Property	getStatisticsProperty () const
void	setStatisticsProperty (Property prop)
void	setStatisticsProperty (std::string prop)
void	setApproximateControl (std::shared_ptr< ApproximateControl > actrl)
std::shared_ptr< ApproximateControl >	getApproximateControl ()
std::shared_ptr< ApproximateControl const >	getApproximateControl () const

Detailed Description

Pass parameters to a Background object.

Definition at line 56 of file Background.h.

Constructor & Destructor Documentation

BackgroundControl() [1/6]

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

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
actrl	configuration for approx to be computed

Definition at line 65 of file Background.h.

            : _style(Interpolate::AKIMA_SPLINE),
              _nxSample(nxSample),
              _nySample(nySample),
              _undersampleStyle(THROW_EXCEPTION),
              _sctrl(new StatisticsControl(sctrl)),
              _prop(prop),
              _actrl(new ApproximateControl(actrl)) {
        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));
        }
    }

BackgroundControl() [2/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( int const  nxSample, int const  nySample, StatisticsControl const &  sctrl, std::string const &  prop, ApproximateControl const  actrl = ApproximateControl(ApproximateControl::UNKNOWN, 1)  )

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
actrl	configuration for approx to be computed

Definition at line 91 of file Background.h.

            : _style(Interpolate::AKIMA_SPLINE),
              _nxSample(nxSample),
              _nySample(nySample),
              _undersampleStyle(THROW_EXCEPTION),
              _sctrl(new StatisticsControl(sctrl)),
              _prop(stringToStatisticsProperty(prop)),
              _actrl(new ApproximateControl(actrl)) {
        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));
        }
    }

BackgroundControl() [3/6]

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, ApproximateControl const  actrl = ApproximateControl(ApproximateControl::UNKNOWN, 1)  )

inline

Overload constructor to provide interp style.

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
actrl	configuration for approx to be computed

Definition at line 118 of file Background.h.

            : _style(style),
              _nxSample(nxSample),
              _nySample(nySample),
              _undersampleStyle(undersampleStyle),
              _sctrl(new StatisticsControl(sctrl)),
              _prop(prop),
              _actrl(new ApproximateControl(actrl)) {
        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));
        }
    }

BackgroundControl() [4/6]

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", ApproximateControl const  actrl = ApproximateControl(ApproximateControl::UNKNOWN, 1)  )

inline

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

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
actrl	configuration for approx to be computed

Definition at line 149 of file Background.h.

            : _style(math::stringToInterpStyle(style)),
              _nxSample(nxSample),
              _nySample(nySample),
              _undersampleStyle(math::stringToUndersampleStyle(undersampleStyle)),
              _sctrl(new StatisticsControl(sctrl)),
              _prop(stringToStatisticsProperty(prop)),
              _actrl(new ApproximateControl(actrl)) {
        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));
        }
    }

BackgroundControl() [5/6]

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

default

BackgroundControl() [6/6]

lsst::afw::math::BackgroundControl::BackgroundControl ( BackgroundControl &&  )

default

~BackgroundControl()

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

virtualdefault

Member Function Documentation

getApproximateControl() [1/2]

std::shared_ptr<ApproximateControl> lsst::afw::math::BackgroundControl::getApproximateControl ( )

inline

Definition at line 219 of file Background.h.

{ return _actrl; }

getApproximateControl() [2/2]

std::shared_ptr<ApproximateControl const> lsst::afw::math::BackgroundControl::getApproximateControl ( ) const

inline

Definition at line 220 of file Background.h.

{ return _actrl; }

getInterpStyle()

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

inline

Definition at line 203 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;
    }

getNxSample()

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

inline

Definition at line 201 of file Background.h.

{ return _nxSample; }

getNySample()

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

inline

Definition at line 202 of file Background.h.

{ return _nySample; }

getStatisticsControl() [1/2]

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

inline

Definition at line 211 of file Background.h.

{ return _sctrl; }

getStatisticsControl() [2/2]

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

inline

Definition at line 212 of file Background.h.

{ return _sctrl; }

getStatisticsProperty()

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

inline

Definition at line 214 of file Background.h.

{ return _prop; }

getUndersampleStyle()

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

inline

Definition at line 210 of file Background.h.

{ return _undersampleStyle; }

operator=() [1/2]

BackgroundControl& lsst::afw::math::BackgroundControl::operator= ( BackgroundControl &&  )

default

operator=() [2/2]

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

default

setApproximateControl()

void lsst::afw::math::BackgroundControl::setApproximateControl ( std::shared_ptr< ApproximateControl >  actrl )

inline

Definition at line 218 of file Background.h.

{ _actrl = actrl; }

setInterpStyle() [1/2]

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

inline

Definition at line 189 of file Background.h.

{ _style = style; }

setInterpStyle() [2/2]

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

inline

Definition at line 191 of file Background.h.

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

setNxSample()

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

inline

Definition at line 174 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;
    }

setNySample()

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

inline

Definition at line 181 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;
    }

setStatisticsProperty() [1/2]

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

inline

Definition at line 215 of file Background.h.

{ _prop = prop; }

setStatisticsProperty() [2/2]

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

inline

Definition at line 216 of file Background.h.

{ _prop = stringToStatisticsProperty(prop); }

setUndersampleStyle() [1/2]

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

inline

Definition at line 197 of file Background.h.

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

setUndersampleStyle() [2/2]

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

inline

Definition at line 193 of file Background.h.

                                                                      {
        _undersampleStyle = undersampleStyle;
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/math/Background.h