lsst::afw::math::ApproximateControl Class Reference

Control how to make an approximation. More...

#include <Approximate.h>

Public Types
enum	Style { UNKNOWN = -1, CHEBYSHEV, NUM_STYLES }
	Choose the type of approximation to use. More...

Public Member Functions
	ApproximateControl (Style style, int orderX, int orderY=-1, bool weighting=true)
	ctor More...
Style	getStyle () const
	Return the Style. More...
int	getOrderX () const
	Return the order of approximation to use in the x-direction. More...
int	getOrderY () const
	Return the order of approximation to use in the y-direction. More...
bool	getWeighting () const
	Return whether inverse variance weighting will be used in calculation. More...

Private Attributes
Style const	_style
int const	_orderX
int const	_orderY
bool const	_weighting

Detailed Description

Control how to make an approximation.

Note

the x- and y-order must be the same, due to a limitation of Chebyshev1Function2

Definition at line 47 of file Approximate.h.

Member Enumeration Documentation

enum lsst::afw::math::ApproximateControl::Style

Choose the type of approximation to use.

Enumerator
UNKNOWN
CHEBYSHEV	Use a 2-D Chebyshev polynomial.
NUM_STYLES

Definition at line 50 of file Approximate.h.

               {
        UNKNOWN = -1,
        CHEBYSHEV,                      
        NUM_STYLES
    };

Constructor & Destructor Documentation

lsst::afw::math::ApproximateControl::ApproximateControl	(	Style	style,
		int	orderX,
		int	orderY = -1,
		bool	weighting = true
	)

ctor

Parameters

style	Type of approximation
orderX	Order of approximation to use in x-direction
orderY	Order of approximation to use in y-direction
weighting	Use inverse variance weighting?

Definition at line 48 of file Approximate.cc.

                                         :
    _style(style), _orderX(orderX), _orderY(orderY < 0 ? orderX : orderY), _weighting(weighting) {
    if (_orderX != _orderY) {
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                          str(boost::format("X- and Y-orders must be equal (%d != %d) "
                                            "due to a limitation in math::Chebyshev1Function2")
                              % _orderX % _orderY));
    }
}

Member Function Documentation

int lsst::afw::math::ApproximateControl::getOrderX ( ) const

inline

Return the order of approximation to use in the x-direction.

Definition at line 60 of file Approximate.h.

{ return _orderX; }

int lsst::afw::math::ApproximateControl::getOrderY ( ) const

inline

Return the order of approximation to use in the y-direction.

Definition at line 62 of file Approximate.h.

{ return _orderY; }

Style lsst::afw::math::ApproximateControl::getStyle ( ) const

inline

Return the Style.

Definition at line 58 of file Approximate.h.

{ return _style; }

bool lsst::afw::math::ApproximateControl::getWeighting ( ) const

inline

Return whether inverse variance weighting will be used in calculation.

Definition at line 64 of file Approximate.h.

{ return _weighting; }

Member Data Documentation

int const lsst::afw::math::ApproximateControl::_orderX

private

Definition at line 67 of file Approximate.h.

int const lsst::afw::math::ApproximateControl::_orderY

private

Definition at line 68 of file Approximate.h.

Style const lsst::afw::math::ApproximateControl::_style

private

Definition at line 66 of file Approximate.h.

bool const lsst::afw::math::ApproximateControl::_weighting

private

Definition at line 69 of file Approximate.h.

---

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

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