LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | List of all members
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. More...
 
int getOrder () const
 Return the order of the shapelet expansion. More...
 
BasisTypeEnum getBasisType () const
 Return the type of the shapelet expansion. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

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.

46 : _basisType(basisType), _h(order) {}
table::Key< int > 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]arrayOutput array. Must be preallocated to the correct size.
[in]xx coordinate at which to evaluate the basis.
[in]yy coordinate at which to evaluate the basis.
[out]dxOptional output array for the derivative w.r.t. the x coordinate.
[out]dyOptional 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]arrayOutput array. Must be preallocated to the correct size.
[in]pointCoordinates at which to evaluate the basis.
[out]dxOptional output array for the derivative w.r.t. the x coordinate.
[out]dyOptional output array for the derivative w.r.t. the y coordinate.

Definition at line 96 of file BasisEvaluator.h.

100  {
101  fillEvaluation(array, point.getX(), point.getY(), dx, dy);
102  }
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.

◆ 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]arrayOutput array. Must be preallocated to the correct size.
[in]pointCoordinates at which to evaluate the basis.
[out]dxOptional output array for the derivative w.r.t. the x coordinate.
[out]dyOptional output array for the derivative w.r.t. the y coordinate.

Definition at line 79 of file BasisEvaluator.h.

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

◆ 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]arrayOutput array. Must be preallocated to the correct size.
[in]xMomentIntegrate the expansion multiplied by this power of x.
[in]yMomentIntegrate 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.

52 { 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.

49 { return _h.getOrder(); }

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