lsst.afw  20.0.0-14-g1a12fe12b+614f89f815
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
lsst::afw::math::Approximate< PixelT > Class Template Referenceabstract

Approximate values for a MaskedImage. More...

#include <Approximate.h>

Public Types

typedef float OutPixelT
 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...
 

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 39 of file Approximate.h.

Member Typedef Documentation

◆ OutPixelT

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

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.

Member Function Documentation

◆ 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.

◆ 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.

◆ 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.

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: