isce3 0.25.0
Loading...
Searching...
No Matches
isce3::core::LUT2d< T > Class Template Reference

Data structure to store 2D Lookup table. More...

#include <LUT2d.h>

Public Member Functions

 LUT2d (const T &ref_value=T{0})
 
 LUT2d (isce3::core::dataInterpMethod method)
 
 LUT2d (double xstart, double ystart, double dx, double dy, const isce3::core::Matrix< T > &data, isce3::core::dataInterpMethod method=isce3::core::BILINEAR_METHOD, bool boundsError=true)
 
 LUT2d (const std::valarray< double > &xcoord, const std::valarray< double > &ycoord, const isce3::core::Matrix< T > &data, isce3::core::dataInterpMethod method=isce3::core::BILINEAR_METHOD, bool boundsError=true)
 
 LUT2d (const LUT2d< T > &lut)
 
LUT2doperator= (const LUT2d< T > &lut)
 
void setFromData (const std::valarray< double > &xcoord, const std::valarray< double > &ycoord, const isce3::core::Matrix< T > &data)
 
isce3::core::dataInterpMethod interpMethod () const
 
void interpMethod (isce3::core::dataInterpMethod method)
 
double xStart () const
 
double yStart () const
 
double xEnd () const
 
double yEnd () const
 
double xSpacing () const
 
double ySpacing () const
 
size_t length () const
 
size_t width () const
 
Linspace< double > xAxis () const
 
Linspace< double > yAxis () const
 
refValue () const
 
void refValue (const T &val)
 
bool haveData () const
 
bool boundsError () const
 
const isce3::core::Matrix< T > & data () const
 
void boundsError (bool flag)
 
eval (const double y, const double x) const
 
Eigen::Matrix< T, Eigen::Dynamic, 1 > eval (double y, const Eigen::Ref< const Eigen::VectorXd > &x) const
 
bool contains (double y, double x) const
 Check if point resides in domain of LUT.
 
template<typename U = T, std::enable_if_t<!std::is_compound< U >::value, int > = 0>
bool operator== (const isce3::core::LUT2d< T > &other) const
 
template<typename U = T, std::enable_if_t< std::is_compound< U >::value, int > = 0>
bool operator== (const isce3::core::LUT2d< T > &other) const
 

Detailed Description

template<typename T>
class isce3::core::LUT2d< T >

Data structure to store 2D Lookup table.

Suitable for storing data of the form z = f(x,y)

Constructor & Destructor Documentation

◆ LUT2d() [1/2]

template<typename T>
isce3::core::LUT2d< T >::LUT2d ( double xstart,
double ystart,
double dx,
double dy,
const isce3::core::Matrix< T > & data,
isce3::core::dataInterpMethod method = isce3::core::BILINEAR_METHOD,
bool boundsError = true )
Parameters
[in]xstartStarting X-coordinate
[in]ystartStarting Y-coordinate
[in]dxX-spacing
[in]dyY-spacing
[in]methodInterpolation method

◆ LUT2d() [2/2]

template<typename T>
isce3::core::LUT2d< T >::LUT2d ( const std::valarray< double > & xcoord,
const std::valarray< double > & ycoord,
const isce3::core::Matrix< T > & data,
isce3::core::dataInterpMethod method = isce3::core::BILINEAR_METHOD,
bool boundsError = true )
Parameters
[in]xcoordX-coordinates
[in]ycoordY-coordinates
[in]dataMatrix of LUT data
[in]methodInterpolation method

Member Function Documentation

◆ eval()

template<typename T>
T isce3::core::LUT2d< T >::eval ( const double y,
const double x ) const
Parameters
[in]yY-coordinate for evaluation
[in]xX-coordinate for evaluation
[out]valueInterpolated value

◆ setFromData()

template<typename T>
void isce3::core::LUT2d< T >::setFromData ( const std::valarray< double > & xcoord,
const std::valarray< double > & ycoord,
const isce3::core::Matrix< T > & data )
Parameters
[in]xcoordX-coordinates
[in]ycoordY-coordinates
[in]dataMatrix of LUT data

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

Generated for ISCE3.0 by doxygen 1.13.2.