LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
lsst::afw::math::Approximate< PixelT > Class Template Referenceabstract

Approximate values for a MaskedImage. More...

#include <Approximate.h>

Public Types

using OutPixelT = float
 The pixel type of returned images. More...
 

Public Member Functions

 Approximate (Approximate const &)=delete
 
 Approximate (Approximate &&)=delete
 
Approximateoperator= (Approximate const &)=delete
 
Approximateoperator= (Approximate &&)=delete
 
virtual ~Approximate ()=default
 dtor More...
 
std::shared_ptr< image::Image< OutPixelT > > getImage (int orderX=-1, int orderY=-1) const
 Return the approximate image as a Image. More...
 
std::shared_ptr< image::MaskedImage< OutPixelT > > getMaskedImage (int orderX=-1, int orderY=-1) const
 Return the approximate image as a MaskedImage. More...
 

Protected Member Functions

 Approximate (std::vector< double > const &x, std::vector< double > const &y, lsst::geom::Box2I const &bbox, ApproximateControl const &ctrl)
 Base class ctor. More...
 

Protected Attributes

std::vector< double > const _xVec
 the x-values of points More...
 
std::vector< double > const _yVec
 the y-values of points More...
 
lsst::geom::Box2I const _bbox
 Domain for approximation. More...
 
ApproximateControl const _ctrl
 desired approximation algorithm More...
 

Private Member Functions

virtual std::shared_ptr< image::Image< OutPixelT > > doGetImage (int orderX, int orderY) const =0
 
virtual std::shared_ptr< image::MaskedImage< OutPixelT > > doGetMaskedImage (int orderX, int orderY) const =0
 

Friends

std::shared_ptr< Approximate< PixelT > > makeApproximate (std::vector< double > const &x, std::vector< double > const &y, image::MaskedImage< PixelT > const &im, lsst::geom::Box2I const &bbox, ApproximateControl const &ctrl)
 Construct a new Approximate object, inferring the type from the type of the given MaskedImage. More...
 

Detailed Description

template<typename PixelT>
class lsst::afw::math::Approximate< PixelT >

Approximate values for a MaskedImage.

Definition at line 109 of file Approximate.h.

Member Typedef Documentation

◆ OutPixelT

template<typename PixelT >
using lsst::afw::math::Approximate< PixelT >::OutPixelT = float

The pixel type of returned images.

Definition at line 111 of file Approximate.h.

Constructor & Destructor Documentation

◆ Approximate() [1/3]

template<typename PixelT >
lsst::afw::math::Approximate< PixelT >::Approximate ( Approximate< PixelT > const &  )
delete

◆ Approximate() [2/3]

template<typename PixelT >
lsst::afw::math::Approximate< PixelT >::Approximate ( Approximate< PixelT > &&  )
delete

◆ ~Approximate()

template<typename PixelT >
virtual lsst::afw::math::Approximate< PixelT >::~Approximate ( )
virtualdefault

dtor

◆ Approximate() [3/3]

template<typename PixelT >
lsst::afw::math::Approximate< PixelT >::Approximate ( std::vector< double > const &  x,
std::vector< double > const &  y,
lsst::geom::Box2I const &  bbox,
ApproximateControl const &  ctrl 
)
inlineprotected

Base class ctor.

Parameters
xthe x-values of points
ythe y-values of points
bboxRange where approximation should be valid
ctrldesired approximation algorithm

Definition at line 138 of file Approximate.h.

143  : _xVec(x), _yVec(y), _bbox(bbox), _ctrl(ctrl) {}
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
double x
int y
Definition: SpanSet.cc:48
ApproximateControl const _ctrl
desired approximation algorithm
Definition: Approximate.h:148
lsst::geom::Box2I const _bbox
Domain for approximation.
Definition: Approximate.h:147
std::vector< double > const _xVec
the x-values of points
Definition: Approximate.h:145
std::vector< double > const _yVec
the y-values of points
Definition: Approximate.h:146

Member Function Documentation

◆ doGetImage()

template<typename PixelT >
virtual std::shared_ptr<image::Image<OutPixelT> > lsst::afw::math::Approximate< PixelT >::doGetImage ( int  orderX,
int  orderY 
) const
privatepure virtual

◆ doGetMaskedImage()

template<typename PixelT >
virtual std::shared_ptr<image::MaskedImage<OutPixelT> > lsst::afw::math::Approximate< PixelT >::doGetMaskedImage ( int  orderX,
int  orderY 
) const
privatepure virtual

◆ getImage()

template<typename PixelT >
std::shared_ptr<image::Image<OutPixelT> > lsst::afw::math::Approximate< PixelT >::getImage ( int  orderX = -1,
int  orderY = -1 
) const
inline

Return the approximate image as a Image.

Definition at line 126 of file Approximate.h.

126  {
127  return doGetImage(orderX, orderY);
128  }
table::Key< int > orderX
virtual std::shared_ptr< image::Image< OutPixelT > > doGetImage(int orderX, int orderY) const =0

◆ getMaskedImage()

template<typename PixelT >
std::shared_ptr<image::MaskedImage<OutPixelT> > lsst::afw::math::Approximate< PixelT >::getMaskedImage ( int  orderX = -1,
int  orderY = -1 
) const
inline

Return the approximate image as a MaskedImage.

Definition at line 130 of file Approximate.h.

130  {
131  return doGetMaskedImage(orderX, orderY);
132  }
virtual std::shared_ptr< image::MaskedImage< OutPixelT > > doGetMaskedImage(int orderX, int orderY) const =0

◆ operator=() [1/2]

template<typename PixelT >
Approximate& lsst::afw::math::Approximate< PixelT >::operator= ( Approximate< PixelT > &&  )
delete

◆ operator=() [2/2]

template<typename PixelT >
Approximate& lsst::afw::math::Approximate< PixelT >::operator= ( Approximate< PixelT > const &  )
delete

Friends And Related Function Documentation

◆ makeApproximate

template<typename PixelT >
std::shared_ptr<Approximate<PixelT> > makeApproximate ( std::vector< double > const &  x,
std::vector< double > const &  y,
image::MaskedImage< PixelT > const &  im,
lsst::geom::Box2I const &  bbox,
ApproximateControl const &  ctrl 
)
friend

Construct a new Approximate object, inferring the type from the type of the given MaskedImage.

Parameters
xthe x-values of points
ythe y-values of points
imThe values at (x, y)
bboxRange where approximation should be valid
ctrldesired approximation algorithm

Definition at line 279 of file Approximate.cc.

283  {
284  switch (ctrl.getStyle()) {
287  new ApproximateChebyshev<PixelT>(x, y, im, bbox, ctrl));
288  default:
290  str(boost::format("Unknown ApproximationStyle: %d") % ctrl.getStyle()));
291  }
292 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
@ CHEBYSHEV
Use a 2-D Chebyshev polynomial.
Definition: Approximate.h:53
Reports invalid arguments.
Definition: Runtime.h:66
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

Member Data Documentation

◆ _bbox

template<typename PixelT >
lsst::geom::Box2I const lsst::afw::math::Approximate< PixelT >::_bbox
protected

Domain for approximation.

Definition at line 147 of file Approximate.h.

◆ _ctrl

template<typename PixelT >
ApproximateControl const lsst::afw::math::Approximate< PixelT >::_ctrl
protected

desired approximation algorithm

Definition at line 148 of file Approximate.h.

◆ _xVec

template<typename PixelT >
std::vector<double> const lsst::afw::math::Approximate< PixelT >::_xVec
protected

the x-values of points

Definition at line 145 of file Approximate.h.

◆ _yVec

template<typename PixelT >
std::vector<double> const lsst::afw::math::Approximate< PixelT >::_yVec
protected

the y-values of points

Definition at line 146 of file Approximate.h.


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