Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-9263: Fix wrong transformation of distance in meters to radians in Geo3DPoint (#1318)

This commit is contained in:
Ignacio Vera 2020-03-09 17:07:55 +01:00 committed by GitHub
parent c7cf9e8e4f
commit 03c2557681
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 73 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lucene/CHANGES.txt
View File

@ -125,6 +125,8 @@ Bug Fixes
---------------------
* LUCENE-9259: Fix wrong NGramFilterFactory argument name for preserveOriginal option (Paul Pazderski)
* LUCENE-9263: Fix wrong transformation of distance in meters to radians in Geo3DPoint. (Ignacio Vera)
Other
---------------------

2
lucene/spatial3d/src/java/org/apache/lucene/spatial3d/Geo3DPointDistanceComparator.java
View File

@ -144,7 +144,7 @@ class Geo3DPointDistanceComparator extends FieldComparator<Double> implements Le
@Override
public Double value(int slot) {
// Return the arc distance
return Double.valueOf(values[slot] * planetModel.getMeanRadiusMeters());
return Double.valueOf(values[slot] * planetModel.getMeanRadius());
}
@Override

2
lucene/spatial3d/src/java/org/apache/lucene/spatial3d/Geo3DPointOutsideDistanceComparator.java
View File

@ -115,7 +115,7 @@ class Geo3DPointOutsideDistanceComparator extends FieldComparator<Double> implem
@Override
public Double value(int slot) {
// Return the arc distance
return Double.valueOf(values[slot] * planetModel.getMeanRadiusMeters());
return Double.valueOf(values[slot] * planetModel.getMeanRadius());
}
@Override

6
lucene/spatial3d/src/java/org/apache/lucene/spatial3d/Geo3DUtil.java
View File

@ -129,7 +129,8 @@ class Geo3DUtil {
GeoUtils.checkLongitude(longitude);
points[i] = new GeoPoint(planetModel, fromDegrees(latitude), fromDegrees(longitude));
}
return GeoPathFactory.makeGeoPath(planetModel, planetModel.fromMeters(pathWidthMeters), points);
double radiusRadians = pathWidthMeters / (planetModel.getMeanRadius() * planetModel.xyScaling);
return GeoPathFactory.makeGeoPath(planetModel, radiusRadians, points);
}
/**
@ -142,7 +143,8 @@ class Geo3DUtil {
static GeoCircle fromDistance(final PlanetModel planetModel, final double latitude, final double longitude, final double radiusMeters) {
GeoUtils.checkLatitude(latitude);
GeoUtils.checkLongitude(longitude);
return GeoCircleFactory.makeGeoCircle(planetModel, fromDegrees(latitude), fromDegrees(longitude), planetModel.fromMeters(radiusMeters));
double radiusRadians = radiusMeters / (planetModel.getMeanRadius());
return GeoCircleFactory.makeGeoCircle(planetModel, fromDegrees(latitude), fromDegrees(longitude), radiusRadians);
}
/**

77
lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/PlanetModel.java
View File

@ -31,21 +31,19 @@ public class PlanetModel implements SerializableObject {
/** Planet model corresponding to WGS84 ellipsoid*/
// see http://earth-info.nga.mil/GandG/publications/tr8350.2/wgs84fin.pdf
public static final PlanetModel WGS84 = new PlanetModel(6378137.0d, 6356752.314245d, 298.257223563d);
public static final PlanetModel WGS84 = new PlanetModel(6378137.0d, 6356752.314245d);
/** Planet model corresponding to Clarke 1866 ellipsoid*/
// see https://georepository.com/ellipsoid_7008/Clarke-1866.html
public static final PlanetModel CLARKE_1866 = new PlanetModel(6378206.4d, 6356583.8d, 294.9786982d);
public static final PlanetModel CLARKE_1866 = new PlanetModel(6378206.4d, 6356583.8d);
// Surface of the planet:
// x^2/a^2 + y^2/b^2 + z^2/zScaling^2 = 1.0
// Scaling factors are a,b,zScaling. geo3d can only support models where a==b, so use xyScaling instead.
/** Semi-major axis */
public double a;
public final double a;
/** Semi-minor axis */
public double b;
/** Flattening factor */
public double f;
public final double b;
/** The x/y scaling factor */
public final double xyScaling;
/** The z scaling factor */
@ -62,15 +60,15 @@ public class PlanetModel implements SerializableObject {
public final double scaledFlattening;
/** The square ratio */
public final double squareRatio;
/** The mean radius of the planet */
// Computed as (2a + b) / 3 from: "Geodetic Reference System 1980" by H. Moritz
// ftp://athena.fsv.cvut.cz/ZFG/grs80-Moritz.pdf
public final double meanRadius;
/** The scale of the planet */
public final double scale;
/** The inverse of scale */
public final double inverseScale;
/** The mean radius of the planet model */
// Computed as (2a + b) / 3 from: "Geodetic Reference System 1980" by H. Moritz
// ftp://athena.fsv.cvut.cz/ZFG/grs80-Moritz.pdf
public double r1;
// We do NOT include radius, because all computations in geo3d are in radians, not meters.
@ -104,40 +102,22 @@ public class PlanetModel implements SerializableObject {
public final int MAX_ENCODED_VALUE;
/** Min encoded value */
public final int MIN_ENCODED_VALUE;
/** computed radians per meter for *this* planet model */
public final double RADIANS_PER_METER;
/** utility class used to encode/decode from lat/lon (decimal degrees) into doc value integers */
public final DocValueEncoder docValueEncoder;
/**
* Construct a Planet Model from the semi major axis, semi minor axis, and radius of curvature.
*
* NOTE: These parameters are only used to compute the scaling factors used in all computations. If
* scaling factors are already known, use {@code PlanetModel(final double xyScaling, final double zScaling)} instead
* * Construct a Planet Model from the semi major axis, semi minor axis=.
*
* @param semiMajorAxis is the semi major axis (in meters) defined as 'a' in projection formulae.
* @param semiMinorAxis is the semi minor axis (in meters) defined as 'b' in projection formulae.
* @param flattening is the flattening factor defined as a - b / a.
*/
public PlanetModel(final double semiMajorAxis, final double semiMinorAxis, final double flattening) { // final double zScaling) {
this(semiMajorAxis, semiMinorAxis, flattening, ((2d * semiMajorAxis) + semiMinorAxis) / 3d);
}
private PlanetModel(final double a, final double b, final double f, final double r1) {
this(a / r1, b / r1);
this.a = a;
this.b = b;
this.f = f;
this.r1 = r1;
}
/** Constructor.
* @param xyScaling is the x/y scaling factor.
* @param zScaling is the z scaling factor.
*/
public PlanetModel(final double xyScaling, final double zScaling) {
this.xyScaling = xyScaling;
this.zScaling = zScaling;
public PlanetModel(final double semiMajorAxis, final double semiMinorAxis) {
this.a = semiMajorAxis;
this.b = semiMinorAxis;
this.meanRadius = (2.0 * semiMajorAxis + semiMinorAxis) / 3.0;
this.xyScaling = semiMajorAxis / meanRadius;
this.zScaling = semiMinorAxis / meanRadius;
this.scale = (2.0 * xyScaling + zScaling) / 3.0;
this.inverseXYScaling = 1.0 / xyScaling;
this.inverseZScaling = 1.0 / zScaling;
this.scaledFlattening = (xyScaling - zScaling) * inverseXYScaling;
@ -150,7 +130,7 @@ public class PlanetModel implements SerializableObject {
this.MAX_X_POLE = new GeoPoint(xyScaling, 1.0, 0.0, 0.0, 0.0, 0.0);
this.MIN_Y_POLE = new GeoPoint(xyScaling, 0.0, -1.0, 0.0, 0.0, -Math.PI * 0.5);
this.MAX_Y_POLE = new GeoPoint(xyScaling, 0.0, 1.0, 0.0, 0.0, Math.PI * 0.5);
this.scale = (2.0 * xyScaling + zScaling)/3.0;
this.inverseScale = 1.0 / scale;
this.minimumPoleDistance = Math.min(surfaceDistance(NORTH_POLE, SOUTH_POLE), surfaceDistance(MIN_X_POLE, MAX_X_POLE));
@ -160,8 +140,6 @@ public class PlanetModel implements SerializableObject {
this.MIN_ENCODED_VALUE = encodeValue(-MAX_VALUE);
this.MAX_ENCODED_VALUE = encodeValue(MAX_VALUE);
this.RADIANS_PER_METER = 1.0 / xyScaling;
this.docValueEncoder = new DocValueEncoder(this);
}
@ -174,8 +152,8 @@ public class PlanetModel implements SerializableObject {
@Override
public void write(final OutputStream outputStream) throws IOException {
SerializableObject.writeDouble(outputStream, xyScaling);
SerializableObject.writeDouble(outputStream, zScaling);
SerializableObject.writeDouble(outputStream, a);
SerializableObject.writeDouble(outputStream, b);
}
/** Does this planet model describe a sphere?
@ -241,9 +219,9 @@ public class PlanetModel implements SerializableObject {
return this.zScaling;
}
/** return the calculated mean radius (in meters) */
public double getMeanRadiusMeters() {
return this.r1;
/** return the calculated mean radius (in units provided by ab and c) */
public double getMeanRadius() {
return this.meanRadius;
}
/** encode the provided value from double to integer space */
@ -306,11 +284,6 @@ public class PlanetModel implements SerializableObject {
return result;
}
/** Converts earth-surface meters to radians */
public double fromMeters(final double meters) {
return meters * RADIANS_PER_METER;
}
/** Check if point is on surface.
* @param v is the point to check.
* @return true if the point is on the planet surface.
@ -730,12 +703,12 @@ public class PlanetModel implements SerializableObject {
if (!(o instanceof PlanetModel))
return false;
final PlanetModel other = (PlanetModel)o;
return xyScaling == other.xyScaling && zScaling == other.zScaling;
return a == other.a && b == other.b;
}
@Override
public int hashCode() {
return Double.hashCode(xyScaling) + Double.hashCode(zScaling);
return Double.hashCode(a) + Double.hashCode(b);
}
@Override
@ -747,7 +720,7 @@ public class PlanetModel implements SerializableObject {
} else if (this.equals(CLARKE_1866)) {
return "PlanetModel.CLARKE_1866";
} else {
return "PlanetModel(xyScaling="+ xyScaling +" zScaling="+ zScaling +")";
return "PlanetModel(xyScaling="+ a +" zScaling="+ b +")";
}
}
}

31
lucene/spatial3d/src/test/org/apache/lucene/spatial3d/TestGeo3DPoint.java
View File

@ -50,6 +50,7 @@ import org.apache.lucene.index.MultiDocValues;
import org.apache.lucene.index.NumericDocValues;
import org.apache.lucene.index.PointValues.IntersectVisitor;
import org.apache.lucene.index.PointValues.Relation;
import org.apache.lucene.index.RandomIndexWriter;
import org.apache.lucene.index.ReaderUtil;
import org.apache.lucene.index.SegmentReadState;
import org.apache.lucene.index.SegmentWriteState;
@ -610,7 +611,7 @@ public class TestGeo3DPoint extends LuceneTestCase {
case 1: {
// Circles
final double widthMeters = random().nextDouble() * Math.PI * planetModel.getMeanRadiusMeters() /*MEAN_EARTH_RADIUS_METERS*/;
final double widthMeters = random().nextDouble() * Math.PI * planetModel.getMeanRadius();
try {
return Geo3DPoint.newDistanceQuery(field, planetModel, GeoTestUtil.nextLatitude(), GeoTestUtil.nextLongitude(), widthMeters);
} catch (IllegalArgumentException e) {
@ -632,7 +633,7 @@ public class TestGeo3DPoint extends LuceneTestCase {
// Paths
// TBD: Need to rework generation to be realistic
final int pointCount = random().nextInt(5) + 1;
final double width = random().nextDouble() * Math.PI * 0.5 * planetModel.getMeanRadiusMeters(); /* MEAN_EARTH_RADIUS_METERS;*/
final double width = random().nextDouble() * Math.PI * 0.5 * planetModel.getMeanRadius();
final double[] latitudes = new double[pointCount];
final double[] longitudes = new double[pointCount];
for (int i = 0; i < pointCount; i++) {
@ -1328,6 +1329,32 @@ public class TestGeo3DPoint extends LuceneTestCase {
}
}
public void testDistanceQuery() throws Exception {
Directory dir = newDirectory();
RandomIndexWriter w = new RandomIndexWriter(random(), dir);
PlanetModel planetModel = randomPlanetModel();
// index two points:
Document doc = new Document();
doc.add(new Geo3DPoint("field", planetModel, 0.1 , 0.1));
w.addDocument(doc);
doc = new Document();
doc.add(new Geo3DPoint("field", planetModel, 90 , 1));
w.addDocument(doc);
///// search //////
IndexReader reader = w.getReader();
w.close();
IndexSearcher searcher = newSearcher(reader);
// simple query, in any planet model one point should be inside and the other outside
Query q = Geo3DPoint.newDistanceQuery("field", planetModel, 0, 0, planetModel.getMeanRadius() * 0.01);
assertEquals(1, searcher.count(q));
IOUtils.close(w, reader, dir);
}
/** Clips the incoming value to the allowed min/max range before encoding, instead of throwing an exception. */
private static int encodeValueLenient(double x, PlanetModel planetModel) {
double planetMax = planetModel.getMaximumMagnitude();