Package org.matsim.locationchoice

This package provides location choice for discretionary activities.

See:
Description

Class Summary

LocationChoice
LocationMutator

Package org.matsim.locationchoice Description

This package provides location choice for discretionary activities.

Package Maintainer:

• Andreas Horni

Parameters:

Two basic versions of the destination choice module exist, one (v0) based on local search and Haegerstrand's time geography and the other (v1) based on best response including error terms. Parameters required for v0 are given in blue, the ones used in v1 are given in red and parameters applied in both versions are given in black.
[[How do I select if I use v0 or v1? kai, mar'12]]

General Parameters

• flexible_types
  Type and range: String
  Default: null
  Description: This parameter globally (for all agents) specifies the activity types for which location choice is performed. For demand v1 instead of x0.5 ... x24, simply x can be given.
• planSelector
  Type and range: String (BestScore, SelectExpBeta, ChangeExpBeta, SelectRandom)
  Default: SelectExpBeta
  Description: Specifies which plan should be replanned.
• algorithm
  Type and range: String (random, bestResponse, localSearchRecursive, localSearchSingleAct)
  Default: null
  Description: Specifies which version of destination choice module should be applied.
  localSearchRecursive = time geography
  localSearchSingleAct = the same as simple_tg
  random = random mutation
  bestResponse = best response (recommended) destination choice module
  
• randomSeed
  Type and range: long
  Default: 221177
  Description: Initial seed for generation of random error terms

Diluted Scenarios

• centerNode
  Type and range: String
  Default: null
  Description: If the locations have to be chosen from an additionally restrained region a center node and a radius can be set. This is only useful for diluted scenarios
• radius
  Type and range: float > 0
  Default: null
  Description: see above (centerNode)

Time Geography

• recursionTravelSpeedChange
  Type and range: float > 0
  Default: 0.1
  Description: This factor is used to grow or shrink the approximate set of locations (see above).
  radius_i+1 = ttb / 2 x recurisionTravelSpeed x (1.0 -+ recursionTravelSpeedChange)ⁱ, with i: recursion number
• recursionTravelSpeed
  Type and range: float > 0
  Default: 8.5
  Description: Initial assumed travel speed for the investigation area in [m/s]. This value is also used to compute the search space for version 1.
• maxRecursions
  Type and range: int >= 0
  Default: 1
  Description: Max. number of trials to search for a location according to the travel time budget (if 0 := universal choice set)

Spatial Competition (Capacity Restraint Function)

• restraintFcnFactor
  Type and range: float >= 0.0
  Default: 0.0
  Description: Factor of the fac.cap.restraint function
• restraintFcnExp
  Type and range: float >= 0.0
  Default: 0.0
  Description: Exponent of the fac.cap.restraint function
• scaleFactor
  Type and range: int > 0
  Default: 1
  Description: For sample scenarios, i.e. if 10% population then scaleFactor := 10

Utility Function Specification

• epsilonDistribution
  Type and range: String (gumbel/gaussian)
  Default: gumbel
  Description: Either use Normal or Gumbel distribution for error terms
• epsilonScaleFactors
  Type and range: float > array of double separated by ','
  Default: null
  Description: Scale the activities epsilons, separated by comma
• pkValuesFile
  Type and range: String
  Default: null
  Description: specifies the location of the persons k values file (created during previous pre-processing)
• fkValuesFile
  Type and range: String
  Default: null
  Description: specifies the location of the facilities k values file (created during previous pre-processing)

Search Space Construction

• tt_approximationLevel
  Type and range: int (0,1,2)
  Default: 0
  Description: 0: no approximation, routing for every OD-pair
  1: Dijkstra trees forward and backwards See working paper Horni,Nagel,Axhausen 2011, page 13
  2: based on travel distances
• maxDistanceEpsilon
  Type and range: float (-1 or > 0.0)
  Default: -1
  Description: Maximum search space radius [m]. "-1" means no explicit fixed search space limitation.
• probChoiceSetSize
  Type and range: int > 0
  Default: 10
  Description: Number of alternatives taken into account for the probabilistic choice. See working paper Horni,Nagel,Axhausen 2011, page 13
• probChoiceExponent
  Type and range: float
  Default: 3.0
  Description: Weighting of scores in the reduced choice set subject to probabilistic choice. See working paper Horni,Nagel,Axhausen 2011, page 13
• maxEpsFile
  Type and range: String
  Default: null
  Description: specifies the location of the maps eps file (created during pre-processing)
• idExclusion
  Type and range: int > 0
  Default: max int
  Description: exclude all agents from destination choice and analysis with id > analysisIdExclusion. (e.g., border crossers)

*

Analysis

• analysisBoundary
  Type and range: double > 0.0
  Default: 200km
  Description: boundary (radius) of analysis region (used for distance stats creation)
• analysisBinSize
  Type and range: double > 0.0
  Default: 20km
  Description: steps (bin sizes) for analysis (used for distance stats creation)