// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.data.coor;
import static java.lang.Math.PI;
import static java.lang.Math.asin;
import static java.lang.Math.atan2;
import static java.lang.Math.cos;
import static java.lang.Math.sin;
import static java.lang.Math.sqrt;
import static java.lang.Math.toRadians;
import static org.openstreetmap.josm.tools.I18n.trc;
import java.awt.geom.Area;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.util.Arrays;
import java.util.Locale;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.data.Bounds;
import org.openstreetmap.josm.tools.Utils;
/**
* LatLon are unprojected latitude / longitude coordinates.
* <br>
* <b>Latitude</b> specifies the north-south position in degrees
* where valid values are in the [-90,90] and positive values specify positions north of the equator.
* <br>
* <b>Longitude</b> specifies the east-west position in degrees
* where valid values are in the [-180,180] and positive values specify positions east of the prime meridian.
* <br>
* <img alt="lat/lon" src="https://upload.wikimedia.org/wikipedia/commons/thumb/6/62/Latitude_and_Longitude_of_the_Earth.svg/500px-Latitude_and_Longitude_of_the_Earth.svg.png">
* <br>
* This class is immutable.
*
* @author Imi
*/
public class LatLon extends Coordinate {
/**
* Minimum difference in location to not be represented as the same position.
* The API returns 7 decimals.
*/
public static final double MAX_SERVER_PRECISION = 1e-7;
public static final double MAX_SERVER_INV_PRECISION = 1e7;
public static final int MAX_SERVER_DIGITS = 7;
/**
* The (0,0) coordinates.
* @since 6178
*/
public static final LatLon ZERO = new LatLon(0, 0);
private static DecimalFormat cDmsMinuteFormatter = new DecimalFormat("00");
private static DecimalFormat cDmsSecondFormatter = new DecimalFormat("00.0");
private static DecimalFormat cDmMinuteFormatter = new DecimalFormat("00.000");
public static final DecimalFormat cDdFormatter;
public static final DecimalFormat cDdHighPecisionFormatter;
static {
// Don't use the localized decimal separator. This way we can present
// a comma separated list of coordinates.
cDdFormatter = (DecimalFormat) NumberFormat.getInstance(Locale.UK);
cDdFormatter.applyPattern("###0.0######");
cDdHighPecisionFormatter = (DecimalFormat) NumberFormat.getInstance(Locale.UK);
cDdHighPecisionFormatter.applyPattern("###0.0##########");
}
private static final String cDms60 = cDmsSecondFormatter.format(60.0);
private static final String cDms00 = cDmsSecondFormatter.format( 0.0);
private static final String cDm60 = cDmMinuteFormatter.format(60.0);
private static final String cDm00 = cDmMinuteFormatter.format( 0.0);
/**
* Replies true if lat is in the range [-90,90]
*
* @param lat the latitude
* @return true if lat is in the range [-90,90]
*/
public static boolean isValidLat(double lat) {
return lat >= -90d && lat <= 90d;
}
/**
* Replies true if lon is in the range [-180,180]
*
* @param lon the longitude
* @return true if lon is in the range [-180,180]
*/
public static boolean isValidLon(double lon) {
return lon >= -180d && lon <= 180d;
}
/**
* Replies true if lat is in the range [-90,90] and lon is in the range [-180,180]
*
* @return true if lat is in the range [-90,90] and lon is in the range [-180,180]
*/
public boolean isValid() {
return isValidLat(lat()) && isValidLon(lon());
}
public static double toIntervalLat(double value) {
if (value < -90)
return -90;
if (value > 90)
return 90;
return value;
}
/**
* Returns a valid OSM longitude [-180,+180] for the given extended longitude value.
* For example, a value of -181 will return +179, a value of +181 will return -179.
* @param value A longitude value not restricted to the [-180,+180] range.
*/
public static double toIntervalLon(double value) {
if (isValidLon(value))
return value;
else {
int n = (int) (value + Math.signum(value)*180.0) / 360;
return value - n*360.0;
}
}
/**
* Replies the coordinate in degrees/minutes/seconds format
* @param pCoordinate The coordinate to convert
* @return The coordinate in degrees/minutes/seconds format
*/
public static String dms(double pCoordinate) {
double tAbsCoord = Math.abs(pCoordinate);
int tDegree = (int) tAbsCoord;
double tTmpMinutes = (tAbsCoord - tDegree) * 60;
int tMinutes = (int) tTmpMinutes;
double tSeconds = (tTmpMinutes - tMinutes) * 60;
String sDegrees = Integer.toString(tDegree);
String sMinutes = cDmsMinuteFormatter.format(tMinutes);
String sSeconds = cDmsSecondFormatter.format(tSeconds);
if (cDms60.equals(sSeconds)) {
sSeconds = cDms00;
sMinutes = cDmsMinuteFormatter.format(tMinutes+1);
}
if ("60".equals(sMinutes)) {
sMinutes = "00";
sDegrees = Integer.toString(tDegree+1);
}
return sDegrees + "\u00B0" + sMinutes + "\'" + sSeconds + "\"";
}
/**
* Replies the coordinate in degrees/minutes format
* @param pCoordinate The coordinate to convert
* @return The coordinate in degrees/minutes format
*/
public static String dm(double pCoordinate) {
double tAbsCoord = Math.abs(pCoordinate);
int tDegree = (int) tAbsCoord;
double tMinutes = (tAbsCoord - tDegree) * 60;
String sDegrees = Integer.toString(tDegree);
String sMinutes = cDmMinuteFormatter.format(tMinutes);
if (sMinutes.equals(cDm60)) {
sMinutes = cDm00;
sDegrees = Integer.toString(tDegree+1);
}
return sDegrees + "\u00B0" + sMinutes + "\'";
}
/**
* Constructs a new {@link LatLon}
* @param lat the latitude, i.e., the north-south position in degrees
* @param lon the longitude, i.e., the east-west position in degrees
*/
public LatLon(double lat, double lon) {
super(lon, lat);
}
protected LatLon(LatLon coor) {
super(coor.lon(), coor.lat());
}
/**
* Returns the latitude, i.e., the north-south position in degrees.
* @return the latitude
*/
public double lat() {
return y;
}
public static final String SOUTH = trc("compass", "S");
public static final String NORTH = trc("compass", "N");
public String latToString(CoordinateFormat d) {
switch(d) {
case DECIMAL_DEGREES: return cDdFormatter.format(y);
case DEGREES_MINUTES_SECONDS: return dms(y) + ((y < 0) ? SOUTH : NORTH);
case NAUTICAL: return dm(y) + ((y < 0) ? SOUTH : NORTH);
case EAST_NORTH: return cDdFormatter.format(Main.getProjection().latlon2eastNorth(this).north());
default: return "ERR";
}
}
/**
* Returns the longitude, i.e., the east-west position in degrees.
* @return the longitude
*/
public double lon() {
return x;
}
public static final String WEST = trc("compass", "W");
public static final String EAST = trc("compass", "E");
public String lonToString(CoordinateFormat d) {
switch(d) {
case DECIMAL_DEGREES: return cDdFormatter.format(x);
case DEGREES_MINUTES_SECONDS: return dms(x) + ((x < 0) ? WEST : EAST);
case NAUTICAL: return dm(x) + ((x < 0) ? WEST : EAST);
case EAST_NORTH: return cDdFormatter.format(Main.getProjection().latlon2eastNorth(this).east());
default: return "ERR";
}
}
/**
* @return <code>true</code> if the other point has almost the same lat/lon
* values, only differing by no more than
* 1 / {@link #MAX_SERVER_PRECISION MAX_SERVER_PRECISION}.
*/
public boolean equalsEpsilon(LatLon other) {
double p = MAX_SERVER_PRECISION / 2;
return Math.abs(lat()-other.lat()) <= p && Math.abs(lon()-other.lon()) <= p;
}
/**
* @return <code>true</code>, if the coordinate is outside the world, compared
* by using lat/lon.
*/
public boolean isOutSideWorld() {
Bounds b = Main.getProjection().getWorldBoundsLatLon();
return lat() < b.getMinLat() || lat() > b.getMaxLat() ||
lon() < b.getMinLon() || lon() > b.getMaxLon();
}
/**
* @return <code>true</code> if this is within the given bounding box.
*/
public boolean isWithin(Bounds b) {
return b.contains(this);
}
/**
* Check if this is contained in given area or area is null.
*
* @param a Area
* @return <code>true</code> if this is contained in given area or area is null.
*/
public boolean isIn(Area a) {
return a == null || a.contains(x, y);
}
/**
* Computes the distance between this lat/lon and another point on the earth.
* Uses Haversine formular.
* @param other the other point.
* @return distance in metres.
*/
public double greatCircleDistance(LatLon other) {
double R = 6378135;
double sinHalfLat = sin(toRadians(other.lat() - this.lat()) / 2);
double sinHalfLon = sin(toRadians(other.lon() - this.lon()) / 2);
double d = 2 * R * asin(
sqrt(sinHalfLat*sinHalfLat +
cos(toRadians(this.lat()))*cos(toRadians(other.lat()))*sinHalfLon*sinHalfLon));
// For points opposite to each other on the sphere,
// rounding errors could make the argument of asin greater than 1
// (This should almost never happen.)
if (java.lang.Double.isNaN(d)) {
Main.error("NaN in greatCircleDistance");
d = PI * R;
}
return d;
}
/**
* Returns the heading, in radians, that you have to use to get from this lat/lon to another.
*
* (I don't know the original source of this formula, but see
* <a href="https://math.stackexchange.com/questions/720/how-to-calculate-a-heading-on-the-earths-surface">this question</a>
* for some hints how it is derived.)
*
* @param other the "destination" position
* @return heading in the range 0 <= hd < 2*PI
*/
public double heading(LatLon other) {
double hd = atan2(sin(toRadians(this.lon() - other.lon())) * cos(toRadians(other.lat())),
cos(toRadians(this.lat())) * sin(toRadians(other.lat())) -
sin(toRadians(this.lat())) * cos(toRadians(other.lat())) * cos(toRadians(this.lon() - other.lon())));
hd %= 2 * PI;
if (hd < 0) {
hd += 2 * PI;
}
return hd;
}
/**
* Returns this lat/lon pair in human-readable format.
*
* @return String in the format "lat=1.23456 deg, lon=2.34567 deg"
*/
public String toDisplayString() {
NumberFormat nf = NumberFormat.getInstance();
nf.setMaximumFractionDigits(5);
return "lat=" + nf.format(lat()) + "\u00B0, lon=" + nf.format(lon()) + "\u00B0";
}
/**
* Returns this lat/lon pair in human-readable format separated by {@code separator}.
* @return String in the format {@code "1.23456[separator]2.34567"}
*/
public String toStringCSV(String separator) {
return Utils.join(separator, Arrays.asList(
latToString(CoordinateFormat.DECIMAL_DEGREES),
lonToString(CoordinateFormat.DECIMAL_DEGREES)
));
}
public LatLon interpolate(LatLon ll2, double proportion) {
return new LatLon(this.lat() + proportion * (ll2.lat() - this.lat()),
this.lon() + proportion * (ll2.lon() - this.lon()));
}
public LatLon getCenter(LatLon ll2) {
return new LatLon((this.lat() + ll2.lat())/2.0, (this.lon() + ll2.lon())/2.0);
}
/**
* Returns the euclidean distance from this {@code LatLon} to a specified {@code LatLon}.
*
* @param ll the specified coordinate to be measured against this {@code LatLon}
* @return the euclidean distance from this {@code LatLon} to a specified {@code LatLon}
* @since 6166
*/
public double distance(final LatLon ll) {
return super.distance(ll);
}
/**
* Returns the square of the euclidean distance from this {@code LatLon} to a specified {@code LatLon}.
*
* @param ll the specified coordinate to be measured against this {@code LatLon}
* @return the square of the euclidean distance from this {@code LatLon} to a specified {@code LatLon}
* @since 6166
*/
public double distanceSq(final LatLon ll) {
return super.distanceSq(ll);
}
@Override public String toString() {
return "LatLon[lat="+lat()+",lon="+lon()+"]";
}
/**
* Returns the value rounded to OSM precisions, i.e. to
* LatLon.MAX_SERVER_PRECISION
*
* @return rounded value
*/
public static double roundToOsmPrecision(double value) {
return Math.round(value * MAX_SERVER_INV_PRECISION) / MAX_SERVER_INV_PRECISION;
}
/**
* Returns the value rounded to OSM precision. This function is now the same as
* {@link #roundToOsmPrecision(double)}, since the rounding error has been fixed.
*
* @return rounded value
*/
public static double roundToOsmPrecisionStrict(double value) {
return roundToOsmPrecision(value);
}
/**
* Replies a clone of this lat LatLon, rounded to OSM precisions, i.e. to
* MAX_SERVER_PRECISION
*
* @return a clone of this lat LatLon
*/
public LatLon getRoundedToOsmPrecision() {
return new LatLon(
roundToOsmPrecision(lat()),
roundToOsmPrecision(lon())
);
}
/**
* Replies a clone of this lat LatLon, rounded to OSM precisions, i.e. to
* MAX_SERVER_PRECISION
*
* @return a clone of this lat LatLon
*/
public LatLon getRoundedToOsmPrecisionStrict() {
return new LatLon(
roundToOsmPrecisionStrict(lat()),
roundToOsmPrecisionStrict(lon())
);
}
@Override
public int hashCode() {
return computeHashCode(super.hashCode());
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (!super.equals(obj))
return false;
if (getClass() != obj.getClass())
return false;
Coordinate other = (Coordinate) obj;
if (java.lang.Double.doubleToLongBits(x) != java.lang.Double.doubleToLongBits(other.x))
return false;
if (java.lang.Double.doubleToLongBits(y) != java.lang.Double.doubleToLongBits(other.y))
return false;
return true;
}
}