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

Discrepancy in Elevation Percentile Calculation Between User Manual and Source Code #428

Open
masseygeo opened this issue Aug 24, 2024 · 0 comments

Comments

@masseygeo
Copy link

masseygeo commented Aug 24, 2024

There seems to be a discrepancy between the user manual and the source code for the ElevPercentile tool. The user manual describes the elevation percentile (EP) as being calculated based on the count of cells with higher elevation, but the source code correctly implements EP based on the count of cells with lower elevation (I think...I'm not a Rust expert). The discrepancy is also present in the code documentation header.

Existing description in user manual and tool documentation header:
EP = count_i∈C(z_i > z_0) * (100 / n_C)

Proposed Solution:
EP = count_i∈C(z_i < z_0) * (100 / n_C) or EP = count_i∈C(z_i <= z_0) * (100 / n_C)
The user manual & code documentation should be updated to reflect the correct calculation method, or a clarification should be added if the manual is describing a different metric (inverse elevation percentile?).

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

No branches or pull requests

1 participant