garmentiq.landmark.derivation.derivation_dict

 1derivation_dict = {
 2    "derive_keypoint_coord": {
 3        "p1_id": None,
 4        "p2_id": None,
 5        "p3_id": None,
 6        "p4_id": None,
 7        "p5_id": None,
 8        "direction": ["parallel", "perpendicular"],
 9    }
10}
11"""dict: A dictionary defining the schemas for various landmark derivation functions.
12
13Each key in this dictionary represents a derivation function, and its value is
14another dictionary specifying the expected parameters for that function.
15`None` as a parameter value indicates that the parameter must be provided
16when calling the function, and it is typically an integer ID corresponding to a
17predefined landmark.
18
19Example structure for "derive_keypoint_coord":
20    "derive_keypoint_coord": {
21        "p1_id": None,  # Required: Integer ID of the first point.
22        "p2_id": None,  # Required: Integer ID of the second point.
23        "p3_id": None,  # Required: Integer ID of the third point.
24        "p4_id": None,  # Required: Integer ID of the fourth point.
25        "p5_id": None,  # Required: Integer ID of the fifth point.
26        "direction": ["parallel", "perpendicular"], # Required: How to derive line 1's direction.
27    }
28"""
derivation_dict = {'derive_keypoint_coord': {'p1_id': None, 'p2_id': None, 'p3_id': None, 'p4_id': None, 'p5_id': None, 'direction': ['parallel', 'perpendicular']}}

dict: A dictionary defining the schemas for various landmark derivation functions.

Each key in this dictionary represents a derivation function, and its value is another dictionary specifying the expected parameters for that function. None as a parameter value indicates that the parameter must be provided when calling the function, and it is typically an integer ID corresponding to a predefined landmark.

Example structure for "derive_keypoint_coord": "derive_keypoint_coord": { "p1_id": None, # Required: Integer ID of the first point. "p2_id": None, # Required: Integer ID of the second point. "p3_id": None, # Required: Integer ID of the third point. "p4_id": None, # Required: Integer ID of the fourth point. "p5_id": None, # Required: Integer ID of the fifth point. "direction": ["parallel", "perpendicular"], # Required: How to derive line 1's direction. }