centerlineLength -> centerline_length

Author: cyschneck

README.md

@@ -25,8 +25,8 @@ Find the centerline and width of rivers based on the latitude and longitude posi
     * centerline_equal_distance
     * centerline_evenly_spaced
     * centerline_smoothed
-    * centerlineLength
 * **Return river features**
+    * centerline_length
     * rightBankLength
     * leftBankLength
     * area
@@ -229,7 +229,7 @@ The red pins represent the equal distance centerline coordinates produced by cen
 * 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
 * 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)
+* centerline_length (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)
 * area (float): Area contained within river bank polygon (in km^2)
@@ -382,13 +382,13 @@ Returns a .mat file with the Latitude and Longitude coordinates of the specified
 ### Length of Centerline
 Return the length of the centerline found between the left and right bank generated by the Voronoi diagram
 ```
-river_object.centerlineLength
+river_object.centerline_length
 ```
 Length returned in kilometers
 ```python
 import centerline_width
 river_object = centerline_width.CenterlineWidth(csv_data="data/river_coords.csv")
-river_centerline_length = river_object.centerlineLength
+river_centerline_length = river_object.centerline_length
 ```
 The length of the river centerline returns `215.34700589636674` km
 

centerline_width/pytests/test_verifyRiverCenterlineClass.py

@@ -403,7 +403,7 @@ def test_CenterlineWidth_default():
         pytest.approx((-92.86800742482134, 30.03754989867807)),
         pytest.approx((-92.86801289742837, 30.03752504557166))
     ]
-    assert river_class_example.centerlineLength == pytest.approx(
+    assert river_class_example.centerline_length == pytest.approx(
         0.08284102060354828)
     assert river_class_example.equal_distance == 10
     assert river_class_example.centerline_equal_distance == [
@@ -1869,7 +1869,7 @@ def test_CenterlineWidth_interpolateTrue():
         pytest.approx((-92.86800742482134, 30.03754989867807)),
         pytest.approx((-92.86801289742837, 30.03752504557166))
     ]
-    assert river_class_example.centerlineLength == pytest.approx(
+    assert river_class_example.centerline_length == pytest.approx(
         0.08592777952584983)
     assert river_class_example.equal_distance == 10
     assert river_class_example.centerline_equal_distance == [

centerline_width/pytests/test_verifyRiverFeatures.py

@@ -111,7 +111,7 @@ def river_class_object():
 
 ## riverFeatures() #####################################################
 def test_riverFeatures_centerlineLength():
-    assert river_class_example.centerlineLength == pytest.approx(
+    assert river_class_example.centerline_length == pytest.approx(
         0.08284102060354828)
 
 

centerline_width/riverCenterlineClass.py

@@ -152,6 +152,9 @@ def __init__(self,
         self.centerlineLength = centerline_width.centerlineLength(
             centerline_coordinates=shortest_path_coordinates,
             ellipsoid=self.ellipsoid)
+        self.centerline_length = centerline_width.centerlineLength(
+            centerline_coordinates=shortest_path_coordinates,
+            ellipsoid=self.ellipsoid)
 
         # Set the different types of Centerline coordinates
         self.equal_distance = equal_distance

river_centerline_width_example.py

@@ -40,8 +40,8 @@
     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))
     print("Right Bank Length = {0} km".format(river.rightBankLength))
     print("Left Bank Length = {0} km".format(river.leftBankLength))

river_centerline_width_example_deprecation.py

@@ -41,8 +41,8 @@
         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))
     print("Right Bank Length = {0} km".format(river.rightBankLength))
     print("Left Bank Length = {0} km".format(river.leftBankLength))