Better doc get_coordinate_cursor

Thiago Franco de Moraes
1 parent 519c44b4
Showing 1 changed file with 12 additions and 1 deletions Show diff stats
invesalius/data/viewer_slice.py
@@ -976,7 +976,18 @@ class Viewer(wx.Panel):
         return mx, my
  
     def get_coordinate_cursor(self, mx, my, picker=None):
-        # Find position
+        """
+        Given the mx, my screen position returns the x, y, z position in world
+        coordinates.
+
+        Parameters
+            mx (int): x position.
+            my (int): y position
+            picker: the picker used to get calculate the voxel coordinate.
+
+        Returns:
+            world coordinate (x, y, z)
+        """
         if picker is None:
             picker = self.pick
...	...	@@ -976,7 +976,18 @@ class Viewer(wx.Panel):
976	976	return mx, my
977	977
978	978	def get_coordinate_cursor(self, mx, my, picker=None):
979		- # Find position
	979	+ """
	980	+ Given the mx, my screen position returns the x, y, z position in world
	981	+ coordinates.
	982	+
	983	+ Parameters
	984	+ mx (int): x position.
	985	+ my (int): y position
	986	+ picker: the picker used to get calculate the voxel coordinate.
	987	+
	988	+ Returns:
	989	+ world coordinate (x, y, z)
	990	+ """
980	991	if picker is None:
981	992	picker = self.pick
982	993
...	...