Skip to content

Commit

Permalink
clean up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
amystamile-usgs committed Apr 26, 2024
1 parent e35fc47 commit 6e06809
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
11 changes: 7 additions & 4 deletions knoten/shape.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

class Ellipsoid:
"""
A biaxial ellipsoid shape model.
A biaxial or triaxial ellipsoid shape model.
"""

def __init__(self, semi_major, semi_minor=None, median=None):
Expand All @@ -15,9 +15,11 @@ def __init__(self, semi_major, semi_minor=None, median=None):
Parameters
----------
semi_major : float
The equatorial semi-major radius of the ellipsoid.
Length of ellipsoid semi-axis along the x-axis.
semi_minor : float
The polar semi-minor radius of the ellipsoid.
Length of ellipsoid semi-axis along the z-axis.
median : float
Length of ellipsoid semi-axis along the y-axis.
"""
self.a = semi_major
self.b = semi_major
Expand All @@ -34,7 +36,8 @@ def __init__(self, semi_major, semi_minor=None, median=None):
def from_csm_sensor(cls, sensor):
semi_major, semi_minor = csm.get_radii(sensor)
return cls(semi_major, semi_minor)



def get_surface_normal(self, ground_pt):
"""
Given a ground point, calculate the surface normal.
Expand Down
1 change: 0 additions & 1 deletion knoten/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ def sep_angle(a_vec, b_vec):
: np.ndarray
"""
dot_prod = a_vec.x * b_vec.x + a_vec.y * b_vec.y + a_vec.z * b_vec.z
print(dot_prod)
dot_prod /= magnitude(a_vec) * magnitude(b_vec)

if(dot_prod >= 1.0): return 0.0
Expand Down

0 comments on commit 6e06809

Please sign in to comment.