DVector.__init__#

DVector.__init__(segmentation, import_data, zoning_system=None, time_format=None, val_col='val', low_memory=False, cut_read=False, _bypass_validation=False)[source]#

Init method.

Parameters:

  • segmentation (Segmentation) – An instance of the segmentation class. This should usually be built from enumerated options in the SegmentsSuper class, but custom segments can be user defined if necesssary.

  • import_data (pd.Dataframe) – The DVector data. This should usually be a dataframe or path to a dataframe, but there is also an option to read in and convert DVectors in the old format from NorMITs-demand.

  • zoning_system (Optional[ZoningSystem | Sequence[ZoningSystem]] = None) – Instance of ZoningSystem. This must match import data. If this is given, import data must contain zone info in the column names, if this is not given import data must contain only 1 column. If the DVector contains multiple zoning systems (in the form of MultiIndexed columns in the input data), a Sequence of ZoningSystems can be passed here. Each level of the columns index will be validated against ZoningSystems passed in.

  • low_memory (bool = False) – Set to True for low_memory dunder_methods.

  • _bypass_validation (bool = False) – Can be used to bypass validation and save some time. THIS IS ADDED AS AN OPTION TO USE IN IPF ONCE IT IS CERTAIN THE RETURN IS CORRECT. DO NOT MANUALLY SET TO TRUE.

  • time_format (str | TimeFormat | None)

  • val_col (str | None)

  • cut_read (bool)

Return type:

None