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 Types | Public Member Functions | Friends | List of all members
lsst::shapelet::ShapeletFunctionEvaluator Class Reference

Evaluates a ShapeletFunction. More...

#include <ShapeletFunction.h>

Public Types

typedef std::shared_ptr< ShapeletFunctionEvaluatorPtr
 
typedef std::shared_ptr< ShapeletFunctionEvaluator const > ConstPtr
 

Public Member Functions

double operator() (double x, double y) const
 Evaluate at the given point. More...
 
double operator() (geom::Point2D const &point) const
 Evaluate at the given point. More...
 
double operator() (geom::Extent2D const &point) const
 Evaluate at the given point. More...
 
ndarray::Array< double, 1, 1 > operator() (ndarray::Array< double const, 1 > const &x, ndarray::Array< double const, 1 > const &y) const
 Evaluate at the given points, returning a newly-allocated array. More...
 
void addToImage (ndarray::Array< double, 2, 1 > const &array, geom::Point2I const &xy0=geom::Point2I()) const
 Add the function to the given image-like array. More...
 
void addToImage (afw::image::Image< double > &image) const
 Evaluate the function on the given image. More...
 
double integrate () const
 Compute the definite integral or integral moments. More...
 
afw::geom::ellipses::Ellipse computeMoments () const
 Return the unweighted dipole and quadrupole moments of the function as an ellipse. More...
 
void update (ShapeletFunction const &function)
 Update the evaluator from the given function. More...
 
 ShapeletFunctionEvaluator (ShapeletFunction const &function)
 Construct an evaluator for the given function. More...
 

Friends

class MultiShapeletFunctionEvaluator
 

Detailed Description

Evaluates a ShapeletFunction.

This is distinct from ShapeletFunction to allow the evaluator to construct temporaries and allocate workspace that will be reused when evaluating at multiple points.

A ShapeletFunctionEvaluator is invalidated whenever the ShapeletFunction it was constructed from is modified.

Definition at line 177 of file ShapeletFunction.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 181 of file ShapeletFunction.h.

◆ Ptr

Definition at line 180 of file ShapeletFunction.h.

Constructor & Destructor Documentation

◆ ShapeletFunctionEvaluator()

lsst::shapelet::ShapeletFunctionEvaluator::ShapeletFunctionEvaluator ( ShapeletFunction const &  function)
explicit

Construct an evaluator for the given function.

Member Function Documentation

◆ addToImage() [1/2]

void lsst::shapelet::ShapeletFunctionEvaluator::addToImage ( afw::image::Image< double > &  image) const
inline

Evaluate the function on the given image.

Definition at line 211 of file ShapeletFunction.h.

211  {
212  addToImage(image.getArray(), image.getXY0());
213  }
void addToImage(ndarray::Array< double, 2, 1 > const &array, geom::Point2I const &xy0=geom::Point2I()) const
Add the function to the given image-like array.
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.

◆ addToImage() [2/2]

void lsst::shapelet::ShapeletFunctionEvaluator::addToImage ( ndarray::Array< double, 2, 1 > const &  array,
geom::Point2I const &  xy0 = geom::Point2I() 
) const

Add the function to the given image-like array.

◆ computeMoments()

afw::geom::ellipses::Ellipse lsst::shapelet::ShapeletFunctionEvaluator::computeMoments ( ) const

Return the unweighted dipole and quadrupole moments of the function as an ellipse.

◆ integrate()

double lsst::shapelet::ShapeletFunctionEvaluator::integrate ( ) const
inline

Compute the definite integral or integral moments.

Definition at line 216 of file ShapeletFunction.h.

216  {
217  return _h.sumIntegration(_coefficients);
218  }
double sumIntegration(ndarray::Array< double const, 1 > const &coeff, int xMoment=0, int yMoment=0) const
Integrate a simple unscaled shapelet expansion.

◆ operator()() [1/4]

double lsst::shapelet::ShapeletFunctionEvaluator::operator() ( double  x,
double  y 
) const
inline

Evaluate at the given point.

Definition at line 184 of file ShapeletFunction.h.

184  {
185  return this->operator()(geom::Point2D(x, y));
186  }
double x
int y
Definition: SpanSet.cc:48
double operator()(double x, double y) const
Evaluate at the given point.

◆ operator()() [2/4]

double lsst::shapelet::ShapeletFunctionEvaluator::operator() ( geom::Extent2D const &  point) const
inline

Evaluate at the given point.

Definition at line 194 of file ShapeletFunction.h.

194  {
195  return _normalization * _h.sumEvaluation(_coefficients, _transform(point));
196  }
double sumEvaluation(ndarray::Array< double const, 1 > const &coeff, double x, double y, double *dx=0, double *dy=0) const
Evaluate a simple unscaled shapelet expansion at the given point.

◆ operator()() [3/4]

double lsst::shapelet::ShapeletFunctionEvaluator::operator() ( geom::Point2D const &  point) const
inline

Evaluate at the given point.

Definition at line 189 of file ShapeletFunction.h.

189  {
190  return _normalization * _h.sumEvaluation(_coefficients, _transform(point));
191  }

◆ operator()() [4/4]

ndarray::Array<double,1,1> lsst::shapelet::ShapeletFunctionEvaluator::operator() ( ndarray::Array< double const, 1 > const &  x,
ndarray::Array< double const, 1 > const &  y 
) const

Evaluate at the given points, returning a newly-allocated array.

◆ update()

void lsst::shapelet::ShapeletFunctionEvaluator::update ( ShapeletFunction const &  function)

Update the evaluator from the given function.

Friends And Related Function Documentation

◆ MultiShapeletFunctionEvaluator

friend class MultiShapeletFunctionEvaluator
friend

Definition at line 231 of file ShapeletFunction.h.


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