caf.base.data_structures

Module containing the data structures used in the CAF package.

Currently this is only the DVector class, but this may be expanded in the future.

Functions

deepcopy(x[, memo, _nil])	Deep copy operation on arbitrary Python objects.
listdir([path])	Return a list containing the names of the files in the directory.
normalise_column_name(column)	Convert column to lowercase and replace spaces with underscores.

Classes

BalancingZones(segmentation, default_zoning, ...)	Stores the zoning systems for the attraction model balancing.
Collection()
DVector(segmentation, import_data[, ...])	Class to store and manipulate data with segmentation and optionally zoning.
IpfTarget(data[, zoning_diff, ...])	Dataclass to store targets to pass to IPF method of DVector.
Number()	All numbers inherit from this class.
Path(*args, **kwargs)	PurePath subclass that can make system calls.
PathLike()	Abstract base class for implementing the file system path protocol.
SegConverter(value)	Enum class for converting segment combos.
Segment(*, name, values[, alias, ...])	Class containing info on a Segment, which combined with other Segments form a segmentation.
Segmentation(config)	Segmentation class for handling segmentation objects.
SegmentationSlice(slice_params[, naming_order])	Single slice of a segmentation.
SegmentsSuper(value)	Getter for predefined segments.
TimeFormat(value)	Class for time formats.
TranslationWeighting(value)	Available weightings for zone translations.
ZoningSystem(name, unique_zones, metadata)	Zoning definitions to provide common interface.
ZoningSystemMetaData(*, name[, ...])	Class to store metadata relating to zoning systems in normits_demand.

Exceptions

SegmentationError	Error for segmentation objects.
SegmentationWarning	Warn about segmentation objects.
TranslationError	Error related to zone zone_translation.
ZoningError	Error related to zoning.