From c723fd5262f9a0ad00f4847263196a0c0dd424aa Mon Sep 17 00:00:00 2001
From: Nathan Painchaud <23144457+nathanpainchaud@users.noreply.github.com>
Date: Mon, 6 Nov 2023 23:24:30 +0100
Subject: [PATCH] Fix the name of the `gls` method, since it no longer computes
 strictly global strain (#180)

- Also add missing docstring for `half` arg
---
 vital/utils/image/us/measure.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/vital/utils/image/us/measure.py b/vital/utils/image/us/measure.py
index 08f9984b..c785e8cb 100644
--- a/vital/utils/image/us/measure.py
+++ b/vital/utils/image/us/measure.py
@@ -397,7 +397,7 @@ def endo_epi_control_points(
 
     @staticmethod
     @auto_cast_data
-    def gls(
+    def longitudinal_strain(
         segmentation: T,
         lv_labels: SemanticStructureId,
         myo_labels: SemanticStructureId,
@@ -411,6 +411,8 @@ def gls(
                 ED instant.
             lv_labels: Labels of the classes that are part of the left ventricle.
             myo_labels: Labels of the classes that are part of the myocardium.
+            half: The half of the endocardium to consider when computing the strain. `None` to compute a global strain,
+                and either "left" or "right" to compute local strain.
             voxelspacing: Size of the segmentation's voxels along each (height, width) dimension (in mm).
 
         Returns: