lsst::shapelet::BasisEvaluator Class Reference

Evaluates a standard shapelet Basis. More...

#include <BasisEvaluator.h>

Public Member Functions
	BasisEvaluator (int order, BasisTypeEnum basisType)
	Construct an evaluator for a shapelet basis with the given order and type.
int	getOrder () const
	Return the order of the shapelet expansion.
BasisTypeEnum	getBasisType () const
	Return the type of the shapelet expansion.
void	fillEvaluation (Array1d const &array, double x, double y, Array1d const &dx=Array1d(), Array1d const &dy=Array1d()) const
	Fill an array with an evaluation vector that can be used to evaluate a shapelet model at a point.
void	fillEvaluation (Array1d const &array, geom::Point2D const &point, Array1d const &dx=Array1d(), Array1d const &dy=Array1d()) const
	Fill an array with an evaluation vector that can be used to evaluate a shapelet model at a point.
void	fillEvaluation (Array1d const &array, geom::Extent2D const &point, Array1d const &dx=Array1d(), Array1d const &dy=Array1d()) const
	Fill an array with an evaluation vector that can be used to evaluate a shapelet model at a point.
void	fillIntegration (Array1d const &array, int xMoment=0, int yMoment=0) const
	Fill an array with an integration vector that can be used to integrate a shapelet model.

Detailed Description

Evaluates a standard shapelet Basis.

Definition at line 42 of file BasisEvaluator.h.

Constructor & Destructor Documentation

BasisEvaluator()

lsst::shapelet::BasisEvaluator::BasisEvaluator ( int order, BasisTypeEnum basisType )

inline

Construct an evaluator for a shapelet basis with the given order and type.

Definition at line 46 of file BasisEvaluator.h.

: _basisType(basisType), _h(order) {}

Member Function Documentation

fillEvaluation() [1/3]

void lsst::shapelet::BasisEvaluator::fillEvaluation	(	Array1d const &	array,
		double	x,
		double	y,
		Array1d const &	dx = Array1d(),
		Array1d const &	dy = Array1d() ) const

Fill an array with an evaluation vector that can be used to evaluate a shapelet model at a point.

Parameters

[out]	array	Output array. Must be preallocated to the correct size.
[in]	x	x coordinate at which to evaluate the basis.
[in]	y	y coordinate at which to evaluate the basis.
[out]	dx	Optional output array for the derivative w.r.t. the x coordinate.
[out]	dy	Optional output array for the derivative w.r.t. the y coordinate.

fillEvaluation() [2/3]

void lsst::shapelet::BasisEvaluator::fillEvaluation ( Array1d const & array, geom::Extent2D const & point, Array1d const & dx = Array1d(), Array1d const & dy = Array1d() ) const

inline

Fill an array with an evaluation vector that can be used to evaluate a shapelet model at a point.

Parameters

[out]	array	Output array. Must be preallocated to the correct size.
[in]	point	Coordinates at which to evaluate the basis.
[out]	dx	Optional output array for the derivative w.r.t. the x coordinate.
[out]	dy	Optional output array for the derivative w.r.t. the y coordinate.

Definition at line 96 of file BasisEvaluator.h.

            {
        fillEvaluation(array, point.getX(), point.getY(), dx, dy);
    }

fillEvaluation() [3/3]

void lsst::shapelet::BasisEvaluator::fillEvaluation ( Array1d const & array, geom::Point2D const & point, Array1d const & dx = Array1d(), Array1d const & dy = Array1d() ) const

inline

Fill an array with an evaluation vector that can be used to evaluate a shapelet model at a point.

Parameters

[out]	array	Output array. Must be preallocated to the correct size.
[in]	point	Coordinates at which to evaluate the basis.
[out]	dx	Optional output array for the derivative w.r.t. the x coordinate.
[out]	dy	Optional output array for the derivative w.r.t. the y coordinate.

Definition at line 79 of file BasisEvaluator.h.

            {
        fillEvaluation(array, point.getX(), point.getY(), dx, dy);
    }

fillIntegration()

void lsst::shapelet::BasisEvaluator::fillIntegration	(	Array1d const &	array,
		int	xMoment = 0,
		int	yMoment = 0 ) const

Fill an array with an integration vector that can be used to integrate a shapelet model.

Parameters

[out]	array	Output array. Must be preallocated to the correct size.
[in]	xMoment	Integrate the expansion multiplied by this power of x.
[in]	yMoment	Integrate the expansion multiplied by this power of y.

getBasisType()

BasisTypeEnum lsst::shapelet::BasisEvaluator::getBasisType ( ) const

inline

Return the type of the shapelet expansion.

Definition at line 52 of file BasisEvaluator.h.

{ return _basisType; }

getOrder()

int lsst::shapelet::BasisEvaluator::getOrder ( ) const

inline

Return the order of the shapelet expansion.

Definition at line 49 of file BasisEvaluator.h.

{ return _h.getOrder(); }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/shapelet/g47891489e3+f459a6810c/include/lsst/shapelet/BasisEvaluator.h