IpfTarget.check_compatibility#

classmethod IpfTarget.check_compatibility(targets, reference=None, adjust=False, chain_adjust=True, trans_cache=None)[source]#

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

This will check rmse between targets and return a rmse value for the set. If adjust is set to True then all targets will be set to match the last target at whatever level of zoning/segmentation they match. If two targets don’t match at any level of zoning/segmentation this method will not attempt to convert to check, it will just ignore those.

Parameters:

  • targets (Collection[IpfTarget]) – The targets to check.

  • reference (DVector | None = None) – A reference DVector other targets will be compared/adjusted to. If left as None the final DVector in targets will take precedence.

  • adjust (bool = False) – Whether to change the targets or just report on their compatibility.

  • chain_adjust (bool = True) – Whether to ‘chain’ adjustments, meaning if set to True every DVector will be compared to every other from back to front, else every DVector will be compared to either ‘reference’, or the final DVector in targets.

  • trans_cache (Path = None) – Dir containing translations, default value will be used if not provided.