Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update raster extension to v1.1.0 #809

Merged
merged 4 commits into from
Jun 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

### Changed

- Updated Raster Extension from v1.0.0 to v1.1.0 ([#809](https://github.com/stac-utils/pystac/pull/809))

### Fixed

- "How to create STAC catalogs" tutorial ([#775](https://github.com/stac-utils/pystac/pull/775))
Expand Down
16 changes: 11 additions & 5 deletions pystac/extensions/raster.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
)
from pystac.utils import StringEnum, get_opt, get_required, map_opt

SCHEMA_URI = "https://stac-extensions.github.io/raster/v1.0.0/schema.json"
SCHEMA_URI = "https://stac-extensions.github.io/raster/v1.1.0/schema.json"

BANDS_PROP = "raster:bands"

Expand Down Expand Up @@ -39,6 +39,12 @@ class DataType(StringEnum):
OTHER = "other"


class NoDataStrings(StringEnum):
INF = "inf"
NINF = "-inf"
NAN = "nan"


class Statistics:
"""Represents statistics information attached to a band in the raster extension.

Expand Down Expand Up @@ -350,7 +356,7 @@ def __init__(self, properties: Dict[str, Any]) -> None:

def apply(
self,
nodata: Optional[float] = None,
nodata: Optional[Union[float, NoDataStrings]] = None,
sampling: Optional[Sampling] = None,
data_type: Optional[DataType] = None,
bits_per_sample: Optional[float] = None,
Expand Down Expand Up @@ -400,7 +406,7 @@ def apply(
@classmethod
def create(
cls,
nodata: Optional[float] = None,
nodata: Optional[Union[float, NoDataStrings]] = None,
sampling: Optional[Sampling] = None,
data_type: Optional[DataType] = None,
bits_per_sample: Optional[float] = None,
Expand Down Expand Up @@ -452,7 +458,7 @@ def create(
return b

@property
def nodata(self) -> Optional[float]:
def nodata(self) -> Optional[Union[float, NoDataStrings]]:
"""Get or sets the nodata pixel value

Returns:
Expand All @@ -461,7 +467,7 @@ def nodata(self) -> Optional[float]:
return self.properties.get("nodata")

@nodata.setter
def nodata(self, v: Optional[float]) -> None:
def nodata(self, v: Optional[Union[float, NoDataStrings]]) -> None:
if v is not None:
self.properties["nodata"] = v
else:
Expand Down
2 changes: 1 addition & 1 deletion tests/data-files/raster/raster-planet-example.json
Original file line number Diff line number Diff line change
Expand Up @@ -1245,6 +1245,6 @@
"https://stac-extensions.github.io/projection/v1.0.0/schema.json",
"https://stac-extensions.github.io/eo/v1.0.0/schema.json",
"https://stac-extensions.github.io/processing/v1.0.0/schema.json",
"https://stac-extensions.github.io/raster/v1.0.0/schema.json"
"https://stac-extensions.github.io/raster/v1.1.0/schema.json"
]
}
9 changes: 8 additions & 1 deletion tests/data-files/raster/raster-sentinel2-example.json
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,13 @@
"full_width_half_max": 0.026
}
],
"raster:bands": [
{
"data_type": "uint16",
"spatial_resolution": 60,
"nodata": "nan"
}
],
"proj:shape": [
1830,
1830
Expand Down Expand Up @@ -711,7 +718,7 @@
"https://stac-extensions.github.io/eo/v1.0.0/schema.json",
"https://stac-extensions.github.io/view/v1.0.0/schema.json",
"https://stac-extensions.github.io/projection/v1.0.0/schema.json",
"https://stac-extensions.github.io/raster/v1.0.0/schema.json"
"https://stac-extensions.github.io/raster/v1.1.0/schema.json"
],
"virtual:assets": {
"SIR": {
Expand Down
21 changes: 18 additions & 3 deletions tests/extensions/test_raster.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from pystac.utils import get_opt
from pystac.extensions.raster import (
Histogram,
NoDataStrings,
RasterExtension,
RasterBand,
Sampling,
Expand Down Expand Up @@ -41,6 +42,7 @@ def test_validate_raster(self) -> None:

def test_asset_bands(self) -> None:
item = pystac.Item.from_file(self.PLANET_EXAMPLE_URI)
item2 = pystac.Item.from_file(self.SENTINEL2_EXAMPLE_URI)

# Get
data_asset = item.assets["data"]
Expand Down Expand Up @@ -74,8 +76,12 @@ def test_asset_bands(self) -> None:
asset_bands = RasterExtension.ext(index_asset).bands
self.assertIs(None, asset_bands)

b09_asset = item2.assets["B09"]
b09_bands = RasterExtension.ext(b09_asset).bands
assert b09_bands is not None
self.assertEqual(b09_bands[0].nodata, "nan")

# Set
item2 = pystac.Item.from_file(self.SENTINEL2_EXAMPLE_URI)
b2_asset = item2.assets["B02"]
self.assertEqual(
get_opt(get_opt(RasterExtension.ext(b2_asset).bands)[0].statistics).maximum,
Expand All @@ -90,6 +96,9 @@ def test_asset_bands(self) -> None:
get_opt(get_opt(new_b2_asset_bands)[0].statistics).maximum, 20567
)

new_b2_asset_band0 = get_opt(new_b2_asset_bands)[0]
new_b2_asset_band0.nodata = NoDataStrings.INF

item2.validate()

# Check adding a new asset
Expand Down Expand Up @@ -127,7 +136,7 @@ def test_asset_bands(self) -> None:
histogram=new_histograms[1],
),
RasterBand.create(
nodata=3,
nodata=NoDataStrings.NINF,
unit="test3",
statistics=new_stats[2],
histogram=new_histograms[2],
Expand All @@ -148,6 +157,9 @@ def test_asset_bands(self) -> None:
item.assets["test"].extra_fields["raster:bands"][1]["histogram"]["min"],
3848.354901960784,
)
self.assertEqual(
item.assets["test"].extra_fields["raster:bands"][2]["nodata"], "-inf"
)

for s in new_stats:
s.minimum = None
Expand Down Expand Up @@ -190,7 +202,7 @@ def test_asset_bands(self) -> None:
histogram=new_histograms[1],
)
new_bands[0].apply(
nodata=3,
nodata=NoDataStrings.NAN,
unit="test3",
statistics=new_stats[0],
histogram=new_histograms[2],
Expand All @@ -202,6 +214,9 @@ def test_asset_bands(self) -> None:
],
1,
)
self.assertEqual(
item.assets["test"].extra_fields["raster:bands"][0]["nodata"], "nan"
)

def test_extension_not_implemented(self) -> None:
# Should raise exception if Item does not include extension URI
Expand Down