feat: ability to restrict VDF updates to a shapefile area (#247)

Author: tkchouaki

core/src/main/java/org/eqasim/core/simulation/vdf/VDFConfigGroup.java

@@ -26,6 +26,7 @@ public class VDFConfigGroup extends ReflectiveConfigGroup {
 
 	static private final String HANDLER = "handler";
 	static private final String INPUT_FILE = "inputFile";
+	static private final String UPDATE_AREA_SHAPEFILE = "updateAreaShapefile";
 	static private final String WRITE_INTERVAL = "writeInterval";
 	static private final String WRITE_FLOW_INTERVAL = "writeFlowInterval";
 
@@ -43,6 +44,7 @@ public class VDFConfigGroup extends ReflectiveConfigGroup {
 	private double capacityFactor = 1.0;
 
 	private String inputFile = null;
+	private String updateAreaShapefile = null;
 	private int writeInterval = 0;
 	private int writeFlowInterval = 0;
 
@@ -200,6 +202,16 @@ public void setInputFile(String inputFile) {
 		this.inputFile = inputFile;
 	}
 
+	@StringGetter(UPDATE_AREA_SHAPEFILE)
+	public String getUpdateAreaShapefile() {
+		return updateAreaShapefile;
+	}
+
+	@StringSetter(UPDATE_AREA_SHAPEFILE)
+	public void setUpdateAreaShapefile(String updateAreaShapefile) {
+		this.updateAreaShapefile = updateAreaShapefile;
+	}
+
 	@StringGetter(WRITE_INTERVAL)
 	public int getWriteInterval() {
 		return writeInterval;

core/src/main/java/org/eqasim/core/simulation/vdf/VDFModule.java

@@ -1,8 +1,13 @@
 package org.eqasim.core.simulation.vdf;
 
+import java.io.File;
+import java.io.IOException;
 import java.net.URL;
+import java.util.Optional;
 
 import org.eqasim.core.components.config.EqasimConfigGroup;
+import org.eqasim.core.scenario.cutter.extent.ScenarioExtent;
+import org.eqasim.core.scenario.cutter.extent.ShapeScenarioExtent;
 import org.eqasim.core.simulation.vdf.handlers.VDFHorizonHandler;
 import org.eqasim.core.simulation.vdf.handlers.VDFInterpolationHandler;
 import org.eqasim.core.simulation.vdf.handlers.VDFTrafficHandler;
@@ -64,9 +69,10 @@ public VDFScope provideVDFScope(VDFConfigGroup config) {
 	@Provides
 	@Singleton
 	public VDFTravelTime provideVDFTravelTime(VDFConfigGroup config, VDFScope scope, Network network,
-			VolumeDelayFunction vdf, QSimConfigGroup qsimConfig, EqasimConfigGroup eqasimConfig) {
+			VolumeDelayFunction vdf, QSimConfigGroup qsimConfig, EqasimConfigGroup eqasimConfig) throws IOException {
+		ScenarioExtent updateExtent = config.getUpdateAreaShapefile() == null ? null : new ShapeScenarioExtent.Builder(new File(ConfigGroup.getInputFileURL(getConfig().getContext(), config.getUpdateAreaShapefile()).getPath()), Optional.empty(), Optional.empty()).build();
 		return new VDFTravelTime(scope, config.getMinimumSpeed(), config.getCapacityFactor(),
-				eqasimConfig.getSampleSize(), network, vdf, eqasimConfig.getCrossingPenalty());
+				eqasimConfig.getSampleSize(), network, vdf, eqasimConfig.getCrossingPenalty(), updateExtent);
 	}
 
 	@Provides

core/src/main/java/org/eqasim/core/simulation/vdf/VDFUpdateListener.java

@@ -85,7 +85,7 @@ public void notifyStartup(StartupEvent event) {
 
 			IdMap<Link, List<Double>> data = handler.aggregate();
 			scope.verify(data, "Wrong flow format");
-			travelTime.update(data);
+			travelTime.update(data, true);
 
 			logger.info("  Done");
 		}

core/src/main/java/org/eqasim/core/simulation/vdf/travel_time/VDFTravelTime.java

@@ -7,6 +7,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.eqasim.core.scenario.cutter.extent.ScenarioExtent;
 import org.eqasim.core.simulation.vdf.VDFScope;
 import org.eqasim.core.simulation.vdf.travel_time.function.VolumeDelayFunction;
 import org.matsim.api.core.v01.Id;
@@ -27,18 +28,25 @@ public class VDFTravelTime implements TravelTime {
 
 	private final Network network;
 	private final VolumeDelayFunction vdf;
+	private final ScenarioExtent updateAreaExtent;
 
 	private final IdMap<Link, List<Double>> travelTimes = new IdMap<>(Link.class);
 
 	private final Logger logger = LogManager.getLogger(VDFTravelTime.class);
 
-	public VDFTravelTime(VDFScope scope, double minimumSpeed, double capacityFacotor, double samplingRate,
-			Network network, VolumeDelayFunction vdf, double crossingPenalty) {
+	public VDFTravelTime(VDFScope scope, double minimumSpeed, double capacityFactor, double samplingRate,
+						 Network network, VolumeDelayFunction vdf, double crossingPenalty) {
+		this(scope, minimumSpeed, capacityFactor, samplingRate, network, vdf, crossingPenalty, null);
+	}
+
+	public VDFTravelTime(VDFScope scope, double minimumSpeed, double capacityFactor, double samplingRate,
+			Network network, VolumeDelayFunction vdf, double crossingPenalty, ScenarioExtent updateAreaExtent) {
 		this.scope = scope;
 		this.network = network;
 		this.vdf = vdf;
+		this.updateAreaExtent = updateAreaExtent;
 		this.minimumSpeed = minimumSpeed;
-		this.capacityFactor = capacityFacotor;
+		this.capacityFactor = capacityFactor;
 		this.samplingRate = samplingRate;
 		this.crossingPenalty = crossingPenalty;
 
@@ -57,13 +65,32 @@ public double getLinkTravelTime(Link link, double time, Person person, Vehicle v
 	}
 
 	public void update(IdMap<Link, List<Double>> counts) {
-		logger.info(String.format("Updating VDFTravelTime ..."));
+		update(counts, false);
+	}
+
+	public void update(IdMap<Link, List<Double>> counts, boolean forceUpdateAllLinks) {
+		String logMessage = "Updating VDFTravelTime ";
+		if(updateAreaExtent != null && !forceUpdateAllLinks) {
+			logMessage += " using update extent ...";
+		} else {
+			logMessage += " ...";
+		}
+		logger.info(logMessage);
 
 		long totalCount = counts.size() * scope.getIntervals();
 		long nonFreespeedCount = 0;
 
 		for (Map.Entry<Id<Link>, List<Double>> entry : counts.entrySet()) {
 			Link link = network.getLinks().get(entry.getKey());
+			if(link == null) {
+				continue;
+			}
+
+			if(updateAreaExtent != null && !forceUpdateAllLinks) {
+				if(!updateAreaExtent.isInside(link.getFromNode().getCoord()) || !updateAreaExtent.isInside(link.getToNode().getCoord())) {
+					continue;
+				}
+			}
 
 			List<Double> linkCounts = entry.getValue();
 			List<Double> linkTravelTimes = travelTimes.get(entry.getKey());