Package org.matsim.contrib.locationchoice

This package provides location choice for discretionary activities.

Package Maintainer:

  • Andreas Horni

Parameters:

General Parameters

  • algorithm
    Type and range: String (localSearchRecursive, localSearchSingleAct, random, bestResponse)
    Default: bestResponse
    Description: Specifies which version of destination choice module should be applied.
    localSearchRecursive = time geography (deprecated)
    localSearchSingleAct = the same as simple_tg (deprecated)
    random = random mutation (deprecated)
    bestResponse = best response (recommended) destination choice module
  • 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 has to be given.
  • planSelector
    Type and range: String (BestScore, SelectExpBeta, ChangeExpBeta, SelectRandom)
    Default: SelectExpBeta
    Description: Specifies which plan should be replanned.
  • 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 destinations 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)

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 doubles separated by ','
    Default: null
    Description: Scale the activities epsilons
  • 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)
  • prefsFile
    Type and range: String
    Default: null
    Description: Specifies the agents' earliestEndTime, latestStartTime, minimalDuration and typicalDuration. If no prefs file is found, the module tries to get the typicalDuration from the desires and the rest from the config. If also no desires are available, then everything is tried to be taken from the config. And finally, if also in the config not everything is there, you need to help yourself ;) This should sooner or later go somewhere else, more into the core.
  • pBetasFileName
    Type and range: String
    Default: null
    Description: Specifies the beta parameters for additional destination attributes specified in fAttributesFileName below
  • fAttributesFileName
    Type and range: String
    Default: null
    Description: see pBetasFileName

Search Space Construction

  • tt_approximationLevel
    Type and range: int (0,1,2)
    Default: 0
    Description: 0: no approximation, routing for every OD-pair (for real-world scenarios not applicable as it is much too slow)
    1: Dijkstra trees forward and backwards. See working paper Horni, Nagel, Axhausen 2011, page 13
    2: based on travel distances
  • maxDistanceDCScore
    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: 5
    Description: Number of alternatives taken into account for the probabilistic choice. See working paper Horni, Nagel, Axhausen 2011, page 13
  • maxDCScoreFile
    Type and range: String
    Default: null
    Description: specifies the location of the unscaled max dc score file (created during pre-processing). If the k values have not changed from one run to another, the (unscaled) max dc score values can be reused and the pre-processing can be skipped.
  • idExclusion (deprecated)
    Type and range: int > 0
    Default: max int
    Description: Better use the subpopulation specifications in the config strategy section! But here used to exclude all agents from destination choice and analysis with id > analysisIdExclusion. (e.g., border crossers)
  • travelSpeed_car
    Type and range: double > 0.0
    Default: 8.5 m/s
    Description: approximated assumed car travel speed to convert time into distance for search space construction.
  • travelSpeed_pt
    Type and range: double > 0.0
    Default: 5 m/s
    Description: approximated assumed pt travel speed to convert time into distance for search space construction.
  • destinationSamplePercent
    Type and range: double, 3 possible values: 100.0, 10.0, and 1.0
    Default: 100.0
    Description: specifies how many percent of the destinations in the choice set should be used for the final choice

Analysis

  • analysisBoundary
    Type and range: double > 0.0
    Default: 200km
    Description: maximum distance in distance stats. Greater values go into the last bin.
  • analysisBinSize
    Type and range: double > 0.0
    Default: 20km
    Description: steps (bin sizes) for distance stats