Data structure to hold a 1D Lookup table. More...

#include <LUT1d.h>

Public Member Functions
	LUT1d ()
	Default constructor.

	LUT1d (T refValue)
	Constructor with a constant reference value.

	LUT1d (size_t size)
	Constructor with size.

	LUT1d (const std::valarray< double > &coords, const std::valarray< T > &values, bool extrapolate=false)
	Constructor with coordinates and values. More...

	LUT1d (const LUT1d< T > &lut)
	Copy constructor. More...

LUT1d &	operator= (const LUT1d< T > &lut)
	Assignment operator. More...

	LUT1d (const LUT2d< T > &lut2d)
	Constructor from an LUT2d (values averaged in y-direction) More...

LUT1d &	operator= (const LUT2d< T > &lut2d)
	Assignment operator from an LUT2d (values averaged in y-direction) More...

std::valarray< double > &	coords ()
	Get a reference to the coordinates. More...

const std::valarray< double > &	coords () const
	Get a read-only reference to the coordinates. More...

void	coords (const std::valarray< double > &c)
	Set the coordinates. More...

std::valarray< T > &	values ()
	Get a reference to the coordinates. More...

const std::valarray< T > &	values () const
	Get a read-only reference to the values. More...

void	values (const std::valarray< T > &v)
	Set the values. More...

bool	extrapolate () const
	Get extrapolate flag. More...

void	extrapolate (bool flag)
	Set extrapolate flag. More...

bool	haveData () const
	Get flag for having data.

T	refValue () const
	Get reference value.

size_t	size () const
	Get size of LUT. More...

T	eval (double x) const
	Evaluate the LUT. More...

Detailed Description

template<class>
class isce3::core::LUT1d< class >

Data structure to hold a 1D Lookup table.

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

Constructor & Destructor Documentation

template<class >

isce3::core::LUT1d< class >::LUT1d	(	const std::valarray< double > &	coords,
		const std::valarray< T > &	values,
		bool	extrapolate = `false`
	)

inline

Constructor with coordinates and values.

Parameters

[in]	coords	Valarray for coordinates of LUT
[in]	values	Valarray for values of LUT
[in]	extrapolate	Flag for allowing extrapolation beyond bounds

template<class >

isce3::core::LUT1d< class >::LUT1d ( const LUT1d< T > & lut )

inline

Copy constructor.

Parameters

[in] lut LUT1d object to copy from

template<typename T >

isce3::core::LUT1d< T >::LUT1d ( const LUT2d< T > & lut2d )

inline

Constructor from an LUT2d (values averaged in y-direction)

Parameters

[in] lut2d LUT2d to copy data from

Member Function Documentation

template<class >

std::valarray<double>& isce3::core::LUT1d< class >::coords ( )

inline

Get a reference to the coordinates.

Parameters

[out] coords Reference to valarray for coordinates

template<class >

const std::valarray<double>& isce3::core::LUT1d< class >::coords ( ) const

inline

Get a read-only reference to the coordinates.

Parameters

[out] coords Copy of valarray for coordinates

template<class >

void isce3::core::LUT1d< class >::coords ( const std::valarray< double > & c )

inline

Set the coordinates.

Parameters

[in] c Input valarray for coordinates

template<typename T >

T isce3::core::LUT1d< T >::eval ( double x ) const

inline

Evaluate the LUT.

Parameters

[in]	x	Point to evaluate the LUT
[out]	result	Interpolated value

template<class >

bool isce3::core::LUT1d< class >::extrapolate ( ) const

inline

Get extrapolate flag.

Parameters

[out] flag Extrapolation flag

template<class >

void isce3::core::LUT1d< class >::extrapolate ( bool flag )

inline

Set extrapolate flag.

Parameters

[in] flag Extrapolation flag

template<class >

LUT1d& isce3::core::LUT1d< class >::operator= ( const LUT1d< T > & lut )

inline

Assignment operator.

Parameters

[in] lut LUT1d object to assign from

template<typename T >

isce3::core::LUT1d< T > & isce3::core::LUT1d< T >::operator= ( const LUT2d< T > & lut2d )

inline

Assignment operator from an LUT2d (values averaged in y-direction)

Parameters

[in] lut2d LUT2d to copy data from

template<class >

size_t isce3::core::LUT1d< class >::size ( ) const

inline

Get size of LUT.

Parameters

[out] size Size (number of coordinates) of LUT

template<class >

std::valarray<T>& isce3::core::LUT1d< class >::values ( )

inline

Get a reference to the coordinates.

Parameters

[out] values Reference to valarray for values

template<class >

const std::valarray<T>& isce3::core::LUT1d< class >::values ( ) const

inline

Get a read-only reference to the values.

Parameters

[out] values Copy of valarray for values

template<class >

void isce3::core::LUT1d< class >::values ( const std::valarray< T > & v )

inline

Set the values.

Parameters

[in] v Input valarray for values

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

isce/cxx/isce3/core/forward.h
isce/cxx/isce3/core/LUT1d.h
isce/cxx/isce3/core/LUT1d.icc

Public Member Functions

Detailed Description

template<class> class isce3::core::LUT1d< class >

Constructor & Destructor Documentation

Member Function Documentation

template<class>
class isce3::core::LUT1d< class >