| 1 |
import os |
| 2 |
from grass.gunittest.case import TestCase |
| 3 |
from grass.gunittest.main import test |
| 4 |
from pathlib import Path |
| 5 |
|
| 6 |
|
| 7 |
class TestLandsatTOARBasic(TestCase): |
| 8 |
"""Regression tests for i.landsat.toar""" |
| 9 |
|
| 10 |
input_prefix = "lsat_" |
| 11 |
output_prefix = "toar_" |
| 12 |
metfile = "LC08_MTL.txt" |
| 13 |
bands = ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11"] |
| 14 |
|
| 15 |
@classmethod |
| 16 |
def setUpClass(cls): |
| 17 |
"""Create test data.""" |
| 18 |
cls.use_temp_region() |
| 19 |
cls.runModule("g.region", n=50, s=0, e=50, w=0, rows=50, cols=50) |
| 20 |
for band in cls.bands: |
| 21 |
cls.runModule( |
| 22 |
"r.mapcalc", |
| 23 |
expression=f"{cls.input_prefix}{band} = 1000 + row() + col()", |
| 24 |
overwrite=True, |
| 25 |
) |
| 26 |
Path(cls.metfile).write_text("""GROUP = L1_METADATA_FILE |
| 27 |
GROUP = PRODUCT_METADATA |
| 28 |
SPACECRAFT_ID = "LANDSAT_8" |
| 29 |
SENSOR_ID = "OLI_TIRS" |
| 30 |
DATE_ACQUIRED = "2023-01-01" |
| 31 |
FILE_DATE = "2023-01-01" |
| 32 |
SCENE_CENTER_TIME = "10:30:00" |
| 33 |
END_GROUP = PRODUCT_METADATA |
| 34 |
GROUP = IMAGE_ATTRIBUTES |
| 35 |
SUN_ELEVATION = 45.0 |
| 36 |
SUN_AZIMUTH = 135.0 |
| 37 |
END_GROUP = IMAGE_ATTRIBUTES |
| 38 |
GROUP = PROJECTION_PARAMETERS |
| 39 |
EARTH_SUN_DISTANCE = 0.9833368 |
| 40 |
END_GROUP = PROJECTION_PARAMETERS |
| 41 |
GROUP = RADIOMETRIC_RESCALING |
| 42 |
RADIANCE_MULT_BAND_1 = 0.1 |
| 43 |
RADIANCE_ADD_BAND_1 = 0.0 |
| 44 |
RADIANCE_MAXIMUM_BAND_1 = 6553.5 |
| 45 |
RADIANCE_MINIMUM_BAND_1 = 0.1 |
| 46 |
REFLECTANCE_MULT_BAND_1 = 2.0e-4 |
| 47 |
REFLECTANCE_ADD_BAND_1 = 0.0 |
| 48 |
REFLECTANCE_MAXIMUM_BAND_1 = 1.0 |
| 49 |
QUANTIZE_CAL_MAX_BAND_1 = 65535 |
| 50 |
QUANTIZE_CAL_MIN_BAND_1 = 1 |
| 51 |
|
| 52 |
RADIANCE_MULT_BAND_10 = 0.15 |
| 53 |
RADIANCE_ADD_BAND_10 = 0.3 |
| 54 |
RADIANCE_MAXIMUM_BAND_10 = 6553.5 |
| 55 |
RADIANCE_MINIMUM_BAND_10 = 0.15 |
| 56 |
QUANTIZE_CAL_MAX_BAND_10 = 65535 |
| 57 |
QUANTIZE_CAL_MIN_BAND_10 = 1 |
| 58 |
END_GROUP = RADIOMETRIC_RESCALING |
| 59 |
GROUP = THERMAL_CONSTANTS |
| 60 |
K1_CONSTANT_BAND_10 = 774.89 |
| 61 |
K2_CONSTANT_BAND_10 = 1321.08 |
| 62 |
END_GROUP = THERMAL_CONSTANTS |
| 63 |
END_GROUP = L1_METADATA_FILE |
| 64 |
END""") |
| 65 |
|
| 66 |
@classmethod |
| 67 |
def tearDownClass(cls): |
| 68 |
"""Remove generated data""" |
| 69 |
cls.del_temp_region() |
| 70 |
input_rasters = [f"{cls.input_prefix}{b}" for b in cls.bands] |
| 71 |
output_rasters = [f"{cls.output_prefix}{b}" for b in cls.bands] |
| 72 |
extra_outputs = { |
| 73 |
"scaled_": ["1"], |
| 74 |
"rad_": ["1"], |
| 75 |
"manual_": ["1"], |
| 76 |
"dos_": ["1"], |
| 77 |
"gain_": ["1", "2", "3", "4", "5", "61", "62", "7", "8"], |
| 78 |
"dos3_": ["1"], |
| 79 |
} |
| 80 |
|
| 81 |
test_rasters = [] |
| 82 |
for suffix, bands in extra_outputs.items(): |
| 83 |
test_rasters += [f"{cls.output_prefix}{suffix}{b}" for b in bands] |
| 84 |
all_rasters = input_rasters + output_rasters + test_rasters |
| 85 |
cls.runModule("g.remove", flags="f", type="raster", name=all_rasters) |
| 86 |
if Path(cls.metfile).exists(): |
| 87 |
os.remove(cls.metfile) |
| 88 |
|
| 89 |
def test_reflectance_and_temperature_conversion_with_scale(self): |
| 90 |
"""Test conversion of DN to top-of-atmosphere reflectance and brightness temperature with scale factor""" |
| 91 |
self.assertModule( |
| 92 |
"i.landsat.toar", |
| 93 |
input=self.input_prefix, |
| 94 |
output=self.output_prefix, |
| 95 |
metfile=self.metfile, |
| 96 |
overwrite=True, |
| 97 |
) |
| 98 |
self.assertRasterExists(f"{self.output_prefix}1") |
| 99 |
self.assertRasterExists(f"{self.output_prefix}10") |
| 100 |
self.assertRasterFitsUnivar( |
| 101 |
f"{self.output_prefix}1", |
| 102 |
reference={ |
| 103 |
"min": 0.0216226, |
| 104 |
"max": 0.0237374, |
| 105 |
"mean": 0.02268, |
| 106 |
"stddev": 0.0004404, |
| 107 |
}, |
| 108 |
precision=1e-6, |
| 109 |
) |
| 110 |
self.assertRasterFitsUnivar( |
| 111 |
f"{self.output_prefix}10", |
| 112 |
reference={ |
| 113 |
"min": 609.713222, |
| 114 |
"max": 633.735610, |
| 115 |
"mean": 621.791689, |
| 116 |
"stddev": 5.0021045, |
| 117 |
}, |
| 118 |
precision=1e-6, |
| 119 |
) |
| 120 |
scaled_output_prefix = f"{self.output_prefix}scaled_" |
| 121 |
self.assertModule( |
| 122 |
"i.landsat.toar", |
| 123 |
input=self.input_prefix, |
| 124 |
output=scaled_output_prefix, |
| 125 |
metfile=self.metfile, |
| 126 |
scale=0.1, |
| 127 |
overwrite=True, |
| 128 |
) |
| 129 |
self.assertRasterFitsUnivar( |
| 130 |
f"{scaled_output_prefix}1", |
| 131 |
reference={ |
| 132 |
"min": 0.0216226 * 0.1, |
| 133 |
"max": 0.0237374 * 0.1, |
| 134 |
"mean": 0.02268 * 0.1, |
| 135 |
"stddev": 0.0004404 * 0.1, |
| 136 |
}, |
| 137 |
precision=1e-6, |
| 138 |
) |
| 139 |
|
| 140 |
def test_radiance_conversion_flag(self): |
| 141 |
"""Test the radiance output flag (-r) for converting DN to radiance values""" |
| 142 |
self.assertModule( |
| 143 |
"i.landsat.toar", |
| 144 |
input=self.input_prefix, |
| 145 |
output=f"{self.output_prefix}rad_", |
| 146 |
metfile=self.metfile, |
| 147 |
flags="r", |
| 148 |
overwrite=True, |
| 149 |
) |
| 150 |
self.assertRasterFitsUnivar( |
| 151 |
f"{self.output_prefix}rad_1", |
| 152 |
reference={ |
| 153 |
"min": 100.2, |
| 154 |
"max": 110.0, |
| 155 |
"mean": 105.1, |
| 156 |
"stddev": 2.040833, |
| 157 |
}, |
| 158 |
precision=1e-6, |
| 159 |
) |
| 160 |
|
| 161 |
def test_sensor_specific_conversion_without_metfile(self): |
| 162 |
"""Test TOAR conversion using explicit sensor parameters when metadata file is not available""" |
| 163 |
self.assertModule( |
| 164 |
"i.landsat.toar", |
| 165 |
input=self.input_prefix, |
| 166 |
output=f"{self.output_prefix}tm5_", |
| 167 |
sensor="tm5", |
| 168 |
date="2000-06-15", |
| 169 |
sun_elevation=45.0, |
| 170 |
product_date="2000-06-20", |
| 171 |
overwrite=True, |
| 172 |
) |
| 173 |
self.assertRasterFitsUnivar( |
| 174 |
f"{self.output_prefix}tm5_6", |
| 175 |
reference={ |
| 176 |
"min": 511.520389, |
| 177 |
"max": 529.405584, |
| 178 |
"mean": 520.519746, |
| 179 |
}, |
| 180 |
precision=1e-6, |
| 181 |
) |
| 182 |
|
| 183 |
def test_dos1_atmospheric_correction(self): |
| 184 |
"""Test Dark Object Subtraction 1 (DOS1) atmospheric correction method""" |
| 185 |
self.assertModule( |
| 186 |
"i.landsat.toar", |
| 187 |
input=self.input_prefix, |
| 188 |
output=f"{self.output_prefix}dos_", |
| 189 |
metfile=self.metfile, |
| 190 |
method="dos1", |
| 191 |
percent=0.5, |
| 192 |
pixel=500, |
| 193 |
overwrite=True, |
| 194 |
) |
| 195 |
self.assertRasterFitsUnivar( |
| 196 |
f"{self.output_prefix}dos_1", |
| 197 |
reference={ |
| 198 |
"min": 0.521601, |
| 199 |
"max": 0.523715, |
| 200 |
"mean": 0.522658, |
| 201 |
"stddev": 0.0004404, |
| 202 |
}, |
| 203 |
precision=1e-6, |
| 204 |
) |
| 205 |
|
| 206 |
def test_etm_gain_settings_conversion(self): |
| 207 |
"""Test conversion with different gain settings (High/Low) for Landsat ETM+ bands""" |
| 208 |
self.runModule( |
| 209 |
"r.mapcalc", |
| 210 |
expression=f"{self.input_prefix}61 = 1000 + row() + col()", |
| 211 |
overwrite=True, |
| 212 |
) |
| 213 |
self.addCleanup( |
| 214 |
self.runModule, |
| 215 |
"g.remove", |
| 216 |
flags="f", |
| 217 |
type="raster", |
| 218 |
name=f"{self.input_prefix}61", |
| 219 |
) |
| 220 |
self.runModule( |
| 221 |
"r.mapcalc", |
| 222 |
expression=f"{self.input_prefix}62 = 1000 + row() + col()", |
| 223 |
overwrite=True, |
| 224 |
) |
| 225 |
self.addCleanup( |
| 226 |
self.runModule, |
| 227 |
"g.remove", |
| 228 |
flags="f", |
| 229 |
type="raster", |
| 230 |
name=f"{self.input_prefix}62", |
| 231 |
) |
| 232 |
gain_setting = "HHHHHLLHH" |
| 233 |
output_prefix = f"{self.output_prefix}gain_" |
| 234 |
self.assertModule( |
| 235 |
"i.landsat.toar", |
| 236 |
input=self.input_prefix, |
| 237 |
output=output_prefix, |
| 238 |
sensor="tm7", |
| 239 |
gain=gain_setting, |
| 240 |
date="2002-06-15", |
| 241 |
sun_elevation=45.0, |
| 242 |
product_date="2002-06-20", |
| 243 |
overwrite=True, |
| 244 |
) |
| 245 |
etm_bands = ["1", "2", "3", "4", "5", "61", "62", "7", "8"] |
| 246 |
for band in etm_bands: |
| 247 |
self.assertRasterExists(f"{output_prefix}{band}") |
| 248 |
self.assertRasterFitsUnivar( |
| 249 |
f"{output_prefix}1", |
| 250 |
reference={ |
| 251 |
"min": 1.8002626, |
| 252 |
"max": 1.977925, |
| 253 |
"mean": 1.889093, |
| 254 |
"stddev": 0.0369979, |
| 255 |
}, |
| 256 |
precision=1e-6, |
| 257 |
) |
| 258 |
self.assertRasterFitsUnivar( |
| 259 |
f"{output_prefix}61", |
| 260 |
reference={ |
| 261 |
"min": 536.587816, |
| 262 |
"max": 556.244270, |
| 263 |
"mean": 546.4777, |
| 264 |
"stddev": 4.092958, |
| 265 |
}, |
| 266 |
precision=1e-6, |
| 267 |
) |
| 268 |
|
| 269 |
def test_dos3_atmospheric_correction_with_rayleigh(self): |
| 270 |
"""Test Dark Object Subtraction 3 (DOS3) atmospheric correction with Rayleigh scattering parameter""" |
| 271 |
self.assertModule( |
| 272 |
"i.landsat.toar", |
| 273 |
input=self.input_prefix, |
| 274 |
output=f"{self.output_prefix}dos3_", |
| 275 |
metfile=self.metfile, |
| 276 |
method="dos3", |
| 277 |
percent=0.5, |
| 278 |
pixel=500, |
| 279 |
rayleigh=0.5, |
| 280 |
overwrite=True, |
| 281 |
) |
| 282 |
self.assertRasterFitsUnivar( |
| 283 |
f"{self.output_prefix}dos3_1", |
| 284 |
reference={ |
| 285 |
"min": 0.5382208, |
| 286 |
"max": 0.541962, |
| 287 |
"mean": 0.540091, |
| 288 |
"stddev": 0.000779, |
| 289 |
}, |
| 290 |
precision=1e-6, |
| 291 |
) |
| 292 |
|
| 293 |
|
| 294 |
if __name__ == "__main__": |
| 295 |
test() |