[ana5]: add general thalweg extension & resampling by PaulaSp3 · Pull Request #1323 · OpenNHM/AvaFrame

PaulaSp3 · 2026-07-31T10:27:08Z

The goal is to derive a thalweg profile from very general thalweg data (containing x and y coordinates).

This changed in each file:

ana5Utils/DFAPathGeneration.py:
- black formatter
- extendProfileTop : add extension option that extends the path to the top similar as the bottom extension that depends on the flow/ path direction
  (for option 2, the code is very similar as in extendProfileBottom, should we summarize both in one function with options/different handling for top nd bottom extension?)
- extendProfileBottom: add possibility to consider lower left center when reading z values from DEM
- resamplePath : add parameter in configfile that can change the degree of the spline
ana5Utils/DFAPathGenerationCfg.ini:
- add parameter in configfile that can change the degree of the spline (for resampling a path)
ana5Utils/preparePathGeneral.py
functions to prepare a path/thalweg that has only x and y coordinates:
- extend path to top and bottom
- resample path
- read z values along path (from DEM)
- compute s values along path
out3Plot/outCom3Plots.py
- black formatter
- generateCom1DFAPathPlot: put the avalanche thalweg location plot into a separate function avalancheThalwegPlot

PR Checklist

Please confirm before requesting review:

I ran pytest locally without fails
I added/updated tests where needed
I updated documentation where needed

Confirm before the final merge/rebase into master

Commits are sensibly squashed and rebased onto latest master
Standardtest run without difference (with recompiled cython code)

qltysh · 2026-07-31T10:28:46Z

Analysis for project `AvaFrame`

❌ 12 blocking issues (14 total)

Tool	Category	Rule	Count
ripgrep	Lint	# TODO: for option 2, the code is very similar as in extendProfileBottom, should we summarize both in one function with options/different handling for top nd bottom extension?	4	❌
ruff	Style	Incorrect formatting, autoformat by running `qlty fmt`.	3	❌
ruff	Lint	Do not use bare `except`	2	❌
ruff	Lint	Ambiguous variable name: `l`	2	❌
ruff	Lint	f-string without any placeholders	1	❌
qlty	Structure	Function with high complexity (count = 34): extendProfileTop	1
qlty	Structure	Deeply nested control flow (level = 4)	1

@qltysh one-click actions:

Auto-fix formatting (qlty fmt && git push)

qltysh · 2026-07-31T10:28:48Z

+        profile["z"] = np.append(zExtTop, profile["z"])
+        profile["s"] = np.append(0, profile["s"] + ds)
    if debugPlot:
        debPlot.plotPathExtTop(profile, particlesIni, xFirst, yFirst, zFirst, dz1)


Function with high complexity (count = 34): extendProfileTop [qlty:function-complexity]

qltysh · 2026-07-31T10:28:48Z

+            log.warning("Skip top extension of thalweg since profile contains only one point.")
+            return profile
+
+        # TODO: for option 2, the code is very similar as in extendProfileBottom, should we summarize both in one function with options/different handling for top nd bottom extension?


# TODO: for option 2, the code is very similar as in extendProfileBottom, should we summarize both in one function with options/different handling for top nd bottom extension? [ripgrep:TODO]

qltysh · 2026-07-31T10:28:48Z

+            log.error(message)
+            raise ValueError(message)
+        if cfg is None:
+            message = f"If extTopOption = 2, the cfg needs to be provided"


f-string without any placeholders [ruff:F541]

Suggested change

message = f"If extTopOption = 2, the cfg needs to be provided"

message = "If extTopOption = 2, the cfg needs to be provided"

qltysh · 2026-07-31T10:28:49Z

+                else:
+                    # remember last point found inside
+                    factFirst = factExt
+                    factExt = factExt + stepSize


Deeply nested control flow (level = 4) [qlty:nested-control-flow]

qltysh · 2026-07-31T10:28:49Z

-    title = ('com3HybRasterPlot')
-    l = ax.legend(loc='lower left')
+    title = "com3HybRasterPlot"
+    l = ax.legend(loc="lower left")


Ambiguous variable name: l [ruff:E741]

qltysh · 2026-07-31T10:28:49Z

        else:
            extentPlot = extent

+        # TODO: restore changes and rebase master!


# TODO: restore changes and rebase master! [ripgrep:TODO]

qltysh · 2026-07-31T10:28:49Z

@@ -0,0 +1,205 @@
+"""Tests for module preparePathGeneral"""


Found 2 issues:

1. Incorrect formatting, autoformat by running qlty fmt. [ruff:fmt]

2. Incorrect formatting, autoformat by running qlty fmt. [black:fmt]

qltysh · 2026-07-31T10:32:54Z

Coverage Impact

This PR will not change total coverage.

Modified Components (1)

Rating	Component	% Diff
	com1DFA	90.0%

Modified Files with Diff Coverage (3)

File	% Diff	Uncovered Line #s
avaframe/com1DFA/DFAtools.py	90.0%	183
avaframe/ana5Utils/DFAPathGeneration.py	72.6%	54-132, 180-198...
avaframe/ana5Utils/preparePathGeneral.py	83.0%	48-61
Total	74.8%

🤖 Increase coverage with AI coding...

In the `PS_FP_thalweg` branch, add test coverage for this new code:

- `avaframe/ana5Utils/DFAPathGeneration.py` -- Lines 54-132, 180-198, 534-536, 548-564, 568-573, 583-585, 734, 1046-1047, and 1089-1150
- `avaframe/ana5Utils/preparePathGeneral.py` -- Line 48-61
- `avaframe/com1DFA/DFAtools.py` -- Line 183

🚦 See full report on Qlty Cloud »

🛟 Help

Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.
Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.
File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)
- Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

resample path

fso42 · 2026-08-14T09:17:52Z

+    )
+
+    # extend the bottom
+    profile = DFAPathGeneration.extendProfileBottom(cfgPathGen["PATH"], demDict, profile, considerLLC=True)


I'm not 100 % sure if the indices that come out are correct or whether they are shifted by one. Can you check?

pathExtension sets indStartMassAverage = 1 and indEndMassAverage = size(x) - 2 before the extension calls
(preparePathGeneral.py:119-120)

extendProfileTop (option 2) prepends a single point and extendProfileBottom appends a single one, at least in
the normal case

The indices are consumed later by resamplePath on the post-extension profile, via s0 and sEnd

And that's then shifted by one? But maybe I did not follow correctly?

fso42 · 2026-08-14T09:20:44Z

+        indEndCandidates = np.argwhere(avaProfile["s"] >= sEnd + resampleDistance / 3)
+        indEnd = indEndCandidates[0][0] - 1 if len(indEndCandidates) > 0 else np.size(avaProfile["s"]) - 1
+        avaProfile['indEndMassAverage'] = indEnd
+    except:


What are you trying to catch here? If there's a real error, it will be masked here...

fso42 · 2026-08-14T09:22:29Z

    return outPath
+
+
+def avalancheThalwegPlot(ax, fieldRaster, dem, avaProfileMass, splitPoint=None, avalancheDir="", cmapHS=None):


docstring is missing

fso42 · 2026-08-14T09:25:06Z

+    for inputPara in ["alpha", "exponent", "zDeltaMax"]:
+        try:
+            profileExtended[inputPara] = profile[inputPara]
+        except:


Should this be a except KeyError? since real error should be shown

fso42 · 2026-08-14T09:27:25Z

+    # skip profile that only contains one point
+    if len(profileAveraged["x"]) <= 2:
+        profileExtended["indStartMassAverage"] = 0
+        profileExtended["indEndMassAverage"] = max(len(profileExtended["x"]) - 1, 1)


Single Points gets '1', but he profile Array only has 0. Do we need to catch this?

fso42 · 2026-08-14T09:28:45Z

+    return profileAveraged, profileExtended
+
+
+def replaceResampledProfileCore(profile, profileResample):


Remove, it's dead code an in git anyways

PaulaSp3 requested review from awirb and fso42 July 31, 2026 10:27

PaulaSp3 self-assigned this Jul 31, 2026

PaulaSp3 added the enhancement New feature or request label Jul 31, 2026

PaulaSp3 linked an issue Jul 31, 2026 that may be closed by this pull request

[com4], [ana5]: Add Flowpy thalweg postprocessing #1232

Open

7 tasks

PaulaSp3 changed the title ~~[ana5]: add general thalweg generation~~ [ana5]: add general thalweg extension & resampling Jul 31, 2026

PaulaSp3 linked an issue Jul 31, 2026 that may be closed by this pull request

[com4]: thalweg identification #1235

Open

14 tasks

qltysh Bot reviewed Jul 31, 2026

View reviewed changes

PaulaSp3 force-pushed the PS_FP_thalweg branch 2 times, most recently from 7c42103 to ea6399c Compare August 13, 2026 11:24

extend thalweg to top in flow direction

da66642

resample path

PaulaSp3 force-pushed the PS_FP_thalweg branch from ea6399c to da66642 Compare August 13, 2026 11:26

fso42 requested changes Aug 14, 2026

View reviewed changes

	message = f"If extTopOption = 2, the cfg needs to be provided"
	message = "If extTopOption = 2, the cfg needs to be provided"

		return outPath


		def avalancheThalwegPlot(ax, fieldRaster, dem, avaProfileMass, splitPoint=None, avalancheDir="", cmapHS=None):

		return profileAveraged, profileExtended


		def replaceResampledProfileCore(profile, profileResample):

Uh oh!

Conversation

PaulaSp3 commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Uh oh!

qltysh Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis for project AvaFrame

❌ 12 blocking issues (14 total)

Uh oh!

qltysh Bot Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

qltysh Bot Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qltysh Bot Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

qltysh Bot Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

qltysh Bot Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

qltysh Bot Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

qltysh Bot Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

qltysh Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fso42 Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

fso42 Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

fso42 Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

fso42 Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

fso42 Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

fso42 Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PaulaSp3 commented Jul 31, 2026 •

edited

Loading

qltysh Bot commented Jul 31, 2026 •

edited

Loading

Analysis for project `AvaFrame`

qltysh Bot commented Jul 31, 2026 •

edited

Loading