org.opentripplanner.standalone

Class GraphBuilderParameters

java.lang.Object

org.opentripplanner.standalone.GraphBuilderParameters

public class GraphBuilderParameters
extends Object

These are parameters that when changed, necessitate a Graph rebuild. They are distinct from the RouterParameters which can be applied to a pre-built graph or on the fly at runtime. Eventually both classes may be initialized from the same config file so make sure there is no overlap in the JSON keys used.

These used to be command line parameters, but there were getting to be too many of them and besides, we want to allow different graph builder configuration for each Graph.

TODO maybe have only one giant config file and just annotate the parameters to indicate which ones trigger a rebuild ...or just feed the same JSON tree to two different classes, one of which is the build configuration and the other is the router configuration.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	areaVisibility Perform visibility calculations on OSM areas (these calculations can be time consuming).
boolean	banDiscouragedBiking This field indicates whether bicycling should be allowed on OSM ways tagged with "bicycle=discouraged".
boolean	banDiscouragedWalking This field indicates whether walking should be allowed on OSM ways tagged with "foot=discouraged".
CustomNamer	customNamer A custom OSM namer to use.
S3BucketConfig	elevationBucket If specified, download NED elevation tiles from the given AWS S3 bucket.
double	elevationUnitMultiplier Unit conversion multiplier for elevation values.
boolean	embedRouterConfig Embed the Router config in the graph, which allows it to be sent to a server fully configured over the wire.
Boolean	extraEdgesStopPlatformLink This will add extra edges when linking a stop to a platform, to prevent detours along the platform edge.
FareServiceFactory	fareServiceFactory A specific fares service to use.
boolean	fetchElevationUS Download US NED elevation data and apply it to the graph.
boolean	htmlAnnotations Generates nice HTML report of Graph errors/warnings (annotations).
boolean	includeEllipsoidToGeoidDifference When set to true (it is false by default), the elevation module will include the Ellipsoid to Geiod difference in the calculations of every point along every StreetWithElevationEdge in the graph.
boolean	includeOsmTags
int	maxHtmlAnnotationsPerFile If number of annotations is larger then specified number annotations will be split in multiple files.
int	maxInterlineDistance Maximal distance between stops in meters that will connect consecutive trips that are made with same vehicle
double	maxTransferDistance Transfers up to this length in meters will be pre-calculated and included in the Graph.
String	micromobilityDropoffRestrictionsUrlOrFile An optional url or file with GeoJson polygons that represent areas where micromobility vehicle rental dropoffs are forbidden.
String	micromobilityTravelRestrictionsUrlOrFile An optional url or file with GeoJson polygons that represent areas where micromobility travel is forbidden.
boolean	multiThreadElevationCalculations Whether or not to multi-thread the elevation calculations in the elevation module.
boolean	parentStopLinking Link GTFS stops to their parent stops.
boolean	platformEntriesLinking Link unconnected entries to public transport platforms.
int	pruningThresholdIslandWithoutStops This field indicates the pruning threshold for islands without stops.
int	pruningThresholdIslandWithStops This field indicates the pruning threshold for islands with stops.
boolean	readCachedElevations When set to true (it is by default), the elevation module will attempt to read this file in order to reuse calculations of elevation data for various coordinate sequences instead of recalculating them all over again.
boolean	staticBikeParkAndRide Whether we should create bike P+R stations from OSM data.
boolean	staticBikeRental Whether bike rental stations should be loaded from OSM, rather than periodically dynamically pulled from APIs.
boolean	staticParkAndRide Whether we should create car P+R stations from OSM data.
boolean	stationTransfers Create direct transfers between the constituent stops of each parent station.
StopClusterMode	stopClusterMode Stop clusters can be built in one of two ways, either by geographical proximity and name, or according to a parent/child station topology, if it exists.
boolean	streets Include street input files (OSM/PBF).
double	subwayAccessTime Minutes necessary to reach stops served by trips on routes of route_type=1 (subway) from the street.
boolean	transit Include all transit input files (GTFS) from scanned directory.
boolean	useTransfersTxt Create direct transfer edges from transfers.txt in GTFS, instead of based on distance.
WayPropertySetSource	wayPropertySet Custom OSM way properties
boolean	writeCachedElevations When set to true (it is false by default), the elevation module will create a file of a lookup map of the LineStrings and the corresponding calculated elevation data for those coordinates.

Constructor Summary

Constructors

Constructor and Description
GraphBuilderParameters(com.fasterxml.jackson.databind.JsonNode config) Set all parameters from the given Jackson JSON tree, applying defaults.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

htmlAnnotations

public final boolean htmlAnnotations

Generates nice HTML report of Graph errors/warnings (annotations). They are stored in the same location as the graph.

maxHtmlAnnotationsPerFile

public final int maxHtmlAnnotationsPerFile

If number of annotations is larger then specified number annotations will be split in multiple files. Since browsers have problems opening large HTML files.

transit

public final boolean transit

Include all transit input files (GTFS) from scanned directory.

useTransfersTxt

public final boolean useTransfersTxt

Create direct transfer edges from transfers.txt in GTFS, instead of based on distance.

parentStopLinking

public final boolean parentStopLinking

Link GTFS stops to their parent stops.

stationTransfers

public final boolean stationTransfers

Create direct transfers between the constituent stops of each parent station.

stopClusterMode

public final StopClusterMode stopClusterMode

Stop clusters can be built in one of two ways, either by geographical proximity and name, or according to a parent/child station topology, if it exists.

• "parentStation" See GraphIndex.clusterByParentStation()
• "proximity" See GraphIndex.clusterByProximityAndName(). This is the default value.

subwayAccessTime

public final double subwayAccessTime

Minutes necessary to reach stops served by trips on routes of route_type=1 (subway) from the street. Perhaps this should be a runtime router parameter rather than a graph build parameter.

streets

public final boolean streets

Include street input files (OSM/PBF).

embedRouterConfig

public final boolean embedRouterConfig

Embed the Router config in the graph, which allows it to be sent to a server fully configured over the wire.

areaVisibility

public final boolean areaVisibility

Perform visibility calculations on OSM areas (these calculations can be time consuming).

platformEntriesLinking

public final boolean platformEntriesLinking

Link unconnected entries to public transport platforms.

fetchElevationUS

public final boolean fetchElevationUS

Download US NED elevation data and apply it to the graph.

elevationBucket

public final S3BucketConfig elevationBucket

If specified, download NED elevation tiles from the given AWS S3 bucket.

elevationUnitMultiplier

public final double elevationUnitMultiplier

Unit conversion multiplier for elevation values. No conversion needed if the elevation values are defined in meters in the source data. If, for example, decimetres are used in the source data, this should be set to 0.1.

fareServiceFactory

public final FareServiceFactory fareServiceFactory

A specific fares service to use.

customNamer

public final CustomNamer customNamer

A custom OSM namer to use.

wayPropertySet

public final WayPropertySetSource wayPropertySet

Custom OSM way properties

staticBikeRental

public boolean staticBikeRental

Whether bike rental stations should be loaded from OSM, rather than periodically dynamically pulled from APIs.

staticParkAndRide

public boolean staticParkAndRide

Whether we should create car P+R stations from OSM data.

staticBikeParkAndRide

public boolean staticBikeParkAndRide

Whether we should create bike P+R stations from OSM data.

maxInterlineDistance

public int maxInterlineDistance

Maximal distance between stops in meters that will connect consecutive trips that are made with same vehicle

pruningThresholdIslandWithoutStops

public final int pruningThresholdIslandWithoutStops

This field indicates the pruning threshold for islands without stops. Any such island under this size will be pruned.

pruningThresholdIslandWithStops

public final int pruningThresholdIslandWithStops

This field indicates the pruning threshold for islands with stops. Any such island under this size will be pruned.

banDiscouragedWalking

public final boolean banDiscouragedWalking

This field indicates whether walking should be allowed on OSM ways tagged with "foot=discouraged".

banDiscouragedBiking

public final boolean banDiscouragedBiking

This field indicates whether bicycling should be allowed on OSM ways tagged with "bicycle=discouraged".

maxTransferDistance

public final double maxTransferDistance

Transfers up to this length in meters will be pre-calculated and included in the Graph.

includeOsmTags

public final boolean includeOsmTags

extraEdgesStopPlatformLink

public final Boolean extraEdgesStopPlatformLink

This will add extra edges when linking a stop to a platform, to prevent detours along the platform edge.

micromobilityTravelRestrictionsUrlOrFile

public final String micromobilityTravelRestrictionsUrlOrFile

An optional url or file with GeoJson polygons that represent areas where micromobility travel is forbidden.

micromobilityDropoffRestrictionsUrlOrFile

public String micromobilityDropoffRestrictionsUrlOrFile

An optional url or file with GeoJson polygons that represent areas where micromobility vehicle rental dropoffs are forbidden.

readCachedElevations

public boolean readCachedElevations

When set to true (it is by default), the elevation module will attempt to read this file in order to reuse calculations of elevation data for various coordinate sequences instead of recalculating them all over again.

writeCachedElevations

public boolean writeCachedElevations

When set to true (it is false by default), the elevation module will create a file of a lookup map of the LineStrings and the corresponding calculated elevation data for those coordinates. Subsequent graph builds can reuse the data in this file to avoid recalculating all the elevation data again.

includeEllipsoidToGeoidDifference

public boolean includeEllipsoidToGeoidDifference

When set to true (it is false by default), the elevation module will include the Ellipsoid to Geiod difference in the calculations of every point along every StreetWithElevationEdge in the graph. NOTE: if this is set to true for graph building, make sure to not set the value of RoutingResource.geoidElevation to true otherwise OTP will add this geoid value again to all of the elevation values in the street edges.

multiThreadElevationCalculations

public boolean multiThreadElevationCalculations

Whether or not to multi-thread the elevation calculations in the elevation module. The default is set to false. For unknown reasons that seem to depend on data and machine settings, it might be faster to use a single processor. If multi-threading is activated, parallel streams will be used to calculate the elevations.

Constructor Detail

GraphBuilderParameters

public GraphBuilderParameters(com.fasterxml.jackson.databind.JsonNode config)

Set all parameters from the given Jackson JSON tree, applying defaults. Supplying MissingNode.getInstance() will cause all the defaults to be applied. This could be done automatically with the "reflective query scraper" but it's less type safe and less clear. Until that class is more type safe, it seems simpler to just list out the parameters by name here.