lsst::shapelet::MultiShapeletBasis Class Reference

A basis formed from a linear combination of shapelet bases that differ only in radius. More...

#include <MultiShapeletBasis.h>

Public Types
typedef MultiShapeletBasisComponent	Component
typedef std::vector< Component >	ComponentVector
typedef ComponentVector::const_iterator	Iterator

Public Member Functions
	MultiShapeletBasis (int size)
	Construct a MultiShapeletBasis with the given number of elements (i.e. free amplitudes). More...
int	getSize () const
	Return the number of elements (i.e. free amplitudes) in the MultiShapeletBasis. More...
int	getComponentCount () const
	Return the number of components (distinct shapelet bases) in the MultiShapeletBasis. More...
Iterator	begin () const
	Iterator over the components (distinct shapelet bases) of the MultiShapeletBasis. More...
Iterator	end () const
void	addComponent (double radius, int order, ndarray::Array< double const, 2, 2 > const &matrix)
	Add a new component (shapelet basis) to the MultiShapeletBasis. More...
void	scale (double factor)
	Multiply the radius of all basis elements by the given factor. More...
void	normalize ()
	Rescale all matrices so each element has unit flux. More...
void	merge (MultiShapeletBasis const &other)
	Combine the given basis with this (in place), by appending its elements. More...
MultiShapeletFunction	makeFunction (afw::geom::ellipses::Ellipse const &ellipse, ndarray::Array< double const, 1, 1 > const &coefficients) const
	Create a MultiShapeletFunction from the basis. More...

Detailed Description

A basis formed from a linear combination of shapelet bases that differ only in radius.

A MultiShapeletBasis can have many "components" (shapelet bases with different orders and radii), which are mapped via matrices into one or more "elements". It's common for a basis to have only one or two elements, representing a galaxy model that is a linear combination of one or two radial profiles. It's also common for most components to be zeroth order (Gaussians), as higher- order shapelet terms don't provide much of an advantage when approximating axisymmetric functions.

MultiShapeletBasis itself provides the interface to define these multi-Gaussian approximations and combine and refine them, and delegates the work of defining them to MultiShapeletFunction (via the makeFunction() method) and the MultiShapeletMatrixBuilder class. MultiShapeletFunction is a more user-friendly and versatile approach, intended for debugging and testing, while the MultiShapletMatrixBuilder approach is intended for performance-critical evaluation of PSF-convolved MultiShapeletBasis objects.

Definition at line 93 of file MultiShapeletBasis.h.

Member Typedef Documentation

Component

typedef MultiShapeletBasisComponent lsst::shapelet::MultiShapeletBasis::Component

Definition at line 95 of file MultiShapeletBasis.h.

ComponentVector

typedef std::vector<Component> lsst::shapelet::MultiShapeletBasis::ComponentVector

Definition at line 96 of file MultiShapeletBasis.h.

Iterator

typedef ComponentVector::const_iterator lsst::shapelet::MultiShapeletBasis::Iterator

Definition at line 97 of file MultiShapeletBasis.h.

Constructor & Destructor Documentation

MultiShapeletBasis()

lsst::shapelet::MultiShapeletBasis::MultiShapeletBasis ( int  size )

explicit

Construct a MultiShapeletBasis with the given number of elements (i.e. free amplitudes).

Member Function Documentation

addComponent()

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

Add a new component (shapelet basis) to the MultiShapeletBasis.

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.

begin()

Iterator lsst::shapelet::MultiShapeletBasis::begin ( ) const

inline

Iterator over the components (distinct shapelet bases) of the MultiShapeletBasis.

Definition at line 110 of file MultiShapeletBasis.h.

{ return _components.begin(); }

end()

Iterator lsst::shapelet::MultiShapeletBasis::end ( ) const

inline

Definition at line 111 of file MultiShapeletBasis.h.

{ return _components.end(); }

getComponentCount()

int lsst::shapelet::MultiShapeletBasis::getComponentCount ( ) const

inline

Return the number of components (distinct shapelet bases) in the MultiShapeletBasis.

Definition at line 106 of file MultiShapeletBasis.h.

{ return _components.size(); }

getSize()

int lsst::shapelet::MultiShapeletBasis::getSize ( ) const

inline

Return the number of elements (i.e. free amplitudes) in the MultiShapeletBasis.

Definition at line 103 of file MultiShapeletBasis.h.

{ return _size; }

makeFunction()

MultiShapeletFunction lsst::shapelet::MultiShapeletBasis::makeFunction	(	afw::geom::ellipses::Ellipse const &	ellipse,
		ndarray::Array< double const, 1, 1 > const &	coefficients
	)		const

Create a MultiShapeletFunction from the basis.

Parameters

[in]	ellipse	Shapelet basis ellipse that will define the MultiShapeletFunction (will be scaled by the radius of each component).
[in]	coefficients	Coefficients of the basis elements.

merge()

void lsst::shapelet::MultiShapeletBasis::merge

(

MultiShapeletBasis const &

other

)

Combine the given basis with this (in place), by appending its elements.

normalize()

void lsst::shapelet::MultiShapeletBasis::normalize

(

)

Rescale all matrices so each element has unit flux.

scale()

void lsst::shapelet::MultiShapeletBasis::scale

(

double

factor

)

Multiply the radius of all basis elements by the given factor.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/shapelet/22.0.1-1-g8e32f31+297cba6710/include/lsst/shapelet/MultiShapeletBasis.h