Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrong docstring for rv_to_mean_elements_j2osc #67

Closed
ThatcherC opened this issue Sep 23, 2021 · 1 comment
Closed

Wrong docstring for rv_to_mean_elements_j2osc #67

ThatcherC opened this issue Sep 23, 2021 · 1 comment

Comments

@ThatcherC
Copy link
Contributor

It looks like the docstring for rv_to_mean_elements_j2osc is pretty much a duplication of rv_to_mean_elements_sgp4 despite the functions being very different. For example, the j2osc docstring references BSTAR and SGP4_GravCte, neither of which are used in the j2osc function and neither of which are valid arguments to the j2osc function.

"""
rv_to_mean_elements_j2osc(vJD::AbstractVector{T}, vr::AbstractVector{Tv}, vv::AbstractVector{Tv}, W = I; mean_elements_epoch::Symbol = :end, max_it::Int = 50, j2_gc = sgp4_gc_wgs84, atol::Number = 2e-4, rtol::Number = 2e-4) where {T,Tv<:AbstractVector}
Compute the mean elements for SGP4 based on the position `vr` and velocity
vectors `vr` represented in TEME reference frame. The epoch of those
measurements [Julian Day] must be in `vJD`.
The matrix `W` defined the weights for the least-square algorithm.
# Keywords
* `estimate_bstar`: If `true`, then the BSTAR parameters of the TLE will be
estimated.
* `mean_elements_epoch`: If it is `:end`, the epoch of the mean elements will
be equal to the last value in `vJD`. Otherwise, if it
is `:begin`, the epoch will be selected as the first
value in `vJD`.
* `max_it`: The maximum allowed number of iterations.
* `sgp4_gc`: SPG4 constants (see `SGP4_GravCte`).
* `atol`: The tolerance for the absolute value of the residue. If, at any
iteration, the residue is lower than `atol`, then the iterations stop.
* `rtol`: The tolerance for the relative difference between the residues. If, at
any iteration, the relative difference between the residues in two
consecutive iterations is lower than `rtol`, then the iterations stop.
# Returns
* The epoch of the elements [Julian Day].
* The mean elements for SGP4 algorithm:
* Semi-major axis [m];
* Eccentricity [ ];
* Inclination [rad];
* Right ascension of the ascending node [rad];
* Argument of perigee [rad];
* True anomaly [rad];
* BSTAR (0 if `estimate_bstar` is `false`).
* The covariance matrix of the mean elements estimation.
"""
function rv_to_mean_elements_j2osc(vJD::AbstractVector{T},

@ronisbr
Copy link
Member

ronisbr commented Sep 23, 2021

You are 100% right! I will fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants