lsst::shapelet::MatrixBuilder< T > Class Template Reference

Class that evaluates a (multi-)shapelet basis at predefined points. More...

#include <MatrixBuilder.h>

Public Types
typedef MatrixBuilderFactory< T >	Factory
	Factory type associated with this builder.
typedef MatrixBuilderWorkspace< T >	Workspace
	Workspace type associated with this builder.

Public Member Functions
	MatrixBuilder (ndarray::Array< T const, 1, 1 > const &x, ndarray::Array< T const, 1, 1 > const &y, int order)
	Create a MatrixBuilder that evaluates a simple non-compound shapelet basis.
	MatrixBuilder (ndarray::Array< T const, 1, 1 > const &x, ndarray::Array< T const, 1, 1 > const &y, int order, ShapeletFunction const &psf)
	Create a MatrixBuilder that evaluates a simple non-compound shapelet basis after convolving it with a ShapeletFunction.
	MatrixBuilder (ndarray::Array< T const, 1, 1 > const &x, ndarray::Array< T const, 1, 1 > const &y, MultiShapeletBasis const &basis)
	Create a MatrixBuilder that evaluates a MultiShapeletBasis object.
	MatrixBuilder (ndarray::Array< T const, 1, 1 > const &x, ndarray::Array< T const, 1, 1 > const &y, MultiShapeletBasis const &basis, MultiShapeletFunction const &psf)
	Create a MatrixBuilder that evaluates a MultiShapeletBasis object after convolving it with a MultiShapeletFunction.
int	getDataSize () const
	Return the number of data points.
int	getBasisSize () const
	Return the number of basis elements.
ndarray::Array< T, 2,-2 >	allocateOutput () const
	Return a matrix appropriate for use as an output for operator().
void	operator() (ndarray::Array< T, 2,-1 > const &output, afw::geom::ellipses::Ellipse const &ellipse) const
	Fill an array with the model matrix.
ndarray::Array< T, 2,-2 >	operator() (afw::geom::ellipses::Ellipse const &ellipse) const
	Return a newly-allocated model matrix.

Friends
template<typename U >
class	MatrixBuilderFactory

Detailed Description

template<typename T>
class lsst::shapelet::MatrixBuilder< T >

Class that evaluates a (multi-)shapelet basis at predefined points.

The output "matrix" has pixels along the rows, and basis elements along columns; this is the design matrix involved in a linear least squares fit for the basis coefficients.

A MatrixBuilder can be constructed in two ways: via one of its own constructors, or via a MatrixBuilderFactory. Using the latter allows the workspace arrays used by the MatrixBuilder to be shared between instances. See MatrixBuilderFactory and MatrixBuilderWorkspace for more information.

Definition at line 55 of file MatrixBuilder.h.

Member Typedef Documentation

Factory

template<typename T >

typedef MatrixBuilderFactory<T> lsst::shapelet::MatrixBuilder< T >::Factory

Factory type associated with this builder.

Definition at line 58 of file MatrixBuilder.h.

Workspace

template<typename T >

typedef MatrixBuilderWorkspace<T> lsst::shapelet::MatrixBuilder< T >::Workspace

Workspace type associated with this builder.

Definition at line 59 of file MatrixBuilder.h.

Constructor & Destructor Documentation

MatrixBuilder() [1/4]

template<typename T >

lsst::shapelet::MatrixBuilder< T >::MatrixBuilder	(	ndarray::Array< T const, 1, 1 > const &	x,
		ndarray::Array< T const, 1, 1 > const &	y,
		int	order )

Create a MatrixBuilder that evaluates a simple non-compound shapelet basis.

Parameters

[in]	x	column positions at which the basis should be evaluated.
[in]	y	row positions at which the basis should be evaluated (same size as x).
[in]	order	order of the shapelet basis

MatrixBuilder() [2/4]

template<typename T >

lsst::shapelet::MatrixBuilder< T >::MatrixBuilder	(	ndarray::Array< T const, 1, 1 > const &	x,
		ndarray::Array< T const, 1, 1 > const &	y,
		int	order,
		ShapeletFunction const &	psf )

Create a MatrixBuilder that evaluates a simple non-compound shapelet basis after convolving it with a ShapeletFunction.

Parameters

[in]	x	column positions at which the basis should be evaluated.
[in]	y	row positions at which the basis should be evaluated (same size as x).
[in]	order	order of the shapelet basis
[in]	psf	function to convolve the basis with

MatrixBuilder() [3/4]

template<typename T >

lsst::shapelet::MatrixBuilder< T >::MatrixBuilder	(	ndarray::Array< T const, 1, 1 > const &	x,
		ndarray::Array< T const, 1, 1 > const &	y,
		MultiShapeletBasis const &	basis )

Create a MatrixBuilder that evaluates a MultiShapeletBasis object.

Parameters

[in]	x	column positions at which the basis should be evaluated.
[in]	y	row positions at which the basis should be evaluated (same size as x).
[in]	basis	basis object defining the functions the matrix evaluates

MatrixBuilder() [4/4]

template<typename T >

lsst::shapelet::MatrixBuilder< T >::MatrixBuilder	(	ndarray::Array< T const, 1, 1 > const &	x,
		ndarray::Array< T const, 1, 1 > const &	y,
		MultiShapeletBasis const &	basis,
		MultiShapeletFunction const &	psf )

Create a MatrixBuilder that evaluates a MultiShapeletBasis object after convolving it with a MultiShapeletFunction.

Parameters

[in]	x	column positions at which the basis should be evaluated.
[in]	y	row positions at which the basis should be evaluated (same size as x).
[in]	basis	basis object defining the functions the matrix evaluates
[in]	psf	function to convolve the basis with

Member Function Documentation

allocateOutput()

template<typename T >

ndarray::Array< T, 2,-2 > lsst::shapelet::MatrixBuilder< T >::allocateOutput

(

)

const

Return a matrix appropriate for use as an output for operator().

getBasisSize()

template<typename T >

int lsst::shapelet::MatrixBuilder< T >::getBasisSize

(

)

const

Return the number of basis elements.

getDataSize()

template<typename T >

int lsst::shapelet::MatrixBuilder< T >::getDataSize

(

)

const

Return the number of data points.

operator()() [1/2]

template<typename T >

ndarray::Array< T, 2,-2 > lsst::shapelet::MatrixBuilder< T >::operator() ( afw::geom::ellipses::Ellipse const & ellipse ) const

inline

Return a newly-allocated model matrix.

Parameters

[in]

ellipse

Ellipse parameters of the model, with center relative to the x and y arrays passed at construction.

Definition at line 149 of file MatrixBuilder.h.

                                                                                  {
        ndarray::Array<T,2,-2> output = allocateOutput();
        (*this)(output, ellipse);
        return output;
    }

operator()() [2/2]

template<typename T >

void lsst::shapelet::MatrixBuilder< T >::operator()	(	ndarray::Array< T, 2,-1 > const &	output,
		afw::geom::ellipses::Ellipse const &	ellipse ) const

Fill an array with the model matrix.

Parameters

[out]	output	Matrix to fill, with dimensions (getDataSize(), getBasisSize()). Will be zeroed before filling.
[in]	ellipse	Ellipse parameters of the model, with center relative to the x and y arrays passed at construction.

Friends And Related Symbol Documentation

MatrixBuilderFactory

template<typename T >

template<typename U >

friend class MatrixBuilderFactory

friend

Definition at line 157 of file MatrixBuilder.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/shapelet/ge79ae78c31+9634bc57db/include/lsst/shapelet/MatrixBuilder.h