org.opentripplanner.analyst

Class PointSet

java.lang.Object

org.opentripplanner.analyst.PointSet

All Implemented Interfaces:

Serializable

public class PointSet
extends Object
implements Serializable

PointSets serve as named groups of destinations when calculating analyst one-to-many indicators. They could also serve as origins in many-to-many indicators. PointSets are one of the three main web analyst resources: Pointsets, Indicators, and TimeSurfaces

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	capacity
String	description A detailed textual description of this PointSet
protected GraphService	graphService
String	id A server-unique identifier for this PointSet
protected String[]	ids A unique identifier for each feature.
String	label A short description of this PointSet for use in a legend or menu
protected double[]	lats The latitude of each feature (or its centroid if it's not a point).
protected double[]	lons The longitude of each feature (or its centroid if it's not a point).
protected org.locationtech.jts.geom.Polygon[]	polygons The polygon for each feature (which is reduced to a centroid point for routing purposes).
Map<String,int[]>	properties
Map<String,PropertyMetadata>	propMetadata
int[][]	times Deprecated.

Constructor Summary

Constructors

Constructor and Description
PointSet(int capacity) Create a PointSet manually by defining capacity and calling addFeature(geom, data) repeatedly.

Method Summary

Modifier and Type	Method and Description
void	addFeature(PointFeature feat, int index) Add a single feature with a variable number of free-form properties.
int	featureCount()
static PointSet	fromCsv(File filename) Rather than trying to load anything any everything, we stick to a strict format and rely on other tools to get the data into the correct format.
static PointSet	fromGeoJson(File filename)
static PointSet	fromShapefile(File file)
static PointSet	fromShapefile(File file, String originIDField, List<String> propertyFields)
org.locationtech.jts.geom.Coordinate	getCoordinate(int index) Returns a new coordinate object for the feature at the given index in this set, or its centroid.
PointFeature	getFeature(int index)
int	getIndexForFeature(String featureId) Get the index of a particular feature ID in this pointset.
double	getLat(int i) Using getter methods here to allow generating coordinates and geometries on demand instead of storing them.
double	getLon(int i)
PropertyMetadata	getOrCreatePropertyForId(String id) Gets the Category object for the given ID, creating it if it doesn't exist.
SampleSet	getOrCreateSampleSet(Graph graph)
SampleSet	getSampleSet(Graph g) gets a sample set for a graph object -- does not require graph service to be set
SampleSet	getSampleSet(String routerId) gets a sample set for a given graph id -- requires graphservice to be set
static PointSet	regularGrid(org.locationtech.jts.geom.Envelope envelope, double gridSizeMeters)
void	setGraphService(GraphService graphService) Adds a graph service to allow for auto creation of SampleSets for a given graph
void	setLabel(String catId, String label)
void	setStyle(String catId, String styleAttribute, String styleValue)
PointSet	slice(int start, int end)
PointSet	slice(List<String> ids) Get a subset of this point set containing only the specified point IDs.
static int	validateGeoJson(InputStream is) Examines a JSON stream to see if it matches the expected OTPA format.
void	writeJson(OutputStream out)
void	writeJson(OutputStream out, Boolean forcePoints) Use the Jackson streaming API to output this as GeoJSON without creating another object.
void	writeJsonProperties(com.fasterxml.jackson.core.JsonGenerator jgen)
protected void	writeStructured(int i, com.fasterxml.jackson.core.JsonGenerator jgen) This will be called once per point in an origin/destination pointset, and once per origin in a one- or many-to-many indicator.
protected void	writeTimes(com.fasterxml.jackson.core.JsonGenerator jgen, int[] times) Pairs an array of times with the array of features in this pointset, writing out the resulting (ID,time) pairs to a JSON object.

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

A server-unique identifier for this PointSet

label

public String label

A short description of this PointSet for use in a legend or menu

description

public String description

A detailed textual description of this PointSet

propMetadata

public Map<String,PropertyMetadata> propMetadata

properties

public Map<String,int[]> properties

capacity

public int capacity

graphService

protected GraphService graphService

times

@Deprecated
public int[][] times

Deprecated.

ids

protected String[] ids

A unique identifier for each feature.

lats

protected double[] lats

The latitude of each feature (or its centroid if it's not a point).

lons

protected double[] lons

The longitude of each feature (or its centroid if it's not a point).

polygons

protected org.locationtech.jts.geom.Polygon[] polygons

The polygon for each feature (which is reduced to a centroid point for routing purposes).

Constructor Detail

PointSet

public PointSet(int capacity)

Create a PointSet manually by defining capacity and calling addFeature(geom, data) repeatedly.

Parameters:

capacity - expected number of features to be added to this PointSet.

Method Detail

fromCsv

public static PointSet fromCsv(File filename)
                        throws IOException

Rather than trying to load anything any everything, we stick to a strict format and rely on other tools to get the data into the correct format. This includes column headers in the category:subcategory:attribute format and coordinates in WGS84. Comment lines are allowed in these input files, and begin with a #.

Throws:

IOException

fromShapefile

public static PointSet fromShapefile(File file)
                              throws org.opengis.referencing.NoSuchAuthorityCodeException,
                                     IOException,
                                     org.opengis.referencing.FactoryException,
                                     EmptyPolygonException,
                                     UnsupportedGeometryException

Throws:

org.opengis.referencing.NoSuchAuthorityCodeException

IOException

org.opengis.referencing.FactoryException

EmptyPolygonException

UnsupportedGeometryException

fromShapefile

public static PointSet fromShapefile(File file,
                                     String originIDField,
                                     List<String> propertyFields)
                              throws IOException,
                                     org.opengis.referencing.NoSuchAuthorityCodeException,
                                     org.opengis.referencing.FactoryException,
                                     EmptyPolygonException,
                                     UnsupportedGeometryException

Throws:

IOException

org.opengis.referencing.NoSuchAuthorityCodeException

org.opengis.referencing.FactoryException

EmptyPolygonException

UnsupportedGeometryException

fromGeoJson

public static PointSet fromGeoJson(File filename)

validateGeoJson

public static int validateGeoJson(InputStream is)

Examines a JSON stream to see if it matches the expected OTPA format. TODO improve the level of detail of validation. Many files pass the validation and then crash the load function.

Returns:

the number of features in the collection if it's valid, or -1 if it doesn't fit the OTPA format.

setGraphService

public void setGraphService(GraphService graphService)

Adds a graph service to allow for auto creation of SampleSets for a given graph

getSampleSet

public SampleSet getSampleSet(String routerId)

gets a sample set for a given graph id -- requires graphservice to be set

Returns:

sampleset for graph

getOrCreateSampleSet

public SampleSet getOrCreateSampleSet(Graph graph)

getSampleSet

public SampleSet getSampleSet(Graph g)

gets a sample set for a graph object -- does not require graph service to be set

Parameters:

g - a graph objects

Returns:

sampleset for graph

featureCount

public int featureCount()

addFeature

public void addFeature(PointFeature feat,
                       int index)

Add a single feature with a variable number of free-form properties. Attribute data contains id value pairs, ids are in form "cat_id:prop_id". If the properties and categories do not exist, they will be created. TODO: read explicit schema or infer it and validate property presence as they're read

Parameters:

feat - must be a Point, a Polygon, or a single-element MultiPolygon

getFeature

public PointFeature getFeature(int index)

setLabel

public void setLabel(String catId,
                     String label)

setStyle

public void setStyle(String catId,
                     String styleAttribute,
                     String styleValue)

getOrCreatePropertyForId

public PropertyMetadata getOrCreatePropertyForId(String id)

Gets the Category object for the given ID, creating it if it doesn't exist.

writeJson

public void writeJson(OutputStream out)

writeJson

public void writeJson(OutputStream out,
                      Boolean forcePoints)

Use the Jackson streaming API to output this as GeoJSON without creating another object. The Indicator is a column store, and is transposed WRT the JSON representation.

writeJsonProperties

public void writeJsonProperties(com.fasterxml.jackson.core.JsonGenerator jgen)
                         throws com.fasterxml.jackson.core.JsonGenerationException,
                                IOException

Throws:

com.fasterxml.jackson.core.JsonGenerationException

IOException

writeTimes

protected void writeTimes(com.fasterxml.jackson.core.JsonGenerator jgen,
                          int[] times)
                   throws IOException

Pairs an array of times with the array of features in this pointset, writing out the resulting (ID,time) pairs to a JSON object.

Throws:

IOException

writeStructured

protected void writeStructured(int i,
                               com.fasterxml.jackson.core.JsonGenerator jgen)
                        throws IOException

This will be called once per point in an origin/destination pointset, and once per origin in a one- or many-to-many indicator.

Throws:

IOException

slice

public PointSet slice(List<String> ids)

Get a subset of this point set containing only the specified point IDs.

slice

public PointSet slice(int start,
                      int end)

getIndexForFeature

public int getIndexForFeature(String featureId)

Get the index of a particular feature ID in this pointset.

Returns:

the index, or -1 if there is no such index.

regularGrid

public static PointSet regularGrid(org.locationtech.jts.geom.Envelope envelope,
                                   double gridSizeMeters)

getCoordinate

public org.locationtech.jts.geom.Coordinate getCoordinate(int index)

Returns a new coordinate object for the feature at the given index in this set, or its centroid.

getLat

public double getLat(int i)

Using getter methods here to allow generating coordinates and geometries on demand instead of storing them. This would allow for implicit geometry, as in a regular grid of points.

getLon

public double getLon(int i)