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

THIS CLASS IS MULTI-THREADED (When configured to do so, it uses parallel streams to distribute elevation calculation tasks for edges.) 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. Data sources that could be used include 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(ElevationGridCoverageFactory factory) used only for testing purposes
ElevationModule(ElevationGridCoverageFactory factory, File cacheDirectory, boolean readCachedElevations, boolean writeCachedElevations, boolean includeEllipsoidToGeoidDifference, boolean multiThreadElevationCalculations, double elevationUnitMultiplier)

Method Summary

Modifier and Type	Method and Description
void	buildGraph(Graph graph, GraphBuilderModuleSummary graphBuilderModuleSummary) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ElevationModule

public ElevationModule(ElevationGridCoverageFactory factory)

used only for testing purposes

ElevationModule

public ElevationModule(ElevationGridCoverageFactory factory,
                       File cacheDirectory,
                       boolean readCachedElevations,
                       boolean writeCachedElevations,
                       boolean includeEllipsoidToGeoidDifference,
                       boolean multiThreadElevationCalculations,
                       double elevationUnitMultiplier)

Method Detail

buildGraph

public void buildGraph(Graph graph,
                       GraphBuilderModuleSummary graphBuilderModuleSummary)

Description copied from interface: GraphBuilderModule

Process whatever inputs were supplied to this module and add the resulting elements to the given graph. Also, add build info to the given GraphBuilderModuleSummary as needed.

Specified by:

buildGraph in interface GraphBuilderModule

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