lsst::shapelet::MatrixBuilderFactory< T > Class Template Reference
A factory class for MatrixBuilder, providing more control over workspace memory. More...
#include <MatrixBuilder.h>
Public Types | |
| typedef MatrixBuilderWorkspace< T > | Workspace |
| Associated workspace class. | |
| typedef MatrixBuilder< T > | Builder |
| Associated builder class. | |
Public Member Functions | |
| MatrixBuilderFactory (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. | |
| MatrixBuilderFactory (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. | |
| MatrixBuilderFactory (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. | |
| MatrixBuilderFactory (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. | |
| int | computeWorkspace () const |
| Return the size of the workspace needed for this MatrixBuilder, in elements of T. | |
| MatrixBuilder< T > | operator() () const |
| Return a new MatrixBuilder with internal, unshared workspace. | |
| MatrixBuilder< T > | operator() (Workspace &workspace) const |
| Return a new MatrixBuilder using the given workspace. | |
Detailed Description
template<typename T>
class lsst::shapelet::MatrixBuilderFactory< T >
class lsst::shapelet::MatrixBuilderFactory< T >
A factory class for MatrixBuilder, providing more control over workspace memory.
To allocate workspace manually for a MatrixBuilder, we use the following pattern:;
MatrixBuilderFactory<T> factory(...);
MatrixBuilderWorkspace<T> workspace(factory.computeWorkspace());
MatrixBuilder<T> builder = factory(workspace);
MatrixBuilderFactory(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.
Class that evaluates a (multi-)shapelet basis at predefined points.
Definition MatrixBuilder.h:55
Reusable, shareable workspace for MatrixBuilder.
Definition MatrixBuilder.h:188
Because we aren't doing anything special with the workspace, however, this is actually exactly equivalent to just constructing the MatrixBuilder directly, i.e.:
MatrixBuilder<T> builder(...);
A more interesting case is if we want to use the same workspace for a pair of MatrixBuilders:
MatrixBuilderFactory<T> factory1(...);
MatrixBuilderFactory<T> factory2(...);
MatrixBuilderWorkspace<T> workspace1(
std::max(factory1.computeWorkspace(), factory2.computeWorkspace())
);
MatrixBuilderWorkspace<T> workspace2(workspace1);
MatrixBuilder<T> builder1 = factory1(workspace1);
MatrixBuilder<T> builder2 = factory2(workspace2);
T max(T... args)
Definition at line 265 of file MatrixBuilder.h.
Member Typedef Documentation
◆ Builder
template<typename T>
| typedef MatrixBuilder<T> lsst::shapelet::MatrixBuilderFactory< T >::Builder |
Associated builder class.
Definition at line 269 of file MatrixBuilder.h.
◆ Workspace
template<typename T>
| typedef MatrixBuilderWorkspace<T> lsst::shapelet::MatrixBuilderFactory< T >::Workspace |
Associated workspace class.
Definition at line 268 of file MatrixBuilder.h.
Constructor & Destructor Documentation
◆ MatrixBuilderFactory() [1/4]
template<typename T>
| lsst::shapelet::MatrixBuilderFactory< T >::MatrixBuilderFactory | ( | 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
◆ MatrixBuilderFactory() [2/4]
template<typename T>
| lsst::shapelet::MatrixBuilderFactory< T >::MatrixBuilderFactory | ( | 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
◆ MatrixBuilderFactory() [3/4]
template<typename T>
| lsst::shapelet::MatrixBuilderFactory< T >::MatrixBuilderFactory | ( | 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
◆ MatrixBuilderFactory() [4/4]
template<typename T>
| lsst::shapelet::MatrixBuilderFactory< T >::MatrixBuilderFactory | ( | 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
◆ computeWorkspace()
template<typename T>
| int lsst::shapelet::MatrixBuilderFactory< T >::computeWorkspace | ( | ) | const |
Return the size of the workspace needed for this MatrixBuilder, in elements of T.
◆ getBasisSize()
template<typename T>
| int lsst::shapelet::MatrixBuilderFactory< T >::getBasisSize | ( | ) | const |
Return the number of basis elements.
◆ getDataSize()
template<typename T>
| int lsst::shapelet::MatrixBuilderFactory< T >::getDataSize | ( | ) | const |
Return the number of data points.
◆ operator()() [1/2]
template<typename T>
| MatrixBuilder< T > lsst::shapelet::MatrixBuilderFactory< T >::operator() | ( | ) | const |
Return a new MatrixBuilder with internal, unshared workspace.
◆ operator()() [2/2]
template<typename T>
| MatrixBuilder< T > lsst::shapelet::MatrixBuilderFactory< T >::operator() | ( | Workspace & | workspace | ) | const |
Return a new MatrixBuilder using the given workspace.
The documentation for this class was generated from the following file:
- include/lsst/shapelet/MatrixBuilder.h
Generated on Sun Apr 26 2026 09:02:45 for lsst.shapelet by
1.13.2