org.opentripplanner.graph_builder.module.ned

Class ElevationModule

java.lang.Object

org.opentripplanner.graph_builder.module.ned.ElevationModule

All Implemented Interfaces:

GraphBuilderModule

public class ElevationModule
extends Object
implements GraphBuilderModule

GraphBuilderModule plugin that applies elevation data to street data that has already been loaded into a (@link Graph}, creating elevation profiles for each Street encountered in the Graph. Depending on the ElevationGridCoverageFactory specified this could be auto-downloaded and cached National Elevation Dataset (NED) raster data or a GeoTIFF file. The elevation profiles are stored as PackedCoordinateSequence objects, where each (x,y) pair represents one sample, with the x-coord representing the distance along the edge measured from the start, and the y-coord representing the sampled elevation at that point (both in meters).

Constructor Summary

Constructors

Constructor and Description
ElevationModule()
ElevationModule(ElevationGridCoverageFactory factory, double elevationUnitMultiplier)

Method Summary

Modifier and Type	Method and Description
void	buildGraph(Graph graph, HashMap<Class<?>,Object> extra) Process whatever inputs were supplied to this module and add the resulting elements to the given graph.
void	checkInputs() Check that all inputs to the graphbuilder are valid; throw an exception if not.
org.locationtech.jts.geom.Coordinate	getPointAlongEdge(org.locationtech.jts.geom.Coordinate[] coords, double length, double t) Returns a coordinate along a path located at a specific point indicated by the percentage of distance covered from start to end.
List<String>	getPrerequisites()
List<String>	provides()
void	setDistanceBetweenSamplesM(double distance)
void	setGridCoverageFactory(ElevationGridCoverageFactory factory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ElevationModule

public ElevationModule()

ElevationModule

public ElevationModule(ElevationGridCoverageFactory factory,
                       double elevationUnitMultiplier)

Method Detail

provides

public List<String> provides()

getPrerequisites

public List<String> getPrerequisites()

setGridCoverageFactory

public void setGridCoverageFactory(ElevationGridCoverageFactory factory)

setDistanceBetweenSamplesM

public void setDistanceBetweenSamplesM(double distance)

buildGraph

public void buildGraph(Graph graph,
                       HashMap<Class<?>,Object> extra)

Description copied from interface: GraphBuilderModule

Process whatever inputs were supplied to this module and add the resulting elements to the given graph.

Specified by:

buildGraph in interface GraphBuilderModule

getPointAlongEdge

public org.locationtech.jts.geom.Coordinate getPointAlongEdge(org.locationtech.jts.geom.Coordinate[] coords,
                                                              double length,
                                                              double t)

Returns a coordinate along a path located at a specific point indicated by the percentage of distance covered from start to end.

Parameters:

coords - the list of (x,y) coordinates that form the path

length - the total length of the path

t - the percentage (ranges from 0 to 1)

Returns:

the (x,y) coordinate at t

checkInputs

public void checkInputs()

Description copied from interface: GraphBuilderModule

Check that all inputs to the graphbuilder are valid; throw an exception if not.

Specified by:

checkInputs in interface GraphBuilderModule