org.opentripplanner.graph_builder.GraphBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
/* This program is free software: you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see _graphBuilderModules = new ArrayList();
private final File graphFile;
private boolean _alwaysRebuild = true;
private List _modeList;
private String _baseGraph = null;
private Graph graph = new Graph();
/** Should the graph be serialized to disk after being created or not? */
public boolean serializeGraph = true;
public GraphBuilder(File path, GraphBuilderParameters builderParams) {
graphFile = new File(path, "Graph.obj");
graph.stopClusterMode = builderParams.stopClusterMode;
}
public void addModule(GraphBuilderModule loader) {
_graphBuilderModules.add(loader);
}
public void setGraphBuilders(List graphLoaders) {
_graphBuilderModules = graphLoaders;
}
public void setAlwaysRebuild(boolean alwaysRebuild) {
_alwaysRebuild = alwaysRebuild;
}
public void setBaseGraph(String baseGraph) {
this._baseGraph = baseGraph;
try {
graph = Graph.load(new File(baseGraph), LoadLevel.FULL);
} catch (Exception e) {
throw new RuntimeException("error loading base graph");
}
}
public void addMode(RoutingRequest mo) {
_modeList.add(mo);
}
public void setModes(List modeList) {
_modeList = modeList;
}
public Graph getGraph() {
return this.graph;
}
public void run() {
/* Record how long it takes to build the graph, purely for informational purposes. */
long startTime = System.currentTimeMillis();
if (serializeGraph) {
if (graphFile == null) {
throw new RuntimeException("graphBuilderTask has no attribute graphFile.");
}
if( graphFile.exists() && ! _alwaysRebuild) {
LOG.info("graph already exists and alwaysRebuild=false => skipping graph build");
return;
}
try {
if (!graphFile.getParentFile().exists()) {
if (!graphFile.getParentFile().mkdirs()) {
LOG.error("Failed to create directories for graph bundle at " + graphFile);
}
}
graphFile.createNewFile();
} catch (IOException e) {
throw new RuntimeException("Cannot create or overwrite graph at path " + graphFile);
}
}
// Check all graph builder inputs, and fail fast to avoid waiting until the build process advances.
for (GraphBuilderModule builder : _graphBuilderModules) {
builder.checkInputs();
}
HashMap, Object> extra = new HashMap, Object>();
for (GraphBuilderModule load : _graphBuilderModules)
load.buildGraph(graph, extra);
graph.summarizeBuilderAnnotations();
if (serializeGraph) {
try {
graph.save(graphFile);
} catch (Exception ex) {
throw new IllegalStateException(ex);
}
} else {
LOG.info("Not saving graph to disk, as requested.");
}
long endTime = System.currentTimeMillis();
LOG.info(String.format("Graph building took %.1f minutes.", (endTime - startTime) / 1000 / 60.0));
}
/**
* Factory method to create and configure a GraphBuilder with all the appropriate modules to build a graph from
* the files in the given directory, accounting for any configuration files located there.
*
* TODO parameterize with the router ID and call repeatedly to make multiple builders
* note of all command line options this is only using params.inMemory params.preFlight and params.build directory
*/
public static GraphBuilder forDirectory(CommandLineParameters params, File dir) {
LOG.info("Wiring up and configuring graph builder task.");
List gtfsFiles = Lists.newArrayList();
List osmFiles = Lists.newArrayList();
JsonNode builderConfig = null;
JsonNode routerConfig = null;
File demFile = null;
LOG.info("Searching for graph builder input files in {}", dir);
if ( ! dir.isDirectory() && dir.canRead()) {
LOG.error("'{}' is not a readable directory.", dir);
return null;
}
// Find and parse config files first to reveal syntax errors early without waiting for graph build.
builderConfig = OTPMain.loadJson(new File(dir, BUILDER_CONFIG_FILENAME));
GraphBuilderParameters builderParams = new GraphBuilderParameters(builderConfig);
GraphBuilder graphBuilder = new GraphBuilder(dir, builderParams);
// Load the router config JSON to fail fast, but we will only apply it later when a router starts up
routerConfig = OTPMain.loadJson(new File(dir, Router.ROUTER_CONFIG_FILENAME));
LOG.info(ReflectionLibrary.dumpFields(builderParams));
for (File file : dir.listFiles()) {
switch (InputFileType.forFile(file)) {
case GTFS:
LOG.info("Found GTFS file {}", file);
gtfsFiles.add(file);
break;
case OSM:
LOG.info("Found OSM file {}", file);
osmFiles.add(file);
break;
case DEM:
if (!builderParams.fetchElevationUS && demFile == null) {
LOG.info("Found DEM file {}", file);
demFile = file;
} else {
LOG.info("Skipping DEM file {}", file);
}
break;
case OTHER:
LOG.warn("Skipping unrecognized file '{}'", file);
}
}
boolean hasOSM = builderParams.streets && !osmFiles.isEmpty();
boolean hasGTFS = builderParams.transit && !gtfsFiles.isEmpty();
if ( ! ( hasOSM || hasGTFS )) {
LOG.error("Found no input files from which to build a graph in {}", dir);
return null;
}
if ( hasOSM ) {
List osmProviders = Lists.newArrayList();
for (File osmFile : osmFiles) {
OpenStreetMapProvider osmProvider = new AnyFileBasedOpenStreetMapProviderImpl(osmFile);
osmProviders.add(osmProvider);
}
OpenStreetMapModule osmModule = new OpenStreetMapModule(osmProviders);
DefaultStreetEdgeFactory streetEdgeFactory = new DefaultStreetEdgeFactory();
streetEdgeFactory.useElevationData = builderParams.fetchElevationUS || (demFile != null);
osmModule.edgeFactory = streetEdgeFactory;
osmModule.customNamer = builderParams.customNamer;
osmModule.setDefaultWayPropertySetSource(builderParams.wayPropertySet);
osmModule.skipVisibility = !builderParams.areaVisibility;
osmModule.platformEntriesLinking = builderParams.platformEntriesLinking;
osmModule.staticBikeRental = builderParams.staticBikeRental;
osmModule.staticBikeParkAndRide = builderParams.staticBikeParkAndRide;
osmModule.staticParkAndRide = builderParams.staticParkAndRide;
osmModule.banDiscouragedWalking = builderParams.banDiscouragedWalking;
osmModule.banDiscouragedBiking = builderParams.banDiscouragedBiking;
graphBuilder.addModule(osmModule);
PruneFloatingIslands pruneFloatingIslands = new PruneFloatingIslands();
pruneFloatingIslands.setPruningThresholdIslandWithoutStops(builderParams.pruningThresholdIslandWithoutStops);
pruneFloatingIslands.setPruningThresholdIslandWithStops(builderParams.pruningThresholdIslandWithStops);
graphBuilder.addModule(pruneFloatingIslands);
}
if ( hasGTFS ) {
List gtfsBundles = Lists.newArrayList();
for (File gtfsFile : gtfsFiles) {
GtfsBundle gtfsBundle = new GtfsBundle(gtfsFile);
gtfsBundle.setTransfersTxtDefinesStationPaths(builderParams.useTransfersTxt);
if (builderParams.parentStopLinking) {
gtfsBundle.linkStopsToParentStations = true;
}
gtfsBundle.parentStationTransfers = builderParams.stationTransfers;
gtfsBundle.subwayAccessTime = (int)(builderParams.subwayAccessTime * 60);
gtfsBundle.maxInterlineDistance = builderParams.maxInterlineDistance;
gtfsBundles.add(gtfsBundle);
}
GtfsModule gtfsModule = new GtfsModule(gtfsBundles);
gtfsModule.setFareServiceFactory(builderParams.fareServiceFactory);
graphBuilder.addModule(gtfsModule);
if ( hasOSM ) {
if (builderParams.matchBusRoutesToStreets) {
graphBuilder.addModule(new BusRouteStreetMatcher());
}
graphBuilder.addModule(new TransitToTaggedStopsModule());
}
}
// This module is outside the hasGTFS conditional block because it also links things like bike rental
// which need to be handled even when there's no transit.
StreetLinkerModule streetLinkerModule = new StreetLinkerModule();
streetLinkerModule.setAddExtraEdgesToAreas(builderParams.areaVisibility);
graphBuilder.addModule(streetLinkerModule);
// Load elevation data and apply it to the streets.
// We want to do run this module after loading the OSM street network but before finding transfers.
if (builderParams.elevationBucket != null) {
// Download the elevation tiles from an Amazon S3 bucket
S3BucketConfig bucketConfig = builderParams.elevationBucket;
File cacheDirectory = new File(params.cacheDirectory, "ned");
DegreeGridNEDTileSource awsTileSource = new DegreeGridNEDTileSource();
awsTileSource = new DegreeGridNEDTileSource();
awsTileSource.awsAccessKey = bucketConfig.accessKey;
awsTileSource.awsSecretKey = bucketConfig.secretKey;
awsTileSource.awsBucketName = bucketConfig.bucketName;
NEDGridCoverageFactoryImpl gcf = new NEDGridCoverageFactoryImpl(cacheDirectory);
gcf.tileSource = awsTileSource;
GraphBuilderModule elevationBuilder = new ElevationModule(gcf);
graphBuilder.addModule(elevationBuilder);
} else if (builderParams.fetchElevationUS) {
// Download the elevation tiles from the official web service
File cacheDirectory = new File(params.cacheDirectory, "ned");
ElevationGridCoverageFactory gcf = new NEDGridCoverageFactoryImpl(cacheDirectory);
GraphBuilderModule elevationBuilder = new ElevationModule(gcf);
graphBuilder.addModule(elevationBuilder);
} else if (demFile != null) {
// Load the elevation from a file in the graph inputs directory
ElevationGridCoverageFactory gcf = new GeotiffGridCoverageFactoryImpl(demFile);
GraphBuilderModule elevationBuilder = new ElevationModule(gcf);
graphBuilder.addModule(elevationBuilder);
}
if ( hasGTFS ) {
// The stops can be linked to each other once they are already linked to the street network.
if ( ! builderParams.useTransfersTxt) {
// This module will use streets or straight line distance depending on whether OSM data is found in the graph.
graphBuilder.addModule(new DirectTransferGenerator(builderParams.maxTransferDistance));
}
}
graphBuilder.addModule(new EmbedConfig(builderConfig, routerConfig));
if (builderParams.htmlAnnotations) {
graphBuilder.addModule(new AnnotationsToHTML(params.build, builderParams.maxHtmlAnnotationsPerFile));
}
graphBuilder.serializeGraph = ( ! params.inMemory ) || params.preFlight;
return graphBuilder;
}
/**
* Represents the different types of files that might be present in a router / graph build directory.
* We want to detect even those that are not graph builder inputs so we can effectively warn when unrecognized file
* types are present. This helps point out when config files have been misnamed (builder-config vs. build-config).
*/
private static enum InputFileType {
GTFS, OSM, DEM, CONFIG, GRAPH, OTHER;
public static InputFileType forFile(File file) {
String name = file.getName();
if (name.endsWith(".zip")) {
try {
ZipFile zip = new ZipFile(file);
ZipEntry stopTimesEntry = zip.getEntry("stop_times.txt");
zip.close();
if (stopTimesEntry != null) return GTFS;
} catch (Exception e) { /* fall through */ }
}
if (name.endsWith(".pbf")) return OSM;
if (name.endsWith(".osm")) return OSM;
if (name.endsWith(".osm.xml")) return OSM;
if (name.endsWith(".tif") || name.endsWith(".tiff")) return DEM; // Digital elevation model (elevation raster)
if (name.equals("Graph.obj")) return GRAPH;
if (name.equals(GraphBuilder.BUILDER_CONFIG_FILENAME) || name.equals(Router.ROUTER_CONFIG_FILENAME)) {
return CONFIG;
}
return OTHER;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy