retuve.hip_us.handlers.side

  1# Copyright 2024 Adam McArthur
  2#
  3# Licensed under the Apache License, Version 2.0 (the "License");
  4# you may not use this file except in compliance with the License.
  5# You may obtain a copy of the License at
  6#
  7#     http://www.apache.org/licenses/LICENSE-2.0
  8#
  9# Unless required by applicable law or agreed to in writing, software
 10# distributed under the License is distributed on an "AS IS" BASIS,
 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12# See the License for the specific language governing permissions and
 13# limitations under the License.
 14
 15"""
 16Handles 3D and 2D Sweep Hip Ultrasounds that do not have the
 17Anterior and Posterior sides correctly set.
 18
 19Retuve is set up to have the Anterior side first and the Posterior side second.
 20"""
 21
 22from typing import List, Tuple
 23
 24from retuve.classes.seg import SegFrameObjects
 25from retuve.hip_us.classes.enums import HipLabelsUS, Side
 26from retuve.hip_us.classes.general import HipDatasUS, HipDataUS
 27
 28
 29def get_side_metainfo(
 30    hip: HipDataUS, results: List[SegFrameObjects]
 31) -> Tuple[Tuple[int], List[int]]:
 32    """
 33    Get the side metainfo for a HipDataUS object.
 34
 35    :param hip: HipDataUS object.
 36    :param results: List of SegFrameObjects.
 37    """
 38    if not hip.landmarks:
 39        return None, None
 40
 41    left = hip.landmarks.left
 42    apex = hip.landmarks.apex
 43
 44    mid = (left[0] + apex[0]) / 2, (left[1] + apex[1]) / 2
 45
 46    illium = [
 47        seg_obj
 48        for seg_obj in results
 49        if seg_obj.cls == HipLabelsUS.IlliumAndAcetabulum
 50    ]
 51
 52    if len(illium) == 0:
 53        return None, None
 54
 55    illium = illium[0]
 56
 57    illium_midline = illium.midline
 58
 59    # reverse x and y in midline
 60    illium_midline = [(y, x) for x, y in illium_midline]
 61
 62    closest_illium = min(
 63        illium_midline,
 64        key=lambda point: abs(point[0] - mid[0]),
 65    )
 66
 67    return closest_illium, mid
 68
 69
 70def set_side(
 71    hip_datas: HipDatasUS,
 72    results: List[SegFrameObjects],
 73    allow_flipping,
 74) -> Tuple[HipDatasUS, List[SegFrameObjects]]:
 75    """
 76    Set the side for each HipDataUS object in the HipDatasUS object.
 77
 78    Returns the HipDatasUS object and the results with the Anterior side first.
 79
 80    :param hip_datas: HipDatasUS object.
 81    :param results: List of SegFrameObjects.
 82    :param allow_flipping: Boolean indicating if flipping is allowed.
 83
 84    :return: Tuple of HipDatasUS object and List of SegFrameObjects.
 85    """
 86
 87    # split the hip datas into two sides, based on graf frame
 88    front_side = []
 89    back_side = []
 90
 91    for hip_data, seg_frame_objs in zip(hip_datas, results):
 92        if hip_data.landmarks is None or hip_data.landmarks.apex is None:
 93            continue
 94
 95        closest_illium, mid = get_side_metainfo(hip_data, seg_frame_objs)
 96
 97        if closest_illium is None:
 98            continue
 99
100        # Find the y distance between the midline points
101        delta = mid[1] - closest_illium[1]
102
103        if hip_data.frame_no < hip_datas.graf_frame:
104            front_side.append(delta)
105        else:
106            back_side.append(delta)
107
108    for side in [("Front", front_side), ("Back", back_side)]:  # noqa
109        if len(side[1]) == 0:
110            hip_datas.recorded_error.append(f"No {side[0]} Side.")
111            hip_datas.recorded_error.critical = True
112
113    if len(front_side) == 0:
114        front_side = [0]
115    if len(back_side) == 0:
116        back_side = [0]
117
118    if front_side == [0] and back_side == [0]:
119        hip_datas.recorded_error.append("No Side Detected.")
120        return hip_datas, results
121
122    back_side_delta = sum(back_side) / len(back_side)
123    front_side_delta = sum(front_side) / len(front_side)
124
125    flip_frames = False
126    if (back_side_delta > front_side_delta) and allow_flipping:
127        hip_datas.recorded_error.append("Swapped Post and Ant")
128        hip_datas.hip_datas = hip_datas.hip_datas[::-1]
129        results = results[::-1]
130        hip_datas.graf_frame = len(hip_datas) - hip_datas.graf_frame
131        flip_frames = True
132
133    # set the side for each hip data
134    for i, hip_data in enumerate(hip_datas):
135        if flip_frames:
136            hip_data.frame_no = i
137        if hip_data.frame_no < hip_datas.graf_frame:
138            hip_data.side = Side.ANT
139        else:
140            hip_data.side = Side.POST
141
142    return hip_datas, results