QGIS API Documentation 3.41.0-Master (d5b93354e9c)
Loading...
Searching...
No Matches
qgsinterpolator.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsinterpolator.h
3 ------------------------
4 begin : March 10, 2008
5 copyright : (C) 2008 by Marco Hugentobler
6 email : marco dot hugentobler at karto dot baug dot ethz dot ch
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSINTERPOLATOR_H
19#define QGSINTERPOLATOR_H
20
21#include <QVector>
22#include <QList>
23
24#include "qgis_sip.h"
25#include "qgis_analysis.h"
27
29class QgsGeometry;
30class QgsFeedback;
31
32#ifdef SIP_RUN
33//%ModuleHeaderCode
34#include "qgsinterpolator.h"
35//%End
36#endif
37
41struct ANALYSIS_EXPORT QgsInterpolatorVertexData
42{
47 QgsInterpolatorVertexData( double x, double y, double z )
48 : x( x )
49 , y( y )
50 , z( z )
51 {}
52
54
56 double x = 0.0;
58 double y = 0.0;
60 double z = 0.0;
61};
62
71class ANALYSIS_EXPORT QgsInterpolator
72{
73 public:
81
89
98
101 {
103 QgsFeatureSource *source = nullptr;
107 int interpolationAttribute = -1;
109 QgsInterpolator::SourceType sourceType = SourcePoints;
110
117 };
118
119 QgsInterpolator( const QList<QgsInterpolator::LayerData> &layerData );
120
121 virtual ~QgsInterpolator() = default;
122
131 virtual int interpolatePoint( double x, double y, double &result SIP_OUT, QgsFeedback *feedback = nullptr ) = 0;
132
134 QList<LayerData> layerData() const SIP_SKIP { return mLayerData; }
135
136 protected:
146 Result cacheBaseData( QgsFeedback *feedback = nullptr );
147
149 QVector<QgsInterpolatorVertexData> mCachedBaseData;
150
152 bool mDataIsCached = false;
153
155 QList<LayerData> mLayerData;
156
157 private:
158 QgsInterpolator() = delete;
159
167 bool addVerticesToCache( const QgsGeometry &geom, ValueSource source, double attributeValue );
168};
169
170#endif
Contains information about the context in which a coordinate transform is executed.
An interface for objects which provide features via a getFeatures method.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
A geometry is the spatial representation of a feature.
Interface class for interpolations.
QVector< QgsInterpolatorVertexData > mCachedBaseData
Cached vertex data for input sources.
virtual int interpolatePoint(double x, double y, double &result, QgsFeedback *feedback=nullptr)=0
Calculates interpolation value for map coordinates x, y.
ValueSource
Source for interpolated values from features.
@ ValueM
Use feature's geometry M values for interpolation.
@ ValueAttribute
Take value from feature's attribute.
@ ValueZ
Use feature's geometry Z values for interpolation.
Result
Result of an interpolation operation.
@ Canceled
Operation was manually canceled.
@ InvalidSource
Operation failed due to invalid source.
@ FeatureGeometryError
Operation failed due to invalid feature geometry.
SourceType
Describes the type of input data.
@ SourcePoints
Point source.
@ SourceStructureLines
Structure lines.
@ SourceBreakLines
Break lines.
QList< LayerData > layerData() const
QList< LayerData > mLayerData
Information about the input vector layers and the attributes (or z-values) that are used for interpol...
virtual ~QgsInterpolator()=default
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_OUT
Definition qgis_sip.h:58
Interpolation data for an individual source vertex.
QgsInterpolatorVertexData()=default
QgsInterpolatorVertexData(double x, double y, double z)
Constructor for QgsInterpolatorVertexData with the specified x, y, and z coordinate.
A source together with the information about interpolation attribute / z-coordinate interpolation and...
QgsCoordinateTransformContext transformContext
Coordinate transform context.