Skip to content

Commit

Permalink
Fix surfpt docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
helgee committed Feb 8, 2019
1 parent 3269156 commit 6b990a6
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions src/s.jl
Original file line number Diff line number Diff line change
Expand Up @@ -267,13 +267,25 @@ function subpnt(method, target, et, fixref, obsrvr; abcorr="NONE")
end

"""
positn I Position of the observer in body-fixed frame.
u I Vector from the observer in some direction.
a I Length of the ellipsoid semi-axis along the x-axis.
b I Length of the ellipsoid semi-axis along the y-axis.
c I Length of the ellipsoid semi-axis along the z-axis.
point O Point on the ellipsoid pointed to by u.
found O Flag indicating if u points at the ellipsoid.
surfpt(positn, u, a, b, c)
Determine the intersection of a line-of-sight vector with the surface of an ellipsoid.
### Arguments ###
- `positn`: Position of the observer in body-fixed frame
- `u`: Vector from the observer in some direction
- `a`: Length of the ellipsoid semi-axis along the x-axis
- `b`: Length of the ellipsoid semi-axis along the y-axis
- `c`: Length of the ellipsoid semi-axis along the z-axis
### Output ###
Returns the point on the ellipsoid pointed to by u or `nothing` if none was found.
### References ###
- [NAIF Documentation](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/surfpt_c.html)
"""
function surfpt(positn, u, a, b, c)
length(positn) != 3 && throw(ArgumentError("Length of `positn` must be 3."))
Expand Down

0 comments on commit 6b990a6

Please sign in to comment.