org.opentripplanner.analyst.batch

Interface Population

All Superinterfaces:

Iterable<Individual>

All Known Implementing Classes:

BasicPopulation, CSVPopulation, RasterPopulation, ShapefilePopulation, SyntheticRasterPopulation

public interface Population
extends Iterable<Individual>

A collection of individual locations that will be used as either the origin set or the destination set in a many-to-many (batch Analyst) search. An iterator over a population will skip those individuals that have been marked as rejected by its filter chain, and is not the same as an iterator over a population's list of individuals.

Author:

andrewbyrd

Method Summary

Modifier and Type	Method and Description
void	addIndividual(Individual individual)
void	clearIndividuals(List<Individual> individuals)
void	createIndividuals() Subclass-specific method to load the individuals from a file or create them based on other properties.
void	setup() Prepare the population for use.
int	size()
void	writeAppropriateFormat(String fileName, ResultSet results) Save the output data in this population to a file, using a format that is appropriate for the specific class of population.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

addIndividual

void addIndividual(Individual individual)

clearIndividuals

void clearIndividuals(List<Individual> individuals)

size

int size()

Returns:

the number of individuals in this population.

setup

void setup()

Prepare the population for use. This includes loading or generating the individuals, filtering them, but not sampling (linking them into the graph) because origin populations do not need to be permanently linked.

createIndividuals

void createIndividuals()

Subclass-specific method to load the individuals from a file or create them based on other properties. This method should fill in all fields of each individual except the sample, since sampling will be carried out after the filter chain is applied.

writeAppropriateFormat

void writeAppropriateFormat(String fileName,
                            ResultSet results)

Save the output data in this population to a file, using a format that is appropriate for the specific class of population. For example, a population loaded from an image file or generated on a regular grid will be saved as a Geotiff raster. A population of points that are not known to be aligned on a regular grid in some CRS will be saved as a CSV file.