centerlineSmoothedRelative -> centerline_smoothed_relative

Author: cyschneck

README.md

@@ -237,7 +237,7 @@ The red pins represent the equal distance centerline coordinates produced by cen
 * centerline_voronoi_relative (list of tuples): List of the relative distance coordinates of the centerline generated by Voronoi diagrams
 * centerline_equal_distance_relative (list of tuples): List of the relative distance coordinates of the centerline generated by equal distances between coordinates from the Voronoi diagrams
 * centerline_evenly_spaced_relative (list of tuples): List of the relative distance coordinates of the centerline generated by evenly spacing out points generated by the Voronoi diagrams
-* centerlineSmoothedRelative (list of tuples): List of the relative distance coordinates of the centerline generated by smoothing out the evenly spaced out points generated by the Voronoi diagrams
+* centerline_smoothed_relative (list of tuples): List of the relative distance coordinates of the centerline generated by smoothing out the evenly spaced out points generated by the Voronoi diagrams
 
 <details closed>
 <summary><b>Object (class) additional attributes:</b> (Click to view all)</summary>
@@ -323,7 +323,7 @@ Centerline coordinates are formed from Smoothed vertices
 ```
 river_object.centerline_smoothed
 ```
-| river_object.centerline_smoothed | river_object.centerlineSmoothedRelative |
+| river_object.centerline_smoothed | river_object.centerline_smoothed_relative |
 | ------------- | ------------- |
 | ![centerlineEvenlySpaced+png](https://raw.githubusercontent.com/cyschneck/centerline-width/main/data/doc_examples/smoothed_centerline.png) | ![centerlineEvenlySpacedRelative+png](https://raw.githubusercontent.com/cyschneck/centerline-width/main/data/doc_examples/smoothed_centerline_relative.png) |
 

centerline_width/plotDiagrams.py

@@ -124,7 +124,7 @@ def plotCenterlineBackend(
         if coordinate_unit == "Decimal Degrees":
             centerline_coordinates_by_type = river_object.centerline_smoothed
         if coordinate_unit == "Relative Distance":
-            centerline_coordinates_by_type = river_object.centerlineSmoothedRelative
+            centerline_coordinates_by_type = river_object.centerline_smoothed_relative
 
     # Plot the centerline coordinates
     if centerline_coordinates_by_type:
@@ -339,7 +339,7 @@ def plot_centerline_width(
                 if coordinate_unit == "Decimal Degrees":
                     smoothed_coords = river_object.centerline_smoothed
                 if coordinate_unit == "Relative Distance":
-                    smoothed_coords = river_object.centerlineSmoothedRelative
+                    smoothed_coords = river_object.centerline_smoothed_relative
                 for k, v in smoothed_coords:
                     x.append(k)
                     y.append(v)

centerline_width/pytests/test_verifyRiverCenterlineClass.py

@@ -544,7 +544,7 @@ def test_CenterlineWidth_default():
         pytest.approx((-3.242532102266962, 54.17801808352102)),
         pytest.approx((-6.163506358375243, 53.60729340259522))
     ]
-    assert river_class_example.centerlineSmoothedRelative == [
+    assert river_class_example.centerline_smoothed_relative == [
         pytest.approx((73.52246060342735, 72.49167057298256)),
         pytest.approx((70.47686340416793, 72.89719088368028)),
         pytest.approx((67.46092539809182, 73.13889337599008)),
@@ -2019,7 +2019,7 @@ def test_CenterlineWidth_interpolateTrue():
         pytest.approx((-3.136784877238625, 54.20536200865886)),
         pytest.approx((-6.163506358375243, 53.60729340259522))
     ]
-    assert river_class_example.centerlineSmoothedRelative == [
+    assert river_class_example.centerline_smoothed_relative == [
         pytest.approx((76.63553244637076, 71.97906499637598)),
         pytest.approx((73.46054425852371, 72.56088597649791)),
         pytest.approx((70.31707172940611, 72.95911928491681)),

centerline_width/riverCenterlineClass.py

@@ -185,7 +185,8 @@ def __init__(self,
         self.centerlineSmoothed = centerline_width.smoothedCoordinates(
             river_object=self,
             centerline_coordinates=self.centerline_evenly_spaced,
-            interprolate_num=self.interpolate_n_centerpoints)
+            interprolate_num=self.interpolate_n_centerpoints
+        )  # Pending Deprecation
         self.centerline_smoothed = centerline_width.smoothedCoordinates(
             river_object=self,
             centerline_coordinates=self.centerline_evenly_spaced,
@@ -214,6 +215,9 @@ def __init__(self,
             self.ellipsoid)
 
         self.centerlineSmoothedRelative = centerline_width.relativeCenterlineCoordinates(
+            self.left_bank_coordinates[0], self.centerline_smoothed,
+            self.ellipsoid)  # Pending Deprecation
+        self.centerline_smoothed_relative = centerline_width.relativeCenterlineCoordinates(
             self.left_bank_coordinates[0], self.centerline_smoothed,
             self.ellipsoid)
 

centerline_width/saveOutput.py

@@ -68,7 +68,7 @@ def save_centerline_csv(river_object: centerline_width.CenterlineWidth = None,
         if centerline_type == "Evenly Spaced":
             centerline_coordinates_by_type = river_object.centerline_evenly_spaced_relative
         if centerline_type == "Smoothed":
-            centerline_coordinates_by_type = river_object.centerlineSmoothedRelative
+            centerline_coordinates_by_type = river_object.centerline_smoothed_relative
 
     # set default latitude/longitude headers
     if coordinate_unit == "Decimal Degrees":
@@ -131,7 +131,7 @@ def save_centerline_mat(river_object: centerline_width.CenterlineWidth = None,
         if centerline_type == "Evenly Spaced":
             centerline_coordinates_by_type = river_object.centerline_evenly_spaced_relative
         if centerline_type == "Smoothed":
-            centerline_coordinates_by_type = river_object.centerlineSmoothedRelative
+            centerline_coordinates_by_type = river_object.centerline_smoothed_relative
 
     # .mat files do not allow for spaces or special characters in the header
     # convert spaces/special characters to underscores

river_centerline_width_example.py

@@ -49,11 +49,11 @@
         river.centerline_equal_distance_relative))
     print("centerline_evenly_spaced_relative = {0}".format(
         river.centerline_evenly_spaced_relative))
+    print("centerline_smoothed_relative = {0}".format(
+        river.centerline_smoothed_relative))
     '''
     print("Centerline Length = {0} m".format(river.centerlineLength * 1000))
     print("ellipsoid = {0}".format(river.ellipsoid))
-    print("centerlineSmoothedRelative = {0}".format(
-        river.centerlineSmoothedRelative))
     print(river.right_bank_relative_coordinates)
     print(river.left_bank_relative_coordinates)
     '''

river_centerline_width_example_deprecation.py

@@ -50,11 +50,11 @@
         river.centerlineEqualDistanceRelative))
     print("centerlineEvenlySpacedRelative = {0}".format(
         river.centerlineEvenlySpacedRelative))
+    print("centerlineSmoothedRelative = {0}".format(
+        river.centerlineSmoothedRelative))
     '''
     print("Centerline Length = {0} m".format(river.centerlineLength * 1000))
     print("ellipsoid = {0}".format(river.ellipsoid))
-    print("centerlineSmoothedRelative = {0}".format(
-        river.centerlineSmoothedRelative))
     print(river.right_bank_relative_coordinates)
     print(river.left_bank_relative_coordinates)
     '''