org.opentripplanner.analyst.cluster

Class ResultEnvelope

java.lang.Object

org.opentripplanner.analyst.cluster.ResultEnvelope

All Implemented Interfaces:

Serializable

public class ResultEnvelope
extends Object
implements Serializable

This is a class that stores several result sets: an upper bound, a lower bound, and a central tendency. This is an "Envelope" in the sense that the results it contains enclose an area on a map or a chart: either the space between the minimum and maximum extent of an N-minute isochrone, or the space between the minimum and maximum accessibility curves on the cumulative access chart.

Author:

mattwigway

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultEnvelope.Which

Field Summary

Fields

Modifier and Type	Field and Description
ResultSet	avgCase The average case (e.g.
ResultSet	bestCase The best case/upper bound (e.g.
String	destinationPointsetId The ID of the shapefile/pointset from whence this result envelope came
String	id The ID of the feature from whence this result envelope came
String	jobId The ID of the job of which this resultenvelope is a part
ResultSet	pointEstimate A point estimate of accessibility, in the statistical sense: a single result that serves as a representative point in a distribution.
boolean	profile Is this a profile request? If so, upperBound and lowerBound will be defined, and pointEstimate not.
ResultSet	spread The spread of results (future use).
ResultSet	worstCase The lower bound (e.g.

Constructor Summary

Constructors

Constructor and Description
ResultEnvelope() Build an empty result envelope.

Method Summary

Modifier and Type	Method and Description
Map<String,ResultEnvelope>	explode() Explode this result envelope into a result envelope for each contained attribute We do this because we need to retrieve all of the values for a particular variable quickly, in order to display the map, and looping over 10GB of data to do this is not tractable.
ResultSet	get(ResultEnvelope.Which key)
void	put(ResultEnvelope.Which key, ResultSet val)

Methods inherited from class java.lang.Object

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

Field Detail

bestCase

public ResultSet bestCase

The best case/upper bound (e.g. number of jobs reachable considering the best travel times seen during the time window)

worstCase

public ResultSet worstCase

The lower bound (e.g. number of jobs reachable considering the worst travel times seen during the time window)

avgCase

public ResultSet avgCase

The average case (e.g. the number of jobs reachable on average, departing randomly within the time window)

pointEstimate

public ResultSet pointEstimate

A point estimate of accessibility, in the statistical sense: a single result that serves as a representative point in a distribution. When we are not doing profile routing (when we are not varying the departure time or other characteristics such as frequency board delays or schedule pulsing) we get only a single set of travel times out of a search. This is only one draw out of a distribution, and we don't know how much the values can vary around this single example. Note that this is not a single travel time, but a single set of travel times to all targets (points/vertices).

spread

public ResultSet spread

The spread of results (future use). This could be the standard deviation or interquartile range, for example.

profile

public boolean profile

Is this a profile request? If so, upperBound and lowerBound will be defined, and pointEstimate not. Otherwise, only pointEstimate will be defined.

jobId

public String jobId

The ID of the job of which this resultenvelope is a part

id

public String id

The ID of the feature from whence this result envelope came

destinationPointsetId

public String destinationPointsetId

The ID of the shapefile/pointset from whence this result envelope came

Constructor Detail

ResultEnvelope

public ResultEnvelope()

Build an empty result envelope.

Method Detail

get

public ResultSet get(ResultEnvelope.Which key)

put

public void put(ResultEnvelope.Which key,
                ResultSet val)

explode

public Map<String,ResultEnvelope> explode()

Explode this result envelope into a result envelope for each contained attribute We do this because we need to retrieve all of the values for a particular variable quickly, in order to display the map, and looping over 10GB of data to do this is not tractable.