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

Add error pipeline and adapt documentation #283

Merged
merged 38 commits into from
Aug 24, 2022

Conversation

rhugonnet
Copy link
Contributor

@rhugonnet rhugonnet commented Aug 19, 2022

Summary of changes in spatialstats.py:

Documentation updated with changes of this branch is here: https://xdem-rhugonnet.readthedocs.io/en/error_pipeline/

This PR:

  • Adds the number_effective_samples wrapper function and related tests,
  • Adds the two_step_standardization function to consistently rescale the standardization after interp_nd_binning and related tests,
  • Adds the infer_heteroscedasticity_from_stable function (wrapper around Raster and Vector objects) and the estimate_model_heteroscedasticity function (wrapper of nd_binning, interp_nd_binning and two_step_standardization with np.ndarray) functions and tests,
  • Adds the infer_spatial_correlation_from_stable (wrapper around Raster and Vector objects) and estimate_model_spatial_correlation (wrapper of sample_empirical_variogram and fit_sum_model_variogram with np.ndarray) wrapper function and tests,
  • Add the spatial_error_propagation wrapper function (wrapper around Raster and Vector objects) and tests,
  • Adds short, basic gallery examples "Elevation error map" in plot_infer_heterosc, "Spatial correlation of errors" in plot_infer_spatial_correlation and "Spatial propagation of elevation errors" in plot_spatial_error_propagation for each of the 3 wrapper functions that work directly with Raster and Vector objects with all steps included,
  • Updates the existing advanced gallery examples with the new functions, references and naming (trying to shorten content that was a bit long, now referencing to Hugonnet et al. (2022) for lots of things). This results in the renaming of "Non-stationarity of elevation measurement errors" into "Estimation and modelling of elevation heteroscedasticity" now in plot_variogram_estimation_modelling.py, renaming of "Spatial correlation of elevation measurement errors" into "Estimation and modelling of spatial variograms" in plot_variogram_estimation_modelling.py;
  • Updates the documentation page on spatial statistics with the new reference and terms for consistency across the package.

Resolves #256

@rhugonnet rhugonnet changed the title Add error pipeline and simplify documentation on uncertainty analysis Add error pipeline and adapt documentation Aug 19, 2022
xdem/spatialstats.py Outdated Show resolved Hide resolved
xdem/spatialstats.py Outdated Show resolved Hide resolved
xdem/spatialstats.py Outdated Show resolved Hide resolved
xdem/spatialstats.py Outdated Show resolved Hide resolved
xdem/spatialstats.py Outdated Show resolved Hide resolved
tests/test_spatialstats.py Outdated Show resolved Hide resolved
tests/test_spatialstats.py Outdated Show resolved Hide resolved
tests/test_spatialstats.py Outdated Show resolved Hide resolved
adehecq
adehecq previously approved these changes Aug 23, 2022
Copy link
Member

@adehecq adehecq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from mostly minor comments, this looks all good!
Fantastic work !! 👏

@rhugonnet rhugonnet merged commit eac4b4e into GlacioHack:main Aug 24, 2022
@rhugonnet rhugonnet deleted the error_pipeline branch August 24, 2022 13:25
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 this pull request may close these issues.

Add ref to ICP in doc
2 participants