centerlineSmoothed -> centerline_smoothed

Author: cyschneck

README.md

@@ -24,7 +24,7 @@ Find the centerline and width of rivers based on the latitude and longitude posi
     * centerline_voronoi
     * centerline_equal_distance
     * centerline_evenly_spaced
-    * centerlineSmoothed
+    * centerline_smoothed
     * centerlineLength
 * **Return river features**
     * rightBankLength
@@ -228,7 +228,7 @@ The red pins represent the equal distance centerline coordinates produced by cen
 * centerline_voronoi (list of tuples): List of the latitude and longitude coordinates of the centerline generated by Voronoi diagrams
 * centerline_equal_distance (list of tuples): List of the latitude and longitude coordinates of the centerline generated by equal distances between coordinates from the Voronoi diagrams
 * centerline_evenly_spaced (list of tuples): List of the latitude and longitude coordinates of the centerline generated by evenly spacing out points generated by the Voronoi diagrams
-* centerlineSmoothed (list of tuples): List of the latitude and longitude coordinates of the centerline generated by smoothing out the evenly spaced-out points generated by the Voronoi diagrams
+* centerline_smoothed (list of tuples): List of the latitude and longitude coordinates of the centerline generated by smoothing out the evenly spaced-out points generated by the Voronoi diagrams
 * centerlineLength (float): Length of the centerline of the river (in km)
 * rightBankLength (float): Length of the right bank of the river (in km)
 * leftBankLength (float): Length of the left bank of the river (in km)
@@ -321,9 +321,9 @@ river_object.centerline_evenly_spaced
 
 Centerline coordinates are formed from Smoothed vertices
 ```
-river_object.centerlineSmoothed
+river_object.centerline_smoothed
 ```
-| river_object.centerlineSmoothed | river_object.centerlineSmoothedRelative |
+| river_object.centerline_smoothed | river_object.centerlineSmoothedRelative |
 | ------------- | ------------- |
 | ![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) |
 
@@ -777,7 +777,7 @@ This can be fixed by using the flip_direction optional argument `centerline_widt
 ![invalid_flipped_banks+png](https://raw.githubusercontent.com/cyschneck/centerline-width/main/data/doc_examples/invalid_flipped_banks.png)
 
 ### Invalid Smoothed Centerline
-The smoothed centerline (`river_object.centerlineSmoothed`) can end up lying outside the river if the centerline data points are sparse in a narrow river. If more than two points in the smoothed centerline lie outside the river, a warning will be thrown
+The smoothed centerline (`river_object.centerline_smoothed`) can end up lying outside the river if the centerline data points are sparse in a narrow river. If more than two points in the smoothed centerline lie outside the river, a warning will be thrown
 
 Example Error: `WARNING: Partially invalid smoothed centerline due to sparse centerline data (6 points lie outside the polygon), fix recommendation: rerun CenterlineWidth to create river object with interpolate_n_centerpoints set to 62+`
 

centerline_width/plotDiagrams.py

@@ -122,7 +122,7 @@ def plotCenterlineBackend(
     if centerline_type == "Smoothed":
         centerline_legend = "Smoothed Centerline Coordinates"
         if coordinate_unit == "Decimal Degrees":
-            centerline_coordinates_by_type = river_object.centerlineSmoothed
+            centerline_coordinates_by_type = river_object.centerline_smoothed
         if coordinate_unit == "Relative Distance":
             centerline_coordinates_by_type = river_object.centerlineSmoothedRelative
 
@@ -329,15 +329,15 @@ def plot_centerline_width(
             if apply_smoothing:
                 right_width_coordinates, left_width_coordinates, num_intersection_coordinates = centerline_width.riverWidthFromCenterlineCoordinates(
                     river_object=river_object,
-                    centerline_coordinates=river_object.centerlineSmoothed,
+                    centerline_coordinates=river_object.centerline_smoothed,
                     transect_span_distance=transect_span_distance,
                     transect_slope=transect_slope,
                     remove_intersections=remove_intersections,
                     coordinate_unit=coordinate_unit)
                 x = []
                 y = []
                 if coordinate_unit == "Decimal Degrees":
-                    smoothed_coords = river_object.centerlineSmoothed
+                    smoothed_coords = river_object.centerline_smoothed
                 if coordinate_unit == "Relative Distance":
                     smoothed_coords = river_object.centerlineSmoothedRelative
                 for k, v in smoothed_coords:

centerline_width/pytests/test_verifyRiverCenterlineClass.py

@@ -448,7 +448,7 @@ def test_CenterlineWidth_default():
         pytest.approx((-92.86800697996587, 30.03755139550792)),
         pytest.approx((-92.86801289742837, 30.03752504557166))
     ]
-    assert river_class_example.centerlineSmoothed == [
+    assert river_class_example.centerline_smoothed == [
         pytest.approx((-92.86781709744432, 30.03824388764834)),
         pytest.approx((-92.8678128931592, 30.03821641344848)),
         pytest.approx((-92.86781038736042, 30.038189206812227)),
@@ -1914,7 +1914,7 @@ def test_CenterlineWidth_interpolateTrue():
         pytest.approx((-92.86800669645666, 30.03755234944709)),
         pytest.approx((-92.86801289742837, 30.03752504557166))
     ]
-    assert river_class_example.centerlineSmoothed == [
+    assert river_class_example.centerline_smoothed == [
         pytest.approx((-92.86782241200312, 30.038271970539554)),
         pytest.approx((-92.86781637981315, 30.038243329100077)),
         pytest.approx((-92.86781225108764, 30.038214971972298)),

centerline_width/riverCenterlineClass.py

@@ -173,6 +173,10 @@ def __init__(self,
             river_object=self,
             centerline_coordinates=self.centerline_evenly_spaced,
             interprolate_num=self.interpolate_n_centerpoints)
+        self.centerline_smoothed = centerline_width.smoothedCoordinates(
+            river_object=self,
+            centerline_coordinates=self.centerline_evenly_spaced,
+            interprolate_num=self.interpolate_n_centerpoints)
 
         # Relative Distance from bottom left bank point to each Centerline coordinates
         self.centerlineVoronoiRelative = centerline_width.relativeCenterlineCoordinates(
@@ -185,7 +189,7 @@ def __init__(self,
             self.left_bank_coordinates[0], self.centerline_evenly_spaced,
             self.ellipsoid)
         self.centerlineSmoothedRelative = centerline_width.relativeCenterlineCoordinates(
-            self.left_bank_coordinates[0], self.centerlineSmoothed,
+            self.left_bank_coordinates[0], self.centerline_smoothed,
             self.ellipsoid)
 
         # Overall Sinuosity

centerline_width/saveOutput.py

@@ -59,7 +59,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
         if centerline_type == "Smoothed":
-            centerline_coordinates_by_type = river_object.centerlineSmoothed
+            centerline_coordinates_by_type = river_object.centerline_smoothed
     if coordinate_unit == "Relative Distance":
         if centerline_type == "Voronoi":
             centerline_coordinates_by_type = river_object.centerlineVoronoiRelative
@@ -122,7 +122,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
         if centerline_type == "Smoothed":
-            centerline_coordinates_by_type = river_object.centerlineSmoothed
+            centerline_coordinates_by_type = river_object.centerline_smoothed
     if coordinate_unit == "Relative Distance":
         if centerline_type == "Voronoi":
             centerline_coordinates_by_type = river_object.centerlineVoronoiRelative

centerline_width/width.py

@@ -363,7 +363,7 @@ def width(river_object: centerline_width.CenterlineWidth = None,
         # if using smoothing, replace left/right coordinates with the smoothed variation
         right_width_coordinates, left_width_coordinates, num_intersection_coordinates = centerline_width.riverWidthFromCenterlineCoordinates(
             river_object=river_object,
-            centerline_coordinates=river_object.centerlineSmoothed,
+            centerline_coordinates=river_object.centerline_smoothed,
             transect_span_distance=transect_span_distance,
             remove_intersections=remove_intersections,
             coordinate_unit="Decimal Degrees")

river_centerline_width_example.py

@@ -39,6 +39,7 @@
         river.centerline_equal_distance))
     print("centerline_evenly_spaced = {0}".format(
         river.centerline_evenly_spaced))
+    print("centerline_smoothed = {0}".format(river.centerline_smoothed))
     '''
     print("\nCenterline Length = {0} km".format(river.centerlineLength))
     print("Centerline Length = {0} m".format(river.centerlineLength * 1000))
@@ -51,7 +52,6 @@
         river.centerlineEqualDistanceRelative))
     print("centerlineEvenlySpacedRelative = {0}".format(
         river.centerlineEvenlySpacedRelative))
-    print("centerlineSmoothed = {0}".format(river.centerlineSmoothed))
     print("centerlineSmoothedRelative = {0}".format(
         river.centerlineSmoothedRelative))
     print(river.right_bank_relative_coordinates)

river_centerline_width_example_deprecation.py

@@ -40,6 +40,7 @@
     print("equalDistanceCenterline = {0}".format(
         river.centerlineEqualDistance))
     print("centerlineEvenlySpaced = {0}".format(river.centerlineEvenlySpaced))
+    print("centerlineSmoothed = {0}".format(river.centerlineSmoothed))
     '''
     print("\nCenterline Length = {0} km".format(river.centerlineLength))
     print("Centerline Length = {0} m".format(river.centerlineLength * 1000))
@@ -52,7 +53,6 @@
         river.centerlineEqualDistanceRelative))
     print("centerlineEvenlySpacedRelative = {0}".format(
         river.centerlineEvenlySpacedRelative))
-    print("centerlineSmoothed = {0}".format(river.centerlineSmoothed))
     print("centerlineSmoothedRelative = {0}".format(
         river.centerlineSmoothedRelative))
     print(river.right_bank_relative_coordinates)