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.
double	operator() (geom::Point2D const &point) const
	Evaluate at the given point.
double	operator() (geom::Extent2D const &point) const
	Evaluate at the given point.
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.
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.
void	addToImage (afw::image::Image< double > &image) const
	Evaluate the function on the given image.
double	integrate () const
	Compute the definite integral or integral moments.
afw::geom::ellipses::Ellipse	computeMoments () const
	Return the unweighted dipole and quadrupole moments of the function as an ellipse.
void	update (ShapeletFunction const &function)
	Update the evaluator from the given function.
	ShapeletFunctionEvaluator (ShapeletFunction const &function)
	Construct an evaluator for the given function.

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

typedef std::shared_ptr<ShapeletFunctionEvaluator const> lsst::shapelet::ShapeletFunctionEvaluator::ConstPtr

Definition at line 181 of file ShapeletFunction.h.

Ptr

typedef std::shared_ptr<ShapeletFunctionEvaluator> lsst::shapelet::ShapeletFunctionEvaluator::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.

                                                         {
        addToImage(image.getArray(), image.getXY0());
    }

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.

                             {
        return _h.sumIntegration(_coefficients);
    }

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.

                                                {
        return this->operator()(geom::Point2D(x, y));
    }

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.

                                                        {
        return _normalization * _h.sumEvaluation(_coefficients, _transform(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.

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

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 Symbol 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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/shapelet/g47891489e3+6dc8069a4c/include/lsst/shapelet/ShapeletFunction.h