PathForecastTracer¶

class passengersim.tracers.forecasts.PathForecastTracer(path_ids: list[int])[source]¶

Bases: _ForecastTracer

A per-sample tracer that records the forecasts for specified paths.

This will generally be called as a begin-sample callback, so that it records the forecasts at the start of each sample.

Methods

__init__(path_ids)
attach(sim)	Attach this tracer to a Simulation, which will be traced as it runs.
finalize()	Convert the internal counters on this tracer to a dataframe.
fresh()	Return a fresh copy of this tracer, tracing the same targets but not sharing state.
reset()	Reset the internal counters on this tracer to a null state.

Attributes

name

name : str = 'selected_path_forecasts'¶

attach(sim: Simulation) → None¶

Attach this tracer to a Simulation, which will be traced as it runs.

finalize() → DataFrame¶

Convert the internal counters on this tracer to a dataframe.

fresh() → _ForecastTracer¶

Return a fresh copy of this tracer, tracing the same targets but not sharing state.

reset() → None¶

Reset the internal counters on this tracer to a null state.