lsst.shapelet  13.0-6-ge6e5c2d+5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
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
< ShapeletFunctionEvaluator
Ptr
 
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() (afw::geom::Point2D const &point) const
 Evaluate at the given point. More...
 
double operator() (afw::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, afw::geom::Point2I const &xy0=afw::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

Definition at line 181 of file ShapeletFunction.h.

Definition at line 180 of file ShapeletFunction.h.

Constructor & Destructor Documentation

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

Construct an evaluator for the given function.

Member Function Documentation

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

Add the function to the given image-like array.

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.

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

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

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

Compute the definite integral or integral moments.

Definition at line 216 of file ShapeletFunction.h.

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

Evaluate at the given point.

Definition at line 184 of file ShapeletFunction.h.

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

Evaluate at the given point.

Definition at line 189 of file ShapeletFunction.h.

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

Evaluate at the given point.

Definition at line 194 of file ShapeletFunction.h.

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.

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

Update the evaluator from the given function.

Friends And Related Function Documentation

friend class MultiShapeletFunctionEvaluator
friend

Definition at line 231 of file ShapeletFunction.h.


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