Commit 6337e5b3 authored by Bryan Cazabonne's avatar Bryan Cazabonne

Fixed JavaDoc.

parent b0a7e378
......@@ -24,13 +24,16 @@ import org.orekit.time.FieldAbsoluteDate;
* electro-magnetic signals between an orbital satellite and a ground station.
* <p>
* Models that implement this interface split the delay into hydrostatic
* and non-hydrostatic part.
* and non-hydrostatic part:
* </p>
* <pre>
* δ = δ<sub>h</sub> + δ<sub>nh</sub>
* <li>δ<sub>h</sub> = hydrostatic delay
* <li>δ<sub>nh</sub> = non-hydrostatic (or wet) delay
* </pre>
* </p>
* With:
* <ul>
* <li> δ<sub>h</sub> = hydrostatic delay </li>
* <li> δ<sub>nh</sub> = non-hydrostatic (or wet) delay </li>
* </ul>
* @author Bryan Cazabonne
*/
public interface DiscreteTroposphericModel extends MappingFunction {
......@@ -71,18 +74,18 @@ public interface DiscreteTroposphericModel extends MappingFunction {
*/
double[] computeZenithDelay(double height, double[] parameters, AbsoluteDate date);
/** This method allows the computation of the zenith hydrostatic and
* zenith wet delay. The resulting element is an array having the following form:
* <ul>
* <li>T[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay
* <li>T[1] = D<sub>wz</sub> -&gt zenith wet delay
* </ul>
* @param <T> type of the elements
* @param height the height of the station in m above sea level.
/** This method allows the computation of the zenith hydrostatic and
* zenith wet delay. The resulting element is an array having the following form:
* <ul>
* <li>T[0] = D<sub>hz</sub> -&gt zenith hydrostatic delay
* <li>T[1] = D<sub>wz</sub> -&gt zenith wet delay
* </ul>
* @param <T> type of the elements
* @param height the height of the station in m above sea level.
* @param parameters tropospheric model parameters.
* @param date current date
* @return a two components array containing the zenith hydrostatic and wet delays.
*/
* @return a two components array containing the zenith hydrostatic and wet delays.
*/
<T extends RealFieldElement<T>> T[] computeZenithDelay(T height, T[] parameters, FieldAbsoluteDate<T> date);
}
......@@ -77,8 +77,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel {
public EstimatedTroposphericModel(final double t0, final double p0,
final MappingFunction model, final double totalDelay) {
totalZenithDelay = new ParameterDriver(EstimatedTroposphericModel.TOTAL_ZENITH_DELAY,
totalDelay, FastMath.scalb(1.0, 0), 0.0, Double.POSITIVE_INFINITY);
totalZenithDelay = new ParameterDriver(EstimatedTroposphericModel.TOTAL_ZENITH_DELAY,
totalDelay, FastMath.scalb(1.0, 0), 0.0, Double.POSITIVE_INFINITY);
this.t0 = t0;
this.p0 = p0;
......@@ -90,7 +90,7 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel {
* <li>temperature: 18 degree Celsius
* <li>pressure: 1013.25 mbar
* </ul>
* @param model mapping function model (NMF or GMF).l
* @param model mapping function model (NMF or GMF).
* @param totalDelay initial value for the tropospheric zenith total delay [m]
*/
public EstimatedTroposphericModel(final MappingFunction model, final double totalDelay) {
......@@ -145,8 +145,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel {
* <li>double[1] = D<sub>tz</sub> -&gt zenith total delay
* </ul>
* <p>
* Others tropospheric models in Orekit compute the zenith wet delay instead of
* the total zenith delay.
* The user have to be careful because the others tropospheric models in Orekit
* compute the zenith wet delay instead of the total zenith delay.
* </p>
* @param height the height of the station in m above sea level.
* @param parameters tropospheric model parameters.
......@@ -176,8 +176,8 @@ public class EstimatedTroposphericModel implements DiscreteTroposphericModel {
* <li>double[1] = D<sub>tz</sub> -&gt zenith total delay
* </ul>
* <p>
* Others tropospheric models in Orekit compute the zenith wet delay instead of
* the total zenith delay.
* The user have to be careful because the others tropospheric models in Orekit
* compute the zenith wet delay instead of the total zenith delay.
* </p>
* @param <T> type of the elements
* @param height the height of the station in m above sea level.
......
......@@ -263,9 +263,9 @@ public class GlobalMappingFunctionModel implements MappingFunction {
// Denominator
final double denMP = sinE + a / (sinE + b / (sinE + c));
final double felevation = numMP / denMP;
final double fElevation = numMP / denMP;
return felevation;
return fElevation;
}
/** Compute the mapping function related to the coefficient values and the elevation.
......@@ -283,9 +283,9 @@ public class GlobalMappingFunctionModel implements MappingFunction {
// Denominator
final T denMP = a.divide(b.divide(c.add(sinE)).add(sinE)).add(sinE);
final T felevation = numMP.divide(denMP);
final T fElevation = numMP.divide(denMP);
return felevation;
return fElevation;
}
/** This method computes the height correction for the hydrostatic
......
......@@ -63,7 +63,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
/** Carbon dioxyde content (IAG recommendations). */
private static final double C02 = 0.99995995;
/** Geodetic site latitude, radians. */
/** Geodetic site latitude [rad]. */
private double latitude;
/** Laser wavelength [µm]. */
......@@ -78,7 +78,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
/** Water vapor pressure at the laser site [hPa]. */
private double e0;
/** Create a new Marini-Murray model for the troposphere.
/** Create a new Mendes-Pavlis model for the troposphere.
* This initialisation will compute the water vapor pressure
* thanks to the values of the pressure, the temperature and the humidity
* @param t0 the temperature at the station, K
......@@ -99,7 +99,7 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
/** Create a new Mendes-Pavlis model using a standard atmosphere model.
*
* <ul>
* <li>temperature: 20 degree Celsius
* <li>temperature: 18 degree Celsius
* <li>pressure: 1013.25 hPa
* <li>humidity: 50%
* </ul>
......@@ -110,16 +110,16 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
* @return a Mendes-Pavlis model with standard environmental values
*/
public static MendesPavlisModel getStandardModel(final double latitude, final double lambda) {
return new MendesPavlisModel(273.15 + 20, 1013.25, 0.5, latitude, lambda);
return new MendesPavlisModel(273.15 + 18, 1013.25, 0.5, latitude, lambda);
}
/** {@inheritDoc} */
@Override
public double pathDelay(final double elevation, final double height,
final double[] parameters, final AbsoluteDate date) {
// zenith delay
// Zenith delay
final double[] zenithDelay = computeZenithDelay(height, parameters, date);
// mapping function
// Mapping function
final double[] mappingFunction = mappingFactors(elevation, height, parameters, date);
// Tropospheric path delay
return zenithDelay[0] * mappingFunction[0] + zenithDelay[1] * mappingFunction[1];
......@@ -129,9 +129,9 @@ public class MendesPavlisModel implements DiscreteTroposphericModel {
@Override
public <T extends RealFieldElement<T>> T pathDelay(final T elevation, final T height,
final T[] parameters, final FieldAbsoluteDate<T> date) {
// zenith delay
// Zenith delay
final T[] delays = computeZenithDelay(height, parameters, date);
// mapping function
// Mapping function
final T[] mappingFunction = mappingFactors(elevation, height, parameters, date);
// Tropospheric path delay
return delays[0].multiply(mappingFunction[0]).add(delays[1].multiply(mappingFunction[1]));
......
......@@ -168,7 +168,7 @@ public class NiellMappingFunctionModel implements MappingFunction {
// Compute ah, bh and ch Eq. 5
double absLatidude = FastMath.abs(latitude);
// there are no data in the model of latitudes lower than 15°
// there are no data in the model for latitudes lower than 15°
absLatidude = FastMath.max(FastMath.toRadians(15.0), absLatidude);
// there are no data in the model for latitudes greater than 75°
absLatidude = FastMath.min(FastMath.toRadians(75.0), absLatidude);
......@@ -212,7 +212,7 @@ public class NiellMappingFunctionModel implements MappingFunction {
// Compute ah, bh and ch Eq. 5
double absLatidude = FastMath.abs(latitude);
// there are no data in the model of latitudes lower than 15°
// there are no data in the model for latitudes lower than 15°
absLatidude = FastMath.max(FastMath.toRadians(15.0), absLatidude);
// there are no data in the model for latitudes greater than 75°
absLatidude = FastMath.min(FastMath.toRadians(75.0), absLatidude);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment