TripEndByDirectionRunParams

class caf.ntem.inputs.TripEndByDirectionRunParams(years, scenarios, output_zoning=ZoningSystems.NTEM_ZONE, version=Versions.EIGHT, filter_zoning_system=None, filter_zone_names=None, label=None, trip_type=TripType.OD, purpose_filter=None, aggregate_purpose=True, mode_filter=None, aggregate_mode=True, time_period_filter=None)

Bases: RunParams

Trip End by Direction query parameters.

Attributes

aggregate_mode	Whether to aggregate modes.
aggregate_purpose	"Whether to aggregate purposes.
mode_filter	Modes to retrieve, if None all are retrieved.
purpose_filter	Purposes to retrieve, if None all are retrieved.
time_period_filter	Time periods to retrieve, if None all are given
trip_type	Trip types to retrieve.
years	Years to produce outputs.
scenarios	Scenarios to produce outputs

Methods

__init__(*args, **kwargs)

Attributes Documentation

Parameters:

• years (list[int])

• scenarios (list[Scenarios])

• output_zoning (ZoningSystems)

• version (Versions)

• filter_zoning_system (ZoningSystems | None)

• filter_zone_names (list[str] | None)

• label (str | None)

• trip_type (TripType)

• purpose_filter (list[Purpose] | None)

• aggregate_purpose (bool)

• mode_filter (list[Mode] | None)

• aggregate_mode (bool)

• time_period_filter (list[TimePeriod] | None)

aggregate_mode: bool = True

Whether to aggregate modes.

aggregate_purpose: bool = True

“Whether to aggregate purposes.

mode_filter: list[Mode] | None = None

Modes to retrieve, if None all are retrieved.

purpose_filter: list[Purpose] | None = None

Purposes to retrieve, if None all are retrieved.

time_period_filter: list[TimePeriod] | None = None

Time periods to retrieve, if None all are given

trip_type: TripType = 'od'

Trip types to retrieve.

years: list[int]

Years to produce outputs.

scenarios: list[Scenarios]

Scenarios to produce outputs