LegForecastTracer

class passengersim.callbacks.builtins.LegForecastTracer(leg_ids: list[int], *, name: str | None = None)[source]

Bases: _ForecastTracer

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

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

Initialize the tracer.

Parameters:
leg_ids : list[int]

IDs of the legs whose forecasts should be tracked.

name : str, optional

Key for the results in callback_data. Defaults to the class name, ‘selected_leg_forecasts’; give a different name to attach two of these tracers to one simulation.

Methods

__init__(leg_ids, *[, name])

Initialize the tracer.

attach(sim)

Attach a fresh copy of this tracer to a simulation, on all its hooks.

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.

on_begin_sample(sim)

Observe a sample after its first DCP, before any customer arrives.

on_daily(sim, days_prior)

Observe each day of a sample.

on_end_sample(sim)

Observe the end of a sample, before counters are reset.

on_finalize_sample(sim)

Observe a sample after its events and bookkeeping have finished.

on_initialize_sample(sim)

Observe the start of a sample, before its demand is generated.

reset()

Reset all accumulated forecasts to empty Welford accumulators.

setup(sim)

Prepare to trace a run, once its scenario has been built.

Attributes

hook

Lifecycle hook shared by manual and configured attachment.

name

Result key in callback_data.

options_model

Pydantic model of the constructor's keyword options, for configured callbacks.

options_version

Configured-callback implementation version; bump when results change meaning.

skip_burn

Burn-in samples are not recorded.

name : str = 'selected_leg_forecasts'

Result key in callback_data.

The class value is the canonical name. An instance may set its own name, so that two tracers of one class can be attached to the same simulation without overwriting each other’s results.

__init__(leg_ids: list[int], *, name: str | None = None)[source]

Initialize the tracer.

Parameters:
leg_ids : list[int]

IDs of the legs whose forecasts should be tracked.

name : str, optional

Key for the results in callback_data. Defaults to the class name, ‘selected_leg_forecasts’; give a different name to attach two of these tracers to one simulation.

attach(sim: Simulation) → None

Attach a fresh copy of this tracer to a simulation, on all its hooks.

Parameters:
sim : Simulation or MultiSimulation or Experiments

The object to attach to. The simulation stores a copy made with fresh(), so this tracer object itself is never modified by a run and can be attached to several simulations.

Raises:

TypeError – If the tracer declares no hook and overrides no hook method.

finalize() → DataFrame

Convert the internal counters on this tracer to a dataframe.

fresh() → GenericTracer

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

The default makes a deep copy of this tracer and then calls reset() on the copy. Override it if a tracer holds something that cannot be deep-copied, or that is expensive to copy.

Returns:

GenericTracer – A new tracer of the same type and configuration, with no accumulated data.

hook : ClassVar[Literal['begin_sample', 'daily', 'end_sample']] = 'begin_sample'

Lifecycle hook shared by manual and configured attachment.

on_begin_sample(sim: Simulation) → dict | None

Observe a sample after its first DCP, before any customer arrives.

Override this to attach the tracer to the begin_sample hook. Its time is set by the tracer’s priority attribute, if it has one, as for a plain begin-sample callback.

Parameters:
sim : Simulation

The running simulation.

on_daily(sim: Simulation, days_prior: int) → dict | None

Observe each day of a sample.

Override this to attach the tracer to the daily hook. The time of day is set by the tracer’s priority attribute, if it has one, as for a plain daily callback.

Parameters:
sim : Simulation

The running simulation.

days_prior : int

Days remaining before departure.

on_end_sample(sim: Simulation) → dict | None

Observe the end of a sample, before counters are reset.

Override this to attach the tracer to the end_sample hook. Its time is set by the tracer’s priority attribute, if it has one, as for a plain end-sample callback.

Parameters:
sim : Simulation

The running simulation.

on_finalize_sample(sim: Simulation) → dict | None

Observe a sample after its events and bookkeeping have finished.

Override this to attach the tracer to the finalize_sample hook.

Parameters:
sim : Simulation

The running simulation.

on_initialize_sample(sim: Simulation) → dict | None

Observe the start of a sample, before its demand is generated.

Override this to attach the tracer to the initialize_sample hook. A returned dictionary is stored under callback_data.initialize_sample, as for a plain callback.

Parameters:
sim : Simulation

The running simulation.

options_model : ClassVar[type[BaseModel] | None] = None

Pydantic model of the constructor’s keyword options, for configured callbacks.

By default, registration derives the model from the annotated constructor.

options_version : ClassVar[str] = '1'

Configured-callback implementation version; bump when results change meaning.

reset() → None

Reset all accumulated forecasts to empty Welford accumulators.

setup(sim: Simulation) → None

Prepare to trace a run, once its scenario has been built.

Called once per run (run or run_trial), after reset() and after the simulation has built its network, fares, and demands, but before the first sample. Override it to look up what the tracer will observe and to allocate its accumulators, so that problems are reported before the run starts. The default does nothing.

An exception raised here stops the run; nothing is finalized, and the next run starts from a fresh reset.

Parameters:
sim : Simulation

The simulation about to run.

skip_burn : ClassVar[bool] = True

Burn-in samples are not recorded.