File: test_view.py

package info (click to toggle)
pystac 1.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 19,904 kB
  • sloc: python: 24,370; makefile: 124; sh: 7
file content (350 lines) | stat: -rw-r--r-- 11,279 bytes parent folder | download | duplicates (2)
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
import json

import pytest

import pystac
from pystac import ExtensionTypeError, Item
from pystac.collection import Collection
from pystac.extensions.view import ViewExtension
from pystac.summaries import RangeSummary
from tests.utils import TestCases, assert_to_from_dict

EXAMPLE_URI = TestCases.get_path("data-files/view/example-landsat8.json")


@pytest.fixture
def item() -> Item:
    return pystac.Item.from_file(EXAMPLE_URI)


@pytest.fixture
def collection() -> Collection:
    return Collection.from_file(
        TestCases.get_path("data-files/view/collection-with-summaries.json")
    )


def test_to_from_dict() -> None:
    with open(EXAMPLE_URI) as f:
        d = json.load(f)
    assert_to_from_dict(pystac.Item, d)


def test_apply() -> None:
    item = next(TestCases.case_2().get_items(recursive=True))
    assert not ViewExtension.has_extension(item)

    ViewExtension.add_to(item)
    ViewExtension.ext(item).apply(
        off_nadir=1.0,
        incidence_angle=2.0,
        azimuth=3.0,
        sun_azimuth=4.0,
        sun_elevation=5.0,
    )

    assert ViewExtension.ext(item).off_nadir == 1.0
    assert ViewExtension.ext(item).incidence_angle == 2.0
    assert ViewExtension.ext(item).azimuth == 3.0
    assert ViewExtension.ext(item).sun_azimuth == 4.0
    assert ViewExtension.ext(item).sun_elevation == 5.0


@pytest.mark.vcr()
def test_validate_view(item: Item) -> None:
    assert ViewExtension.has_extension(item)
    item.validate()


@pytest.mark.vcr()
def test_off_nadir(item: Item) -> None:
    # Get
    assert "view:off_nadir" in item.properties
    view_off_nadir = ViewExtension.ext(item).off_nadir
    assert view_off_nadir is not None
    assert view_off_nadir == item.properties["view:off_nadir"]

    # Set
    ViewExtension.ext(item).off_nadir = view_off_nadir + 10
    assert view_off_nadir + 10 == item.properties["view:off_nadir"]

    # Get from Asset
    asset_no_prop = item.assets["blue"]
    asset_prop = item.assets["red"]
    assert (
        ViewExtension.ext(asset_no_prop).off_nadir == ViewExtension.ext(item).off_nadir
    )
    assert ViewExtension.ext(asset_prop).off_nadir == 3.0

    # Set to Asset
    asset_value = 13.0
    ViewExtension.ext(asset_no_prop).off_nadir = asset_value
    assert (
        ViewExtension.ext(asset_no_prop).off_nadir != ViewExtension.ext(item).off_nadir
    )
    assert ViewExtension.ext(asset_no_prop).off_nadir == asset_value

    # Validate
    item.validate()


@pytest.mark.vcr()
def test_incidence_angle(item: Item) -> None:
    # Get
    assert "view:incidence_angle" in item.properties
    view_incidence_angle = ViewExtension.ext(item).incidence_angle
    assert view_incidence_angle is not None
    assert view_incidence_angle == item.properties["view:incidence_angle"]
    # Set
    ViewExtension.ext(item).incidence_angle = view_incidence_angle + 10
    assert view_incidence_angle + 10 == item.properties["view:incidence_angle"]
    # Get from Asset
    asset_no_prop = item.assets["blue"]
    asset_prop = item.assets["red"]
    assert (
        ViewExtension.ext(asset_no_prop).incidence_angle
        == ViewExtension.ext(item).incidence_angle
    )
    assert ViewExtension.ext(asset_prop).incidence_angle == 4.0

    # Set to Asset
    asset_value = 14.0
    ViewExtension.ext(asset_no_prop).incidence_angle = asset_value
    assert (
        ViewExtension.ext(asset_no_prop).incidence_angle
        != ViewExtension.ext(item).incidence_angle
    )
    assert ViewExtension.ext(asset_no_prop).incidence_angle == asset_value

    # Validate
    item.validate()


@pytest.mark.vcr()
def test_azimuth(item: Item) -> None:
    # Get
    assert "view:azimuth" in item.properties
    view_azimuth = ViewExtension.ext(item).azimuth
    assert view_azimuth is not None
    assert view_azimuth == item.properties["view:azimuth"]

    # Set
    ViewExtension.ext(item).azimuth = view_azimuth + 100
    assert view_azimuth + 100 == item.properties["view:azimuth"]

    # Get from Asset
    asset_no_prop = item.assets["blue"]
    asset_prop = item.assets["red"]
    assert ViewExtension.ext(asset_no_prop).azimuth == ViewExtension.ext(item).azimuth
    assert ViewExtension.ext(asset_prop).azimuth == 5.0

    # Set to Asset
    asset_value = 15.0
    ViewExtension.ext(asset_no_prop).azimuth = asset_value
    assert ViewExtension.ext(asset_no_prop).azimuth != ViewExtension.ext(item).azimuth
    assert ViewExtension.ext(asset_no_prop).azimuth == asset_value

    # Validate
    item.validate()


@pytest.mark.vcr()
def test_sun_azimuth(item: Item) -> None:
    # Get
    assert "view:sun_azimuth" in item.properties
    view_sun_azimuth = ViewExtension.ext(item).sun_azimuth
    assert view_sun_azimuth is not None
    assert view_sun_azimuth == item.properties["view:sun_azimuth"]

    # Set
    ViewExtension.ext(item).sun_azimuth = view_sun_azimuth + 100
    assert view_sun_azimuth + 100 == item.properties["view:sun_azimuth"]
    # Get from Asset
    asset_no_prop = item.assets["blue"]
    asset_prop = item.assets["red"]
    assert (
        ViewExtension.ext(asset_no_prop).sun_azimuth
        == ViewExtension.ext(item).sun_azimuth
    )
    assert ViewExtension.ext(asset_prop).sun_azimuth == 1.0

    # Set to Asset
    asset_value = 11.0
    ViewExtension.ext(asset_no_prop).sun_azimuth = asset_value
    assert (
        ViewExtension.ext(asset_no_prop).sun_azimuth
        != ViewExtension.ext(item).sun_azimuth
    )
    assert ViewExtension.ext(asset_no_prop).sun_azimuth == asset_value

    # Validate
    item.validate()


@pytest.mark.vcr()
def test_sun_elevation(item: Item) -> None:
    # Get
    assert "view:sun_elevation" in item.properties
    view_sun_elevation = ViewExtension.ext(item).sun_elevation
    assert view_sun_elevation is not None
    assert view_sun_elevation == item.properties["view:sun_elevation"]

    # Set
    ViewExtension.ext(item).sun_elevation = view_sun_elevation + 10
    assert view_sun_elevation + 10 == item.properties["view:sun_elevation"]
    # Get from Asset
    asset_no_prop = item.assets["blue"]
    asset_prop = item.assets["red"]
    assert (
        ViewExtension.ext(asset_no_prop).sun_elevation
        == ViewExtension.ext(item).sun_elevation
    )
    assert ViewExtension.ext(asset_prop).sun_elevation == 2.0

    # Set to Asset
    asset_value = 12.0
    ViewExtension.ext(asset_no_prop).sun_elevation = asset_value
    assert (
        ViewExtension.ext(asset_no_prop).sun_elevation
        != ViewExtension.ext(item).sun_elevation
    )
    assert ViewExtension.ext(asset_no_prop).sun_elevation == asset_value

    # Validate
    item.validate()


def test_extension_not_implemented(item: Item) -> None:
    # Should raise exception if Item does not include extension URI
    item.stac_extensions.remove(ViewExtension.get_schema_uri())

    with pytest.raises(pystac.ExtensionNotImplemented):
        _ = ViewExtension.ext(item)

    # Should raise exception if owning Item does not include extension URI
    asset = item.assets["blue"]

    with pytest.raises(pystac.ExtensionNotImplemented):
        _ = ViewExtension.ext(asset)

    # Should succeed if Asset has no owner
    ownerless_asset = pystac.Asset.from_dict(asset.to_dict())
    _ = ViewExtension.ext(ownerless_asset)


def test_item_ext_add_to(item: Item) -> None:
    item.stac_extensions.remove(ViewExtension.get_schema_uri())
    assert ViewExtension.get_schema_uri() not in item.stac_extensions

    _ = ViewExtension.ext(item, add_if_missing=True)

    assert ViewExtension.get_schema_uri() in item.stac_extensions


def test_asset_ext_add_to(item: Item) -> None:
    item.stac_extensions.remove(ViewExtension.get_schema_uri())
    assert ViewExtension.get_schema_uri() not in item.stac_extensions
    asset = item.assets["blue"]

    _ = ViewExtension.ext(asset, add_if_missing=True)

    assert ViewExtension.get_schema_uri() in item.stac_extensions


def test_should_raise_exception_when_passing_invalid_extension_object() -> None:
    with pytest.raises(
        ExtensionTypeError, match=r"^ViewExtension does not apply to type 'object'$"
    ):
        # calling it wrong on purpose so ------v
        ViewExtension.ext(object())  # type: ignore


def test_get_off_nadir_summaries(collection: Collection) -> None:
    off_nadirs = ViewExtension.summaries(collection, True).off_nadir

    assert off_nadirs is not None

    assert {"minimum": 0.5, "maximum": 7.3} == off_nadirs.to_dict()


def test_get_incidence_angle_summaries(collection: Collection) -> None:
    incidence_angles = ViewExtension.summaries(collection, True).incidence_angle

    assert incidence_angles is not None

    assert {"minimum": 23, "maximum": 35} == incidence_angles.to_dict()


def test_get_azimuth_summaries(collection: Collection) -> None:
    azimuths = ViewExtension.summaries(collection, True).azimuth

    assert azimuths is not None

    assert {"minimum": 20, "maximum": 186} == azimuths.to_dict()


def test_get_sun_azimuth_summaries(collection: Collection) -> None:
    sun_azimuths = ViewExtension.summaries(collection, True).sun_azimuth

    assert sun_azimuths is not None

    assert {"minimum": 48, "maximum": 78} == sun_azimuths.to_dict()


def test_get_sun_elevation_summaries(collection: Collection) -> None:
    sun_elevations = ViewExtension.summaries(collection, True).sun_elevation

    assert sun_elevations is not None

    assert {"minimum": 10, "maximum": 45} == sun_elevations.to_dict()


def test_set_off_nadir_summaries(collection: Collection) -> None:
    view_summaries = ViewExtension.summaries(collection, True)

    view_summaries.off_nadir = RangeSummary(0, 10)
    assert {"minimum": 0, "maximum": 10} == view_summaries.off_nadir.to_dict()


def test_set_incidence_angle_summaries(collection: Collection) -> None:
    view_summaries = ViewExtension.summaries(collection, True)

    view_summaries.incidence_angle = RangeSummary(5, 15)
    assert {"minimum": 5, "maximum": 15} == view_summaries.incidence_angle.to_dict()


def test_set_azimuth_summaries(collection: Collection) -> None:
    view_summaries = ViewExtension.summaries(collection, True)

    view_summaries.azimuth = None
    assert view_summaries.azimuth is None


def test_set_sun_azimuth_summaries(collection: Collection) -> None:
    view_summaries = ViewExtension.summaries(collection, True)

    view_summaries.sun_azimuth = RangeSummary(210, 275)
    assert {"minimum": 210, "maximum": 275} == view_summaries.sun_azimuth.to_dict()


def test_set_sun_elevation_summaries(collection: Collection) -> None:
    view_summaries = ViewExtension.summaries(collection, True)

    view_summaries.sun_elevation = RangeSummary(-10, 38)
    assert {"minimum": -10, "maximum": 38} == view_summaries.sun_elevation.to_dict()


def test_summaries_adds_uri(collection: Collection) -> None:
    collection.stac_extensions = []
    with pytest.raises(
        pystac.ExtensionNotImplemented,
        match="Extension 'view' is not implemented",
    ):
        ViewExtension.summaries(collection, add_if_missing=False)

    _ = ViewExtension.summaries(collection, True)

    assert ViewExtension.get_schema_uri() in collection.stac_extensions

    ViewExtension.remove_from(collection)
    assert ViewExtension.get_schema_uri() not in collection.stac_extensions