_enpt_alg_base.py 12.6 KB
Newer Older
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# -*- coding: utf-8 -*-

# enpt_enmapboxapp, A QGIS EnMAPBox plugin providing a GUI for the EnMAP processing tools (EnPT)
#
# Copyright (C) 2019  Daniel Scheffler (GFZ Potsdam, daniel.scheffler@gfz-potsdam.de)
#
# This software was developed within the context of the EnMAP project supported
# by the DLR Space Administration with funds of the German Federal Ministry of
# Economic Affairs and Energy (on the basis of a decision by the German Bundestag:
# 50 EE 1529) and contributions from DLR, GFZ and OHB System AG.
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option) any
# later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with this program.  If not, see <http://www.gnu.org/licenses/>.

"""This module provides the base class for EnPTAlgorithm and ExternalEnPTAlgorithm."""

import os
from os.path import expanduser
from datetime import date
from multiprocessing import cpu_count
from qgis.core import \
    (QgsProcessingAlgorithm,
     QgsProcessingParameterFile,
     QgsProcessingParameterNumber,
     QgsProcessingParameterFolderDestination,
     QgsProcessingParameterBoolean,
     QgsProcessingParameterString
     )

from .version import __version__


class _EnPTBaseAlgorithm(QgsProcessingAlgorithm):
    # NOTE: The parameter assignments made here follow the parameter names in enpt/options/options_schema.py

    # Input parameters
    P_json_config = 'json_config'
    P_CPUs = 'CPUs'
    P_path_l1b_enmap_image = 'path_l1b_enmap_image'
    P_path_l1b_enmap_image_gapfill = 'path_l1b_enmap_image_gapfill'
    P_path_dem = 'path_dem'
    P_average_elevation = 'average_elevation'
    P_output_dir = 'output_dir'
    P_working_dir = 'working_dir'
    P_n_lines_to_append = 'n_lines_to_append'
    P_disable_progress_bars = 'disable_progress_bars'
    P_path_earthSunDist = 'path_earthSunDist'
    P_path_solar_irr = 'path_solar_irr'
    P_scale_factor_toa_ref = 'scale_factor_toa_ref'
    P_enable_keystone_correction = 'enable_keystone_correction'
    P_enable_vnir_swir_coreg = 'enable_vnir_swir_coreg'
    P_path_reference_image = 'path_reference_image'
    P_enable_ac = 'enable_ac'
    P_auto_download_ecmwf = 'auto_download_ecmwf'
    P_enable_ice_retrieval = 'enable_ice_retrieval'
    P_enable_cloud_screening = 'enable_cloud_screening'
    P_scale_factor_boa_ref = 'scale_factor_boa_ref'
    P_run_smile_P = 'run_smile_P'
    P_run_deadpix_P = 'run_deadpix_P'
    P_deadpix_P_algorithm = 'deadpix_P_algorithm'
    P_deadpix_P_interp_spectral = 'deadpix_P_interp_spectral'
    P_deadpix_P_interp_spatial = 'deadpix_P_interp_spatial'
    P_ortho_resampAlg = 'ortho_resampAlg'
    P_vswir_overlap_algorithm = 'vswir_overlap_algorithm'

    # # Output parameters
    P_OUTPUT_RASTER = 'outraster'
    # P_OUTPUT_VECTOR = 'outvector'
    # P_OUTPUT_FILE = 'outfile'
    P_OUTPUT_FOLDER = 'outfolder'

    def group(self):
        return 'Pre-Processing'

    def groupId(self):
        return 'PreProcessing'

    def name(self):
        return 'EnPTAlgorithm'

    def displayName(self):
        return 'EnMAP processing tool algorithm (v%s)' % __version__

    def createInstance(self, *args, **kwargs):
        return type(self)()

    @staticmethod
    def _get_default_output_dir():
        userhomedir = expanduser('~')

        default_enpt_dir = \
            os.path.join(userhomedir, 'Documents', 'EnPT', 'Output') if os.name == 'nt' else\
            os.path.join(userhomedir, 'EnPT', 'Output')

        outdir_nocounter = os.path.join(default_enpt_dir, date.today().strftime('%Y%m%d'))

        counter = 1
        while os.path.isdir('%s__%s' % (outdir_nocounter, counter)):
            counter += 1

        return '%s__%s' % (outdir_nocounter, counter)

    def initAlgorithm(self, configuration=None):
        self.addParameter(QgsProcessingParameterFile(
            name=self.P_json_config, description='Configuration JSON template file',
            behavior=QgsProcessingParameterFile.File, extension='json',
            defaultValue=None,
            optional=True))

        self.addParameter(QgsProcessingParameterNumber(
            name=self.P_CPUs,
            description='Number of CPU cores to be used for processing',
            type=QgsProcessingParameterNumber.Integer,
            defaultValue=cpu_count(), minValue=0, maxValue=cpu_count(),
            optional=True))

        self.addParameter(QgsProcessingParameterFile(
            name=self.P_path_l1b_enmap_image,
            description='L1B EnMAP image (zip-archive or root directory)'))

        self.addParameter(QgsProcessingParameterFile(
            name=self.P_path_l1b_enmap_image_gapfill,
            description='Adjacent EnMAP L1B image to be used for gap-filling (zip-archive or root directory)',
            optional=True))

        self.addParameter(QgsProcessingParameterFile(
            name=self.P_path_dem,
            description='Input path of digital elevation model in map or sensor geometry; GDAL compatible file '
                        'format \n(must cover the EnMAP L1B data completely if given in map geometry or must have the '
                        'same \npixel dimensions like the EnMAP L1B data if given in sensor geometry)',
            optional=True))

        self.addParameter(QgsProcessingParameterNumber(
            name=self.P_average_elevation,
            description='Average elevation in meters above sea level \n'
                        '(may be provided if no DEM is available and ignored if DEM is given)',
            type=QgsProcessingParameterNumber.Integer,
            defaultValue=0,
            optional=True))

        self.addParameter(QgsProcessingParameterFolderDestination(
            name=self.P_output_dir,
            description='Output directory where processed data and log files are saved',
            defaultValue=self._get_default_output_dir(),
            optional=True))

        self.addParameter(QgsProcessingParameterFile(
            name=self.P_working_dir,
            description='Directory to be used for temporary files',
            behavior=QgsProcessingParameterFile.Folder,
            defaultValue=None,
            optional=True))

        self.addParameter(QgsProcessingParameterNumber(
            name=self.P_n_lines_to_append,
            description='Number of lines to be added to the main image [if not given, use the whole imgap]',
            type=QgsProcessingParameterNumber.Integer,
            defaultValue=None,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_disable_progress_bars,
            description='Disable all progress bars during processing',
            defaultValue=True,
            optional=True))

        self.addParameter(QgsProcessingParameterFile(
            name=self.P_path_earthSunDist,
            description='Input path of the earth sun distance model',
            defaultValue=None,
            optional=True))

        self.addParameter(QgsProcessingParameterFile(
            name=self.P_path_solar_irr,
            description='Input path of the solar irradiance model',
            defaultValue=None,
            optional=True))

        self.addParameter(QgsProcessingParameterNumber(
            name=self.P_scale_factor_toa_ref,
            description='Scale factor to be applied to TOA reflectance result',
            type=QgsProcessingParameterNumber.Integer,
            defaultValue=10000,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_enable_keystone_correction,
            description='Keystone correction',
            defaultValue=False,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_enable_vnir_swir_coreg,
            description='VNIR/SWIR co-registration',
            defaultValue=False,
            optional=True))

        self.addParameter(QgsProcessingParameterFile(
            name=self.P_path_reference_image,
            description='Reference image for co-registration.',
            defaultValue=None,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_enable_ac,
            description='Enable atmospheric correction using SICOR algorithm',
            defaultValue=True,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_auto_download_ecmwf,
            description='Automatically download ECMWF data for atmospheric correction',
            defaultValue=False,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_enable_ice_retrieval,
            description='Enable ice retrieval (increases accuracy of water vapour retrieval)',
            defaultValue=True,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_enable_cloud_screening,
            description='Cloud screening during atmospheric correction',
            defaultValue=False,
            optional=True))

        self.addParameter(QgsProcessingParameterNumber(
            name=self.P_scale_factor_boa_ref,
            description='Scale factor to be applied to BOA reflectance result',
            type=QgsProcessingParameterNumber.Integer,
            defaultValue=10000,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_run_smile_P,
            description='Smile detection and correction (provider smile coefficients are ignored)',
            defaultValue=False,
            optional=True))

        self.addParameter(QgsProcessingParameterBoolean(
            name=self.P_run_deadpix_P,
            description='Dead pixel correction',
            defaultValue=True,
            optional=True))

        self.addParameter(QgsProcessingParameterString(
            name=self.P_deadpix_P_algorithm,
            description="Algorithm for dead pixel correction ('spectral' or 'spatial')",
            defaultValue='spectral',
            multiLine=False,
            optional=True))

        self.addParameter(QgsProcessingParameterString(
            name=self.P_deadpix_P_interp_spectral,
            description="Spectral interpolation algorithm to be used during dead pixel correction "
                        "('linear', 'bilinear', 'cubic', 'spline')",
            defaultValue='linear',
            multiLine=False,
            optional=True))

        self.addParameter(QgsProcessingParameterString(
            name=self.P_deadpix_P_interp_spatial,
            description="Spatial interpolation algorithm to be used during dead pixel correction "
                        "('linear', 'bilinear', 'cubic', 'spline')",
            defaultValue='linear',
            multiLine=False,
            optional=True))

        self.addParameter(QgsProcessingParameterString(
            name=self.P_ortho_resampAlg,
            description="Ortho-rectification resampling algorithm ('nearest', 'bilinear', 'gauss')",
            defaultValue='bilinear',
            multiLine=False,
            optional=True))

        self.addParameter(QgsProcessingParameterString(
            name=self.P_vswir_overlap_algorithm,
            description="Algorithm specifying how to deal with the spectral bands in the VNIR/SWIR spectral overlap "
                        "region ('order_by_wvl', 'average', 'vnir_only', 'swir_only')",
            defaultValue='swir_only',
            multiLine=False,
            optional=True))

    @staticmethod
    def shortHelpString(*args, **kwargs):
        """Example:

        '<p>Here comes the HTML documentation.</p>' \
        '<h3>With Headers...</h3>' \
        '<p>and Hyperlinks: <a href="www.google.de">Google</a></p>'

        :param args:
        :param kwargs:
        """

        text = \
            '<p>General information about this EnMAP box app can be found ' \
            '<a href="https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/enpt_enmapboxapp/doc/">here</a>' \
            '.</p>' \
            '<p>Type <i>python enpt_cli.py -h</i> into a shell to get further information about individual ' \
            'parameters.</p>'

        return text

    def helpString(self):
        return self.shortHelpString()

    @staticmethod
    def helpUrl(*args, **kwargs):
        return 'https://enmap.git-pages.gfz-potsdam.de/GFZ_Tools_EnMAP_BOX/enpt_enmapboxapp/doc/'