Open-EO / openeo-api

The openEO API specification
http://api.openeo.org
Apache License 2.0
91 stars 11 forks source link

Name of the geometries dimension #479

Closed m-mohr closed 1 year ago

m-mohr commented 1 year ago

The name for the vector dimension is now "geometries" (plural) in accordance with "bands", okay?

I don't think that changing to plural "geometries" is really necessary. Apart from "bands", all dimension types and names are/look singular: "spatial", "temporal", "x", "y", "other".

As another data point here: geopandas uses singular "geometry" as column type and name in data frames, e.g. see https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoDataFrame.html#geopandas.GeoDataFrame

Originally posted by @soxofaan in https://github.com/Open-EO/openeo-api/issues/441#issuecomment-1387375003

m-mohr commented 1 year ago

I don't think that changing to plural "geometries" is really necessary.

Are you saying

       * `geometries` for dimensions of type `geometries`

should change to

      * `geometry` for dimensions of type `geometries`

?

m-mohr commented 1 year ago

I guess so.

If I understand correctly, the dimension type has already been settled on plural "geometries" in merged PR https://github.com/stac-extensions/datacube/pull/10 so in this PR #441 there is only room to change the dimension name to singular "geometry", which would indeed not look very consistent in the recommendation

* name `geometry` for dimensions of type `geometries`

Sidenote: I noticed that @aljacob made related comment at https://github.com/Open-EO/openeo-processes/pull/382#pullrequestreview-1261722159

Originally posted by @soxofaan in https://github.com/Open-EO/openeo-api/issues/441#issuecomment-1396956090

m-mohr commented 1 year ago

@aljacob wrote in https://github.com/Open-EO/openeo-processes/pull/382#pullrequestreview-1261722159 :

looks all good to me. My only concern would also be about the plural of geometries and bands, it would be cleaner to have both in singular, but it is nothing that is a big issue after all, at least these two are consistant then, as I guess it would be quite the effort for everyone to go from bands to band as well.

Indeed, bands is settled on the plural as we use it as such since the beginning. "geometries" seems well aligned - x,y,t are all defined in a way that they don't have a specific singular/plural version.

m-mohr commented 1 year ago

Voted to be "geometry"

m-mohr commented 1 year ago

Updated in commit 6da01956