next up previous index
Next: employment_relocation_probabilities Up: Probabilities Classes Previous: Probabilities Classes   Index


household_relocation_probabilities

This class is implemented to be used with a rate set (instance of RateDataset initialized for households) structured according to the description for ``annual_relocation_rates_for_households'' in Section 9.11. The run() method iterates over households and using the rate set, for each household it determines from the values of required primary attributes ``age_of_head'' and ``income'' the probability of relocation. It returns a 1D array of those probabilities. The household set and rate set are expected to be contained in the argument resources of the run() method.


next up previous index
Next: employment_relocation_probabilities Up: Probabilities Classes Previous: Probabilities Classes   Index
info (at) urbansim.org