ToddCurve¶

class passengersim.config.ToddCurve[source]¶

Bases: PrettyModel

Customer preference data for Time Of Day for departure (TODD).

These curves are used to model the probability of a customer choosing various departure times based on the distance of the trip.

Attributes:

name	The name of this TODD curve.
min_distance	Deprecated, no effect.
max_distance	Deprecated, no effect.
k_factor	The k-factor controlling the spread of the TODD preference distribution.
probabilities	Define a TODD curve.

name : str¶

The name of this TODD curve.

min_distance : Annotated[int, Field(deprecated='no effect')]¶

Deprecated, no effect.

max_distance : int¶

Deprecated, no effect.

k_factor : float¶

The k-factor controlling the spread of the TODD preference distribution.

Larger values of k_factor produce a wider spread of departure-time preferences, while smaller values concentrate preferences more tightly around the peak hours.

probabilities : dict[int, float] | None¶

Define a TODD curve.

This must be a dictionary with integer keys in the range (0, 23) inclusive, and float values in the range [0, 1]. The keys represent hours of the day, and the values represent the probability of a customer choosing to depart at that hour for trips within the specified distance range.