Class: QgsInterpolator¶
- class qgis.analysis.QgsInterpolator¶
Bases:
sip.wrapper
Interface class for interpolations.
Interpolators take the vertices of a vector layer as base data. The z-Value can be an attribute or the z-coordinates in case of 3D types.
Methods
Caches the vertex and value data from the provider.
Calculates interpolation value for map coordinates x, y
Attributes
- Canceled = 1¶
- FeatureGeometryError = 3¶
- InvalidSource = 2¶
- class LayerData¶
- class LayerData(QgsInterpolator.LayerData)
Bases:
sip.wrapper
- interpolationAttribute¶
- source¶
- sourceType¶
- transformContext¶
- valueSource¶
- class Result¶
Bases:
int
- SourceBreakLines = 2¶
- SourcePoints = 0¶
- SourceStructureLines = 1¶
- class SourceType¶
Bases:
int
- Success = 0¶
- ValueAttribute = 0¶
- ValueM = 2¶
- class ValueSource¶
Bases:
int
- ValueZ = 1¶
- cacheBaseData(self, feedback: QgsFeedback = None) QgsInterpolator.Result ¶
Caches the vertex and value data from the provider. All the vertex data will be held in virtual memory.
An optional
feedback
argument may be specified to allow cancellation and progress reports from the cache operation.- Return type:
- Returns:
Success in case of success
- Parameters:
feedback (
QgsFeedback
= None) –
- interpolatePoint(self, x: float, y: float, feedback: QgsFeedback = None) Tuple[int, float] ¶
Calculates interpolation value for map coordinates x, y
- Parameters:
x (float) – x-coordinate (in map units)
y (float) – y-coordinate (in map units)
feedback (
QgsFeedback
= None) – optional feedback object for progress and cancellation support
- Return type:
Tuple[int, float]
- Returns:
0 in case of success
result: interpolation result