Commit b9e35b0e authored by Luc Maisonobe's avatar Luc Maisonobe

Fixed javadoc errors.

parent e887fd76
...@@ -416,6 +416,15 @@ ...@@ -416,6 +416,15 @@
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId> <artifactId>maven-javadoc-plugin</artifactId>
<version>${orekit.maven-javadoc-plugin.version}</version> <version>${orekit.maven-javadoc-plugin.version}</version>
<configuration>
<overview>${basedir}/src/main/java/org/orekit/overview.html</overview>
<bottom><![CDATA[Copyright &copy; ${project.inceptionYear}-{currentYear} <a href="http://www.c-s.fr">CS Syst&egrave;mes d&apos;information</a>. All rights reserved.]]></bottom>
<links>
<link>http://docs.oracle.com/javase/8/docs/api/</link>
<link>https://www.hipparchus.org/apidocs/</link>
</links>
<source>${orekit.compiler.source}</source>
</configuration>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.jacoco</groupId> <groupId>org.jacoco</groupId>
...@@ -648,6 +657,7 @@ ...@@ -648,6 +657,7 @@
<link>http://docs.oracle.com/javase/8/docs/api/</link> <link>http://docs.oracle.com/javase/8/docs/api/</link>
<link>https://www.hipparchus.org/apidocs/</link> <link>https://www.hipparchus.org/apidocs/</link>
</links> </links>
<source>${orekit.compiler.source}</source>
</configuration> </configuration>
<reportSets> <reportSets>
<reportSet> <reportSet>
......
...@@ -79,7 +79,7 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape { ...@@ -79,7 +79,7 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape {
/** Simple constructor. /** Simple constructor.
* <p>Standard values for Earth models can be found in the {@link org.orekit.utils.Constants Constants} class:</p> * <p>Standard values for Earth models can be found in the {@link org.orekit.utils.Constants Constants} class:</p>
* <table border="1" cellpadding="5" style="background-color:#f5f5dc;"> * <table border="1" cellpadding="5" style="background-color:#f5f5dc;" summary="">
* <caption>Ellipsoid Models</caption> * <caption>Ellipsoid Models</caption>
* <tr style="background-color:#c9d5c9;"><th>model</th><th>a<sub>e</sub> (m)</th> <th>f</th></tr> * <tr style="background-color:#c9d5c9;"><th>model</th><th>a<sub>e</sub> (m)</th> <th>f</th></tr>
* <tr><td style="background-color:#c9d5c9;">GRS 80</td> * <tr><td style="background-color:#c9d5c9;">GRS 80</td>
...@@ -88,7 +88,7 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape { ...@@ -88,7 +88,7 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape {
* <tr><td style="background-color:#c9d5c9;">WGS84</td> * <tr><td style="background-color:#c9d5c9;">WGS84</td>
* <td>{@link org.orekit.utils.Constants#WGS84_EARTH_EQUATORIAL_RADIUS Constants.WGS84_EARTH_EQUATORIAL_RADIUS}</td> * <td>{@link org.orekit.utils.Constants#WGS84_EARTH_EQUATORIAL_RADIUS Constants.WGS84_EARTH_EQUATORIAL_RADIUS}</td>
* <td>{@link org.orekit.utils.Constants#WGS84_EARTH_FLATTENING Constants.WGS84_EARTH_FLATTENING}</td></tr> * <td>{@link org.orekit.utils.Constants#WGS84_EARTH_FLATTENING Constants.WGS84_EARTH_FLATTENING}</td></tr>
* </table summary=""> * </table>
* @param ae equatorial radius * @param ae equatorial radius
* @param f the flattening (f = (a-b)/a) * @param f the flattening (f = (a-b)/a)
* @param bodyFrame body frame related to body shape * @param bodyFrame body frame related to body shape
...@@ -215,7 +215,21 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape { ...@@ -215,7 +215,21 @@ public class OneAxisEllipsoid extends Ellipsoid implements BodyShape {
} }
/** {@inheritDoc} */ /** Get the intersection point of a line with the surface of the body.
* <p>A line may have several intersection points with a closed
* surface (we consider the one point case as a degenerated two
* points case). The close parameter is used to select which of
* these points should be returned. The selected point is the one
* that is closest to the close point.</p>
* @param line test line (may intersect the body or not)
* @param close point used for intersections selection
* @param frame frame in which line is expressed
* @param date date of the line in given frame
* @param <T> type of the field elements
* @return intersection point at altitude zero or null if the line does
* not intersect the surface
* @since 9.3
*/
public <T extends RealFieldElement<T>> FieldVector3D<T> getCartesianIntersectionPoint(final FieldLine<T> line, public <T extends RealFieldElement<T>> FieldVector3D<T> getCartesianIntersectionPoint(final FieldLine<T> line,
final FieldVector3D<T> close, final FieldVector3D<T> close,
final Frame frame, final Frame frame,
......
...@@ -57,7 +57,7 @@ public class AngularAzEl extends AbstractMeasurement<AngularAzEl> { ...@@ -57,7 +57,7 @@ public class AngularAzEl extends AbstractMeasurement<AngularAzEl> {
* @param angular observed value * @param angular observed value
* @param sigma theoretical standard deviation * @param sigma theoretical standard deviation
* @param baseWeight base weight * @param baseWeight base weight
* @deprecated since 9.3, replaced by {@#AngularAzEl(GroundStation, AbsoluteDate, * @deprecated since 9.3, replaced by {@link #AngularAzEl(GroundStation, AbsoluteDate,
* double[], double[], double[], ObservableSatellite)} * double[], double[], double[], ObservableSatellite)}
*/ */
@Deprecated @Deprecated
...@@ -74,7 +74,7 @@ public class AngularAzEl extends AbstractMeasurement<AngularAzEl> { ...@@ -74,7 +74,7 @@ public class AngularAzEl extends AbstractMeasurement<AngularAzEl> {
* @param baseWeight base weight * @param baseWeight base weight
* @param propagatorIndex index of the propagator related to this measurement * @param propagatorIndex index of the propagator related to this measurement
* @since 9.0 * @since 9.0
* @deprecated since 9.3, replaced by {@#AngularAzEl(GroundStation, AbsoluteDate, * @deprecated since 9.3, replaced by {@link #AngularAzEl(GroundStation, AbsoluteDate,
* double[], double[], double[], ObservableSatellite)} * double[], double[], double[], ObservableSatellite)}
*/ */
@Deprecated @Deprecated
......
...@@ -64,7 +64,7 @@ public class AngularRaDec extends AbstractMeasurement<AngularRaDec> { ...@@ -64,7 +64,7 @@ public class AngularRaDec extends AbstractMeasurement<AngularRaDec> {
* @param angular observed value * @param angular observed value
* @param sigma theoretical standard deviation * @param sigma theoretical standard deviation
* @param baseWeight base weight * @param baseWeight base weight
* @deprecated since 9.3, replaced by {@#AngularRaDec(GroundStation, AbsoluteDate, * @deprecated since 9.3, replaced by {@link #AngularRaDec(GroundStation, Frame, AbsoluteDate,
* double[], double[], double[], ObservableSatellite)} * double[], double[], double[], ObservableSatellite)}
*/ */
@Deprecated @Deprecated
...@@ -82,7 +82,7 @@ public class AngularRaDec extends AbstractMeasurement<AngularRaDec> { ...@@ -82,7 +82,7 @@ public class AngularRaDec extends AbstractMeasurement<AngularRaDec> {
* @param baseWeight base weight * @param baseWeight base weight
* @param propagatorIndex index of the propagator related to this measurement * @param propagatorIndex index of the propagator related to this measurement
* @since 9.0 * @since 9.0
* @deprecated since 9.3, replaced by {@#AngularRaDec(GroundStation, AbsoluteDate, * @deprecated since 9.3, replaced by {@link #AngularRaDec(GroundStation, Frame, AbsoluteDate,
* double[], double[], double[], ObservableSatellite)} * double[], double[], double[], ObservableSatellite)}
*/ */
@Deprecated @Deprecated
......
...@@ -29,7 +29,7 @@ public interface ComparableMeasurement extends TimeStamped, Comparable<Comparabl ...@@ -29,7 +29,7 @@ public interface ComparableMeasurement extends TimeStamped, Comparable<Comparabl
* <p> * <p>
* The observed value is the value that was measured by the instrument. * The observed value is the value that was measured by the instrument.
* </p> * </p>
* @return observed value (array of size {@link #getDimension()} * @return observed value
*/ */
double[] getObservedValue(); double[] getObservedValue();
......
...@@ -345,7 +345,7 @@ public class PV extends AbstractMeasurement<PV> { ...@@ -345,7 +345,7 @@ public class PV extends AbstractMeasurement<PV> {
* @param baseWeight base weight * @param baseWeight base weight
* @since 9.2 * @since 9.2
* @deprecated as of 9.3, replaced by {@link #PV(AbsoluteDate, Vector3D, Vector3D, * @deprecated as of 9.3, replaced by {@link #PV(AbsoluteDate, Vector3D, Vector3D,
* double[][], double, ObservableSatellite))} * double[][], double, ObservableSatellite)}
*/ */
@Deprecated @Deprecated
public PV(final AbsoluteDate date, final Vector3D position, final Vector3D velocity, public PV(final AbsoluteDate date, final Vector3D position, final Vector3D velocity,
...@@ -364,7 +364,7 @@ public class PV extends AbstractMeasurement<PV> { ...@@ -364,7 +364,7 @@ public class PV extends AbstractMeasurement<PV> {
* @param propagatorIndex index of the propagator related to this measurement * @param propagatorIndex index of the propagator related to this measurement
* @since 9.2 * @since 9.2
* @deprecated as of 9.3, replaced by {@link #PV(AbsoluteDate, Vector3D, Vector3D, * @deprecated as of 9.3, replaced by {@link #PV(AbsoluteDate, Vector3D, Vector3D,
* double[][], double, ObservableSatellite))} * double[][], double, ObservableSatellite)}
*/ */
@Deprecated @Deprecated
public PV(final AbsoluteDate date, final Vector3D position, final Vector3D velocity, public PV(final AbsoluteDate date, final Vector3D position, final Vector3D velocity,
......
...@@ -31,7 +31,7 @@ import org.orekit.propagation.sampling.OrekitStepInterpolator; ...@@ -31,7 +31,7 @@ import org.orekit.propagation.sampling.OrekitStepInterpolator;
import org.orekit.time.AbsoluteDate; import org.orekit.time.AbsoluteDate;
/** Main generator for {@link ObservedMeasurements observed measurements}. /** Main generator for {@link ObservedMeasurement observed measurements}.
* @author Luc Maisonobe * @author Luc Maisonobe
* @since 9.3 * @since 9.3
*/ */
......
...@@ -24,7 +24,7 @@ import org.orekit.propagation.SpacecraftState; ...@@ -24,7 +24,7 @@ import org.orekit.propagation.SpacecraftState;
import org.orekit.time.AbsoluteDate; import org.orekit.time.AbsoluteDate;
/** Interface for generating individual {@link ObservedMeasurements measurements}. /** Interface for generating individual {@link ObservedMeasurement measurements}.
* @param <T> the type of the measurement * @param <T> the type of the measurement
* @author Luc Maisonobe * @author Luc Maisonobe
* @since 9.3 * @since 9.3
......
...@@ -24,7 +24,7 @@ import org.orekit.propagation.sampling.OrekitStepInterpolator; ...@@ -24,7 +24,7 @@ import org.orekit.propagation.sampling.OrekitStepInterpolator;
import org.orekit.time.AbsoluteDate; import org.orekit.time.AbsoluteDate;
/** Interface for generating {@link ObservedMeasurements measurements} sequences. /** Interface for generating {@link ObservedMeasurement measurements} sequences.
* @param <T> the type of the measurement * @param <T> the type of the measurement
* @author Luc Maisonobe * @author Luc Maisonobe
* @since 9.3 * @since 9.3
......
...@@ -21,7 +21,6 @@ import java.util.List; ...@@ -21,7 +21,6 @@ import java.util.List;
import org.hipparchus.linear.MatrixDecomposer; import org.hipparchus.linear.MatrixDecomposer;
import org.hipparchus.linear.QRDecomposer; import org.hipparchus.linear.QRDecomposer;
import org.hipparchus.linear.RealMatrix;
import org.orekit.errors.OrekitException; import org.orekit.errors.OrekitException;
import org.orekit.errors.OrekitMessages; import org.orekit.errors.OrekitMessages;
import org.orekit.propagation.conversion.NumericalPropagatorBuilder; import org.orekit.propagation.conversion.NumericalPropagatorBuilder;
...@@ -56,15 +55,13 @@ public class KalmanEstimatorBuilder { ...@@ -56,15 +55,13 @@ public class KalmanEstimatorBuilder {
this.processNoiseMatricesProviders = new ArrayList<>(); this.processNoiseMatricesProviders = new ArrayList<>();
} }
/** Construct a {@link KalmanEstimatorReal} from the data in this builder. /** Construct a {@link KalmanEstimator} from the data in this builder.
* <p> * <p>
* Before this method is called, {@link #addPropagationConfiguration(NumericalPropagatorBuilder, * Before this method is called, {@link #addPropagationConfiguration(NumericalPropagatorBuilder,
* ProcessNoiseMatrixProvider)addPropagationConfiguration()} must have been called * CovarianceMatrixProvider) addPropagationConfiguration()} must have been called
* at least once and {@link #initialCovarianceMatrix(RealMatrix) initialCovarianceMatrix()} * at least once, otherwise configuration is incomplete and an exception will be raised.
* must have been called, otherwise configuration is incomplete and an exception
* will be raised.
* </p> * </p>
* @return a new {@link KalmanEstimatorReal}. * @return a new {@link KalmanEstimator}.
*/ */
public KalmanEstimator build() { public KalmanEstimator build() {
final int n = propagatorBuilders.size(); final int n = propagatorBuilders.size();
...@@ -92,7 +89,7 @@ public class KalmanEstimatorBuilder { ...@@ -92,7 +89,7 @@ public class KalmanEstimatorBuilder {
* </p> * </p>
* <p> * <p>
* The {@code provider} should return a matrix with dimensions and ordering * The {@code provider} should return a matrix with dimensions and ordering
* consistent with the {@link builder} configuration. The first 6 rows/columns * consistent with the {@code builder} configuration. The first 6 rows/columns
* correspond to the 6 orbital parameters which must all be present, regardless * correspond to the 6 orbital parameters which must all be present, regardless
* of the fact they are estimated or not. The remaining elements correspond * of the fact they are estimated or not. The remaining elements correspond
* to the subset of propagation parameters that are estimated, in the * to the subset of propagation parameters that are estimated, in the
......
...@@ -34,7 +34,7 @@ import org.orekit.propagation.SpacecraftState; ...@@ -34,7 +34,7 @@ import org.orekit.propagation.SpacecraftState;
* The method {@link #getProcessNoiseMatrix} then square the values so that they are consistent with a covariance matrix. * The method {@link #getProcessNoiseMatrix} then square the values so that they are consistent with a covariance matrix.
* <p> * <p>
* The orbital parameters evolutions are provided in LOF frame and Cartesian (PV); * The orbital parameters evolutions are provided in LOF frame and Cartesian (PV);
* then converted in inertial frame and current {@link OrbitType} and {@link PositionAngle} * then converted in inertial frame and current {@link org.orekit.orbits.OrbitType} and {@link PositionAngle}
* when method {@link #getProcessNoiseMatrix} is called. * when method {@link #getProcessNoiseMatrix} is called.
* </p> * </p>
* <p> * <p>
......
...@@ -504,7 +504,7 @@ public enum Keyword { ...@@ -504,7 +504,7 @@ public enum Keyword {
/** Data: ANGLE_1 in degrees and in [-180, +360[ [deg].<p> /** Data: ANGLE_1 in degrees and in [-180, +360[ [deg].<p>
* The value assigned to the ANGLE_1 keyword represents the azimuth, right ascension, or ‘X’ * The value assigned to the ANGLE_1 keyword represents the azimuth, right ascension, or ‘X’
* angle of the measurement, depending on the value of the ANGLE_TYPE keyword.<p> * angle of the measurement, depending on the value of the ANGLE_TYPE keyword.<p>
* The angle measurement shall be a double precision value as follows: -180.0 <= ANGLE_1 < 360.0<p> * The angle measurement shall be a double precision value as follows: -180.0 &le; ANGLE_1 &lt; 360.0<p>
* Units shall be degrees.<p> * Units shall be degrees.<p>
* See meta-data keyword ANGLE_TYPE for the definition of the angles. * See meta-data keyword ANGLE_TYPE for the definition of the angles.
*/ */
...@@ -512,7 +512,7 @@ public enum Keyword { ...@@ -512,7 +512,7 @@ public enum Keyword {
/** Data: ANGLE_2 in degrees and in [-180, +360[ [deg].<p> /** Data: ANGLE_2 in degrees and in [-180, +360[ [deg].<p>
* The value assigned to the ANGLE_2 keyword represents the elevation, declination, or ‘Y’ * The value assigned to the ANGLE_2 keyword represents the elevation, declination, or ‘Y’
* angle of the measurement, depending on the value of the ANGLE_TYPE keyword.<p> * angle of the measurement, depending on the value of the ANGLE_TYPE keyword.<p>
* The angle measurement shall be a double precision value as follows: -180.0 <= ANGLE_2 < 360.0.<p> * The angle measurement shall be a double precision value as follows: -180.0 &le; ANGLE_2 &lt; 360.0.<p>
* Units shall be degrees.<p> * Units shall be degrees.<p>
* See meta-data keyword ANGLE_TYPE for the definition of the angles. * See meta-data keyword ANGLE_TYPE for the definition of the angles.
*/ */
......
...@@ -39,7 +39,7 @@ import org.orekit.utils.PVCoordinatesProvider; ...@@ -39,7 +39,7 @@ import org.orekit.utils.PVCoordinatesProvider;
* It is described in the paper:<br> * It is described in the paper:<br>
* <a href="http://sol.spacenvironment.net/~JB2008/pubs/AIAA_2008-6438_JB2008_Model.pdf">A * <a href="http://sol.spacenvironment.net/~JB2008/pubs/AIAA_2008-6438_JB2008_Model.pdf">A
* New Empirical Thermospheric Density Model JB2008 Using New Solar Indices</a><br> * New Empirical Thermospheric Density Model JB2008 Using New Solar Indices</a><br>
* <i>Bruce R. Bowman & al.</i><br> * <i>Bruce R. Bowman &amp; al.</i><br>
* AIAA 2008-6438<br> * AIAA 2008-6438<br>
* </p> * </p>
* <p> * <p>
...@@ -209,9 +209,9 @@ public class JB2008 implements Atmosphere { ...@@ -209,9 +209,9 @@ public class JB2008 implements Atmosphere {
* (Tabular time 2.0 days earlier) * (Tabular time 2.0 days earlier)
* @param xm10B MG2 81-day ave. centered index<br> * @param xm10B MG2 81-day ave. centered index<br>
* (Tabular time 2.0 days earlier) * (Tabular time 2.0 days earlier)
* @param y10 Solar X-Ray & Lya index scaled to F10<br> * @param y10 Solar X-Ray &amp; Lya index scaled to F10<br>
* (Tabular time 5.0 days earlier) * (Tabular time 5.0 days earlier)
* @param y10B Solar X-Ray & Lya 81-day ave. centered index<br> * @param y10B Solar X-Ray &amp; Lya 81-day ave. centered index<br>
* (Tabular time 5.0 days earlier) * (Tabular time 5.0 days earlier)
* @param dstdtc Temperature change computed from Dst index * @param dstdtc Temperature change computed from Dst index
* @return total mass-Density at input position (kg/m³) * @return total mass-Density at input position (kg/m³)
...@@ -469,9 +469,9 @@ public class JB2008 implements Atmosphere { ...@@ -469,9 +469,9 @@ public class JB2008 implements Atmosphere {
* (Tabular time 2.0 days earlier) * (Tabular time 2.0 days earlier)
* @param xm10B MG2 81-day ave. centered index<br> * @param xm10B MG2 81-day ave. centered index<br>
* (Tabular time 2.0 days earlier) * (Tabular time 2.0 days earlier)
* @param y10 Solar X-Ray & Lya index scaled to F10<br> * @param y10 Solar X-Ray &amp; Lya index scaled to F10<br>
* (Tabular time 5.0 days earlier) * (Tabular time 5.0 days earlier)
* @param y10B Solar X-Ray & Lya 81-day ave. centered index<br> * @param y10B Solar X-Ray &amp; Lya 81-day ave. centered index<br>
* (Tabular time 5.0 days earlier) * (Tabular time 5.0 days earlier)
* @param dstdtc Temperature change computed from Dst index * @param dstdtc Temperature change computed from Dst index
* @param <T> type fo the field elements * @param <T> type fo the field elements
......
...@@ -81,17 +81,17 @@ public interface JB2008InputParameters extends Serializable { ...@@ -81,17 +81,17 @@ public interface JB2008InputParameters extends Serializable {
*/ */
double getXM10B(AbsoluteDate date); double getXM10B(AbsoluteDate date);
/** Get the Solar X-Ray & Lya index scaled to F10. /** Get the Solar X-Ray &amp; Lya index scaled to F10.
* <p>Tabular time 5.0 days earlier.</p> * <p>Tabular time 5.0 days earlier.</p>
* @param date the current date * @param date the current date
* @return the Solar X-Ray & Lya index scaled to F10 * @return the Solar X-Ray &amp; Lya index scaled to F10
*/ */
double getY10(AbsoluteDate date); double getY10(AbsoluteDate date);
/** Get the Solar X-Ray & Lya 81-day ave. centered index. /** Get the Solar X-Ray &amp; Lya 81-day ave. centered index.
* <p>Tabular time 5.0 days earlier.</p> * <p>Tabular time 5.0 days earlier.</p>
* @param date the current date * @param date the current date
* @return the Solar X-Ray & Lya 81-day ave. centered index * @return the Solar X-Ray &amp; Lya 81-day ave. centered index
*/ */
double getY10B(AbsoluteDate date); double getY10B(AbsoluteDate date);
......
...@@ -121,7 +121,7 @@ import org.orekit.utils.PVCoordinatesProvider; ...@@ -121,7 +121,7 @@ import org.orekit.utils.PVCoordinatesProvider;
* Instances of this class are immutable. * Instances of this class are immutable.
* </p> * </p>
* *
* @author Mike Picone & al (Naval Research Laboratory), 2001: FORTRAN routine * @author Mike Picone &amp; al (Naval Research Laboratory), 2001: FORTRAN routine
* @author Dominik Brodowski, 2004: C routine * @author Dominik Brodowski, 2004: C routine
* @author Pascal Parraud, 2016: Java translation * @author Pascal Parraud, 2016: Java translation
* @since 8.1 * @since 8.1
......
...@@ -57,14 +57,14 @@ public interface NRLMSISE00InputParameters extends Serializable { ...@@ -57,14 +57,14 @@ public interface NRLMSISE00InputParameters extends Serializable {
* <p> * <p>
* A<sub>p</sub> indices are provided as an array such as: * A<sub>p</sub> indices are provided as an array such as:
* <ul> * <ul>
* <li>0 -> daily A<sub>p</sub></li> * <li>0 daily A<sub>p</sub></li>
* <li>1 -> 3 hr A<sub>p</sub> index for current time</li> * <li>1 3 hr A<sub>p</sub> index for current time</li>
* <li>2 -> 3 hr A<sub>p</sub> index for 3 hrs before current time</li> * <li>2 3 hr A<sub>p</sub> index for 3 hrs before current time</li>
* <li>3 -> 3 hr A<sub>p</sub> index for 6 hrs before current time</li> * <li>3 3 hr A<sub>p</sub> index for 6 hrs before current time</li>
* <li>4 -> 3 hr A<sub>p</sub> index for 9 hrs before current time</li> * <li>4 3 hr A<sub>p</sub> index for 9 hrs before current time</li>
* <li>5 -> Average of eight 3 hr A<sub>p</sub> indices from 12 to 33 hrs * <li>5 Average of eight 3 hr A<sub>p</sub> indices from 12 to 33 hrs
* prior to current time</li> * prior to current time</li>
* <li>6 -> Average of eight 3 hr A<sub>p</sub> indices from 36 to 57 hrs * <li>6 Average of eight 3 hr A<sub>p</sub> indices from 36 to 57 hrs
* prior to current time</li> * prior to current time</li>
* </ul> * </ul>
* </p> * </p>
......
...@@ -64,8 +64,8 @@ public interface DiscreteTroposphericModel extends MappingFunction { ...@@ -64,8 +64,8 @@ public interface DiscreteTroposphericModel extends MappingFunction {
/** This method allows the computation of the zenith hydrostatic and /** This method allows the computation of the zenith hydrostatic and
* zenith wet delay. The resulting element is an array having the following form: * zenith wet delay. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay * <li>double[0] = D<sub>hz</sub> zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt zenith wet delay * <li>double[1] = D<sub>wz</sub> zenith wet delay
* </ul> * </ul>
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
* @param parameters tropospheric model parameters. * @param parameters tropospheric model parameters.
...@@ -77,8 +77,8 @@ public interface DiscreteTroposphericModel extends MappingFunction { ...@@ -77,8 +77,8 @@ public interface DiscreteTroposphericModel extends MappingFunction {
/** This method allows the computation of the zenith hydrostatic and /** This method allows the computation of the zenith hydrostatic and
* zenith wet delay. The resulting element is an array having the following form: * zenith wet delay. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>T[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay * <li>T[0] = D<sub>hz</sub> zenith hydrostatic delay
* <li>T[1] = D<sub>wz</sub> -&gt zenith wet delay * <li>T[1] = D<sub>wz</sub> zenith wet delay
* </ul> * </ul>
* @param <T> type of the elements * @param <T> type of the elements
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
......
...@@ -141,8 +141,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel { ...@@ -141,8 +141,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel {
/** This method allows the computation of the zenith hydrostatic and zenith total delays. /** This method allows the computation of the zenith hydrostatic and zenith total delays.
* The resulting element is an array having the following form: * The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay * <li>double[0] = D<sub>hz</sub> zenith hydrostatic delay
* <li>double[1] = D<sub>tz</sub> -&gt zenith total delay * <li>double[1] = D<sub>tz</sub> zenith total delay
* </ul> * </ul>
* <p> * <p>
* The user have to be careful because the others tropospheric models in Orekit * The user have to be careful because the others tropospheric models in Orekit
...@@ -172,8 +172,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel { ...@@ -172,8 +172,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel {
/** This method allows the computation of the zenith hydrostatic and zenith total delays. /** This method allows the computation of the zenith hydrostatic and zenith total delays.
* The resulting element is an array having the following form: * The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay * <li>double[0] = D<sub>hz</sub> zenith hydrostatic delay
* <li>double[1] = D<sub>tz</sub> -&gt zenith total delay * <li>double[1] = D<sub>tz</sub> zenith total delay
* </ul> * </ul>
* <p> * <p>
* The user have to be careful because the others tropospheric models in Orekit * The user have to be careful because the others tropospheric models in Orekit
......
...@@ -64,7 +64,7 @@ public class GlobalPressureTemperatureModel implements WeatherModel { ...@@ -64,7 +64,7 @@ public class GlobalPressureTemperatureModel implements WeatherModel {
/** Build a new instance. /** Build a new instance.
* <p> * <p>
* At the initialization the values of the pressure and the temperature are set to NaN. * At the initialization the values of the pressure and the temperature are set to NaN.
* The user has to call {@link #computeTemperatureAndPressure} method before using * The user has to call {@link #weatherParameters(double, AbsoluteDate)} method before using
* the values of the pressure and the temperature. * the values of the pressure and the temperature.
* </p> * </p>
* @param latitude geodetic latitude, in radians * @param latitude geodetic latitude, in radians
......
...@@ -34,8 +34,8 @@ public interface MappingFunction extends Serializable { ...@@ -34,8 +34,8 @@ public interface MappingFunction extends Serializable {
/** This method allows the computation of the hydrostatic and /** This method allows the computation of the hydrostatic and
* wet mapping functions. The resulting element is an array having the following form: * wet mapping functions. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = m<sub>h</sub>(e) -&gt hydrostatic mapping function * <li>double[0] = m<sub>h</sub>(e) hydrostatic mapping function
* <li>double[1] = m<sub>w</sub>(e) -&gt wet mapping function * <li>double[1] = m<sub>w</sub>(e) wet mapping function
* </ul> * </ul>
* @param elevation the elevation of the satellite, in radians. * @param elevation the elevation of the satellite, in radians.
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
...@@ -48,8 +48,8 @@ public interface MappingFunction extends Serializable { ...@@ -48,8 +48,8 @@ public interface MappingFunction extends Serializable {
/** This method allows the computation of the hydrostatic and /** This method allows the computation of the hydrostatic and
* wet mapping functions. The resulting element is an array having the following form: * wet mapping functions. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>T[0] = m<sub>h</sub>(e) -&gt hydrostatic mapping function * <li>T[0] = m<sub>h</sub>(e) hydrostatic mapping function
* <li>T[1] = m<sub>w</sub>(e) -&gt wet mapping function * <li>T[1] = m<sub>w</sub>(e) wet mapping function
* </ul> * </ul>
* @param elevation the elevation of the satellite, in radians. * @param elevation the elevation of the satellite, in radians.
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
......
...@@ -83,7 +83,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel { ...@@ -83,7 +83,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
* thanks to the values of the pressure, the temperature and the humidity * thanks to the values of the pressure, the temperature and the humidity
* @param t0 the temperature at the station, K * @param t0 the temperature at the station, K
* @param p0 the atmospheric pressure at the station, hPa * @param p0 the atmospheric pressure at the station, hPa
* @param rh the humidity at the station, percent (50% -&gt; 0.5) * @param rh the humidity at the station, percent (50% 0.5)
* @param latitude geodetic latitude of the station, radians * @param latitude geodetic latitude of the station, radians
* @param lambda laser wavelength, µm * @param lambda laser wavelength, µm
* */ * */
...@@ -225,8 +225,8 @@ public class MendesPavlisModel implements DiscreteTroposphericModel { ...@@ -225,8 +225,8 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
* Therefore, the two components of the resulting array are * Therefore, the two components of the resulting array are
* equals. * equals.
* <ul> * <ul>
* <li>double[0] = m(e) -&gt total mapping function * <li>double[0] = m(e) total mapping function
* <li>double[1] = m(e) -&gt total mapping function * <li>double[1] = m(e) total mapping function
* </ul> * </ul>
* </p><p> * </p><p>
* The total delay will thus be computed as this: * The total delay will thus be computed as this:
...@@ -365,7 +365,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel { ...@@ -365,7 +365,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
* *
* See: Giacomo, P., Equation for the dertermination of the density of moist air, Metrologia, V. 18, 1982 * See: Giacomo, P., Equation for the dertermination of the density of moist air, Metrologia, V. 18, 1982
* *
* @param rh relative humidity, in percent (50% -&gt; 0.5). * @param rh relative humidity, in percent (50% 0.5).
* @return the water vapor, in mbar (1 mbar = 1 hPa). * @return the water vapor, in mbar (1 mbar = 1 hPa).
*/ */
private double getWaterVapor(final double rh) { private double getWaterVapor(final double rh) {
......
...@@ -93,8 +93,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { ...@@ -93,8 +93,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel {
/** This method allows the computation of the zenith hydrostatic and /** This method allows the computation of the zenith hydrostatic and
* zenith wet delay. The resulting element is an array having the following form: * zenith wet delay. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay * <li>double[0] = D<sub>hz</sub> zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt zenith wet delay * <li>double[1] = D<sub>wz</sub> zenith wet delay
* </ul> * </ul>
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
* @param parameters tropospheric model parameters. * @param parameters tropospheric model parameters.
...@@ -111,8 +111,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { ...@@ -111,8 +111,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel {
/** This method allows the computation of the zenith hydrostatic and /** This method allows the computation of the zenith hydrostatic and
* zenith wet delay. The resulting element is an array having the following form: * zenith wet delay. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay * <li>double[0] = D<sub>hz</sub> zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt zenith wet delay * <li>double[1] = D<sub>wz</sub> zenith wet delay
* </ul> * </ul>
* @param <T> type of the elements * @param <T> type of the elements
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
...@@ -132,8 +132,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { ...@@ -132,8 +132,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel {
/** This method allows the computation of the hydrostatic and /** This method allows the computation of the hydrostatic and
* wet mapping functions. The resulting element is an array having the following form: * wet mapping functions. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = m<sub>h</sub>(e) -&gt hydrostatic mapping function * <li>double[0] = m<sub>h</sub>(e) hydrostatic mapping function
* <li>double[1] = m<sub>w</sub>(e) -&gt wet mapping function * <li>double[1] = m<sub>w</sub>(e) wet mapping function
* </ul> * </ul>
* @param elevation the elevation of the satellite, in radians. * @param elevation the elevation of the satellite, in radians.
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
...@@ -151,8 +151,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel { ...@@ -151,8 +151,8 @@ public interface TroposphericModel extends DiscreteTroposphericModel {
/** This method allows the computation of the hydrostatic and /** This method allows the computation of the hydrostatic and
* wet mapping functions. The resulting element is an array having the following form: * wet mapping functions. The resulting element is an array having the following form:
* <ul> * <ul>
* <li>double[0] = m<sub>h</sub>(e) -&gt hydrostatic mapping function * <li>double[0] = m<sub>h</sub>(e) hydrostatic mapping function
* <li>double[1] = m<sub>w</sub>(e) -&gt wet mapping function * <li>double[1] = m<sub>w</sub>(e) wet mapping function
* </ul> * </ul>
* @param elevation the elevation of the satellite, in radians. * @param elevation the elevation of the satellite, in radians.
* @param height the height of the station in m above sea level. * @param height the height of the station in m above sea level.
......
...@@ -142,8 +142,8 @@ public class ViennaModelCoefficientsLoader implements DataLoader { ...@@ -142,8 +142,8 @@ public class ViennaModelCoefficientsLoader implements DataLoader {
/** Returns the zenith delay array. /** Returns the zenith delay array.
* <ul> * <ul>
* <li>double[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay * <li>double[0] = D<sub>hz</sub> zenith hydrostatic delay
* <li>double[1] = D<sub>wz</sub> -&gt zenith wet delay * <li>double[1] = D<sub>wz</sub> zenith wet delay
* </ul> * </ul>
* @return the zenith delay array * @return the zenith delay array
*/ */
......
...@@ -875,7 +875,7 @@ public class FieldKeplerianOrbit<T extends RealFieldElement<T>> extends FieldOrb ...@@ -875,7 +875,7 @@ public class FieldKeplerianOrbit<T extends RealFieldElement<T>> extends FieldOrb
* @return position vector * @return position vector
* @deprecated as of 9.3 replaced with {@link #FieldKeplerianOrbit(RealFieldElement, RealFieldElement, * @deprecated as of 9.3 replaced with {@link #FieldKeplerianOrbit(RealFieldElement, RealFieldElement,
* RealFieldElement, RealFieldElement, RealFieldElement, RealFieldElement, PositionAngle, Frame, * RealFieldElement, RealFieldElement, RealFieldElement, RealFieldElement, PositionAngle, Frame,
* FieldAbsoluteDate, double)} and {@#getPVCoordinates()} * FieldAbsoluteDate, double)} and {@link #getPVCoordinates()}
*/ */
@Deprecated @Deprecated
public static <T extends RealFieldElement<T>> FieldVector3D<T> ellipticKeplerianToPosition(final T a, final T e, final T i, public static <T extends RealFieldElement<T>> FieldVector3D<T> ellipticKeplerianToPosition(final T a, final T e, final T i,
...@@ -925,7 +925,7 @@ public class FieldKeplerianOrbit<T extends RealFieldElement<T>> extends FieldOrb ...@@ -925,7 +925,7 @@ public class FieldKeplerianOrbit<T extends RealFieldElement<T>> extends FieldOrb
* @return position vector * @return position vector
* @deprecated as of 9.3 replaced with {@link #FieldKeplerianOrbit(RealFieldElement, RealFieldElement, * @deprecated as of 9.3 replaced with {@link #FieldKeplerianOrbit(RealFieldElement, RealFieldElement,
* RealFieldElement, RealFieldElement, RealFieldElement, RealFieldElement, PositionAngle, Frame, * RealFieldElement, RealFieldElement, RealFieldElement, RealFieldElement, PositionAngle, Frame,
* FieldAbsoluteDate, double)} and {@#getPVCoordinates()} * FieldAbsoluteDate, double)} and {@link #getPVCoordinates()}
*/ */
@Deprecated @Deprecated
public static <T extends RealFieldElement<T>> FieldVector3D<T> hyperbolicKeplerianToPosition(final T a, final T e, final T i, public static <T extends RealFieldElement<T>> FieldVector3D<T> hyperbolicKeplerianToPosition(final T a, final T e, final T i,
......