Merge branch 'master' into dependabot/maven/org.apache.maven.plugins-…

…maven-surefire-report-plugin-3.5.0
matsim-org · Sep 19, 2024 · 572f797 · 572f797
2 parents d8c5563 + 6faf99e
commit 572f797
Show file tree

Hide file tree

Showing 4 changed files with 207 additions and 3 deletions.
diff --git a/...bs/application/src/main/java/org/matsim/application/analysis/population/TripAnalysis.java b/...bs/application/src/main/java/org/matsim/application/analysis/population/TripAnalysis.java
@@ -2,6 +2,8 @@
 
 import it.unimi.dsi.fastutil.ints.IntArrayList;
 import it.unimi.dsi.fastutil.ints.IntList;
+import it.unimi.dsi.fastutil.ints.IntOpenHashSet;
+import it.unimi.dsi.fastutil.ints.IntSet;
 import it.unimi.dsi.fastutil.objects.Object2IntLinkedOpenHashMap;
 import it.unimi.dsi.fastutil.objects.Object2IntMap;
 import it.unimi.dsi.fastutil.objects.Object2LongMap;
@@ -55,15 +57,15 @@ public class TripAnalysis implements MATSimAppCommand {
 	/**
 	 * Attributes which relates this person to a reference person.
 	 */
-	public static String ATTR_REF_ID = "ref_id";
+	public static final String ATTR_REF_ID = "ref_id";
 	/**
 	 * Person attribute that contains the reference modes of a person. Multiple modes are delimited by "-".
 	 */
-	public static String ATTR_REF_MODES = "ref_modes";
+	public static final String ATTR_REF_MODES = "ref_modes";
 	/**
 	 * Person attribute containing its weight for analysis purposes.
 	 */
-	public static String ATTR_REF_WEIGHT = "ref_weight";
+	public static final String ATTR_REF_WEIGHT = "ref_weight";
 
 	@CommandLine.Mixin
 	private InputOptions input = InputOptions.ofCommand(TripAnalysis.class);
@@ -85,6 +87,10 @@ public class TripAnalysis implements MATSimAppCommand {
 	@CommandLine.Option(names = "--shp-filter", description = "Define how the shp file filtering should work", defaultValue = "home")
 	private LocationFilter filter;
 
+	@CommandLine.Option(names = "--person-filter", description = "Define which persons should be included into trip analysis. Map like: Attribute name (key), attribute value (value). " +
+		"The attribute needs to be contained by output_persons.csv. Persons who do not match all filters are filtered out.", split = ",")
+	private final Map<String, String> personFilters = new HashMap<>();
+
 	@CommandLine.Mixin
 	private ShpOptions shp;
 
@@ -146,6 +152,43 @@ public Integer call() throws Exception {
 			persons = persons.where(persons.textColumn("person").matchesRegex(matchId));
 		}
 
+//		filter persons according to person (attribute) filter
+		if (!personFilters.isEmpty()) {
+			IntSet generalFilteredRowIds = null;
+			for (Map.Entry<String, String> entry : personFilters.entrySet()) {
+				if (!persons.containsColumn(entry.getKey())) {
+					log.warn("Persons table does not contain column for filter attribute {}. Filter on {} will not be applied.", entry.getKey(), entry.getValue());
+					continue;
+				}
+				log.info("Using person filter for attribute {} and value {}", entry.getKey(), entry.getValue());
+
+				IntSet filteredRowIds = new IntOpenHashSet();
+
+				for (int i = 0; i < persons.rowCount(); i++) {
+					Row row = persons.row(i);
+					String value = row.getString(entry.getKey());
+//					only add value once
+					if (value.equals(entry.getValue())) {
+						filteredRowIds.add(i);
+					}
+				}
+
+				if (generalFilteredRowIds == null) {
+					// If generalFilteredRowIds is empty, add all elements from filteredRowIds to generalFilteredRowIds
+					generalFilteredRowIds = filteredRowIds;
+				} else {
+					// If generalFilteredRowIds is not empty, retain only the elements that are also in filteredRowIds
+					generalFilteredRowIds.retainAll(filteredRowIds);
+				}
+			}
+
+			if (generalFilteredRowIds != null) {
+				persons = persons.where(Selection.with(generalFilteredRowIds.intStream().toArray()));
+			}
+		}
+
+		log.info("Filtered {} out of {} persons", persons.rowCount(), total);
+
 		// Home filter by standard attribute
 		if (shp.isDefined() && filter == LocationFilter.home) {
 			Geometry geometry = shp.getGeometry();

diff --git a/...pplication/src/test/java/org/matsim/application/analysis/population/TripAnalysisTest.java b/...pplication/src/test/java/org/matsim/application/analysis/population/TripAnalysisTest.java
@@ -0,0 +1,131 @@
+package org.matsim.application.analysis.population;
+
+import org.apache.commons.csv.CSVFormat;
+import org.apache.commons.csv.CSVPrinter;
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.matsim.application.options.CsvOptions;
+import org.matsim.core.utils.io.IOUtils;
+import org.matsim.testcases.MatsimTestUtils;
+import tech.tablesaw.api.ColumnType;
+import tech.tablesaw.api.StringColumn;
+import tech.tablesaw.api.Table;
+import tech.tablesaw.io.csv.CsvReadOptions;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Map;
+
+class TripAnalysisTest {
+	@RegisterExtension
+	private final MatsimTestUtils utils = new MatsimTestUtils();
+	private final CsvOptions csv = new CsvOptions(CSVFormat.Predefined.Default);
+
+	@Test
+	void defaultParametersTest() throws IOException {
+
+		writeInputCsvFiles();
+
+		new TripAnalysis().execute("--input-trips", Path.of(utils.getInputDirectory(), "trips.csv").toString(),
+			"--input-persons", Path.of(utils.getInputDirectory(), "persons.csv").toString(),
+			"--output-mode-share", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share.csv").toString(),
+			"--output-mode-share-per-dist", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share_per_dist.csv").toString(),
+			"--output-mode-users", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_users.csv").toString(),
+			"--output-trip-stats", Path.of(utils.getOutputDirectory(), "analysis", "population", "trip_stats.csv").toString(),
+			"--output-population-trip-stats", Path.of(utils.getOutputDirectory(), "analysis", "population", "population_trip_stats.csv").toString(),
+			"--output-trip-purposes-by-hour", Path.of(utils.getOutputDirectory(), "analysis", "population", "trip_purposes_by_hour.csv").toString(),
+			"--output-mode-share-distance-distribution", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share_distance_distribution.csv").toString(),
+			"--output-mode-choices", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_choices.csv").toString(),
+			"--output-mode-choice-evaluation", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_choice_evaluation.csv").toString(),
+			"--output-mode-choice-evaluation-per-mode", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_choice_evaluation_per_mode.csv").toString(),
+			"--output-mode-confusion-matrix", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_confusion_matrix.csv").toString(),
+			"--output-mode-prediction-error", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_prediction_error.csv").toString());
+
+		Path out = Path.of(utils.getOutputDirectory(), "analysis", "population");
+
+		Assertions.assertThat(out)
+			.isDirectoryContaining("glob:**trip_stats.csv")
+			.isDirectoryContaining("glob:**mode_share.csv")
+			.isDirectoryContaining("glob:**mode_share_per_dist.csv")
+			.isDirectoryContaining("glob:**mode_users.csv")
+			.isDirectoryContaining("glob:**population_trip_stats.csv")
+			.isDirectoryContaining("glob:**trip_purposes_by_hour.csv")
+			.isDirectoryContaining("glob:**mode_share_distance_distribution.csv");
+
+		Path.of(utils.getInputDirectory()).toFile().delete();
+	}
+
+	@Test
+	void personFilterTest() throws IOException {
+
+		writeInputCsvFiles();
+
+		new TripAnalysis().execute("--person-filter", "subpopulation=person",
+			"--input-trips", Path.of(utils.getInputDirectory(), "trips.csv").toString(),
+			"--input-persons", Path.of(utils.getInputDirectory(), "persons.csv").toString(),
+			"--output-mode-share", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share.csv").toString(),
+			"--output-mode-share-per-dist", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share_per_dist.csv").toString(),
+			"--output-mode-users", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_users.csv").toString(),
+			"--output-trip-stats", Path.of(utils.getOutputDirectory(), "analysis", "population", "trip_stats.csv").toString(),
+			"--output-population-trip-stats", Path.of(utils.getOutputDirectory(), "analysis", "population", "population_trip_stats.csv").toString(),
+			"--output-trip-purposes-by-hour", Path.of(utils.getOutputDirectory(), "analysis", "population", "trip_purposes_by_hour.csv").toString(),
+			"--output-mode-share-distance-distribution", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share_distance_distribution.csv").toString(),
+			"--output-mode-choices", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_choices.csv").toString(),
+			"--output-mode-choice-evaluation", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_choice_evaluation.csv").toString(),
+			"--output-mode-choice-evaluation-per-mode", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_choice_evaluation_per_mode.csv").toString(),
+			"--output-mode-confusion-matrix", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_confusion_matrix.csv").toString(),
+			"--output-mode-prediction-error", Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_prediction_error.csv").toString());
+
+		Path out = Path.of(utils.getOutputDirectory(), "analysis", "population");
+
+		Assertions.assertThat(out)
+			.isDirectoryContaining("glob:**trip_stats.csv")
+			.isDirectoryContaining("glob:**mode_share.csv")
+			.isDirectoryContaining("glob:**mode_share_per_dist.csv")
+			.isDirectoryContaining("glob:**mode_users.csv")
+			.isDirectoryContaining("glob:**population_trip_stats.csv")
+			.isDirectoryContaining("glob:**trip_purposes_by_hour.csv")
+			.isDirectoryContaining("glob:**mode_share_distance_distribution.csv");
+
+		Table modeShare = Table.read().csv(CsvReadOptions.builder(IOUtils.getBufferedReader(Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share.csv").toString()))
+			.columnTypesPartial(Map.of("person", ColumnType.TEXT))
+			.sample(false)
+			.separator(CsvOptions.detectDelimiter(Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share.csv").toString())).build());
+
+		StringColumn mainMode = modeShare.stringColumn("main_mode");
+
+//		only 1 row with values
+		Assertions.assertThat(modeShare.rowCount()).isEqualTo(1);
+		//		only mode car, no mode goods in mode share stats
+		Assertions.assertThat(mainMode.get(0)).isEqualTo("car");
+
+		Path.of(utils.getInputDirectory()).toFile().delete();
+	}
+
+	private void writeInputCsvFiles() throws IOException {
+		Path persons = Path.of(utils.getInputDirectory()).resolve("persons.csv");
+		Files.createDirectories(persons.getParent());
+		CSVPrinter printer = csv.createPrinter(persons);
+
+//		print dummy persons
+		printer.printRecord("person", "executed_score", "first_act_x", "first_act_y", "first_act_type", "age", "carAvail", "home_x", "home_y", "householdIncome", "householdSize",
+			"income", "sex", "sim_ptAbo", "sim_regionType", "subpopulation", "purpose", "tourStartArea", "vehicleTypes");
+		printer.printRecord("100", "-130.69951448065348", "369956.19", "5776578.61", "home_49200", "50", "always", "369956.19", "5776578.61", "5", "2", "1159.0", "f", "none", "124", "person", "", "", "");
+		printer.printRecord("100_goodsTraffic", "-130.69951448065348", "369956.19", "5776578.61", "home_49200", "50", "always", "369956.19", "5776578.61", "5", "2", "1159.0", "f", "none", "124", "goodsTraffic", "", "", "");
+		printer.close();
+
+//		print dummy trips
+		printer = csv.createPrinter(Path.of(utils.getInputDirectory(), "trips.csv"));
+		printer.printRecord("person", "trip_number", "trip_id", "dep_time", "trav_time", "wait_time", "traveled_distance", "euclidean_distance", "main_mode", "longest_distance_mode",
+			"modes", "start_activity_type", "end_activity_type", "start_facility_id", "start_link", "start_x", "start_y", "end_facility_id", "end_link", "end_x", "end_y", "first_pt_boarding_stop", "last_pt_egress_stop");
+		printer.printRecord("100", "1", "100_1", "13:57:42", "00:34:07", "00:00:00", "53025", "34976", "car", "car", "walk-car-walk", "home_49200", "errands_3600", "null", "-199781090",
+			"369956.19", "5776578.61", "null", "152273276", "401592.51", "5761661.71", "", "");
+		printer.printRecord("100", "2", "100_2", "15:42:50", "01:01:52", "00:00:00", "78917", "54643", "car", "car", "walk-car-walk", "errands_3600", "errands_4200", "null", "152273276",
+			"401592.51", "5761661.71", "null", "-366338372", "455444.34", "5752394.08", "", "");
+		printer.printRecord("100_goodsTraffic", "1", "100_1", "13:57:42", "00:34:07", "00:00:00", "53025", "34976", "goods", "goods", "walk-goods-walk", "home_49200", "errands_3600", "null", "-199781090",
+			"369956.19", "5776578.61", "null", "152273276", "401592.51", "5761661.71", "", "");
+		printer.close();
+	}
+}
diff --git a/...tensions/src/main/java/org/matsim/contrib/drt/extension/DrtWithExtensionsConfigGroup.java b/...tensions/src/main/java/org/matsim/contrib/drt/extension/DrtWithExtensionsConfigGroup.java
@@ -20,11 +20,14 @@
 package org.matsim.contrib.drt.extension;
 
 import java.util.Optional;
+import java.util.function.Supplier;
 
 import javax.annotation.Nullable;
 
 import org.matsim.contrib.drt.extension.companions.DrtCompanionParams;
 import org.matsim.contrib.drt.extension.operations.DrtOperationsParams;
+import org.matsim.contrib.drt.optimizer.constraints.DefaultDrtOptimizationConstraintsSet;
+import org.matsim.contrib.drt.optimizer.constraints.DrtOptimizationConstraintsSet;
 import org.matsim.contrib.drt.run.DrtConfigGroup;
 
 /**
@@ -41,6 +44,11 @@ public class DrtWithExtensionsConfigGroup extends DrtConfigGroup {
 	private DrtOperationsParams drtOperationsParams;
 
 	public DrtWithExtensionsConfigGroup() {
+		this(DefaultDrtOptimizationConstraintsSet::new);
+	}
+
+	public DrtWithExtensionsConfigGroup(Supplier<DrtOptimizationConstraintsSet> drtOptimizationConstraintsSetSupplier) {
+		super(drtOptimizationConstraintsSetSupplier);
 		// Optional
 		addDefinition(DrtCompanionParams.SET_NAME, DrtCompanionParams::new, () -> drtCompanionParams,
 				params -> drtCompanionParams = (DrtCompanionParams) params);

diff --git a/contribs/simwrapper/src/test/java/org/matsim/simwrapper/dashboard/DashboardTests.java b/contribs/simwrapper/src/test/java/org/matsim/simwrapper/dashboard/DashboardTests.java
@@ -4,15 +4,20 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 import org.matsim.application.MATSimApplication;
+import org.matsim.application.options.CsvOptions;
 import org.matsim.core.config.Config;
 import org.matsim.core.config.ConfigUtils;
 import org.matsim.core.controler.Controler;
+import org.matsim.core.utils.io.IOUtils;
 import org.matsim.simwrapper.Dashboard;
 import org.matsim.simwrapper.SimWrapper;
 import org.matsim.simwrapper.SimWrapperConfigGroup;
 import org.matsim.simwrapper.TestScenario;
 import org.matsim.testcases.MatsimTestUtils;
+import tech.tablesaw.api.Table;
+import tech.tablesaw.io.csv.CsvReadOptions;
 
+import java.io.IOException;
 import java.nio.file.Path;
 import java.util.Set;
 
@@ -72,6 +77,23 @@ void trip() {
 			.isDirectoryContaining("glob:**mode_share.csv");
 	}
 
+	@Test
+	void tripPersonFilter() throws IOException {
+
+		Path out = Path.of(utils.getOutputDirectory(), "analysis", "population");
+
+		run(new TripDashboard().setAnalysisArgs("--person-filter", "subpopulation=person"));
+		Assertions.assertThat(out)
+			.isDirectoryContaining("glob:**trip_stats.csv")
+			.isDirectoryContaining("glob:**mode_share.csv");
+
+		Table tripStats = Table.read().csv(CsvReadOptions.builder(IOUtils.getBufferedReader(Path.of(utils.getOutputDirectory(), "analysis", "population", "trip_stats.csv").toString()))
+			.sample(false)
+			.separator(CsvOptions.detectDelimiter(Path.of(utils.getOutputDirectory(), "analysis", "population", "mode_share.csv").toString())).build());
+
+		Assertions.assertThat(tripStats.containsColumn("freight")).isFalse();
+	}
+
 	@Test
 	void tripRef() {