QGIS/python/PyQt6/analysis/auto_additions/qgsinterpolator.py
2025-04-23 07:39:24 +10:00

95 lines
4.7 KiB
Python

# The following has been generated automatically from src/analysis/interpolation/qgsinterpolator.h
# monkey patching scoped based enum
QgsInterpolator.SourcePoints = QgsInterpolator.SourceType.Points
QgsInterpolator.SourceType.SourcePoints = QgsInterpolator.SourceType.Points
QgsInterpolator.SourcePoints.is_monkey_patched = True
QgsInterpolator.SourcePoints.__doc__ = "Point source"
QgsInterpolator.SourceStructureLines = QgsInterpolator.SourceType.StructureLines
QgsInterpolator.SourceType.SourceStructureLines = QgsInterpolator.SourceType.StructureLines
QgsInterpolator.SourceStructureLines.is_monkey_patched = True
QgsInterpolator.SourceStructureLines.__doc__ = "Structure lines"
QgsInterpolator.SourceBreakLines = QgsInterpolator.SourceType.BreakLines
QgsInterpolator.SourceType.SourceBreakLines = QgsInterpolator.SourceType.BreakLines
QgsInterpolator.SourceBreakLines.is_monkey_patched = True
QgsInterpolator.SourceBreakLines.__doc__ = "Break lines"
QgsInterpolator.SourceType.__doc__ = """Describes the type of input data
* ``Points``: Point source
Available as ``QgsInterpolator.SourcePoints`` in older QGIS releases.
* ``StructureLines``: Structure lines
Available as ``QgsInterpolator.SourceStructureLines`` in older QGIS releases.
* ``BreakLines``: Break lines
Available as ``QgsInterpolator.SourceBreakLines`` in older QGIS releases.
"""
# --
# monkey patching scoped based enum
QgsInterpolator.ValueAttribute = QgsInterpolator.ValueSource.Attribute
QgsInterpolator.ValueSource.ValueAttribute = QgsInterpolator.ValueSource.Attribute
QgsInterpolator.ValueAttribute.is_monkey_patched = True
QgsInterpolator.ValueAttribute.__doc__ = "Take value from feature's attribute"
QgsInterpolator.ValueZ = QgsInterpolator.ValueSource.Z
QgsInterpolator.ValueSource.ValueZ = QgsInterpolator.ValueSource.Z
QgsInterpolator.ValueZ.is_monkey_patched = True
QgsInterpolator.ValueZ.__doc__ = "Use feature's geometry Z values for interpolation"
QgsInterpolator.ValueM = QgsInterpolator.ValueSource.M
QgsInterpolator.ValueSource.ValueM = QgsInterpolator.ValueSource.M
QgsInterpolator.ValueM.is_monkey_patched = True
QgsInterpolator.ValueM.__doc__ = "Use feature's geometry M values for interpolation"
QgsInterpolator.ValueSource.__doc__ = """Source for interpolated values from features
* ``Attribute``: Take value from feature's attribute
Available as ``QgsInterpolator.ValueAttribute`` in older QGIS releases.
* ``Z``: Use feature's geometry Z values for interpolation
Available as ``QgsInterpolator.ValueZ`` in older QGIS releases.
* ``M``: Use feature's geometry M values for interpolation
Available as ``QgsInterpolator.ValueM`` in older QGIS releases.
"""
# --
# monkey patching scoped based enum
QgsInterpolator.Result.Success.__doc__ = "Operation was successful"
QgsInterpolator.Result.Canceled.__doc__ = "Operation was manually canceled"
QgsInterpolator.Result.InvalidSource.__doc__ = "Operation failed due to invalid source"
QgsInterpolator.Result.FeatureGeometryError.__doc__ = "Operation failed due to invalid feature geometry"
QgsInterpolator.Result.__doc__ = """Result of an interpolation operation
* ``Success``: Operation was successful
* ``Canceled``: Operation was manually canceled
* ``InvalidSource``: Operation failed due to invalid source
* ``FeatureGeometryError``: Operation failed due to invalid feature geometry
"""
# --
try:
QgsInterpolatorVertexData.__attribute_docs__ = {'x': 'X-coordinate', 'y': 'Y-coordinate', 'z': 'Z-coordinate'}
QgsInterpolatorVertexData.__annotations__ = {'x': float, 'y': float, 'z': float}
QgsInterpolatorVertexData.__doc__ = """Interpolation data for an individual source vertex."""
QgsInterpolatorVertexData.__group__ = ['interpolation']
except (NameError, AttributeError):
pass
try:
QgsInterpolator.LayerData.__attribute_docs__ = {'source': 'Feature source', 'valueSource': 'Source for feature values to interpolate', 'interpolationAttribute': 'Index of feature attribute to use for interpolation', 'sourceType': 'Source type', 'transformContext': 'Coordinate transform context.\n\n.. versionadded:: 3.10.1'}
QgsInterpolator.LayerData.__annotations__ = {'source': 'QgsFeatureSource', 'valueSource': 'QgsInterpolator.ValueSource', 'interpolationAttribute': int, 'sourceType': 'QgsInterpolator.SourceType', 'transformContext': 'QgsCoordinateTransformContext'}
QgsInterpolator.LayerData.__doc__ = """A source together with the information about interpolation attribute / z-coordinate interpolation and the type (point, structure line, breakline)"""
QgsInterpolator.LayerData.__group__ = ['interpolation']
except (NameError, AttributeError):
pass
try:
QgsInterpolator.__abstract_methods__ = ['interpolatePoint']
QgsInterpolator.__group__ = ['interpolation']
except (NameError, AttributeError):
pass