lsst::afw::math::Approximate< PixelT > Class Template Reference

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
Approximate &	operator= (Approximate const &)=delete
Approximate &	operator= (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

x	the x-values of points
y	the y-values of points
bbox	Range where approximation should be valid
ctrl	desired approximation algorithm

Definition at line 138 of file Approximate.h.

            : _xVec(x), _yVec(y), _bbox(bbox), _ctrl(ctrl) {}

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.

                                                                                          {
        return doGetImage(orderX, orderY);
    }

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.

                                                                                                      {
        return doGetMaskedImage(orderX, orderY);
    }

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

x	the x-values of points
y	the y-values of points
im	The values at (x, y)
bbox	Range where approximation should be valid
ctrl	desired approximation algorithm

Definition at line 279 of file Approximate.cc.

                                                                                     {
    switch (ctrl.getStyle()) {
        case ApproximateControl::CHEBYSHEV:
            return std::shared_ptr<Approximate<PixelT>>(
                    new ApproximateChebyshev<PixelT>(x, y, im, bbox, ctrl));
        default:
            throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                              str(boost::format("Unknown ApproximationStyle: %d") % ctrl.getStyle()));
    }
}

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g9722cb1a7f+d8f85438e7/include/lsst/afw/math/Approximate.h