LandmarkRename

class lib.align.updater.LandmarkRename(alignments: dict[str, Any], version: float)

Bases: _Updater

Landmarks renamed from landmarksXY to landmarks_xy for PEP compliance

Attributes Summary

is_updated

True if this updater has been run otherwise False

Methods Summary

test()

check for legacy landmarksXY keys.

update()

Update legacy landmarksXY keys to PEP compliant landmarks_xy keys.

Attributes Documentation

Parameters:
  • alignments (dict[str, T.Any])

  • version (float)

is_updated

True if this updater has been run otherwise False

Methods Documentation

test() bool

check for legacy landmarksXY keys.

Return type:

True if the alignments file contains legacy landmarksXY keys otherwise False

update() int

Update legacy landmarksXY keys to PEP compliant landmarks_xy keys.

Return type:

The number of landmarks keys that were changed

test() bool

check for legacy landmarksXY keys.

Return type:

True if the alignments file contains legacy landmarksXY keys otherwise False

update() int

Update legacy landmarksXY keys to PEP compliant landmarks_xy keys.

Return type:

The number of landmarks keys that were changed