LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
lsst.afw.math::Approximate< T > 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

virtual ~Approximate ()
 dtor More...
 
boost::shared_ptr
< image::Image< OutPixelT > > 
getImage (int orderX=-1, int orderY=-1) const
 Return the approximate image as a Image. More...
 
boost::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, 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...
 
geom::Box2I const _bbox
 Domain for approximation. More...
 
ApproximateControl const _ctrl
 desired approximation algorithm More...
 

Private Member Functions

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

Friends

boost::shared_ptr< Approximate
< PixelT > > 
makeApproximate (std::vector< double > const &x, std::vector< double > const &y, image::MaskedImage< PixelT > const &im, 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 T>
class lsst.afw.math::Approximate< T >

Approximate values for a MaskedImage.

Definition at line 38 of file Approximate.h.

Member Typedef Documentation

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

The pixel type of returned images.

Definition at line 96 of file Approximate.h.

Constructor & Destructor Documentation

template<typename T>
virtual lsst.afw.math::Approximate< T >::~Approximate ( )
inlinevirtual

dtor

Definition at line 103 of file Approximate.h.

103 {}
template<typename T>
lsst.afw.math::Approximate< T >::Approximate ( std::vector< double > const &  x,
std::vector< double > const &  y,
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 116 of file Approximate.h.

120  : _xVec(x), _yVec(y), _bbox(bbox), _ctrl(ctrl) {}
std::vector< double > const _yVec
the y-values of points
Definition: Approximate.h:123
std::vector< double > const _xVec
the x-values of points
Definition: Approximate.h:122
geom::Box2I const _bbox
Domain for approximation.
Definition: Approximate.h:124
ApproximateControl const _ctrl
desired approximation algorithm
Definition: Approximate.h:125
template<typename T>
lsst.afw.math::Approximate< T >::Approximate ( Approximate< T > const &  )
private

Member Function Documentation

template<typename T>
virtual boost::shared_ptr< image::Image<OutPixelT> > lsst.afw.math::Approximate< T >::doGetImage ( int  orderX,
int  orderY 
) const
privatepure virtual
template<typename T>
virtual boost::shared_ptr< image::MaskedImage<OutPixelT> > lsst.afw.math::Approximate< T >::doGetMaskedImage ( int  orderX,
int  orderY 
) const
privatepure virtual
template<typename T>
boost::shared_ptr< image::Image<OutPixelT> > lsst.afw.math::Approximate< T >::getImage ( int  orderX = -1,
int  orderY = -1 
) const
inline

Return the approximate image as a Image.

Definition at line 105 of file Approximate.h.

105  {
106  return doGetImage(orderX, orderY);
107  }
virtual boost::shared_ptr< image::Image< OutPixelT > > doGetImage(int orderX, int orderY) const =0
table::Key< int > orderX
template<typename T>
boost::shared_ptr< image::MaskedImage<OutPixelT> > lsst.afw.math::Approximate< T >::getMaskedImage ( int  orderX = -1,
int  orderY = -1 
) const
inline

Return the approximate image as a MaskedImage.

Definition at line 109 of file Approximate.h.

109  {
110  return doGetMaskedImage(orderX, orderY);
111  }
virtual boost::shared_ptr< image::MaskedImage< OutPixelT > > doGetMaskedImage(int orderX, int orderY) const =0
table::Key< int > orderX
template<typename T>
Approximate& lsst.afw.math::Approximate< T >::operator= ( Approximate< T > const &  )
private

Friends And Related Function Documentation

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

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

A factory function to make Approximate objects.

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

Member Data Documentation

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

Domain for approximation.

Definition at line 124 of file Approximate.h.

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

desired approximation algorithm

Definition at line 125 of file Approximate.h.

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

the x-values of points

Definition at line 122 of file Approximate.h.

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

the y-values of points

Definition at line 123 of file Approximate.h.


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