LSST Applications g013ef56533+63812263fb,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+fde7a7a78c,g210f2d0738+db0c280453,g262e1987ae+abed931625,g29ae962dfc+058d1915d8,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+64337f1634,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+d9e514a434,g64539dfbff+db0c280453,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g7382096ae9+36d16ea71a,g74acd417e5+c70e70fbf6,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+1b779678e3,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+9583a964dd,g98a1a72a9c+028271c396,g98df359435+530b675b85,gb8cb2b794d+4e54f68785,gbf99507273+8c5ae1fdc5,gc2a301910b+db0c280453,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+c70e70fbf6,ge410e46f29+f459a6810c,ge41e95a9f2+db0c280453,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.
 

Public Member Functions

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

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.
 

Protected Attributes

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

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.
 

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) {}
Approximate values for a MaskedImage.
ApproximateControl const _ctrl
desired approximation algorithm
lsst::geom::Box2I const _bbox
Domain for approximation.
std::vector< double > const _xVec
the x-values of points
std::vector< double > const _yVec
the y-values of points

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 }
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 {
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 Symbol 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()) {
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

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: