Skip to content

Conversation

@robbibt
Copy link
Member

@robbibt robbibt commented Oct 23, 2025

Proposed changes

This PR adds a new notebook for tracking coastal sediment through time using optical flow vector computer vision techniques.

Includes a new xr_optical_flow function with tests.

Closes issues (optional)

  • Closes Issue #000

Checklist

If this is a notebook, then have you:

  • Checked the structure of the notebook follows our DEA-notebooks template
  • Removed any unused Python packages from Load packages
  • Removed any unused/empty code cells
  • Removed any guidance cells (e.g. General advice)
  • Ensured that all code cells follow the PEP8 standard for code. The jupyterlab_code_formatter tool can be used to format code cells to a consistent style: select each code cell, then click Edit and then one of the Apply X Formatter options (YAPF or Black are recommended).
  • Included relevant tags in the final notebook cell (refer to the DEA Tags Index, and re-use tags if possible)
  • Tested notebook on the DEA Sandbox
  • Cleared all outputs, run notebook from start to finish, and save the notebook in the state where all cells have been sequentially evaluated
  • If applicable, update the Notebook currently compatible with line below the notebook title to reflect the environments the notebook is compatible with
  • Check for any spelling mistakes using the DEA Sandbox's built-in spellchecker (double click on markdown cells then right-click on pink highlighted words). For example:

sandbox_spellchecker

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@cbur24
Copy link
Collaborator

cbur24 commented Oct 23, 2025

Looks awesome @robbibt! The xr_optical_flow function makes a nice addition to dea-tools as well. I wonder if its worth highlighting in the JOSS paper?

All the markdown text and code looks good to me. I played around with the figures using different colormaps and experimented with adding a basemap to the final figure to give a bit of context....feel free to revert any of it if you think its not helping.

I've also removed the dask cluster as I don't think you were using it for the datacube load, and looks as though xr_optical_flow uses concurrent.futures.

One suggestion: is there any benefit in the Optical Flow Modelling section of the notebook in providing a bit of context on the method= and radius= parameters for xr_optical_flow? Is the radius measured in pixels? Why is the default 20?

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.

2 participants