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

cookbook: misleading info on apply_neighborhood #84

Closed
soxofaan opened this issue Jan 10, 2024 · 0 comments · Fixed by #85
Closed

cookbook: misleading info on apply_neighborhood #84

soxofaan opened this issue Jan 10, 2024 · 0 comments · Fixed by #85

Comments

@soxofaan
Copy link
Member

Raised by @MartinSchobben at Open-EO/openeo-processes-dask#215 (comment)

Pre-defined processes (median, max, sd etc.) can be applied to spatial, temporal or even spatio-temporal neighbourhoods with apply_neighborhood.

(from: https://github.com/Open-EO/openeo.org/blame/10b68cee63b1dac17d8a4902a02f325563be6743/documentation/1.0/cookbook/README.md#L1198)

This is misleading: none of the given examples (median, max, sd) can actually be used with apply_neighborhood: the former processes take an array as input and produce a scalar, while apply_neighborhood expects processes that receive a raster data cube and produce a new raster data cube.

I think the only pre-defined process that makes practical sense to pass to apply_neighborhood is run_udf at the moment

I propose to just remove the following from the cookbook

Pre-defined processes (median, max, sd etc.) can be applied to spatial, temporal or even spatio-temporal neighbourhoods with apply_neighborhood. Due to lack of implementation by back-ends, this is not covered at this point.

Note that the VITO backend does implement apply_neighborhood, so that second sentence also makes little sense to keep as-is.

soxofaan added a commit to soxofaan/openeo.org that referenced this issue Jan 10, 2024
m-mohr pushed a commit that referenced this issue Mar 19, 2024
* Issue #84: drop misleading notes on `apply_neighborhood`
@m-mohr m-mohr linked a pull request Mar 19, 2024 that will close this issue
@m-mohr m-mohr closed this as completed Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants