org.opentripplanner.analyst

Class ResultSet

java.lang.Object

org.opentripplanner.analyst.ResultSet

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ResultSetDelta

public class ResultSet
extends Object
implements Serializable

This holds the results of a one-to-many search from a single origin point to a whole set of destination points. This may be either a profile search (capturing variation over a time window of several hours) or a "classic" search at a single departure time. Those results are expressed as histograms: bins representing how many destinations you can reach after M minutes of travel. For large point sets (large numbers of origins and destinations), this is significantly more compact than a full origin-destination travel time matrix. It makes the total size of the results linear in the number of origins, rather than quadratic. Optionally, this can also carry travel times to every point in the target pointset and/or a series vector isochrones around the origin point.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultSet.RangeSet

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Histogram>	histograms One histogram for each category of destination points in the target pointset.
String	id An identifier consisting of the ids for the pointset and time surface that were combined.
IsochroneData[]	isochrones Isochrone geometries around the origin, may be null.
int[]	times Times to reach every feature, may be null

Constructor Summary

Constructors

Constructor and Description
ResultSet()
ResultSet(int[] times, PointSet targets, boolean includeTimes, boolean includeHistograms, boolean includeIsochrones) Build a new ResultSet directly from times at point features, optionally including histograms or interpolating isochrones
ResultSet(SampleSet samples, TimeSurface surface) Build a new ResultSet by evaluating the given TimeSurface at all the given sample points, not including times.
ResultSet(SampleSet samples, TimeSurface surface, boolean includeTimes, boolean includeIsochrones) Build a new ResultSet by evaluating the given TimeSurface at all the given sample points, optionally including times.
ResultSet(TimeSurface surface) Build a new ResultSet that contains only isochrones, built by accumulating the times at all street vertices into a regular grid without an intermediate pointSet.

Method Summary

Modifier and Type	Method and Description
protected void	buildHistograms(int[] times, PointSet targets) Given an array of travel times to reach each point in the supplied pointset, make a histogram of travel times to reach each separate category of points (i.e.
long	sum(Integer timeLimit, String... categories) Sum the values of the specified categories up to the time limit specified (in seconds).
long	sum(String... categories) Sum the values of specified categories at all time limits within the bounds of the search.
void	writeIsochrones(com.fasterxml.jackson.core.JsonGenerator jgen) Write the isochrones as GeoJSON
void	writeJson(OutputStream output) Serialize this ResultSet to the given output stream as a JSON document, when the pointset is not available.
void	writeJson(OutputStream output, PointSet ps) Serialize this ResultSet to the given output stream as a JSON document.

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

An identifier consisting of the ids for the pointset and time surface that were combined.

histograms

public Map<String,Histogram> histograms

One histogram for each category of destination points in the target pointset.

times

public int[] times

Times to reach every feature, may be null

isochrones

public IsochroneData[] isochrones

Isochrone geometries around the origin, may be null.

Constructor Detail

ResultSet

public ResultSet()

ResultSet

public ResultSet(SampleSet samples,
                 TimeSurface surface)

Build a new ResultSet by evaluating the given TimeSurface at all the given sample points, not including times.

ResultSet

public ResultSet(SampleSet samples,
                 TimeSurface surface,
                 boolean includeTimes,
                 boolean includeIsochrones)

Build a new ResultSet by evaluating the given TimeSurface at all the given sample points, optionally including times.

ResultSet

public ResultSet(TimeSurface surface)

Build a new ResultSet that contains only isochrones, built by accumulating the times at all street vertices into a regular grid without an intermediate pointSet.

ResultSet

public ResultSet(int[] times,
                 PointSet targets,
                 boolean includeTimes,
                 boolean includeHistograms,
                 boolean includeIsochrones)

Build a new ResultSet directly from times at point features, optionally including histograms or interpolating isochrones

Method Detail

buildHistograms

protected void buildHistograms(int[] times,
                               PointSet targets)

Given an array of travel times to reach each point in the supplied pointset, make a histogram of travel times to reach each separate category of points (i.e. "property") within the pointset. Each new histogram object will be stored as a part of this result set keyed on its property/category.

sum

public long sum(String... categories)

Sum the values of specified categories at all time limits within the bounds of the search. If no categories are specified, sum all categories.

sum

public long sum(Integer timeLimit,
                String... categories)

Sum the values of the specified categories up to the time limit specified (in seconds). If no categories are specified, sum all categories.

writeJson

public void writeJson(OutputStream output)

Serialize this ResultSet to the given output stream as a JSON document, when the pointset is not available. TODO: explain why and when that would happen

writeJson

public void writeJson(OutputStream output,
                      PointSet ps)

Serialize this ResultSet to the given output stream as a JSON document. properties: a list of the names of all the pointSet properties for which we have histograms. data: for each property, a histogram of arrival times.

writeIsochrones

public void writeIsochrones(com.fasterxml.jackson.core.JsonGenerator jgen)
                     throws IOException

Write the isochrones as GeoJSON

Throws:

IOException