org.matsim.analysis.TravelDistanceStats Class Reference

Public Member Functions
void	addIteration (int iteration, IdMap< Person, Plan > map)
void	close ()

Private Member Functions
	TravelDistanceStats (ControllerConfigGroup controllerConfigGroup, String travelDistanceStatsFileName, String legStatsPngName, String tripStatsPngName, String delimiter)
void	initWriter (String travelDistanceStatsFileName)
void	initStats (ControllerConfigGroup controllerConfigGroup)
void	writeCsvHeader () throws IOException
void	writeCsvEntry (int iteration)
void	writeTripStatsPng (int iteration)
void	writeLegStatsPng (int iteration)

Static Private Member Functions
static DoubleSummaryStatistics	getTripStats (IdMap< Person, Plan > map)
static DoubleSummaryStatistics	getLegStats (IdMap< Person, Plan > map)

Private Attributes
final ControllerConfigGroup	controllerConfigGroup
BufferedWriter	out
final String	legStatsPngName
final String	tripStatsPngName
final String	delimiter
Map< Integer, DoubleSummaryStatistics >	legStats
Map< Integer, DoubleSummaryStatistics >	tripStats

Static Private Attributes
static final int	MAX_ITERATIONS_IN_GRAPH = 5000
static final Logger	log = LogManager.getLogger(TravelDistanceStats.class)

Detailed Description

Calculates at the end of each iteration the following statistics:

• average of the average leg distance per plan

Is used by the standard Controler and fed the "really executed" "plans" which are generated from Events during the simulation and which are also used by the scoring. But you can also use it on other kinds of plans from your own code.

Author

anhorni, michaz, jbischoff

Definition at line 58 of file TravelDistanceStats.java.

Constructor & Destructor Documentation

TravelDistanceStats()

org.matsim.analysis.TravelDistanceStats.TravelDistanceStats ( ControllerConfigGroup  controllerConfigGroup, String  travelDistanceStatsFileName, String  legStatsPngName, String  tripStatsPngName, String  delimiter  )

private

Definition at line 81 of file TravelDistanceStats.java.

References org.matsim.analysis.TravelDistanceStats.controllerConfigGroup, org.matsim.analysis.TravelDistanceStats.delimiter, org.matsim.analysis.TravelDistanceStats.initStats(), org.matsim.analysis.TravelDistanceStats.initWriter(), org.matsim.analysis.TravelDistanceStats.legStatsPngName, and org.matsim.analysis.TravelDistanceStats.tripStatsPngName.

                                                                           {
        this.controllerConfigGroup = controllerConfigGroup;
        this.legStatsPngName = legStatsPngName;
        this.tripStatsPngName = tripStatsPngName;
        this.delimiter = delimiter;
        initStats(controllerConfigGroup);
        initWriter(travelDistanceStatsFileName);
    }

Here is the call graph for this function:

Member Function Documentation

initWriter()

void org.matsim.analysis.TravelDistanceStats.initWriter ( String  travelDistanceStatsFileName )

private

Definition at line 91 of file TravelDistanceStats.java.

References org.matsim.core.utils.io.IOUtils.getBufferedWriter(), and org.matsim.analysis.TravelDistanceStats.writeCsvHeader().

Referenced by org.matsim.analysis.TravelDistanceStats.TravelDistanceStats().

                                                                {
        if (travelDistanceStatsFileName.toLowerCase(Locale.ROOT).endsWith(".csv")) {
            this.out = IOUtils.getBufferedWriter(travelDistanceStatsFileName);
        } else {
            this.out = IOUtils.getBufferedWriter(travelDistanceStatsFileName + ".csv");
        }

        try {
            writeCsvHeader();
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

Here is the call graph for this function:

initStats()

void org.matsim.analysis.TravelDistanceStats.initStats ( ControllerConfigGroup  controllerConfigGroup )

private

Definition at line 105 of file TravelDistanceStats.java.

References org.matsim.core.config.groups.ControllerConfigGroup.getFirstIteration(), and org.matsim.core.config.groups.ControllerConfigGroup.getLastIteration().

Referenced by org.matsim.analysis.TravelDistanceStats.TravelDistanceStats().

                                                                        {
        int expectedIterations = controllerConfigGroup.getLastIteration() - controllerConfigGroup.getFirstIteration();
        this.legStats = new HashMap<>(expectedIterations+1);
        this.tripStats = new HashMap<>(expectedIterations+1);
    }

Here is the call graph for this function:

addIteration()

void org.matsim.analysis.TravelDistanceStats.addIteration	(	int	iteration,
		IdMap< Person, Plan >	map
	)

Definition at line 111 of file TravelDistanceStats.java.

References org.matsim.analysis.TravelDistanceStats.getLegStats(), org.matsim.analysis.TravelDistanceStats.getTripStats(), org.matsim.analysis.TravelDistanceStats.MAX_ITERATIONS_IN_GRAPH, org.matsim.api.core.v01.IdMap< T, V >.size, and org.matsim.analysis.TravelDistanceStats.writeCsvEntry().

                                                                     {
        DoubleSummaryStatistics legStats = getLegStats(map);
        DoubleSummaryStatistics tripStats = getTripStats(map);

        log.info("-- average leg distance per plan (executed plans only): " + legStats.getAverage() + " meters");
        log.info("average leg distance per Person (executed plans only): " + legStats.getSum() / map.size() + " meters (statistic on all " + legStats.getCount() + " legs which have a finite distance)");
        log.info("-- average trip distance per plan (executed plans only): " + tripStats.getAverage() + " meters");
        log.info("average trip distance per Person (executed plans only): " + tripStats.getSum() / map.size() + " meters (statistic on all " + tripStats.getCount() + " trips which have a finite distance)");
        log.info("(TravelDistanceStats takes an average over all legs where the simulation reports travelled (network) distances");
        log.info("(and teleported legs whose route contains a distance.)");// TODO: still valid?

        this.legStats.put(iteration, legStats);
        this.tripStats.put(iteration, tripStats);

        assert this.legStats.size() == this.tripStats.size();
    }

Here is the call graph for this function:

writeCsvHeader()

void org.matsim.analysis.TravelDistanceStats.writeCsvHeader ( ) throws IOException

private

Definition at line 136 of file TravelDistanceStats.java.

Referenced by org.matsim.analysis.TravelDistanceStats.initWriter().

                                                     {
        this.out.write("ITERATION" + this.delimiter + "avg. Average Leg distance" + this.delimiter + "avg. Average Trip distance\n");
        this.out.flush();
    }

writeCsvEntry()

void org.matsim.analysis.TravelDistanceStats.writeCsvEntry ( int  iteration )

private

Definition at line 141 of file TravelDistanceStats.java.

References org.matsim.analysis.TravelDistanceStats.writeLegStatsPng(), and org.matsim.analysis.TravelDistanceStats.writeTripStatsPng().

Referenced by org.matsim.analysis.TravelDistanceStats.addIteration().

                                              {
        DoubleSummaryStatistics legStats = this.legStats.get(iteration);
        DoubleSummaryStatistics tripStats = this.tripStats.get(iteration);

        try {
            this.out.write(iteration + this.delimiter + legStats.getAverage() + this.delimiter + tripStats.getAverage() + "\n");
            this.out.flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

Here is the call graph for this function:

writeTripStatsPng()

void org.matsim.analysis.TravelDistanceStats.writeTripStatsPng ( int  iteration )

private

Definition at line 158 of file TravelDistanceStats.java.

References org.matsim.core.utils.charts.ChartUtil.addMatsimLogo(), org.matsim.core.utils.charts.XYLineChart.addSeries(), org.matsim.core.config.groups.ControllerConfigGroup.getFirstIteration(), and org.matsim.core.utils.charts.ChartUtil.saveAsPng().

Referenced by org.matsim.analysis.TravelDistanceStats.writeCsvEntry().

                                                  {
        if (iteration == controllerConfigGroup.getFirstIteration()){
            return;
        }

        // create chart when data of more than one iteration is available.
        XYLineChart chart = new XYLineChart("Trip Travel Distance Statistics", "iteration", "average of the average trip distance per plan ");
        double[] iterations = new double[iteration + 1];
        double[] values = new double[iteration + 1];

        for (int i = 0; i <= iteration; i++) {
            iterations[i] = i + controllerConfigGroup.getFirstIteration();
            values[i] = Optional.ofNullable(this.tripStats.get(i)).map(DoubleSummaryStatistics::getAverage).orElse(0.);
        }

        chart.addSeries("executed plan", iterations, values);
        chart.addMatsimLogo();
        chart.saveAsPng(this.tripStatsPngName + ".png", 800, 600);
    }

Here is the call graph for this function:

writeLegStatsPng()

void org.matsim.analysis.TravelDistanceStats.writeLegStatsPng ( int  iteration )

private

Definition at line 178 of file TravelDistanceStats.java.

References org.matsim.core.utils.charts.ChartUtil.addMatsimLogo(), org.matsim.core.utils.charts.XYLineChart.addSeries(), org.matsim.core.config.groups.ControllerConfigGroup.getFirstIteration(), and org.matsim.core.utils.charts.ChartUtil.saveAsPng().

Referenced by org.matsim.analysis.TravelDistanceStats.writeCsvEntry().

                                                 {
        if (iteration == controllerConfigGroup.getFirstIteration()){
            return;
        }

        // create chart when data of more than one iteration is available.
        XYLineChart chart = new XYLineChart("Leg Travel Distance Statistics", "iteration", "average of the average leg distance per plan ");
        double[] iterations = new double[iteration + 1];
        double[] values = new double[iteration + 1];

        for (int i = 0; i <= iteration; i++) {
            iterations[i] = i + controllerConfigGroup.getFirstIteration();
            values[i] = Optional.ofNullable(this.legStats.get(i)).map(DoubleSummaryStatistics::getAverage).orElse(0.);

        }

        chart.addSeries("executed plan", iterations, values);
        chart.addMatsimLogo();
        chart.saveAsPng(this.legStatsPngName + ".png", 800, 600);
    }

Here is the call graph for this function:

getTripStats()

static DoubleSummaryStatistics org.matsim.analysis.TravelDistanceStats.getTripStats ( IdMap< Person, Plan >  map )

staticprivate

Definition at line 199 of file TravelDistanceStats.java.

References org.matsim.core.router.TripStructureUtils.Trip.getTripElements(), org.matsim.core.router.TripStructureUtils.getTrips(), and org.matsim.api.core.v01.IdMap< T, V >.values().

Referenced by org.matsim.analysis.TravelDistanceStats.addIteration().

                                                                                 {
        return map.values()
                  .parallelStream()
                  .flatMap(plan -> TripStructureUtils.getTrips(plan).stream())
                  .mapToDouble(t -> {
                      Trip trip = (Trip) t;
                      return trip.getTripElements()
                                 .stream()
                                 .filter(Leg.class::isInstance)
                                 .collect(Collectors.summingDouble(l -> {
                                     Leg leg = (Leg) l;
                                     // TODO NaN handling of Collectors.summingDouble will lead to many NaNs... rethink
                                     return leg.getRoute() != null ? leg.getRoute().getDistance() : Double.NaN;
                                 }));
                  })
                  // the following means trips with infinite distance are silently ignored.
                  .filter(Double::isFinite)
                  .summaryStatistics();
    }

Here is the call graph for this function:

getLegStats()

static DoubleSummaryStatistics org.matsim.analysis.TravelDistanceStats.getLegStats ( IdMap< Person, Plan >  map )

staticprivate

Definition at line 219 of file TravelDistanceStats.java.

References org.matsim.api.core.v01.population.Route.getDistance(), org.matsim.api.core.v01.population.Leg.getRoute(), and org.matsim.api.core.v01.IdMap< T, V >.values().

Referenced by org.matsim.analysis.TravelDistanceStats.addIteration().

                                                                                {
        return map.values()
                  //TODO: This probably doesn't control how many threads parallelStream is using despite the number of threads setting in config
                  .parallelStream()
                  .flatMap(plan -> plan.getPlanElements().stream())
                  .filter(Leg.class::isInstance)
                  .mapToDouble(l -> {
                      Leg leg = (Leg) l;
                      return leg.getRoute() != null ? leg.getRoute().getDistance() : Double.NaN;
                  })
                  // the following means legs with infinite distance are ignored
                  .filter(Double::isFinite)
                  .summaryStatistics();
    }

Here is the call graph for this function:

close()

void org.matsim.analysis.TravelDistanceStats.close

(

)

Definition at line 234 of file TravelDistanceStats.java.

                        {
        try {
            this.out.close();
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

Member Data Documentation

MAX_ITERATIONS_IN_GRAPH

final int org.matsim.analysis.TravelDistanceStats.MAX_ITERATIONS_IN_GRAPH = 5000

staticprivate

Definition at line 60 of file TravelDistanceStats.java.

Referenced by org.matsim.analysis.TravelDistanceStats.addIteration().

controllerConfigGroup

final ControllerConfigGroup org.matsim.analysis.TravelDistanceStats.controllerConfigGroup

private

Definition at line 62 of file TravelDistanceStats.java.

Referenced by org.matsim.analysis.TravelDistanceStats.TravelDistanceStats().

out

BufferedWriter org.matsim.analysis.TravelDistanceStats.out

private

Definition at line 63 of file TravelDistanceStats.java.

legStatsPngName

final String org.matsim.analysis.TravelDistanceStats.legStatsPngName

private

Definition at line 64 of file TravelDistanceStats.java.

Referenced by org.matsim.analysis.TravelDistanceStats.TravelDistanceStats().

tripStatsPngName

final String org.matsim.analysis.TravelDistanceStats.tripStatsPngName

private

Definition at line 65 of file TravelDistanceStats.java.

Referenced by org.matsim.analysis.TravelDistanceStats.TravelDistanceStats().

delimiter

final String org.matsim.analysis.TravelDistanceStats.delimiter

private

Definition at line 66 of file TravelDistanceStats.java.

Referenced by org.matsim.analysis.TravelDistanceStats.TravelDistanceStats().

legStats

Map<Integer, DoubleSummaryStatistics> org.matsim.analysis.TravelDistanceStats.legStats

private

Definition at line 68 of file TravelDistanceStats.java.

tripStats

Map<Integer, DoubleSummaryStatistics> org.matsim.analysis.TravelDistanceStats.tripStats

private

Definition at line 69 of file TravelDistanceStats.java.

log

final Logger org.matsim.analysis.TravelDistanceStats.log = LogManager.getLogger(TravelDistanceStats.class)

staticprivate

Definition at line 71 of file TravelDistanceStats.java.

---

The documentation for this class was generated from the following file:

• analysis/TravelDistanceStats.java