IpfTarget#

class caf.base.data_structures.IpfTarget(data, zoning_diff=None, zone_translation=None, segment_translations=None)[source]#

Bases: object

Dataclass to store targets to pass to IPF method of DVector.

Parameters:

  • data (DVector) – DVector containing the target data.

  • zoning_diff (bool | None = None) – Whether target zoning is different to seed. This needn’t be set by the user as it is determined internally.

  • zone_translation (pd.DataFrame | None = None) – A translation between the seed and target zoning if necessary. This must be a strict aggregation from seed to target zoning. If left blank the IPF method will attempt to find a translation and use that using DVector translation methods.

  • segment_translations (dict[str, str] | None = None) – A dict defining corresponding segments in seed for segments in target not in seed. These will be used to find lookups in the seg_translations folder. As with zoning, these must be strict aggregations from seed to target segment.

Attributes

segment_translations

zone_translation

zoning_diff

data

Methods

__init__(*args, **kwargs)

check_compatibility(targets[, reference, ...])

Check compatibility between ipf targets, and optionally adjust to match.

singly_zoned(values)

Validate that dvecs are singly zoned.

Attributes Documentation

segment_translations: dict[str, str] | None = None#
zone_translation: DataFrame | None = None#
zoning_diff: bool | None = None#
data: DVector[source]#