/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.elasticsearch.common.geo;
import org.apache.lucene.geo.Rectangle;
import org.elasticsearch.common.io.stream.BytesStreamOutput;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.unit.DistanceUnit;
import org.elasticsearch.test.ESTestCase;
import java.io.IOException;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.greaterThan;
import static org.hamcrest.Matchers.lessThan;
/**
* Basic Tests for {@link GeoDistance}
*/
public class GeoDistanceTests extends ESTestCase {
public void testGeoDistanceSerialization() throws IOException {
// make sure that ordinals don't change, because we rely on then in serialization
assertThat(GeoDistance.PLANE.ordinal(), equalTo(0));
assertThat(GeoDistance.ARC.ordinal(), equalTo(1));
assertThat(GeoDistance.values().length, equalTo(2));
GeoDistance geoDistance = randomFrom(GeoDistance.PLANE, GeoDistance.ARC);
try (BytesStreamOutput out = new BytesStreamOutput()) {
geoDistance.writeTo(out);
try (StreamInput in = out.bytes().streamInput()) {;
GeoDistance copy = GeoDistance.readFromStream(in);
assertEquals(copy.toString() + " vs. " + geoDistance.toString(), copy, geoDistance);
}
}
}
public void testInvalidReadFrom() throws Exception {
try (BytesStreamOutput out = new BytesStreamOutput()) {
if (randomBoolean()) {
out.writeVInt(randomIntBetween(GeoDistance.values().length, Integer.MAX_VALUE));
} else {
out.writeVInt(randomIntBetween(Integer.MIN_VALUE, -1));
}
try (StreamInput in = out.bytes().streamInput()) {
GeoDistance.readFromStream(in);
} catch (IOException e) {
assertThat(e.getMessage(), containsString("Unknown GeoDistance ordinal ["));
}
}
}
public void testDistanceCheck() {
// Note, is within is an approximation, so, even though 0.52 is outside 50mi, we still get "true"
double radius = DistanceUnit.convert(50, DistanceUnit.MILES, DistanceUnit.METERS);
Rectangle box = Rectangle.fromPointDistance(0, 0, radius);
assertThat(GeoUtils.rectangleContainsPoint(box, 0.5, 0.5), equalTo(true));
assertThat(GeoUtils.rectangleContainsPoint(box, 0.52, 0.52), equalTo(true));
assertThat(GeoUtils.rectangleContainsPoint(box, 1, 1), equalTo(false));
radius = DistanceUnit.convert(200, DistanceUnit.MILES, DistanceUnit.METERS);
box = Rectangle.fromPointDistance(0, 179, radius);
assertThat(GeoUtils.rectangleContainsPoint(box, 0, -179), equalTo(true));
assertThat(GeoUtils.rectangleContainsPoint(box, 0, -178), equalTo(false));
}
/**
* The old plane calculation in 1.x/2.x incorrectly computed the plane distance in decimal degrees. This test is
* well intended but bogus. todo: fix w/ new plane distance calculation
* note: plane distance error varies by latitude so the test will need to correctly estimate expected error
*/
@AwaitsFix(bugUrl = "old plane calculation incorrectly computed everything in degrees. fix this bogus test")
public void testArcDistanceVsPlaneInEllipsis() {
GeoPoint centre = new GeoPoint(48.8534100, 2.3488000);
GeoPoint northernPoint = new GeoPoint(48.8801108681, 2.35152032666);
GeoPoint westernPoint = new GeoPoint(48.85265, 2.308896);
// With GeoDistance.ARC both the northern and western points are within the 4km range
assertThat(GeoDistance.ARC.calculate(centre.lat(), centre.lon(), northernPoint.lat(),
northernPoint.lon(), DistanceUnit.KILOMETERS), lessThan(4D));
assertThat(GeoDistance.ARC.calculate(centre.lat(), centre.lon(), westernPoint.lat(),
westernPoint.lon(), DistanceUnit.KILOMETERS), lessThan(4D));
// With GeoDistance.PLANE, only the northern point is within the 4km range,
// the western point is outside of the range due to the simple math it employs,
// meaning results will appear elliptical
assertThat(GeoDistance.PLANE.calculate(centre.lat(), centre.lon(), northernPoint.lat(),
northernPoint.lon(), DistanceUnit.KILOMETERS), lessThan(4D));
assertThat(GeoDistance.PLANE.calculate(centre.lat(), centre.lon(), westernPoint.lat(),
westernPoint.lon(), DistanceUnit.KILOMETERS), greaterThan(4D));
}
}