File: gdal2xyz.py

package info (click to toggle)
qgis 3.40.6%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,181,336 kB
  • sloc: cpp: 1,593,302; python: 370,494; xml: 23,474; perl: 3,664; sh: 3,482; ansic: 2,257; sql: 2,133; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 157
file content (173 lines) | stat: -rw-r--r-- 6,343 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
"""
***************************************************************************
    gdal2xyz.py
    ---------------------
    Date                 : September 2013
    Copyright            : (C) 2013 by Alexander Bruy
    Email                : alexander dot bruy at gmail dot com
***************************************************************************
*                                                                         *
*   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.                                   *
*                                                                         *
***************************************************************************
"""

__author__ = "Alexander Bruy"
__date__ = "September 2013"
__copyright__ = "(C) 2013, Alexander Bruy"

from qgis.core import (
    QgsProcessingAlgorithm,
    QgsProcessingException,
    QgsProcessingParameterRasterLayer,
    QgsProcessingParameterBand,
    QgsProcessingParameterBoolean,
    QgsProcessingParameterFileDestination,
    QgsProcessingParameterNumber,
)
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
from processing.algs.gdal.GdalUtils import GdalUtils
from processing.tools.system import isWindows


class gdal2xyz(GdalAlgorithm):
    INPUT = "INPUT"
    BAND = "BAND"
    SRCNODATA = "NODATA_INPUT"
    DSTNODATA = "NODATA_OUTPUT"
    SKIPNODATA = "SKIP_NODATA"
    CSV = "CSV"
    OUTPUT = "OUTPUT"

    def __init__(self):
        super().__init__()

    def initAlgorithm(self, config=None):
        self.addParameter(
            QgsProcessingParameterRasterLayer(self.INPUT, self.tr("Input layer"))
        )
        self.addParameter(
            QgsProcessingParameterBand(
                self.BAND,
                self.tr("Band number"),
                1,
                parentLayerParameterName=self.INPUT,
            )
        )

        self.addParameter(
            QgsProcessingParameterNumber(
                self.SRCNODATA,
                self.tr("Input pixel value to treat as NoData"),
                optional=True,
            )
        )  # GDAL > 3.6.3
        self.addParameter(
            QgsProcessingParameterNumber(
                self.DSTNODATA,
                self.tr("Assign specified NoData value to output"),
                optional=True,
            )
        )  # GDAL > 3.6.3
        self.addParameter(
            QgsProcessingParameterBoolean(
                self.SKIPNODATA,
                self.tr("Do not output NoData values"),
                defaultValue=False,
            )
        )  # GDAL > 3.3
        self.addParameter(
            QgsProcessingParameterBoolean(
                self.CSV, self.tr("Output comma-separated values"), defaultValue=False
            )
        )
        self.addParameter(
            QgsProcessingParameterFileDestination(
                self.OUTPUT, self.tr("XYZ ASCII file"), self.tr("CSV files (*.csv)")
            )
        )

    def name(self):
        return "gdal2xyz"

    def displayName(self):
        return self.tr("gdal2xyz")

    def group(self):
        return self.tr("Raster conversion")

    def groupId(self):
        return "rasterconversion"

    def commandName(self):
        return "gdal2xyz"

    def flags(self):
        return super().flags() | QgsProcessingAlgorithm.Flag.FlagDisplayNameIsLiteral

    def getConsoleCommands(self, parameters, context, feedback, executing=True):
        arguments = ["-band", str(self.parameterAsInt(parameters, self.BAND, context))]

        if self.SRCNODATA in parameters and parameters[self.SRCNODATA] is not None:
            if (
                GdalUtils.version() > 3060300
            ):  # src/dstnodata broken <= 3.6.3 https://github.com/OSGeo/gdal/issues/7410
                srcnodata = self.parameterAsDouble(parameters, self.SRCNODATA, context)
                arguments.append("-srcnodata")
                arguments.append(srcnodata)
            else:
                raise QgsProcessingException(
                    self.tr(
                        "The source nodata option (-srcnodata) is only available on GDAL 3.6.4 or later"
                    )
                )

        if self.DSTNODATA in parameters and parameters[self.DSTNODATA] is not None:
            if (
                GdalUtils.version() > 3060300
            ):  # src/dstnodata broken <= 3.6.3 https://github.com/OSGeo/gdal/issues/7410
                dstnodata = self.parameterAsDouble(parameters, self.DSTNODATA, context)
                arguments.append("-dstnodata")
                arguments.append(dstnodata)
            else:
                raise QgsProcessingException(
                    self.tr(
                        "The destination nodata option (-dstnodata) is only available on GDAL 3.6.4 or later"
                    )
                )

        if self.SKIPNODATA in parameters:
            if GdalUtils.version() >= 3030000:  # skipnodata added at GDAL 3.3
                if self.parameterAsBoolean(parameters, self.SKIPNODATA, context):
                    arguments.append("-skipnodata")
            else:
                raise QgsProcessingException(
                    self.tr(
                        "The skip nodata option (-skipnodata) is only available on GDAL 3.3 or later"
                    )
                )

        if self.parameterAsBoolean(parameters, self.CSV, context):
            arguments.append("-csv")

        raster = self.parameterAsRasterLayer(parameters, self.INPUT, context)
        if raster is None:
            raise QgsProcessingException(
                self.invalidRasterError(parameters, self.INPUT)
            )

        input_details = GdalUtils.gdal_connection_details_from_layer(raster)

        arguments.append(input_details.connection_string)
        arguments.append(self.parameterAsFileOutput(parameters, self.OUTPUT, context))

        if input_details.credential_options:
            arguments.extend(input_details.credential_options_as_arguments())

        return [
            self.commandName() + (".bat" if isWindows() else ".py"),
            GdalUtils.escapeAndJoin(arguments),
        ]