centerlineEvenlySpaced -> centerline_evenly_spaced

Author: cyschneck

README.md

@@ -23,7 +23,7 @@ Find the centerline and width of rivers based on the latitude and longitude posi
     * width()
     * centerline_voronoi
     * centerline_equal_distance
-    * centerlineEvenlySpaced
+    * centerline_evenly_spaced
     * centerlineSmoothed
     * centerlineLength
 * **Return river features**
@@ -227,7 +227,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
-* centerlineEvenlySpaced (list of tuples): List of the latitude and longitude coordinates of the centerline generated by evenly spacing out points generated by 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
 * centerlineLength (float): Length of the centerline of the river (in km)
 * rightBankLength (float): Length of the right bank of the river (in km)
@@ -313,9 +313,9 @@ river_object.centerline_equal_distance
 
 Centerline coordinates are formed by Evenly Spaced vertices, set by `interpolate_n_centerpoints`
 ```
-river_object.centerlineEvenlySpaced
+river_object.centerline_evenly_spaced
 ```
-| river_object.centerlineEvenlySpaced | river_object.centerlineEvenlySpacedRelative |
+| river_object.centerline_evenly_spaced | river_object.centerlineEvenlySpacedRelative |
 | ------------- | ------------- |
 | ![centerlineEvenlySpaced+png](https://raw.githubusercontent.com/cyschneck/centerline-width/main/data/doc_examples/evenly_spaced_centerline.png) | ![centerlineEvenlySpacedRelative+png](https://raw.githubusercontent.com/cyschneck/centerline-width/main/data/doc_examples/evenly_spaced_centerline_relative.png) |
 

centerline_width/plotDiagrams.py

@@ -115,7 +115,7 @@ def plotCenterlineBackend(
     if centerline_type == "Evenly Spaced":
         centerline_legend = "Evenly Spaced Centerline Coordinates"
         if coordinate_unit == "Decimal Degrees":
-            centerline_coordinates_by_type = river_object.centerlineEvenlySpaced
+            centerline_coordinates_by_type = river_object.centerline_evenly_spaced
         if coordinate_unit == "Relative Distance":
             centerline_coordinates_by_type = river_object.centerlineEvenlySpacedRelative
 
@@ -352,7 +352,8 @@ def plot_centerline_width(
                 # recreate the centerline with evenly spaced points
                 right_width_coordinates, left_width_coordinates, num_intersection_coordinates = centerline_width.riverWidthFromCenterlineCoordinates(
                     river_object=river_object,
-                    centerline_coordinates=river_object.centerlineEvenlySpaced,
+                    centerline_coordinates=river_object.
+                    centerline_evenly_spaced,
                     transect_span_distance=transect_span_distance,
                     transect_slope=transect_slope,
                     remove_intersections=remove_intersections,

centerline_width/pytests/test_verifyRiverCenterlineClass.py

@@ -417,7 +417,7 @@ def test_CenterlineWidth_default():
         pytest.approx((-92.86797615799243, 30.037635124296454)),
         pytest.approx((-92.86800507153629, 30.037548493536658))
     ]
-    assert river_class_example.centerlineEvenlySpaced == [
+    assert river_class_example.centerline_evenly_spaced == [
         pytest.approx((-92.86781887353752, 30.03824341873465)),
         pytest.approx((-92.86781591391708, 30.038216571334427)),
         pytest.approx((-92.86781295429665, 30.038189723934206)),
@@ -1883,7 +1883,7 @@ def test_CenterlineWidth_interpolateTrue():
         pytest.approx((-92.8679656786269, 30.037661458145394)),
         pytest.approx((-92.86799812738784, 30.037575780441053))
     ]
-    assert river_class_example.centerlineEvenlySpaced == [
+    assert river_class_example.centerline_evenly_spaced == [
         pytest.approx((-92.86782125207236, 30.03827120587997)),
         pytest.approx((-92.86781877818767, 30.03824331037043)),
         pytest.approx((-92.8678157919604, 30.038215465037222)),

centerline_width/pytests/test_verifyWidth.py

@@ -41,13 +41,13 @@ def generate_testRiver():
 def generate_expectedCenterline(span_distance=None):
     # group points inclusive of previous point: [A, B, C, D] = [A, B], [B, C], [C, D]
     groups_of_n_points = []
-    for i in range(0, len(test_river.centerlineEvenlySpaced), span_distance):
+    for i in range(0, len(test_river.centerline_evenly_spaced), span_distance):
         if i == 0:
             groups_of_n_points.append(
-                test_river.centerlineEvenlySpaced[0:span_distance])
+                test_river.centerline_evenly_spaced[0:span_distance])
         else:
             groups_of_n_points.append(
-                test_river.centerlineEvenlySpaced[i - 1:i + span_distance])
+                test_river.centerline_evenly_spaced[i - 1:i + span_distance])
 
     centerline_slope_expected = []
     for group_points in groups_of_n_points:

centerline_width/riverCenterlineClass.py

@@ -166,9 +166,12 @@ def __init__(self,
         self.centerlineEvenlySpaced = centerline_width.evenlySpacedCenterline(
             centerline_coordinates=self.centerline_voronoi,
             number_of_fixed_points=self.interpolate_n_centerpoints)
+        self.centerline_evenly_spaced = centerline_width.evenlySpacedCenterline(
+            centerline_coordinates=self.centerline_voronoi,
+            number_of_fixed_points=self.interpolate_n_centerpoints)
         self.centerlineSmoothed = centerline_width.smoothedCoordinates(
             river_object=self,
-            centerline_coordinates=self.centerlineEvenlySpaced,
+            centerline_coordinates=self.centerline_evenly_spaced,
             interprolate_num=self.interpolate_n_centerpoints)
 
         # Relative Distance from bottom left bank point to each Centerline coordinates
@@ -179,15 +182,15 @@ def __init__(self,
             self.left_bank_coordinates[0], self.centerlineEqualDistance,
             self.ellipsoid)
         self.centerlineEvenlySpacedRelative = centerline_width.relativeCenterlineCoordinates(
-            self.left_bank_coordinates[0], self.centerlineEvenlySpaced,
+            self.left_bank_coordinates[0], self.centerline_evenly_spaced,
             self.ellipsoid)
         self.centerlineSmoothedRelative = centerline_width.relativeCenterlineCoordinates(
             self.left_bank_coordinates[0], self.centerlineSmoothed,
             self.ellipsoid)
 
         # Overall Sinuosity
         self.sinuosity = centerline_width.calculateSinuosity(
-            self.centerlineEvenlySpaced, self.ellipsoid)
+            self.centerline_evenly_spaced, self.ellipsoid)
 
     def incremental_sinuosity(self,
                               incremental_points: int = 10,

centerline_width/riverFeatures.py

@@ -84,11 +84,11 @@ def incremental_sinuosity(
         incremental_points=incremental_points,
         save_to_csv=save_to_csv)
 
-    if river_object.centerlineEvenlySpaced is None:
+    if river_object.centerline_evenly_spaced is None:
         return {}
 
     # Ignore the first and last point in the coordinates
-    centerline_coordinates = river_object.centerlineEvenlySpaced[1:-1]
+    centerline_coordinates = river_object.centerline_evenly_spaced[1:-1]
 
     # Separate centerline in groups of incremental_points long
     centerline_groups = list(

centerline_width/saveOutput.py

@@ -57,7 +57,7 @@ def save_centerline_csv(river_object: centerline_width.CenterlineWidth = None,
         if centerline_type == "Equal Distance":
             centerline_coordinates_by_type = river_object.centerline_equal_distance
         if centerline_type == "Evenly Spaced":
-            centerline_coordinates_by_type = river_object.centerlineEvenlySpaced
+            centerline_coordinates_by_type = river_object.centerline_evenly_spaced
         if centerline_type == "Smoothed":
             centerline_coordinates_by_type = river_object.centerlineSmoothed
     if coordinate_unit == "Relative Distance":
@@ -120,7 +120,7 @@ def save_centerline_mat(river_object: centerline_width.CenterlineWidth = None,
         if centerline_type == "Equal Distance":
             centerline_coordinates_by_type = river_object.centerline_equal_distance
         if centerline_type == "Evenly Spaced":
-            centerline_coordinates_by_type = river_object.centerlineEvenlySpaced
+            centerline_coordinates_by_type = river_object.centerline_evenly_spaced
         if centerline_type == "Smoothed":
             centerline_coordinates_by_type = river_object.centerlineSmoothed
     if coordinate_unit == "Relative Distance":

centerline_width/width.py

@@ -370,7 +370,7 @@ def width(river_object: centerline_width.CenterlineWidth = None,
     else:
         right_width_coordinates, left_width_coordinates, num_intersection_coordinates = centerline_width.riverWidthFromCenterlineCoordinates(
             river_object=river_object,
-            centerline_coordinates=river_object.centerlineEvenlySpaced,
+            centerline_coordinates=river_object.centerline_evenly_spaced,
             transect_span_distance=transect_span_distance,
             remove_intersections=remove_intersections,
             coordinate_unit="Decimal Degrees")

river_centerline_width_example.py

@@ -37,6 +37,8 @@
     print("centerline_voronoi = {0}".format(river.centerline_voronoi))
     print("centerline_equal_distance = {0}".format(
         river.centerline_equal_distance))
+    print("centerline_evenly_spaced = {0}".format(
+        river.centerline_evenly_spaced))
     '''
     print("\nCenterline Length = {0} km".format(river.centerlineLength))
     print("Centerline Length = {0} m".format(river.centerlineLength * 1000))
@@ -47,7 +49,6 @@
         river.centerlineVoronoiRelative))
     print("equalDistanceCenterlineRelative = {0}".format(
         river.centerlineEqualDistanceRelative))
-    print("centerlineEvenlySpaced = {0}".format(river.centerlineEvenlySpaced))
     print("centerlineEvenlySpacedRelative = {0}".format(
         river.centerlineEvenlySpacedRelative))
     print("centerlineSmoothed = {0}".format(river.centerlineSmoothed))

river_centerline_width_example_deprecation.py

@@ -39,6 +39,7 @@
     print("centerlineVoronoi = {0}".format(river.centerlineVoronoi))
     print("equalDistanceCenterline = {0}".format(
         river.centerlineEqualDistance))
+    print("centerlineEvenlySpaced = {0}".format(river.centerlineEvenlySpaced))
     '''
     print("\nCenterline Length = {0} km".format(river.centerlineLength))
     print("Centerline Length = {0} m".format(river.centerlineLength * 1000))
@@ -49,7 +50,6 @@
         river.centerlineVoronoiRelative))
     print("equalDistanceCenterlineRelative = {0}".format(
         river.centerlineEqualDistanceRelative))
-    print("centerlineEvenlySpaced = {0}".format(river.centerlineEvenlySpaced))
     print("centerlineEvenlySpacedRelative = {0}".format(
         river.centerlineEvenlySpacedRelative))
     print("centerlineSmoothed = {0}".format(river.centerlineSmoothed))