def test_label_classes(self) -> None:
# Get
label_item = pystac.Item.from_file(self.label_example_1_uri)
label_classes = LabelExtension.ext(label_item).label_classes
self.assertEqual(len(get_opt(label_classes)), 2)
self.assertEqual(get_opt(label_classes)[1].classes, ["three", "four"])
# Set
new_classes = [
LabelClasses.create(name="label2", classes=["five", "six"]),
LabelClasses.create(name="label", classes=["seven", "eight"]),
]
label_ext = LabelExtension.ext(label_item)
label_ext.label_classes = new_classes
self.assertEqual(
[
class_name for lc in label_item.properties["label:classes"]
for class_name in lc["classes"]
],
["five", "six", "seven", "eight"],
)
self.assertListEqual([lc.name for lc in label_ext.label_classes],
["label2", "label"])
first_lc = label_ext.label_classes[0]
self.assertEqual("<ClassObject classes=five,six>", first_lc.__repr__())
label_item.validate()
def test_extension_not_implemented(self) -> None:
# Should raise exception if Item does not include extension URI
item = pystac.Item.from_file(self.label_example_1_uri)
item.stac_extensions.remove(LabelExtension.get_schema_uri())
with self.assertRaises(pystac.ExtensionNotImplemented):
_ = LabelExtension.ext(item)
def test_ext_add_to(self) -> None:
item = pystac.Item.from_file(self.label_example_1_uri)
item.stac_extensions.remove(LabelExtension.get_schema_uri())
self.assertNotIn(LabelExtension.get_schema_uri(), item.stac_extensions)
_ = LabelExtension.ext(item, add_if_missing=True)
self.assertIn(LabelExtension.get_schema_uri(), item.stac_extensions)
def test_case_3() -> Catalog:
root_cat = Catalog(id="test3",
description="test case 3 catalog",
title="test case 3 title")
image_item = Item(
id="imagery-item",
geometry=ARBITRARY_GEOM,
bbox=ARBITRARY_BBOX,
datetime=datetime.utcnow(),
properties={},
)
image_item.add_asset(
"ortho",
Asset(href="some/geotiff.tiff", media_type=MediaType.GEOTIFF))
overviews = [
LabelOverview.create(
"label",
counts=[
LabelCount.create("one", 1),
LabelCount.create("two", 2)
],
)
]
label_item = Item(
id="label-items",
geometry=ARBITRARY_GEOM,
bbox=ARBITRARY_BBOX,
datetime=datetime.utcnow(),
properties={},
)
LabelExtension.add_to(label_item)
label_ext = LabelExtension.ext(label_item)
label_ext.apply(
label_description="ML Labels",
label_type=LabelType.VECTOR,
label_properties=["label"],
label_classes=[
LabelClasses.create(classes=["one", "two"], name="label")
],
label_tasks=["classification"],
label_methods=["manual"],
label_overviews=overviews,
)
label_ext.add_source(image_item, assets=["ortho"])
root_cat.add_item(image_item)
root_cat.add_item(label_item)
return root_cat
def test_get_sources(self) -> None:
cat = TestCases.test_case_1()
items = cat.get_all_items()
item_ids = set([i.id for i in items])
for li in items:
if LabelExtension.ext(li).has_extension:
sources = list(LabelExtension.ext(li).get_sources() or [])
self.assertEqual(len(sources), 1)
self.assertTrue(sources[0].id in item_ids)
def test_label_tasks(self) -> None:
label_item = pystac.Item.from_file(self.label_example_1_uri)
# Get
self.assertIn("label:tasks", label_item.properties)
label_prop = LabelExtension.ext(label_item).label_tasks
self.assertEqual(label_prop, ["classification", "regression"])
# Set
LabelExtension.ext(label_item).label_tasks = ["classification"]
self.assertEqual(["classification"],
label_item.properties["label:tasks"])
label_item.validate()
def test_label_methods(self) -> None:
label_item = pystac.Item.from_file(self.label_example_1_uri)
# Get
self.assertIn("label:methods", label_item.properties)
label_prop = LabelExtension.ext(label_item).label_methods
self.assertEqual(label_prop, ["manual"])
# Set
LabelExtension.ext(label_item).label_methods = ["manual", "automated"]
self.assertEqual(["manual", "automated"],
label_item.properties["label:methods"])
label_item.validate()
def test_from_file(self) -> None:
label_example_1 = Item.from_file(self.label_example_1_uri)
overviews = get_opt(
LabelExtension.ext(label_example_1).label_overviews)
self.assertEqual(len(get_opt(overviews[0].counts)), 2)
label_example_1.validate()
label_example_2 = Item.from_file(self.label_example_2_uri)
overviews2 = get_opt(
LabelExtension.ext(label_example_2).label_overviews)
self.assertEqual(len(get_opt(overviews2[0].counts)), 2)
label_example_2.validate()
def test_label_description(self) -> None:
label_item = pystac.Item.from_file(self.label_example_1_uri)
# Get
self.assertIn("label:description", label_item.properties)
label_desc = LabelExtension.ext(label_item).label_description
self.assertEqual(label_desc,
label_item.properties["label:description"])
# Set
LabelExtension.ext(
label_item).label_description = "A detailed description"
self.assertEqual("A detailed description",
label_item.properties["label:description"])
label_item.validate()
def test_summaries_adds_uri(self) -> None:
col = pystac.Collection.from_file(self.EXAMPLE_COLLECTION)
col.stac_extensions = []
self.assertRaisesRegex(
pystac.ExtensionNotImplemented,
r"Could not find extension schema URI.*",
LabelExtension.summaries,
col,
False,
)
_ = LabelExtension.summaries(col, True)
self.assertIn(LabelExtension.get_schema_uri(), col.stac_extensions)
LabelExtension.remove_from(col)
self.assertNotIn(LabelExtension.get_schema_uri(), col.stac_extensions)
def test_label_properties(self) -> None:
label_item = pystac.Item.from_file(self.label_example_1_uri)
label_item2 = pystac.Item.from_file(self.label_example_2_uri)
# Get
self.assertIn("label:properties", label_item.properties)
label_prop = LabelExtension.ext(label_item).label_properties
self.assertEqual(label_prop, label_item.properties["label:properties"])
raster_label_prop = LabelExtension.ext(label_item2).label_properties
self.assertEqual(raster_label_prop, None)
# Set
LabelExtension.ext(label_item).label_properties = ["prop1", "prop2"]
self.assertEqual(["prop1", "prop2"],
label_item.properties["label:properties"])
label_item.validate()
def test_label_classes_summary(self) -> None:
label_classes = [
LabelClasses({
"name": "road_type",
"classes": ["1", "2", "3", "4", "5", "6"]
}),
LabelClasses({
"name": "lane_number",
"classes": ["1", "2", "3", "4", "5"]
}),
LabelClasses({
"name": "paved",
"classes": ["0", "1"]
}),
]
collection = Collection.from_file(self.EXAMPLE_COLLECTION)
label_ext_summaries = LabelExtension.summaries(collection, True)
label_ext_summaries.label_classes = label_classes
summaries = collection.summaries
assert summaries is not None
label_classes_summary = summaries.get_list("label:classes")
assert label_classes_summary is not None
self.assertListEqual([lc.to_dict() for lc in label_classes],
label_classes_summary)
label_classes_summary_ext = label_ext_summaries.label_classes
assert label_classes_summary_ext is not None
self.assertListEqual(label_classes, label_classes_summary_ext)
def test_label_type(self) -> None:
label_item = pystac.Item.from_file(self.label_example_1_uri)
# Get
self.assertIn("label:type", label_item.properties)
label_type = LabelExtension.ext(label_item).label_type
self.assertEqual(label_type, label_item.properties["label:type"])
# Set
LabelExtension.ext(label_item).label_type = LabelType.RASTER
self.assertEqual(LabelType.RASTER, label_item.properties["label:type"])
# name for each label:classes object must be null to pass validation
label_classes = LabelExtension.ext(label_item).label_classes
assert label_classes is not None
for classes_obj in label_classes:
classes_obj.name = None
label_item.validate()
def test_from_file_pre_081(self) -> None:
d = pystac.StacIO.default().read_json(self.label_example_1_uri)
d["stac_version"] = "0.8.0-rc1"
d["properties"]["label:property"] = d["properties"]["label:properties"]
d["properties"].pop("label:properties")
d["properties"]["label:overview"] = d["properties"]["label:overviews"]
d["properties"].pop("label:overviews")
d["properties"]["label:method"] = d["properties"]["label:methods"]
d["properties"].pop("label:methods")
d["properties"]["label:task"] = d["properties"]["label:tasks"]
d["properties"].pop("label:tasks")
label_example_1 = pystac.Item.from_dict(d, migrate=True)
self.assertEqual(
len(LabelExtension.ext(label_example_1).label_tasks or []), 2)
def test_label_methods_summary(self) -> None:
label_methods: List[Union[LabelMethod, str]] = [LabelMethod.AUTOMATED]
collection = Collection.from_file(self.EXAMPLE_COLLECTION)
label_ext_summaries = LabelExtension.summaries(collection, True)
label_ext_summaries.label_methods = label_methods
summaries = collection.summaries
assert summaries is not None
label_methods_summary = summaries.get_list("label:methods")
assert label_methods_summary is not None
self.assertListEqual(label_methods, label_methods_summary)
label_methods_summary_ext = label_ext_summaries.label_methods
assert label_methods_summary_ext is not None
self.assertListEqual(label_methods, label_methods_summary_ext)
def test_label_task_summary(self) -> None:
label_tasks: List[Union[LabelTask, str]] = [LabelTask.REGRESSION]
collection = Collection.from_file(self.EXAMPLE_COLLECTION)
label_ext_summaries = LabelExtension.summaries(collection, True)
label_ext_summaries.label_tasks = label_tasks
summaries = collection.summaries
assert summaries is not None
label_tasks_summary = summaries.get_list("label:tasks")
assert label_tasks_summary is not None
self.assertListEqual(label_tasks, label_tasks_summary)
label_tasks_summary_ext = label_ext_summaries.label_tasks
assert label_tasks_summary_ext is not None
self.assertListEqual(label_tasks, label_tasks_summary_ext)
def test_label_type_summary(self) -> None:
label_types = [LabelType.VECTOR]
collection = Collection.from_file(self.EXAMPLE_COLLECTION)
label_ext_summaries = LabelExtension.summaries(collection, True)
label_ext_summaries.label_type = label_types
summaries = collection.summaries
assert summaries is not None
label_type_summary = summaries.get_list("label:type")
assert label_type_summary is not None
self.assertListEqual(label_types, label_type_summary)
label_type_summary_ext = label_ext_summaries.label_type
assert label_type_summary_ext is not None
self.assertListEqual(label_types, label_type_summary_ext)
def test_label_properties_summary(self) -> None:
label_properties = ["road_type", "lane_number", "paved"]
collection = Collection.from_file(self.EXAMPLE_COLLECTION)
label_ext_summaries = LabelExtension.summaries(collection, True)
label_ext_summaries.label_properties = label_properties
summaries = collection.summaries
assert summaries is not None
label_properties_summary = summaries.get_list("label:properties")
assert label_properties_summary is not None
self.assertListEqual(label_properties, label_properties_summary)
label_properties_summary_ext = label_ext_summaries.label_properties
assert label_properties_summary_ext is not None
self.assertListEqual(label_properties, label_properties_summary_ext)
def test_case_3():
root_cat = Catalog(id='test3',
description='test case 3 catalog',
title='test case 3 title')
image_item = Item(id='imagery-item',
geometry=RANDOM_GEOM,
bbox=RANDOM_BBOX,
datetime=datetime.utcnow(),
properties={})
image_item.add_asset(
'ortho',
Asset(href='some/geotiff.tiff', media_type=MediaType.GEOTIFF))
overviews = [
LabelOverview.create('label',
counts=[
LabelCount.create('one', 1),
LabelCount.create('two', 2)
])
]
label_item = Item(id='label-items',
geometry=RANDOM_GEOM,
bbox=RANDOM_BBOX,
datetime=datetime.utcnow(),
properties={})
label_extension = LabelExtension.ext(label_item, add_if_missing=True)
label_extension.apply(label_description='ML Labels',
label_type=LabelType.VECTOR,
label_properties=['label'],
label_classes=[
LabelClasses.create(classes=['one', 'two'],
name='label')
],
label_tasks=['classification'],
label_methods=['manual'],
label_overviews=overviews)
label_extension.add_source(image_item, assets=['ortho'])
root_cat.add_item(image_item)
root_cat.add_item(label_item)
return root_cat
def test_read_label_item_owns_asset(self) -> None:
item = next(x for x in TestCases.test_case_2().get_all_items()
if LabelExtension.ext(x).has_extension)
assert len(item.assets) > 0
for asset_key in item.assets:
self.assertEqual(item.assets[asset_key].owner, item)
def test_label_overviews(self) -> None:
# Get
label_item = pystac.Item.from_file(self.label_example_1_uri)
label_ext = LabelExtension.ext(label_item)
label_overviews = get_opt(label_ext.label_overviews)
label_item2 = pystac.Item.from_file(self.label_example_2_uri)
label_ext2 = LabelExtension.ext(label_item2)
label_overviews2 = get_opt(label_ext2.label_overviews)
self.assertEqual(len(label_overviews), 2)
self.assertEqual(label_overviews[1].property_key, "label-reg")
self.assertEqual(label_overviews2[1].property_key, None) # Raster
label_counts = get_opt(label_overviews[0].counts)
self.assertEqual(label_counts[1].count, 17)
first_overview_counts = get_opt(label_ext.label_overviews)[0].counts
assert first_overview_counts is not None
first_overview_counts[1].count = 18
self.assertEqual(
label_item.properties["label:overviews"][0]["counts"][1]["count"],
18)
self.assertEqual(first_overview_counts[1].name, "two")
label_statistics = get_opt(label_overviews[1].statistics)
self.assertEqual(label_statistics[0].name, "mean")
second_overview_statistics = get_opt(
label_ext.label_overviews)[1].statistics
assert second_overview_statistics is not None
second_overview_statistics[0].name = "avg"
self.assertEqual(
label_item.properties["label:overviews"][1]["statistics"][0]
["name"], "avg")
# Set
new_overviews = [
LabelOverview.create(
property_key="label2",
counts=[
LabelCount.create(name="one", count=1),
LabelCount.create(name="two", count=1),
],
),
LabelOverview.create(
property_key="label-reg",
statistics=[
LabelStatistics.create(name="min", value=0.1),
LabelStatistics.create(name="max", value=1.0),
],
),
]
label_ext.label_overviews = new_overviews
self.assertEqual(
[(count["name"], count["count"])
for count in label_item.properties["label:overviews"][0]["counts"]
],
[("one", 1), ("two", 1)],
)
self.assertEqual(
[(count["name"], count["value"]) for count in
label_item.properties["label:overviews"][1]["statistics"]],
[("min", 0.1), ("max", 1.0)],
)
label_item.validate()
def test_extension_type_error(self) -> None:
collection = pystac.Collection.from_file(
TestCases.get_path("data-files/collections/with-assets.json"))
with self.assertRaises(pystac.ExtensionTypeError):
_ = LabelExtension.ext(collection) # type: ignore