lsst::shapelet::MultiShapeletBasisComponent Class Reference

Simple struct that represents one shapelet expansion in a MultiShapeletBasis. More...

#include <MultiShapeletBasis.h>

Public Member Functions
	MultiShapeletBasisComponent (double radius, int order, ndarray::Array< double const, 2, 2 > const &matrix)
	Main constructor for MultiShapeletBasisComponent. More...
double	getRadius () const
	Return the radius of this shapelet expansion. More...
int	getOrder () const
	Order of this shapelet expansion. More...
ndarray::Array< double const, 2, 2 >	getMatrix () const
	Matrix whose elements [i,j] map MultiShapeletBasis elements j to shapelet terms i. More...

Friends
class	MultiShapeletBasis

Detailed Description

Simple struct that represents one shapelet expansion in a MultiShapeletBasis.

A MultiShapeletBasis is formed by the linear combination of several shapelet bases with different radii and common ellipticity; this represents a single shapelet basis within the MultiShapeletBasis.

Note

This really ought to be an inner class, and should generally be referred to via the MultiShapeletBasis::Component typedef, but Swig doesn't handle inner classes.

Definition at line 40 of file MultiShapeletBasis.h.

Constructor & Destructor Documentation

MultiShapeletBasisComponent()

lsst::shapelet::MultiShapeletBasisComponent::MultiShapeletBasisComponent	(	double	radius,
		int	order,
		ndarray::Array< double const, 2, 2 > const &	matrix
	)

Main constructor for MultiShapeletBasisComponent.

Should usually only be called by MultiShapeletBasis::addComponent.

Parameters

[in]	radius	Radius of the shapelet expansion defined by this component.
[in]	order	Order of the shapelet expansion.
[in]	matrix	Matrix whose elements [i,j] map MultiShapeletBasis elements j to shapelet terms i; must have dimensions [computeSize(order), basis.getSize()], where "basis" is the MultiShapeletBasis this component is attached to. Will be deep-copied by the constructor.

Note that matrix elements follow the amplitude convention defined by ShapeletFunction; values are proportional to flux, not surface brightness.

Member Function Documentation

getMatrix()

ndarray::Array<double const,2,2> lsst::shapelet::MultiShapeletBasisComponent::getMatrix ( ) const

inline

Matrix whose elements [i,j] map MultiShapeletBasis elements j to shapelet terms i.

Definition at line 67 of file MultiShapeletBasis.h.

{ return _matrix; }

getOrder()

int lsst::shapelet::MultiShapeletBasisComponent::getOrder ( ) const

inline

Order of this shapelet expansion.

Definition at line 64 of file MultiShapeletBasis.h.

{ return _order; }

getRadius()

double lsst::shapelet::MultiShapeletBasisComponent::getRadius ( ) const

inline

Return the radius of this shapelet expansion.

Definition at line 61 of file MultiShapeletBasis.h.

{ return _radius; }

Friends And Related Function Documentation

MultiShapeletBasis

friend class MultiShapeletBasis

friend

Definition at line 70 of file MultiShapeletBasis.h.

---

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

• /j/snowflake/release/lsstsw/stack/1a1d771/Linux64/shapelet/20.0.0/include/lsst/shapelet/MultiShapeletBasis.h