Elevation handling improvements by flaktack · Pull Request #4033 · opentripplanner/OpenTripPlanner

flaktack · 2022-03-28T07:15:01Z

Summary

This is a set of related changes to improve elevation handling. It fixes several bugs, along with adding new features.

Bugs

The elevation propagation was non-deterministic. The logic was moved to a separate class (MissingElevationHandler) and refactored so that it is deterministic and testable. A new build parameters is added to limit the propagation distance (maxElevationPropagationMeters).
The elevation profile was not copied to split edges and partial edges. This was fixed by merging StreetEdge and StreetWithElevationEdge, along with moving the partial edge splitting to StreetEdge.
The elevation profile for all StreetEdges was compacted. For split edges and propagated elevations the profile doesn't have uniform distances, which is required for compaction.StreetElevationExtension can store both the compacted and uncompacted profile.

Features

TIFF files may contain a NO_DATA tag to mark areas without elevation data. This was ignored, resulting in areas with unrealistic elevation. A NoDataGridCoverage class is added, which treats NO_DATA areas the same as areas outside the grid's bounds.
All elevation related errors are added to the DataImportIssueStore.
Leg#legElevation is added, which contains the elevation profile for the whole Leg. If the elevation is missing in some segments, than NaN segments are added.
An elevation graph is added to the debug client
An elevation debug layer is added to the debug client. This uses the newly-added Graph#minElevation and Graph#maxElevation to have a consistent coloring between tiles.

Refactors

Elevation is added to the Portland test graph. A snapshot test and a graph serialization test is added.
StreetWithElevationEdge is merged into StreetEdge, with the elevation specific parts moved into StreetElevationExtension. This was needed to simplify edge splitting, which previously discarded the elevation details.

Issue

closes #3862

Unit tests

Unit tests are added for:

elevation compaction
elevation propagation
graph serialization with elevation

A snapshot test is added for planning trips with elevation data.

Code style

☑️

Documentation

A single new build-config.json parameter is added (maxElevationPropagationMeters), for which the documentation is updated.

StreetVertex used a lambda to pass String parameters to LocalizedString(), which meant that toString() wasn't overridden. By using I18NString parameters in LocalizedString the need for the lambda is removed, while generalising the code.

This allows testing the elevation related functionality on an actual graph.

WalkStep also contains the elevation, but having it explicitly on Leg simplifies its usage. An explicit NaN value is added to differentiate when there is no elevation data.

Due to the elevation data it is possible to have Infinity / NaN bicycleSafetyFactor or edge traversal weight. To avoid errors latter on, check for invalid values when setting updated values. ElevationProfileFailure items are added to the issue store.

NoDataGridCoverage is added which throws a PointOutsideCoverageException() if the value at a given point is the NO_DATA value for the loaded file.

This simplifies edge splitting since less cases need to be handled, while also allowing for cleaner code.

When the from/to vertices are along the same edge a partial TemporaryPartialStreetEdge was created without copying the properties from the original StreetEdge. This remedies the oversight by: * moving the responsibility from SameEdgeAdjuster to StreetEdge * and reusing StreetEdge#copyPropertiesToSplitEdge()

All elevation profiles were compacted, which caused the uncompacted profile to have differing distances. By compacting only "computed" elevations this is avoided.

The existing logic is modified so that is deterministic and tested. The new logic interpolates the elevation for each vertex that is within maxElevationPropagationDistance on the street network using the two closest vertices with elevation.

hannesj · 2022-03-28T08:07:29Z

+     * The elevation profile as a comma-separated list of x,y values. x is the distance from the start of the leg, y is the elevation at this
+     * distance.
+     */
+    public String legElevation;


Should we use some more efficient data structure for this?

Isn't that what the WalkStep also uses?

It is, but for example the same encoded polylines could be used as for the legGeometry.

Encoded polyline can't be used due to the different ranges the numbers have, so the existing string seems like the best solution, and so can stay the same.

slvlirnoff · 2022-03-28T10:37:48Z

Why '[changelog skip]' ? This seems relevant to include to me.

flaktack · 2022-03-29T07:38:39Z

Why '[changelog skip]' ? This seems relevant to include to me.

I'm not sure which parts should be in the changelog, and which parts shouldn't. I can rename the PR to better reflect what should be in the changelog, or create separate PRs for the relevant parts.

leonardehrenfried

I really thorough refactoring and bugfix with great test coverage. Thanks!

flaktack added 13 commits March 26, 2022 07:39

Pass I18NString parameters to LocalizedString

79ed523

StreetVertex used a lambda to pass String parameters to LocalizedString(), which meant that toString() wasn't overridden. By using I18NString parameters in LocalizedString the need for the lambda is removed, while generalising the code.

Remove unused methods in TemporaryPartialStreetEdge

f958121

Correctly calculate elevation success percentage

c6c3ab9

Add elevation to the Portland graph

f680917

This allows testing the elevation related functionality on an actual graph.

Add elevation details to Leg

4e5de93

WalkStep also contains the elevation, but having it explicitly on Leg simplifies its usage. An explicit NaN value is added to differentiate when there is no elevation data.

debug-client: display elevation graph

1945b12

Handle NO_DATA values in elevation tif files

5c0e869

NoDataGridCoverage is added which throws a PointOutsideCoverageException() if the value at a given point is the NO_DATA value for the loaded file.

Merge StreetEdge and StreetWithElevationEdge

9412963

This simplifies edge splitting since less cases need to be handled, while also allowing for cleaner code.

Only compact elevation profiles with uniform sampling distances

104ed4b

All elevation profiles were compacted, which caused the uncompacted profile to have differing distances. By compacting only "computed" elevations this is avoided.

Add elevation debug tile layer

7c3ebf4

Parameterize elevation propagation

9345d6f

The existing logic is modified so that is deterministic and tested. The new logic interpolates the elevation for each vertex that is within maxElevationPropagationDistance on the street network using the two closest vertices with elevation.

flaktack requested a review from a team as a code owner March 28, 2022 07:15

hannesj previously approved these changes Mar 28, 2022

View reviewed changes

leonardehrenfried reviewed Mar 28, 2022

View reviewed changes

Comment thread src/main/java/org/opentripplanner/inspector/ElevationEdgeRenderer.java Outdated

leonardehrenfried reviewed Mar 28, 2022

View reviewed changes

Comment thread src/main/java/org/opentripplanner/routing/edgetype/StreetEdge.java Outdated

flaktack added 2 commits March 29, 2022 09:23

ElevationEdgeRender: use pattern matching instanceof

794ead2

StreetEdge: correct exception typo

63a8dc4

flaktack dismissed hannesj’s stale review via 63a8dc4 March 29, 2022 07:36

hannesj approved these changes Mar 29, 2022

View reviewed changes

t2gran added this to the 2.2 milestone Mar 29, 2022

t2gran added the !Improvement A functional improvement or micro feature label Mar 29, 2022

leonardehrenfried approved these changes Mar 29, 2022

View reviewed changes

flaktack changed the title ~~Elevation handling improvements [changelog skip]~~ Elevation handling improvements Mar 30, 2022

flaktack merged commit e36a2c7 into opentripplanner:dev-2.x Mar 30, 2022

t2gran pushed a commit that referenced this pull request Mar 30, 2022

Add changelog entry for #4033 [ci skip]

d66379a

flaktack deleted the feature/elevations branch March 30, 2022 13:44

t2gran added the +Skip Changelog This is not a relevant change for a product owner since last release. label Jun 23, 2022

leonardehrenfried mentioned this pull request Jul 29, 2022

StreetEdges split destructively lose elevation data #2790

Closed

leonardehrenfried mentioned this pull request Dec 15, 2022

Correctly calculate elevation profile for partial street edges #2752

Closed

4 of 8 tasks

Navigation Menu

Repository navigation

Elevation handling improvements - #4033

Elevation handling improvements#4033
flaktack merged 15 commits into
opentripplanner:dev-2.xfrom
realCity:feature/elevations

flaktack commented Mar 28, 2022 •

edited

Loading

Uh oh!

hannesj Mar 28, 2022

Uh oh!

leonardehrenfried Mar 29, 2022

Uh oh!

flaktack Mar 29, 2022

Uh oh!

flaktack Mar 30, 2022

Uh oh!

slvlirnoff commented Mar 28, 2022

Uh oh!

Uh oh!

Uh oh!

flaktack commented Mar 29, 2022

Uh oh!

leonardehrenfried left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

flaktack commented Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Bugs

Features

Refactors

Issue

Unit tests

Code style

Documentation

Uh oh!

hannesj Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

leonardehrenfried Mar 29, 2022

Choose a reason for hiding this comment

Uh oh!

flaktack Mar 29, 2022

Choose a reason for hiding this comment

Uh oh!

flaktack Mar 30, 2022

Choose a reason for hiding this comment

Uh oh!

slvlirnoff commented Mar 28, 2022

Uh oh!

Uh oh!

Uh oh!

flaktack commented Mar 29, 2022

Uh oh!

leonardehrenfried left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

flaktack commented Mar 28, 2022 •

edited

Loading