lsst::geom::polynomials::Basis2d< Basis1d > Class Template Reference

A basis interface for 2-d series expansions. More...

#include <Basis2d.h>

Public Types
using	Function = ...
	A Function2d object that uses this basis. More...
using	Scaled = ...
	The type returned by scale(). More...
using	Workspace = ...
	The type returned by makeWorkspace(). More...

Public Member Functions
std::size_t	getOrder () const
	Return the maximum order of the basis. More...
std::size_t	size () const
	Return the number of basis functions. More...
Scaled	scaled (Scaling2d const &first) const
	Return a scaled basis that delegates to a copy of this. More...
Workspace	makeWorkspace () const
	Allocate workspace that can be passed to sumWith() and fill() to avoid repeated memory allocations. More...
template<typename Vector >
double	sumWith (geom::Point2D const &point, Vector const &coefficients) const
	Evaluate a basis expansion with the given coefficients. More...
template<typename Vector >
double	sumWith (geom::Point2D const &point, Vector const &coefficients, Workspace &workspace) const
	Evaluate a basis expansion with the given coefficients (external workspace version). More...
template<typename Vector >
void	fill (geom::Point2D const &point, Vector &&basis) const
	Evaluate the basis at a given point. More...
template<typename Vector >
void	fill (geom::Point2D const &point, Vector &&basis, Workspace &workspace) const
	Evaluate the basis at a given point (external workspace version). More...

Detailed Description

template<typename Basis1d>
class lsst::geom::polynomials::Basis2d< Basis1d >

A basis interface for 2-d series expansions.

Note

This class is only present in the documentation, as it represents an abstract interface for which C++ (prior to C++20, at least) has no language support. It may be formalized into a true Concept when that language feature is available.

Definition at line 37 of file Basis2d.h.

Member Typedef Documentation

Function

template<typename Basis1d >

using lsst::geom::polynomials::Basis2d< Basis1d >::Function = ...

A Function2d object that uses this basis.

Definition at line 41 of file Basis2d.h.

Scaled

template<typename Basis1d >

using lsst::geom::polynomials::Basis2d< Basis1d >::Scaled = ...

The type returned by scale().

Definition at line 44 of file Basis2d.h.

Workspace

template<typename Basis1d >

using lsst::geom::polynomials::Basis2d< Basis1d >::Workspace = ...

The type returned by makeWorkspace().

Definition at line 47 of file Basis2d.h.

Member Function Documentation

fill() [1/2]

template<typename Basis1d >

template<typename Vector >

void lsst::geom::polynomials::Basis2d< Basis1d >::fill	(	geom::Point2D const &	point,
		Vector &&	basis
	)		const

Evaluate the basis at a given point.

Parameters

[in]	point	Point at which to evaluate the basis functions.
[out]	basis	Flattened output vector. See Basis1d::fill more information.

fill() [2/2]

template<typename Basis1d >

template<typename Vector >

void lsst::geom::polynomials::Basis2d< Basis1d >::fill	(	geom::Point2D const &	point,
		Vector &&	basis,
		Workspace &	workspace
	)		const

Evaluate the basis at a given point (external workspace version).

getOrder()

template<typename Basis1d >

std::size_t lsst::geom::polynomials::Basis2d< Basis1d >::getOrder

(

)

const

Return the maximum order of the basis.

makeWorkspace()

template<typename Basis1d >

Workspace lsst::geom::polynomials::Basis2d< Basis1d >::makeWorkspace

(

)

const

Allocate workspace that can be passed to sumWith() and fill() to avoid repeated memory allocations.

scaled()

template<typename Basis1d >

Scaled lsst::geom::polynomials::Basis2d< Basis1d >::scaled

(

Scaling2d const &

first

)

const

Return a scaled basis that delegates to a copy of this.

The scaled basis will transform all points by the given scaling before evaluating the basis functions in the same way as this.

size()

template<typename Basis1d >

std::size_t lsst::geom::polynomials::Basis2d< Basis1d >::size

(

)

const

Return the number of basis functions.

sumWith() [1/2]

template<typename Basis1d >

template<typename Vector >

double lsst::geom::polynomials::Basis2d< Basis1d >::sumWith	(	geom::Point2D const &	point,
		Vector const &	coefficients
	)		const

Evaluate a basis expansion with the given coefficients.

If the 1-d basis elements are \(B_n(x)\) and the given coefficients are a vector \(a_{p, q}\), this computes

\[ \sum_{p = 0, q = 0}^{p + q \le N} a_{p,q} B_{p}(x) B_{q}(y) \]

Parameters

[in]	point	Point at which to evaluate the expansion.
[in]	coefficients	Flattened coefficients vector. See Basis1d::sumWith for more information.

sumWith() [2/2]

template<typename Basis1d >

template<typename Vector >

double lsst::geom::polynomials::Basis2d< Basis1d >::sumWith	(	geom::Point2D const &	point,
		Vector const &	coefficients,
		Workspace &	workspace
	)		const

Evaluate a basis expansion with the given coefficients (external workspace version).

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/geom/22.0.1-6-g8d3140d+720564cf76/include/lsst/geom/polynomials/Basis2d.h