cog3pio 0.1.0

Cloud-optimized GeoTIFF ... Parallel I/O
Documentation 
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

"""
Test GeoTIFF I/O via image-tiff backend.
"""

import os
import tempfile
import urllib.request

import numpy as np
import pytest
from cog3pio import CogReader, read_geotiff


# %%
@pytest.fixture(scope="module", name="geotiff_path")
def fixture_geotiff_path():
    """
    Filepath to a sample single-band GeoTIFF file.
    """
    with tempfile.TemporaryDirectory() as tmpdir:
        geotiff_path = os.path.join(tmpdir, "float32.tif")
        urllib.request.urlretrieve(
            url="https://github.com/pka/georaster/raw/v0.1.0/data/tiff/float32.tif",
            filename=geotiff_path,
        )
        yield geotiff_path


@pytest.mark.benchmark
def test_read_geotiff_local(geotiff_path):
    """
    Read a single-band GeoTIFF file from a local file path.
    """
    array = read_geotiff(path=geotiff_path)
    assert array.shape == (1, 20, 20)
    assert array.dtype == "float32"


@pytest.mark.benchmark
def test_read_geotiff_remote():
    """
    Read a single-band GeoTIFF file from a remote URL.
    """
    array = read_geotiff(
        path="https://github.com/pka/georaster/raw/v0.1.0/data/tiff/float32.tif"
    )
    assert array.shape == (1, 20, 20)
    assert array.dtype == "float32"


@pytest.mark.benchmark
def test_read_geotiff_multi_band():
    """
    Read a multi-band GeoTIFF file from a remote URL.
    """
    array = read_geotiff(
        path="https://github.com/locationtech/geotrellis/raw/v3.7.1/raster/data/one-month-tiles-multiband/result.tif"
    )
    assert array.shape == (2, 512, 512)
    assert array.dtype == "float32"


def test_read_geotiff_invalid_filepath():
    """
    Check that a ValueError is raised when an invalid filepath is passed to read_geotiff.
    """
    with pytest.raises(ValueError, match=r"Cannot parse path: \\invalid\\path"):
        read_geotiff(path=r"\invalid\path")


def test_read_geotiff_invalid_remote_url():
    """
    Check that a ValueError is raised when an invalid remote url is passed to read_geotiff.
    """
    with pytest.raises(ValueError, match="Cannot parse url: protocol://file.ext"):
        read_geotiff(path="protocol://file.ext")


def test_read_geotiff_missing_url():
    """
    Check that a FileNotFoundError is raised when a url pointing to a non-existent file
    is passed to read_geotiff.
    """
    with pytest.raises(
        FileNotFoundError, match="Cannot find file: https://example.com/geo.tif"
    ):
        read_geotiff(path="https://example.com/geo.tif")


def test_read_geotiff_unsupported_colortype():
    """
    Check that a ValueError is raised when an unsupported GeoTIFF (with ColorType::RGB)
    is passed to read_geotiff.
    """
    with pytest.raises(
        ValueError,
        match="unsupported error: Photometric interpretation "
        r"RGBPalette with bits per sample \[8\] is unsupported",
    ):
        read_geotiff(
            path="https://github.com/GenericMappingTools/gmtserver-admin/raw/caf0dbd015f0154687076dd31dc8baff62c95040/cache/earth_day_HD.tif"
        )


def test_read_geotiff_unsupported_dtype():
    """
    Check that a ValueError is raised when an unsupported GeoTIFF (of ComplexInt16 type)
    is passed to read_geotiff.
    """
    with pytest.raises(
        ValueError,
        match=r"unsupported error: sample format \[Unknown\(5\)\] is unsupported",
    ):
        read_geotiff(
            path="https://github.com/corteva/rioxarray/raw/0.15.1/test/test_data/input/cint16.tif"
        )


def test_cogReader_to_dlpack():
    """
    Ensure that the CogReader class's `__dlpack__` method produces a dl_tensor that
    can be read into a numpy.ndarray.
    """
    cog = CogReader(
        path="https://github.com/rasterio/rasterio/raw/1.3.9/tests/data/float32.tif"
    )

    assert hasattr(cog, "__dlpack__")
    assert hasattr(cog, "__dlpack_device__")
    array = np.from_dlpack(cog)

    assert array.shape == (1, 2, 3)  # band, height, width
    np.testing.assert_equal(
        actual=array,
        desired=np.array(
            [[[1.41, 1.23, 0.78], [0.32, -0.23, -1.88]]], dtype=np.float32
        ),
    )


def test_cogreader_xy_coords():
    """
    Ensure that the CogReader class's `xy_coords` method produces two numpy.ndarray
    objects representing the GeoTIFF's x- and y- coordinates.
    """
    cog = CogReader(
        path="https://github.com/blacha/cogeotiff/raw/core-v9.4.0/packages/core/data/DEM_BS28_2016_1000_1141.tif"
    )
    x_coords, y_coords = cog.xy_coords()
    np.testing.assert_equal(
        actual=x_coords,
        desired=np.linspace(
            start=1679617.031,
            stop=1679680.031,
            num=63,
            endpoint=False,
            dtype=np.float64,
        ),
    )
    np.testing.assert_equal(
        actual=y_coords,
        desired=np.linspace(
            start=5362323.781,
            stop=5362079.781,
            num=244,
            endpoint=False,
            dtype=np.float64,
        ),
    )