QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
QgsIDWInterpolator Class Reference

#include <qgsidwinterpolator.h>

Inheritance diagram for QgsIDWInterpolator:
Inheritance graph
[legend]
Collaboration diagram for QgsIDWInterpolator:
Collaboration graph
[legend]

Public Member Functions

 QgsIDWInterpolator (const QList< LayerData > &layerData)
 ~QgsIDWInterpolator ()
int interpolatePoint (double x, double y, double &result)
 Calculates interpolation value for map coordinates x, y.
void setDistanceCoefficient (double p)
- Public Member Functions inherited from QgsInterpolator
 QgsInterpolator (const QList< LayerData > &layerData)
virtual ~QgsInterpolator ()
const QList< LayerData > & layerData () const

Private Member Functions

 QgsIDWInterpolator ()

Private Attributes

double mDistanceCoefficient
 The parameter that sets how the values are weighted with distance.

Additional Inherited Members

- Public Types inherited from QgsInterpolator
enum  InputType { POINTS, STRUCTURE_LINES, BREAK_LINES }
 Describes the type of input data. More...
- Protected Member Functions inherited from QgsInterpolator
int cacheBaseData ()
 Caches the vertex and value data from the provider.
- Protected Attributes inherited from QgsInterpolator
QVector< vertexDatamCachedBaseData
bool mDataIsCached
 Flag that tells if the cache already has been filled.
QList< LayerDatamLayerData

Detailed Description

Definition at line 23 of file qgsidwinterpolator.h.

Constructor & Destructor Documentation

QgsIDWInterpolator::QgsIDWInterpolator ( const QList< LayerData > &  layerData)

Definition at line 22 of file qgsidwinterpolator.cpp.

QgsIDWInterpolator::~QgsIDWInterpolator ( )

Definition at line 32 of file qgsidwinterpolator.cpp.

QgsIDWInterpolator::QgsIDWInterpolator ( )
private

Definition at line 27 of file qgsidwinterpolator.cpp.

Member Function Documentation

int QgsIDWInterpolator::interpolatePoint ( double  x,
double  y,
double &  result 
)
virtual

Calculates interpolation value for map coordinates x, y.

Parameters
xx-coordinate (in map units)
yy-coordinate (in map units)
resultout: interpolation result
Returns
0 in case of success

Implements QgsInterpolator.

Definition at line 37 of file qgsidwinterpolator.cpp.

References QgsInterpolator::cacheBaseData(), QgsInterpolator::mCachedBaseData, QgsInterpolator::mDataIsCached, mDistanceCoefficient, and pal::min().

void QgsIDWInterpolator::setDistanceCoefficient ( double  p)
inline

Definition at line 36 of file qgsidwinterpolator.h.

Member Data Documentation

double QgsIDWInterpolator::mDistanceCoefficient
private

The parameter that sets how the values are weighted with distance.

Smaller values mean sharper peaks at the data points. The default is a value of 2

Definition at line 45 of file qgsidwinterpolator.h.

Referenced by interpolatePoint().


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