Merge remote-tracking branch 'upstream/master'

[nominatim.git] / lib / ReverseGeocode.php

diff --git a/lib/ReverseGeocode.php b/lib/ReverseGeocode.php
index 3d1a51ceb751d18e682333a4c99dd9467e73c202..b3899e3b918a6d8ecedcd0780285af6e5b8ddafb 100644 (file)
--- a/lib/ReverseGeocode.php
+++ b/lib/ReverseGeocode.php
@@ -1,46 +1,78 @@
 <?php
 
 <?php
 

+namespace Nominatim;
+

 class ReverseGeocode
 {
     protected $oDB;
     protected $iMaxRank = 28;
 
 class ReverseGeocode
 {
     protected $oDB;
     protected $iMaxRank = 28;
 

-    function ReverseGeocode(&$oDB)
+
+    public function __construct(&$oDB)

     {
         $this->oDB =& $oDB;
     }
 
     {
         $this->oDB =& $oDB;
     }
 

-    function setZoom($iZoom)
+
+    public function setZoom($iZoom)

     {
         // Zoom to rank, this could probably be calculated but a lookup gives fine control
         $aZoomRank = array(
     {
         // Zoom to rank, this could probably be calculated but a lookup gives fine control
         $aZoomRank = array(

-            0 => 2, // Continent / Sea
-            1 => 2,
-            2 => 2,
-            3 => 4, // Country
-            4 => 4,
-            5 => 8, // State
-            6 => 10, // Region
-            7 => 10,
-            8 => 12, // County
-            9 => 12,
-            10 => 17, // City
-            11 => 17,
-            12 => 18, // Town / Village
-            13 => 18,
-            14 => 22, // Suburb
-            15 => 22,
-            16 => 26, // Street, TODO: major street?
-            17 => 26,
-            18 => 30, // or >, Building
-            19 => 30, // or >, Building
-            );
+                      0 => 2, // Continent / Sea
+                      1 => 2,
+                      2 => 2,
+                      3 => 4, // Country
+                      4 => 4,
+                      5 => 8, // State
+                      6 => 10, // Region
+                      7 => 10,
+                      8 => 12, // County
+                      9 => 12,
+                      10 => 17, // City
+                      11 => 17,
+                      12 => 18, // Town / Village
+                      13 => 18,
+                      14 => 22, // Suburb
+                      15 => 22,
+                      16 => 26, // Street, TODO: major street?
+                      17 => 26,
+                      18 => 30, // or >, Building
+                      19 => 30, // or >, Building
+                     );

         $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
     }
 
         $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
     }
 

-    // returns { place_id =>, type => '(osm|tiger)' }
-    // fails if no place was found
-    function lookup($fLat, $fLon, $bDoInterpolation = true)
+    /**
+     * Find the closest interpolation with the given search diameter.
+     *
+     * @param string $sPointSQL   Reverse geocoding point as SQL
+     * @param float  $fSearchDiam Search diameter
+     *
+     * @return Record of the interpolation or null.
+     */
+    protected function lookupInterpolation($sPointSQL, $fSearchDiam)
+    {
+        $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search,';
+        $sSQL .= ' ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction';
+        $sSQL .= ' , ST_Distance(linegeo,'.$sPointSQL.') as distance';
+        $sSQL .= ' FROM location_property_osmline';
+        $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
+        $sSQL .= ' and indexed_status = 0 ';
+        $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
+
+        return chksql(
+            $this->oDB->getRow($sSQL),
+            "Could not determine closest housenumber on an osm interpolation line."
+        );
+    }
+
+    /* lookup()
+     * returns { place_id =>, type => '(osm|tiger)' }
+     * fails if no place was found
+     */
+
+
+    public function lookup($fLat, $fLon, $bDoInterpolation = true)

     {
         $sPointSQL = 'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)';
         $iMaxRank = $this->iMaxRank;
     {
         $sPointSQL = 'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)';
         $iMaxRank = $this->iMaxRank;


@@ -48,13 +80,11 @@ class ReverseGeocode
         // Find the nearest point
         $fSearchDiam = 0.0004;
         $iPlaceID = null;
         // Find the nearest point
         $fSearchDiam = 0.0004;
         $iPlaceID = null;

-        $aArea = false;

         $fMaxAreaDistance = 1;
         $bIsInUnitedStates = false;
         $bPlaceIsTiger = false;
         $bPlaceIsLine = false;
         $fMaxAreaDistance = 1;
         $bIsInUnitedStates = false;
         $bPlaceIsTiger = false;
         $bPlaceIsLine = false;

-        while(!$iPlaceID && $fSearchDiam < $fMaxAreaDistance)
-        {
+        while (!$iPlaceID && $fSearchDiam < $fMaxAreaDistance) {

             $fSearchDiam = $fSearchDiam * 2;
 
             // If we have to expand the search area by a large amount then we need a larger feature
             $fSearchDiam = $fSearchDiam * 2;
 
             // If we have to expand the search area by a large amount then we need a larger feature


@@ -66,7 +96,27 @@ class ReverseGeocode
             if ($fSearchDiam > 0.2 && $iMaxRank > 17) $iMaxRank = 17;
             if ($fSearchDiam > 0.1 && $iMaxRank > 18) $iMaxRank = 18;
             if ($fSearchDiam > 0.008 && $iMaxRank > 22) $iMaxRank = 22;
             if ($fSearchDiam > 0.2 && $iMaxRank > 17) $iMaxRank = 17;
             if ($fSearchDiam > 0.1 && $iMaxRank > 18) $iMaxRank = 18;
             if ($fSearchDiam > 0.008 && $iMaxRank > 22) $iMaxRank = 22;

-            if ($fSearchDiam > 0.001 && $iMaxRank > 26) $iMaxRank = 26;
+            if ($fSearchDiam > 0.001 && $iMaxRank > 26) {
+                // try with interpolations before continuing
+                if ($bDoInterpolation) {
+                    // no house found, try with interpolations
+                    $aPlaceLine = $this->lookupInterpolation($sPointSQL, $fSearchDiam/2);
+
+                    if ($aPlaceLine) {
+                        // interpolation is closer to point than placex house
+                        $bPlaceIsLine = true;
+                        $aPlace = $aPlaceLine;
+                        $iPlaceID = $aPlaceLine['place_id'];
+                        $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
+                        $fFraction = $aPlaceLine['fraction'];
+                        $iMaxRank = 30;
+
+                        break;
+                    }
+                }
+                // no interpolation found, continue search
+                $iMaxRank = 26;
+            }

 
             $sSQL = 'select place_id,parent_place_id,rank_search,calculated_country_code';
             $sSQL .= ' FROM placex';
 
             $sSQL = 'select place_id,parent_place_id,rank_search,calculated_country_code';
             $sSQL .= ' FROM placex';


@@ -79,103 +129,64 @@ class ReverseGeocode
             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
             if (CONST_Debug) var_dump($sSQL);
             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
             if (CONST_Debug) var_dump($sSQL);

-            $aPlace = chksql($this->oDB->getRow($sSQL),
-                             "Could not determine closest place.");
+            $aPlace = chksql(
+                $this->oDB->getRow($sSQL),
+                "Could not determine closest place."
+            );

             $iPlaceID = $aPlace['place_id'];
             $iParentPlaceID = $aPlace['parent_place_id'];
             $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
         }
             $iPlaceID = $aPlace['place_id'];
             $iParentPlaceID = $aPlace['parent_place_id'];
             $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
         }

-        // if a street or house was found, look in interpolation lines table
-        if ($bDoInterpolation && $this->iMaxRank >= 28 && $aPlace && $aPlace['rank_search'] >= 26)
-        {
-            // if a house was found, search the interpolation line that is at least as close as the house
-            $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
-            $sSQL .= ' FROM location_property_osmline';
-            $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
-            $sSQL .= ' and indexed_status = 0 ';
-            $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
-            
-            if (CONST_Debug)
-            {
-                $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
-                var_dump($sSQL);

 
 

-                $aAllHouses = chksql($this->oDB->getAll($sSQL));
-                foreach($aAllHouses as $i)
-                {
-                    echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
-                }
-            }
-            $aPlaceLine = chksql($this->oDB->getRow($sSQL),
-                                 "Could not determine closest housenumber on an osm interpolation line.");
-            if ($aPlaceLine)
-            {
-                if (CONST_Debug) var_dump('found housenumber in interpolation lines table', $aPlaceLine);
-                if ($aPlace['rank_search'] == 30)
-                {
-                    // if a house was already found in placex, we have to find out, 
-                    // if the placex house or the interpolated house are closer to the searched point
-                    // distance between point and placex house
-                    $sSQL = 'SELECT ST_distance('.$sPointSQL.', house.geometry) as distance FROM placex as house WHERE house.place_id='.$iPlaceID;
-                    $aDistancePlacex = chksql($this->oDB->getRow($sSQL),
-                                              "Could not determine distance between searched point and placex house.");
-                    $fDistancePlacex = $aDistancePlacex['distance'];
-                    // distance between point and interpolated house (fraction on interpolation line)
-                    $sSQL = 'SELECT ST_distance('.$sPointSQL.', ST_LineInterpolatePoint(linegeo, '.$aPlaceLine['fraction'].')) as distance';
-                    $sSQL .= ' FROM location_property_osmline WHERE place_id = '.$aPlaceLine['place_id'];
-                    $aDistanceInterpolation = chksql($this->oDB->getRow($sSQL),
-                                                     "Could not determine distance between searched point and interpolated house.");
-                    $fDistanceInterpolation = $aDistanceInterpolation['distance'];
-                    if ($fDistanceInterpolation < $fDistancePlacex)
-                    {
-                        // interpolation is closer to point than placex house
-                        $bPlaceIsLine = true;
-                        $aPlace = $aPlaceLine;
-                        $iPlaceID = $aPlaceLine['place_id'];
-                        $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
-                        $fFraction = $aPlaceLine['fraction'];
-                        $iMaxRank = 30;
-                    }
-                    // else: nothing to do, take placex house from above
-                }
-                else
-                {
-                    $bPlaceIsLine = true;
-                    $aPlace = $aPlaceLine;
-                    $iPlaceID = $aPlaceLine['place_id'];
-                    $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
-                    $fFraction = $aPlaceLine['fraction'];
-                    $iMaxRank = 30;
-                }
+        // If a house was found make sure there isn't an interpolation line
+        // that is closer
+        if ($bDoInterpolation && !$bPlaceIsLine && $aPlace && $aPlace['rank_search'] == 30) {
+            // get the distance of the house to the search point
+            $sSQL = 'SELECT ST_distance('.$sPointSQL.', house.geometry)';
+            $sSQL .= ' FROM placex as house WHERE house.place_id='.$iPlaceID;
+
+            $fDistancePlacex = chksql(
+                $this->oDB->getOne($sSQL),
+                "Could not determine distance between searched point and placex house."
+            );
+
+            // look for an interpolation that is closer
+            $aPlaceLine = $this->lookupInterpolation($sPointSQL, $fDistancePlacex);
+
+            if ($aPlaceLine) {
+                // interpolation is closer to point than placex house
+                $bPlaceIsLine = true;
+                $aPlace = $aPlaceLine;
+                $iPlaceID = $aPlaceLine['place_id'];
+                $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
+                $fFraction = $aPlaceLine['fraction'];

             }
         }
             }
         }

-        
+

         // Only street found? If it's in the US we can check TIGER data for nearest housenumber
         // Only street found? If it's in the US we can check TIGER data for nearest housenumber

-        if (CONST_Use_US_Tiger_Data && $bDoInterpolation && $bIsInUnitedStates && $this->iMaxRank >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 ))
-        {
+        if (CONST_Use_US_Tiger_Data && $bDoInterpolation && $bIsInUnitedStates && $this->iMaxRank >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 )) {

             $fSearchDiam = 0.001;
             $fSearchDiam = 0.001;

-            $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
+            $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction';

             //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
             $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$iPlaceID;
             $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';  //no centroid anymore in Tiger data, now we have lines
             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
 
             //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
             $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$iPlaceID;
             $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';  //no centroid anymore in Tiger data, now we have lines
             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
 

-            if (CONST_Debug)
-            {
+            if (CONST_Debug) {

                 $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
                 var_dump($sSQL);
 
                 $aAllHouses = chksql($this->oDB->getAll($sSQL));
                 $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
                 var_dump($sSQL);
 
                 $aAllHouses = chksql($this->oDB->getAll($sSQL));

-                foreach($aAllHouses as $i)
-                {
+                foreach ($aAllHouses as $i) {

                     echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
                 }
             }
 
                     echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
                 }
             }
 

-            $aPlaceTiger = chksql($this->oDB->getRow($sSQL),
-                                  "Could not determine closest Tiger place.");
-            if ($aPlaceTiger)
-            {
+            $aPlaceTiger = chksql(
+                $this->oDB->getRow($sSQL),
+                "Could not determine closest Tiger place."
+            );
+            if ($aPlaceTiger) {

                 if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
                 $bPlaceIsTiger = true;
                 $aPlace = $aPlaceTiger;
                 if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
                 $bPlaceIsTiger = true;
                 $aPlace = $aPlaceTiger;


@@ -187,27 +198,26 @@ class ReverseGeocode
         }
 
         // The point we found might be too small - use the address to find what it is a child of
         }
 
         // The point we found might be too small - use the address to find what it is a child of

-        if ($iPlaceID && $iMaxRank < 28)
-        {
-            if (($aPlace['rank_search'] > 28 || $bPlaceIsTiger || $bPlaceIsLine) && $iParentPlaceID)
-            {
+        if ($iPlaceID && $iMaxRank < 28) {
+            if (($aPlace['rank_search'] > 28 || $bPlaceIsTiger || $bPlaceIsLine) && $iParentPlaceID) {

                 $iPlaceID = $iParentPlaceID;
                 $iPlaceID = $iParentPlaceID;

+                $bPlaceIsLine = false;
+                $bPlaceIsTiger = false;

             }
             $sSQL  = 'select address_place_id';
             $sSQL .= ' FROM place_addressline';
             $sSQL .= " WHERE place_id = $iPlaceID";
             $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
             $sSQL .= ' LIMIT 1';
             }
             $sSQL  = 'select address_place_id';
             $sSQL .= ' FROM place_addressline';
             $sSQL .= " WHERE place_id = $iPlaceID";
             $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
             $sSQL .= ' LIMIT 1';

-            $iPlaceID = chksql($this->oDB->getOne($sSQL),
-                               "Could not get parent for place.");
-            if (!$iPlaceID)
-            {
+            $iPlaceID = chksql($this->oDB->getOne($sSQL), "Could not get parent for place.");
+            if (!$iPlaceID) {

                 $iPlaceID = $aPlace['place_id'];
             }
         }
                 $iPlaceID = $aPlace['place_id'];
             }
         }

-        return array('place_id' => $iPlaceID,
-                    'type' => $bPlaceIsTiger ? 'tiger' : ($bPlaceIsLine ? 'interpolation' : 'osm'),
-                    'fraction' => ($bPlaceIsTiger || $bPlaceIsLine) ? $fFraction : -1);
+        return array(
+                'place_id' => $iPlaceID,
+                'type' => $bPlaceIsTiger ? 'tiger' : ($bPlaceIsLine ? 'interpolation' : 'osm'),
+                'fraction' => ($bPlaceIsTiger || $bPlaceIsLine) ? $fFraction : -1
+               );

     }
     }

-    

 }
 }