LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
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:49
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: