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
Style	getStyle () const
	Return the Style.
void	setStyle (Style const style)
	Set the Style.
int	getOrderX () const
	Return the order of approximation to use in the x-direction.
void	setOrderX (int const orderX)
	Set the order of approximation to use in the x-direction.
int	getOrderY () const
	Return the order of approximation to use in the y-direction.
void	setOrderY (int const orderY)
	Set the order of approximation to use in the y-direction.
bool	getWeighting () const
	Return whether inverse variance weighting will be used in calculation.
void	setWeighting (bool const weighting)
	Set whether inverse variance weighting will be used in calculation.

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 48 of file Approximate.h.

Member Enumeration Documentation

Style

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 51 of file Approximate.h.

               {
        UNKNOWN = -1,
        CHEBYSHEV,  
        NUM_STYLES
    };

Constructor & Destructor Documentation

ApproximateControl()

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 46 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

getOrderX()

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

inline

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

Definition at line 70 of file Approximate.h.

{ return _orderX; }

getOrderY()

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

inline

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

Definition at line 74 of file Approximate.h.

{ return _orderY; }

getStyle()

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

inline

Return the Style.

Definition at line 66 of file Approximate.h.

{ return _style; }

getWeighting()

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

inline

Return whether inverse variance weighting will be used in calculation.

Definition at line 78 of file Approximate.h.

{ return _weighting; }

setOrderX()

void lsst::afw::math::ApproximateControl::setOrderX ( int const orderX )

inline

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

Definition at line 72 of file Approximate.h.

{ _orderX = orderX; }

setOrderY()

void lsst::afw::math::ApproximateControl::setOrderY ( int const orderY )

inline

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

Definition at line 76 of file Approximate.h.

{ _orderY = orderY; }

setStyle()

void lsst::afw::math::ApproximateControl::setStyle ( Style const style )

inline

Set the Style.

Definition at line 68 of file Approximate.h.

{ _style = style; }

setWeighting()

void lsst::afw::math::ApproximateControl::setWeighting ( bool const weighting )

inline

Set whether inverse variance weighting will be used in calculation.

Definition at line 80 of file Approximate.h.

{ _weighting = weighting; }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g9722cb1a7f+d8f85438e7/include/lsst/afw/math/Approximate.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g9722cb1a7f+d8f85438e7/src/math/Approximate.cc