renaming of RTB data access functions

petercorke · petercorke · commit 73cdc5f676e3 · 2021-09-13T12:08:57.000+10:00
diff --git a/roboticstoolbox/mobile/Animations.py b/roboticstoolbox/mobile/Animations.py
@@ -14,7 +14,7 @@
 import matplotlib.transforms as mtransforms
 
 from spatialmath import SE2, base
-from roboticstoolbox import rtb_loaddata
+from roboticstoolbox import rtb_load_data
 
 
 class VehicleAnimation(ABC):
diff --git a/roboticstoolbox/mobile/PoseGraph.py b/roboticstoolbox/mobile/PoseGraph.py
@@ -98,7 +98,7 @@ def __init__(self, filename, laser=False, verbose=False):
         
         self.graph = pgraph.UGraph(verbose=verbose)
 
-        path = Path(rtb.path_to_datafile(filename))
+        path = Path(rtb.rtb_path_to_datafile(filename))
 
         if path.suffix == '.zip':
             zf = zipfile.ZipFile(path, 'r')
diff --git a/roboticstoolbox/tools/__init__.py b/roboticstoolbox/tools/__init__.py
@@ -7,7 +7,7 @@
 from roboticstoolbox.tools.numerical import jacobian_numerical, \
     hessian_numerical
 from roboticstoolbox.tools.jsingu import jsingu
-from roboticstoolbox.tools.data import rtb_loaddata, rtb_loadmat, rtb_path_to_datafile
+from roboticstoolbox.tools.data import rtb_load_data, rtb_load_matfile, rtb_load_jsonfile, rtb_path_to_datafile
 
 
 __all__ = [
@@ -26,7 +26,8 @@
     'jsingu',
     'jacobian_numerical',
     'hessian_numerical',
-    'rtb_loaddata',
-    'rtb_loadmat',
+    'rtb_load_data',
+    'rtb_load_matfile',
+    'rtb_load_jsonfile',
     'rtb_path_to_datafile',
 ]
diff --git a/roboticstoolbox/tools/data.py b/roboticstoolbox/tools/data.py
@@ -3,8 +3,7 @@
 import importlib
 
 
-
-def rtb_loadmat(filename):
+def rtb_load_matfile(filename):
     """
     Load toolbox mat format data file
 
@@ -27,9 +26,33 @@ def rtb_loadmat(filename):
     """
     from scipy.io import loadmat
 
-    return rtb_loaddata(filename, loadmat, squeeze_me=True, struct_as_record=False)
+    return rtb_load_data(filename, loadmat, squeeze_me=True, struct_as_record=False)
+
+def rtb_load_jsonfile(filename):
+    """
+    Load toolbox JSON format data file
+
+    :param filename: relative pathname of datafile
+    :type filename: str
+    :raises ValueError: File does not exist
+    :return: contents of JSON data file
+    :rtype: dict
+
+    Reads a JSON format file which can contain multiple variables and return
+    a dict where the keys are the variable
+    names and the values are NumPy arrays.
+
+    .. note::
+        - If the filename has no path component, eg. ``map1.mat`, it will be 
+          first be looked for in the folder ``roboticstoolbox/data``.
+    
+    :seealso: :func:`path_to_datafile`
+    """
+    import json
+
+    return rtb_load_data(filename, lambda f: json.load(open(f, 'r')))
 
-def rtb_loaddata(filename, handler, **kwargs):
+def rtb_load_data(filename, handler, **kwargs):
     """
     Load toolbox data file
 
@@ -47,7 +70,7 @@ def rtb_loaddata(filename, handler, **kwargs):
 
     For example::
 
-        data = rtb_loaddata('data/queensland.json', lambda f: json.load(open(f, 'r')))
+        data = rtb_load_data('data/queensland.json', lambda f: json.load(open(f, 'r')))
 
     
     .. note:: If the filename has no path component, eg. ``foo.dat``, it will 
