algorithm_TransformToProfil_PolygonIntersection.py

# -*- coding: utf-8 -*-
"""
/***************************************************************************
 ThToolBox
                                 TransformToProfil_PolygonIntersection
 TLUG Algorithms
                              -------------------
        begin                : 2018-08-27
        copyright            : (C) 2017 by Thüringer Landesamt für Umwelt, Bergbau und Naturschutz (TLUBN)
        email                : Michael.Kuerbs@tlubn.thueringen.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 This script initializes the plugin, making it known to QGIS.
"""

__author__ = 'Michael Kürbs'
__date__ = '2024-03-26'
__copyright__ = '(C) 2018 by Michael Kürbs by Thüringer Landesamt für Umwelt, Bergbau und Naturschutz (TLUBN)'

# This will get replaced with a git SHA1 when you do a git archive

__revision__ = '$Format:%H$'

from PyQt5.QtCore import QCoreApplication, QVariant
from qgis.core import (QgsProcessing,
                       QgsFeatureSink,
                       QgsProcessingAlgorithm,
                       QgsProcessingParameterVectorLayer,
                       QgsProcessingParameterFeatureSource,
                       QgsProcessingParameterRasterLayer,
                       QgsProcessingParameterFeatureSink,
                       QgsProcessingParameterNumber,
                       QgsProcessingParameterEnum,
                       QgsProject,
                       QgsFeature,
                       QgsFeatureRequest,
                       QgsField,
                       QgsPoint,
                       QgsPointXY,
                       QgsGeometry,
                       QgsCoordinateTransform,
                       QgsProcessingException)
from .tlug_utils.TerrainModel import TerrainModel
from .tlug_utils.LaengsProfil import LaengsProfil
from .tlug_utils.LinearReferencingMaschine import LinearReferencingMaschine
from PyQt5.QtGui import QIcon
import os

class TransformToProfil_PolygonIntersection(QgsProcessingAlgorithm):
    """
    Get the intersections from a polygon layer with the baseline and transform them to profile coordinates.
    The intersection range can be represented through points or lines.
    A baseline can have breakpoints.
    Select one line feature or use an one feature layer as Baseline.
    """

    # Constants used to refer to parameters and outputs. They will be
    # used when calling the algorithm from another algorithm, or when
    # calling from the QGIS console.

    OUTPUT = 'OUTPUT'
    INPUTBASELINE = 'INPUTVECTOR'
    INPUTRASTER = 'INPUTRASTER'
    INPUTZFACTOR='INPUTZFACTOR'
    INPUTINTERSECTIONLAYER='INPUTINTERSECTIONLAYER'
    OUTPUTGEOMTYPE = 'OUTPUTGEOMTYPE'
    USE_ZERODATA='USE_ZERODATA'
    USE_NEGATIVEDATA='USE_NEGATIVEDATA'
    USE_NODATA='USE_NODATA'
    
    def initAlgorithm(self, config):
        """
        Here we define the inputs and output of the algorithm, along
        with some other properties.
        """
        #print("initAlgorithm")
        # We add the input vector features source. It can have any kind of
        # geometry.
        self.addParameter(
            QgsProcessingParameterVectorLayer(
                self.INPUTINTERSECTIONLAYER,
                self.tr('Intersection Polygon Layer'),
                [QgsProcessing.TypeVectorPolygon]
            )
        )        
        self.addParameter(
            QgsProcessingParameterVectorLayer(
                self.INPUTBASELINE,
                self.tr('Profil Baseline'),
                [QgsProcessing.TypeVectorLine]
            )
        )
        self.addParameter(
            QgsProcessingParameterRasterLayer(
                self.INPUTRASTER,
                self.tr('Elevation Raster'),
                None, 
                False
            )
        )
        self.addParameter(
            QgsProcessingParameterNumber(
                self.INPUTZFACTOR,
                self.tr('Z-Factor / Ueberhoehung'),
                type=QgsProcessingParameterNumber.Integer,
                defaultValue=10,
                optional=False,
                minValue=0,
                maxValue=100
                
            )
        )
        geomTypes = [self.tr('Lines'),
                      self.tr('Points')]        
        self.addParameter(QgsProcessingParameterEnum(
            self.OUTPUTGEOMTYPE,
            self.tr('Output Geometry Type'),
            options=geomTypes, defaultValue=0))


        # We add a feature sink in which to store our processed features (this
        # usually takes the form of a newly created vector layer when the
        # algorithm is run in QGIS).
        self.addParameter(
            QgsProcessingParameterFeatureSink(
                self.OUTPUT,
                self.tr('Profil_Polygon Intersections')
            )
        )

    def processAlgorithm(self, parameters, context, feedback):
        """
        Here is where the processing itself takes place.
        """
        ueberhoehung = self.parameterAsInt(parameters, self.INPUTZFACTOR, context)
        rasterLayer = self.parameterAsRasterLayer(parameters, self.INPUTRASTER, context)
        baseLineLayer = self.parameterAsVectorLayer(parameters, self.INPUTBASELINE, context)
        polygonLayer =  self.parameterAsVectorLayer(parameters, self.INPUTINTERSECTIONLAYER, context)
        outputGeomType = self.parameterAsEnum(parameters, self.OUTPUTGEOMTYPE, context)
        use_zerodata = self.parameterAsBoolean(parameters, self.USE_ZERODATA, context)
        use_nodata = self.parameterAsBoolean(parameters, self.USE_NODATA, context)
        use_negativeData = self.parameterAsBoolean(parameters, self.USE_NEGATIVEDATA, context)

        feedback.pushInfo("use_nodata:" + str(use_nodata))
        feedback.pushInfo("use_negativeData:" + str(use_negativeData))
        feedback.pushInfo("use_zerodata:" + str(use_zerodata))
         
        baseLine=None
        #Basline Layer must have only 1 Feature
        if baseLineLayer.featureCount()==1:
        #baseLine must be the first feature
            baseLineFeature=next(baseLineLayer.getFeatures(QgsFeatureRequest().setLimit(1)))
            baseLine=baseLineFeature.geometry()
        elif len(baseLineLayer.selectedFeatures())==1:
            selection=baseLineLayer.selectedFeatures()
            #baseLine must be the first feature
            selFeats=[f for f in selection]
            baseLineFeature=selFeats[0]
            baseLine=baseLineFeature.geometry() 
        else:
            msg = self.tr("Error: BaseLine layer needs exactly one line feature! "+ str(baseLineLayer.featureCount()) + " Just select one feature!")
            feedback.reportError(msg)
            raise QgsProcessingException(msg)
        #take CRS from Rasterlayer 
        crsProject=QgsProject.instance().crs()   
        #check if layers have the same crs
        if not baseLineLayer.crs().authid()==crsProject.authid():
            # if not, transform to raster crs()
            trafo1=QgsCoordinateTransform(baseLineLayer.crs(),crsProject,QgsProject.instance())
            #transform BaseLine
            opResult1=baseLine.transform(trafo1,QgsCoordinateTransform.ForwardTransform, False)
        if not polygonLayer.crs().authid()==crsProject.authid():
            # if not, transform to raster crs()
            trafo2=QgsCoordinateTransform(polygonLayer.crs(),crsProject,QgsProject.instance())
            #transform BaseLine
            opResult2=baseLine.transform(trafo2,QgsCoordinateTransform.ForwardTransform, False)

        layerZFieldId=-1
        #init Terrain
        tm = TerrainModel(rasterLayer, feedback)
        #init LaengsProfil
        lp = LaengsProfil(baseLine, tm, crsProject, feedback)
        
        try:
            total = 100.0 / len(lp.linearRef.lineSegments)
        except:
            msg = self.tr("Keine Basislinie")
            feedback.reportError(msg)
            raise QgsProcessingException(msg)
        
        bufferWidth=10 #10 m, we make an area to intersect
        #get candidates featuresOnLine=[]
        featuresOnLine=lp.linearRef.getFeaturesOnBaseLine(polygonLayer, bufferWidth)
        #Falls Linien, dann ermittle Schnittpunkte mit Laengsprofil
        schnittpunkte=[] #Liste von Features
        if self.isPolygonType(polygonLayer):
            #get intersection point features
            #hier erfolgt ggf. auch die umwandlung der Projektion
            schnittpunkte, schnittLinien=self.getSchnittpunkteAusPolygonen(featuresOnLine, polygonLayer.crs(), lp, feedback) #Um Attribute der geschnittenen Objekte zu uebernehmen, muss hier mehr uebergeben werden
            
            featuresWithZ=[]
            if outputGeomType == 1: #'Points':
                #calculate Z-Values for Points
                featuresWithZ=tm.addZtoPointFeatures(schnittpunkte, crsProject, layerZFieldId)
            
            else: #0 Lines
                if schnittLinien is None or len(schnittLinien)==0:
                    msg = self.tr("No polygon feature is intersecting this baseline!")
                    feedback.reportError(msg)
                else:
                    #calculate Z-Values for SchnittLines
                    for schnittLineFeat in schnittLinien:
                        featZ = QgsFeature(schnittLineFeat)
                        linRef = LinearReferencingMaschine(schnittLineFeat.geometry(), crsProject, feedback)
                        line3D = self.calc3DProfile(linRef, tm, crsProject)
                        featZ.setGeometry(line3D)
                        featZ.setAttributes(schnittLineFeat.attributes())
                        featuresWithZ.append(featZ)


            if not featuresWithZ is None:



                if len( featuresWithZ )==0:
                    feedback.reportError( "No Features was added with z values." )
                    return {self.OUTPUT: 0}
                else:

                    newFields=[]
                    try:
                        newFields=featuresWithZ[0].fields()
                        wkbTyp=featuresWithZ[0].geometry().wkbType()
                    except IndexError:
                        msg = self.tr( "No Z values could be assigned to the Geometries." )
                        feedback.reportError( msg )
                        raise QgsProcessingException( msg )
                        
                    #newFields.append( QgsField( "profil_id" ,  QVariant.Int ) ) 
                    newFields.append( QgsField( "z_factor" ,  QVariant.Int ) ) 
                    
                    #config Output
                    ( sink, dest_id ) = self.parameterAsSink( parameters, self.OUTPUT,
                    context, newFields, wkbTyp, crsProject )
                

                    #create geometries as profil coordinates
                    profilFeatures = []
                    iFeat=0
                    for current, srcFeat in enumerate( featuresWithZ ):
                        # Stop the algorithm if cancel button has been clicked
                        if feedback.isCanceled():
                            return { self.OUTPUT: dest_id }
                            #break
                        srcGeom = srcFeat.geometry()
                        if srcGeom.isGeosValid():
                            profilGeometries = lp.extractProfilGeom( srcGeom, ueberhoehung, lp.srcProfilLine )
                            #feedback.pushInfo("b " + str(srcFeat.attributes())+ ""+ str(profilGeometries))
                            for profilGeom in profilGeometries:
                                # build a Feature
                                profilFeat = QgsFeature( newFields )   
                                profilFeat.setGeometry( profilGeom )
                                attrs = srcFeat.attributes()
                                attrs.append( ueberhoehung )                               
                                profilFeat.setAttributes( attrs )
                                # Add a feature in the sink
                                sink.addFeature( profilFeat, QgsFeatureSink.FastInsert )
                                iFeat = iFeat + 1
                                #feedback.pushInfo(str(profilFeat.attributes()))
                        else:
                            feedback.reportError( str( srcFeat.attributes() ) + srcGeom.asWkt() )
                        # Update the progress bar
                        feedback.setProgress( int( current * total ) )

                    msgInfo = self.tr( "{0} intersection features where transformed to profile coordinates:" ).format( iFeat )
                    feedback.pushInfo( msgInfo )
                    # Return the results of the algorithm. In this case our only result is
                    return {self.OUTPUT: dest_id}

    def name(self):
        """
        Returns the algorithm name, used for identifying the algorithm. This
        string should be fixed for the algorithm, and must not be localised.
        The name should be unique within each provider. Names should contain
        lowercase alphanumeric characters only and no spaces or other
        formatting characters.
        """
        return self.tr('Polygon_Baseline_Intersections')

    def displayName(self):
        """
        Returns the translated algorithm name, which should be used for any
        user-visible display of the algorithm name.
        """
        return self.tr('Polygon - Baseline Intersections')

    def group(self):
        """
        Returns the name of the group this algorithm belongs to. This string
        should be localised.
        """
        return self.tr(self.groupId())

    def groupId(self):
        """
        Returns the unique ID of the group this algorithm belongs to. This
        string should be fixed for the algorithm, and must not be localised.
        The group id should be unique within each provider. Group id should
        contain lowercase alphanumeric characters only and no spaces or other
        formatting characters.
        """
        return 'To Profile Coordinates'

    def shortHelpString(self):
        """
        Returns a localised short helper string for the algorithm. This string
        should provide a basic description about what the algorithm does and the
        parameters and outputs associated with it..
        """
        return self.tr(self.__doc__)
   
    def icon(self):
        return QIcon(os.path.join(os.path.dirname(__file__),'icons/TransformToProfil_PolygonIntersection_Logo.png'))

    def tr(self, string):
        return QCoreApplication.translate('Processing', string)

    def createInstance(self):
        return TransformToProfil_PolygonIntersection()

    def isPolygonType(self, vectorLayer):
        if vectorLayer.wkbType()==3 or vectorLayer.wkbType()==1003 or vectorLayer.wkbType()==2003 or vectorLayer.wkbType()==3003 or vectorLayer.wkbType()==6 or vectorLayer.wkbType()==1006 or vectorLayer.wkbType()==2006 or vectorLayer.wkbType()==3006:
            return True
        else:
            return False

    #extraiere Linienseqmente
    def extractLineSegments(self, geom):
        points=self.getVertices(geom)
        #create the lines
        lines=[]
        i=0 # Line number
        while i < len(points)-1:
            p1=points[i]
            p2=points[i+1]
            lineGeom=QgsGeometry().fromPolyline([p1,p2])
            lines.append(lineGeom)
            i=i+1
        return lines        

    #liefert die Stuetzpunkte einer Single-Geometrie
    def getVertices(self, geom):
        v_iter = geom.vertices()
        points=[]

        while v_iter.hasNext():
            pt = v_iter.next()
            points.append(pt)
        return points       
    
    # this function create a list of point features with intersection Points and manage the geometry type Single or Multi
    def getSchnittpunkteAusPolygonen(self, overlapFeats, featureCrs, laengsProfil, feedback):
        schnittpunktFeatures=[]
        schnittLinesFeatures=[]
        ioFeat=0
        countPoints=0
        try:
            for feat in overlapFeats:
                #Feature bekommt neues Attribut Station
                if ioFeat==0:
                    fields=feat.fields()
                    fields.append(QgsField("station", QVariant.Double))
                
                schnittpunktFeaturesOfThisPolygon=[]
                schnittpunktListOfPolygon=[] #Liste [points, stations, feature.id's]
                #check if Multipolygon
                iMulti=0
                iRing=0
                
                tempGeom=QgsGeometry()
                tempGeom.fromWkb(feat.geometry().asWkb())
                #transform geom to Project.crs() if crs a different
                if not featureCrs.authid()==QgsProject.instance().crs().authid():
                    trafo=QgsCoordinateTransform(featureCrs, QgsProject.instance().crs(), QgsProject.instance())
                    #transform Geom to Project.crs()
                    tempGeom.transform(trafo,QgsCoordinateTransform.ForwardTransform, False)
                
                if tempGeom.isMultipart():
                    multiGeom = tempGeom.asMultiPolygon()
                    #Schleife zum Auflösen des Multiparts
                    for polygon in multiGeom:
                        for ring in polygon:
                            points=[]
                            for pxy in ring:
                               #feedback.pushInfo(str(iMulti)+" "+str(iRing)+" "+str(pxy) + " " + str(type(pxy)))
                               points.append(QgsPoint(pxy.x(), pxy.y()))
                            singlePolygon=QgsGeometry().fromPolyline(points)
                            iRing=iRing+1
                        
                            #feedback.pushInfo(str(iMulti) + str(type(singlePolygon)) + str(polygon))
                            
                            schnittpunktFeaturesOfThisPolygonItem = self.makeIntersectionFeatures(feat, singlePolygon, laengsProfil, fields, feedback)
                            for spfotp in schnittpunktFeaturesOfThisPolygonItem:
                                schnittpunktFeaturesOfThisPolygon.append(spfotp)
                            #Liste [points, stations, feature.id's]
                            schnittpunktListOfPolygonItem=self.makeIntersectionPointsStationList(feat, singlePolygon, laengsProfil, fields, feedback)
                            for sp in schnittpunktListOfPolygonItem:
                                schnittpunktListOfPolygon.append(sp)


                            iMulti=iMulti+1

                
                else: # single Geometry
                    schnittpunktFeaturesOfThisPolygon = self.makeIntersectionFeatures(feat, tempGeom, laengsProfil, fields, feedback)
                    schnittpunktListOfPolygon = self.makeIntersectionPointsStationList(feat, tempGeom, laengsProfil, fields, feedback)

                #create LineFeatures
                schnittLinesFeats=self.makeLineFeaturesFromPointStationList(feat, schnittpunktListOfPolygon, laengsProfil, feedback)
                for f in schnittLinesFeats:
                    schnittLinesFeatures.append(f)


                #add to list
                for schnittFeat in schnittpunktFeaturesOfThisPolygon: #Intersection Feature in project.crs()
                    schnittpunktFeatures.append(schnittFeat)
                    #feedback.pushInfo(str(schnittFeat.attributes()))
                ioFeat=ioFeat+1
                #count Intersections
                countPoints=countPoints+len(schnittpunktFeaturesOfThisPolygon)

        except:
            msg = self.tr("Error: Creating Intersections Geometry {0} Feature {1}").format(str(type(feat.geometry())), str(feat.attributes()))
            feedback.reportError(msg)
            raise QgsProcessingException(msg)
        msgInfo=self.tr("Intersected Lines: {0} Intersections: {1}").format(ioFeat, countPoints)
        feedback.pushInfo(msgInfo)
        return schnittpunktFeatures, schnittLinesFeatures

        
    # this function create a list of point features with intersection Points
    def makeLineFeaturesFromPointStationList(self, feat, listPointStationId, laengsProfil,  feedback):

        polygon=feat.geometry()
        
        curStat=0
        lastPoint=None
        for line in laengsProfil.linearRef.lineSegments:
            pt = line.vertexAt(0)
            ptGeom = QgsGeometry().fromPointXY( QgsPointXY( pt.x(), pt.y() ) )
            lastPoint=line.vertexAt(1)
            #add if is in polygon
            if ptGeom.intersects(polygon):
                listPointStationId.append( [ptGeom,curStat, -1] )
            curStat = curStat + line.length()

        #add Last Point
        lastGeom=QgsGeometry().fromPointXY( QgsPointXY( lastPoint.x(), lastPoint.y() ))
        if lastGeom.intersects(polygon):
            listPointStationId.append( [lastGeom, curStat, -1] )
              
            
        #sortiert die Punkte an Hand der Station (Index 1)
        listPointStationId.sort( key=lambda x: x[1])
        linePoints = []

        for item in listPointStationId:
            stat = item[1]
            pt = item[0]
            featId = item[2]
            linePoints.append( [pt , stat])
            
        # check which line segments intersect this polygon (only needed be Multipolygons)
        lines = []
        lastStat=None
        i=0 # Line number
        while i < len(linePoints)-1:
            p1=linePoints[i][0].asPoint()
            stat1=linePoints[i][1]
            p2=linePoints[i+1][0].asPoint()
            stat2=linePoints[i+1][1]
            
            #Erzeuge hilfweise den Mittelpunkt auf Linensegment und prüfe ob er im Polygon liegt
            xM = ( p1.x() + p2.x() ) / 2
            yM = ( p1.y() + p2.y() ) / 2
            pm = QgsPointXY( xM , yM )
            ptGeom = QgsGeometry().fromPointXY( QgsPointXY( pm.x(), pm.y() ))
            if ptGeom.intersects(polygon):
                pA = QgsPoint( p1.x(), p1.y() )
                pB = QgsPoint( p2.x(), p2.y() )

                #continue last Line if same Station
                if stat1 == lastStat: #len(lines) > 0 and not lastStat == 0 and 
                    lastIndex = len(lines)-1
                    
                    line = lines[lastIndex]
                    newPts=[]
                    for vertex in line.vertices():
                        newPts.append(vertex)
                    # add new Vertex
                    newPts.append(pB)
                    #overide last line
                    lines[lastIndex] = QgsGeometry().fromPolyline( newPts )
                else:
                    lines.append( QgsGeometry().fromPolyline( [ pA, pB ] ) )

                lastStat=stat2 # Last Station in same Polygon
            i=i+1


        #Create Line Features
        lineFeats=[]
        attrs=feat.attributes()
        for ln in lines:
            feature = QgsFeature(feat)
            geom = ln 
            feature.setGeometry(geom)
            feature.setAttributes(attrs)
            lineFeats.append(feature)

        return lineFeats

    # this function create a list of point features with intersection Points
    def makeIntersectionFeatures(self, feat, geom,  laengsProfil, newfields,  feedback):
        schnittpunktFeatures=[]
        countPoints=0
        #explode polyline, get each line segment as LineString in a list
        try:

            linesOfPolygon = self.extractLineSegments(geom)
        except:
            msg = self.tr("Error: Explode Line Segments for Geometry {0} Feature {1}").format(geom.asWkt(), feat.attributes())
            feedback.reportError(msg)
            raise QgsProcessingException(msg)
        
        for lineP in linesOfPolygon:
            #get all Intersection Points
            intersectionPoints, stations=laengsProfil.linearRef.getIntersectionPointsofPolyLine(lineP)
            if not intersectionPoints is None:
                for i in range(len(intersectionPoints)):
                    try:
                        pt=intersectionPoints[i].asPoint()
                        
                        schnittPunktFeat=QgsFeature(newfields) #Feature with extra attribut
                        schnittPunktFeat.setGeometry(intersectionPoints[i])
                        attrs=feat.attributes()
                        attrs.append(stations[i]) # station is saved in extra Attribute
                        #set new attributes with station
                        schnittPunktFeat.setAttributes(attrs)                               
                        schnittpunktFeatures.append(schnittPunktFeat)
                        #feedback.pushInfo(str(attrs))

                    except:
                        msg = self.tr("Error: Creating Intesections Geometry {0} Feature {1}").format(str(type(intersectionPoints[i].geometry())), str(intersectionPoints[i].attributes()))
                        feedback.reportError(msg)
                        raise QgsProcessingException(msg)
            
        return schnittpunktFeatures

    # this function create a list of [points, stations, feature.id's] of intersection Points for a Polygon
    def makeIntersectionPointsStationList(self, feat, geom,  laengsProfil, newfields,  feedback):
        schnittpunkte=[]
        countPoints=0
        #TEST# clip the BaseLine with the current polygon
        # intersect=geom.intersection(laengsProfil.srcProfilLine)
        # feedback.pushInfo("Clip: " + intersect.asWkt() + " " + str( type(intersect) ))

        
        #explode polyline, get each line segment as LineString in a list
        try:

            linesOfPolygon = self.extractLineSegments(geom)
        except:
            msg = self.tr("Error: Explode Line Segments for Geometry {0} Feature {1}").format(geom.asWkt(), feat.attributes())
            feedback.reportError(msg)
            raise QgsProcessingException(msg)
        
        for lineP in linesOfPolygon:
            #get all Intersection Points
            intersectionPoints, stations=laengsProfil.linearRef.getIntersectionPointsofPolyLine(lineP)
            if not intersectionPoints is None:
                for i in range(len(intersectionPoints)):
                    try:
                        pt=intersectionPoints[i].asPoint()
                        
                        schnittpunkte.append([intersectionPoints[i], stations[i], feat.id()])

                    except:
                        msg = self.tr("Error: Creating Intesections Geometry {0} Feature {1}").format(str(type(intersectionPoints[i].geometry())), str(intersectionPoints[i].attributes()))
                        feedback.reportError(msg)
                        raise QgsProcessingException(msg)

                        
        return schnittpunkte #[points, stations, feature.id's]

    #Erstellt eine Polyline mit Z-Werten in Rasterauflösung
    def calc3DProfile(self, linearRef, terrainModel, crsProject):

        #insert new vertices on raster cells
        detailedLine=linearRef.verdichtePunkte(terrainModel.rasterWidth)
        #sample values from Rasters
        points3D=terrainModel.addZtoPoints(detailedLine.vertices(),crsProject)
        #Create Geometry
        profilLine3d=QgsGeometry.fromPolyline(points3D)
        return profilLine3d