lsst::shapelet::MultiShapeletFunction Class Reference

A multi-scale shapelet function. More...

#include <MultiShapeletFunction.h>

Public Types
typedef std::shared_ptr< MultiShapeletFunction >	Ptr
typedef std::shared_ptr< MultiShapeletFunction const >	ConstPtr
typedef MultiShapeletFunctionEvaluator	Evaluator
typedef ShapeletFunction	Component
typedef std::vector< Component >	ComponentList

Public Member Functions
ComponentList &	getComponents ()
ComponentList const &	getComponents () const
void	normalize (double value=1.0)
	Normalize the integral of the shapelet function to the given value.
void	shiftInPlace (geom::Extent2D const &offset)
	Shift the shapelet function by shifting the ellipse of each component.
void	transformInPlace (geom::AffineTransform const &transform)
	Transform the shapelet function by transforming the ellipse of each component.
MultiShapeletFunction	convolve (ShapeletFunction const &other) const
	Convolve the multi-shapelet function.
MultiShapeletFunction	convolve (MultiShapeletFunction const &other) const
	Convolve the multi-shapelet function.
Evaluator	evaluate () const
	Construct a helper object that can efficiently evaluate the function.
	MultiShapeletFunction ()
	MultiShapeletFunction (MultiShapeletFunction const &other)=default
	MultiShapeletFunction (ComponentList const &components)
	MultiShapeletFunction (ShapeletFunction const &component)

Detailed Description

A multi-scale shapelet function.

Definition at line 38 of file MultiShapeletFunction.h.

Member Typedef Documentation

Component

typedef ShapeletFunction lsst::shapelet::MultiShapeletFunction::Component

Definition at line 46 of file MultiShapeletFunction.h.

ComponentList

typedef std::vector<Component> lsst::shapelet::MultiShapeletFunction::ComponentList

Definition at line 48 of file MultiShapeletFunction.h.

ConstPtr

typedef std::shared_ptr<MultiShapeletFunction const> lsst::shapelet::MultiShapeletFunction::ConstPtr

Definition at line 42 of file MultiShapeletFunction.h.

Evaluator

typedef MultiShapeletFunctionEvaluator lsst::shapelet::MultiShapeletFunction::Evaluator

Definition at line 44 of file MultiShapeletFunction.h.

Ptr

typedef std::shared_ptr<MultiShapeletFunction> lsst::shapelet::MultiShapeletFunction::Ptr

Definition at line 41 of file MultiShapeletFunction.h.

Constructor & Destructor Documentation

MultiShapeletFunction() [1/4]

lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction ( )

inline

Definition at line 72 of file MultiShapeletFunction.h.

: _components() {}

MultiShapeletFunction() [2/4]

lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction ( MultiShapeletFunction const & other )

default

MultiShapeletFunction() [3/4]

lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction ( ComponentList const & components )

inlineexplicit

Definition at line 76 of file MultiShapeletFunction.h.

: _components(components) {}

MultiShapeletFunction() [4/4]

lsst::shapelet::MultiShapeletFunction::MultiShapeletFunction ( ShapeletFunction const & component )

inlineexplicit

Definition at line 78 of file MultiShapeletFunction.h.

: _components(1, component) {}

Member Function Documentation

convolve() [1/2]

MultiShapeletFunction lsst::shapelet::MultiShapeletFunction::convolve

(

MultiShapeletFunction const &

other

)

const

Convolve the multi-shapelet function.

convolve() [2/2]

MultiShapeletFunction lsst::shapelet::MultiShapeletFunction::convolve

(

ShapeletFunction const &

other

)

const

Convolve the multi-shapelet function.

evaluate()

MultiShapeletFunctionEvaluator lsst::shapelet::MultiShapeletFunction::evaluate ( ) const

inline

Construct a helper object that can efficiently evaluate the function.

Definition at line 145 of file MultiShapeletFunction.h.

                                                                            {
    return MultiShapeletFunctionEvaluator(*this);
}

getComponents() [1/2]

ComponentList & lsst::shapelet::MultiShapeletFunction::getComponents ( )

inline

Definition at line 50 of file MultiShapeletFunction.h.

{ return _components; }

getComponents() [2/2]

ComponentList const & lsst::shapelet::MultiShapeletFunction::getComponents ( ) const

inline

Definition at line 52 of file MultiShapeletFunction.h.

{ return _components; }

normalize()

void lsst::shapelet::MultiShapeletFunction::normalize

(

double

value = 1.0

)

Normalize the integral of the shapelet function to the given value.

shiftInPlace()

void lsst::shapelet::MultiShapeletFunction::shiftInPlace

(

geom::Extent2D const &

offset

)

Shift the shapelet function by shifting the ellipse of each component.

transformInPlace()

void lsst::shapelet::MultiShapeletFunction::transformInPlace

(

geom::AffineTransform const &

transform

)

Transform the shapelet function by transforming the ellipse of each component.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/shapelet/g47891489e3+e32160a944/include/lsst/shapelet/MultiShapeletFunction.h