S2PolyWaveApprox Class Reference

#include <s2_poly_wave_approx.hpp>

Classes
struct	Params

Public Types
typedef std::pair< double, double >	Node

Public Member Functions
	S2PolyWaveApprox (const S2PolyWaveApprox::Params &params)
virtual	~S2PolyWaveApprox ()
LeastSquares2D::PolyCoeffs	operator() (const WaveField &field) const
LeastSquares2D::PolyCoeffs	calc_poly (const WaveField &field) const
LeastSquares2D::PolyCoeffs	calc_poly (const std::vector< S2PolyWaveApprox::Node > &nodes) const
virtual std::vector < S2PolyWaveApprox::Node >	calc_nodes (const WaveField &field) const
void	setParams (const S2PolyWaveApprox::Params &params)
const S2PolyWaveApprox::Params &	getParams () const

Protected Attributes
Params	m_params

Detailed Description

Polynomial cefficients calculation for wave approximation using correlation matrix of provided wavefield.

Member Typedef Documentation

typedef std::pair<double, double> S2PolyWaveApprox::Node

(L,t)

Constructor & Destructor Documentation

S2PolyWaveApprox::S2PolyWaveApprox ( const S2PolyWaveApprox::Params &  params )

inline

Constructs object with provided parameters.

virtual S2PolyWaveApprox::~S2PolyWaveApprox ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual std::vector<S2PolyWaveApprox::Node> S2PolyWaveApprox::calc_nodes ( const WaveField &  field ) const

virtual

Calculates nodes (L,t) for approximation polynom construction.

LeastSquares2D::PolyCoeffs S2PolyWaveApprox::calc_poly

(

const WaveField &

field

)

const

Returns polynomial coefficients for provided wavefield, empty array returns on error.

LeastSquares2D::PolyCoeffs S2PolyWaveApprox::calc_poly

(

const std::vector< S2PolyWaveApprox::Node > &

nodes

)

const

Returns polynomial coefficients for nodes, empty array returns on error.

const S2PolyWaveApprox::Params& S2PolyWaveApprox::getParams ( ) const

inline

Get object parameters.

LeastSquares2D::PolyCoeffs S2PolyWaveApprox::operator() ( const WaveField &  field ) const

inline

Returns polynomial coefficients for provided wavefield, empty array returns on error.

void S2PolyWaveApprox::setParams ( const S2PolyWaveApprox::Params &  params )

inline

Set object parameters.

Member Data Documentation

Params S2PolyWaveApprox::m_params

protected

Current object calculation parameters.

---

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

• /net/opt/univers/ubp-i-15.3-centos7-x64.urij/include/s2proc/s2_poly_wave_approx.hpp