retuve.hip_us.modes

 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"""
16Contains the code for the two different operation modes of the hip US module:
17
18- Segmentation: For getting landmarks from the segmentation results.
19- Landmarks: For getting metrics from the landmarks.
20
21Retuve supports either models that generate segmentaitions or landmarks. The
22correct mode(s) will be used based on the model provided.
23"""