org.opentripplanner.ext.transferanalyzer.DirectTransferAnalyzer Maven / Gradle / Ivy

Go to download
package org.opentripplanner.ext.transferanalyzer;

import com.google.common.collect.Iterables;
import org.locationtech.jts.geom.Coordinate;
import org.opentripplanner.ext.transferanalyzer.annotations.TransferCouldNotBeRouted;
import org.opentripplanner.ext.transferanalyzer.annotations.TransferRoutingDistanceTooLong;
import org.opentripplanner.graph_builder.DataImportIssueStore;
import org.opentripplanner.graph_builder.services.GraphBuilderModule;
import org.opentripplanner.model.Stop;
import org.opentripplanner.routing.graph.Graph;
import org.opentripplanner.routing.graph.GraphIndex;
import org.opentripplanner.routing.graphfinder.DirectGraphFinder;
import org.opentripplanner.routing.graphfinder.NearbyStop;
import org.opentripplanner.routing.graphfinder.StreetGraphFinder;
import org.opentripplanner.routing.vertextype.TransitStopVertex;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Module used for analyzing the transfers between nearby stops generated by routing via OSM data.
 * It creates data import issues both for nearby stops that cannot be routed between and instances
 * where the street routing distance is unusually long compared to the euclidean distance (sorted
 * by the ratio between the two distances). These lists can typically be used to improve the quality
 * of OSM data for transfer purposes. This can take a long time if the transfer distance is long
 * and/or there are many stops to route between.
 */
public class DirectTransferAnalyzer implements GraphBuilderModule {

    private static final int RADIUS_MULTIPLIER = 5;

    private static final int MIN_RATIO_TO_LOG = 2;

    private static final int MIN_STREET_DISTANCE_TO_LOG = 100;

    private static final Logger LOG = LoggerFactory.getLogger(DirectTransferAnalyzer.class);

    private final double radiusMeters;

    public DirectTransferAnalyzer(double radiusMeters) {
        this.radiusMeters = radiusMeters;
    }

    @Override
    public void buildGraph(
            Graph graph,
            HashMap, Object> extra,
            DataImportIssueStore issueStore
    ) {
        /* Initialize graph index which is needed by the nearby stop finder. */
        graph.index = new GraphIndex(graph);

        LOG.info("Analyzing transfers (this can be time consuming)...");

        List directTransfersTooLong = new ArrayList<>();
        List directTransfersNotFound = new ArrayList<>();

        DirectGraphFinder nearbyStopFinderEuclidian = new DirectGraphFinder(graph);
        StreetGraphFinder nearbyStopFinderStreets = new StreetGraphFinder(graph);

        int stopsAnalyzed = 0;

        for (TransitStopVertex originStopVertex : graph.getVerticesOfType(TransitStopVertex.class)) {
            if (++stopsAnalyzed % 1000 == 0) {
                LOG.info("{} stops analyzed", stopsAnalyzed);
            }

            /* Find nearby stops by euclidean distance */
            Coordinate c0 = originStopVertex.getCoordinate();
            Map stopsEuclidean = nearbyStopFinderEuclidian
                        .findClosestStops(c0.y, c0.x, radiusMeters)
                        .stream()
                        .filter(t -> t.stop instanceof Stop)
                        .collect(Collectors.toMap(t -> (Stop) t.stop, t -> t));

            /* Find nearby stops by street distance */
            Map stopsStreets = nearbyStopFinderStreets.
                        findClosestStops(c0.y, c0.x, radiusMeters * RADIUS_MULTIPLIER)
                        .stream()
                        .filter(t -> t.stop instanceof Stop)
                        .collect(Collectors.toMap(t -> (Stop) t.stop, t -> t));

            Stop originStop = originStopVertex.getStop();

            /* Get stops found by both street and euclidean search */
            List stopsConnected =
                    stopsEuclidean.keySet().stream().filter(t -> stopsStreets.keySet().contains(t)
                            && t != originStop)
                            .collect(Collectors.toList());

            /* Get stops found by euclidean search but not street search */
            List stopsUnconnected =
                    stopsEuclidean.keySet().stream().filter(t -> !stopsStreets.keySet().contains(t)
                            && t != originStop)
                            .collect(Collectors.toList());

            for (Stop destStop : stopsConnected) {
                NearbyStop euclideanStop = stopsEuclidean.get(destStop);
                NearbyStop streetStop = stopsStreets.get(destStop);

                TransferInfo transferInfo = new TransferInfo(
                        originStop,
                        destStop,
                        euclideanStop.distance,
                        streetStop.distance
                );

                /* Log transfer where the street distance is too long compared to the euclidean distance */
                if (transferInfo.ratio > MIN_RATIO_TO_LOG && transferInfo.streetDistance > MIN_STREET_DISTANCE_TO_LOG) {
                    directTransfersTooLong.add(transferInfo);
                }
            }

            for (Stop destStop : stopsUnconnected) {
                NearbyStop euclideanStop = stopsEuclidean.get(destStop);

                /* Log transfers that are found by euclidean search but not by street search */
                directTransfersNotFound.add(
                        new TransferInfo(
                                originStop,
                                destStop,
                                euclideanStop.distance,
                                -1));
            }
        }

        /* Sort by street distance to euclidean distance ratio before adding to issues */
        directTransfersTooLong.sort(Comparator.comparingDouble(t -> t.ratio));
        Collections.reverse(directTransfersTooLong);

        for (TransferInfo transferInfo : directTransfersTooLong) {
            issueStore.add(new TransferRoutingDistanceTooLong(
                    transferInfo.origin,
                    transferInfo.destination,
                    transferInfo.directDistance,
                    transferInfo.streetDistance,
                    transferInfo.ratio
            ));
        }

        /* Sort by direct distance before adding to issues */
        directTransfersNotFound.sort(Comparator.comparingDouble(t -> t.directDistance));

        for (TransferInfo transferInfo : directTransfersNotFound) {
            issueStore.add(new TransferCouldNotBeRouted(
                    transferInfo.origin,
                    transferInfo.destination,
                    transferInfo.directDistance
            ));
        }

        LOG.info("Done analyzing transfers. {} transfers could not be routed and {} transfers had a too long routing" +
                " distance.", directTransfersNotFound.size(), directTransfersTooLong.size());
    }

    @Override
    public void checkInputs() {
        // No inputs
    }

    private static class TransferInfo {
        final Stop origin;
        final Stop destination;
        final double directDistance;
        final double streetDistance;
        final double ratio;

        TransferInfo(
                Stop origin,
                Stop destination,
                double directDistance,
                double streetDistance) {
            this.origin = origin;
            this.destination = destination;
            this.directDistance = directDistance;
            this.streetDistance = streetDistance;
            this.ratio = directDistance != 0 ? streetDistance / directDistance : 0;
        }
    }
}