README: tiny markdown syntax error

[nominatim.git] / lib / ReverseGeocode.php

diff --git a/lib/ReverseGeocode.php b/lib/ReverseGeocode.php
index 0c0a394eb488f6f4ed38d0e43f68db1acf73b074..820ca3855b178ef4365201ce5db9481f159d223b 100644 (file)
--- a/lib/ReverseGeocode.php
+++ b/lib/ReverseGeocode.php
@@ -68,53 +68,108 @@ class ReverseGeocode
             'Could not determine closest housenumber on an osm interpolation line.'
         );
     }
             'Could not determine closest housenumber on an osm interpolation line.'
         );
     }

-    
-    protected function noPolygonFound($sPointSQL, $iMaxRank)
+
+    protected function lookupLargeArea($sPointSQL, $iMaxRank)

     {
     {

-        $sSQL = 'SELECT * FROM country_osm_grid';
-        $sSQL .= ' WHERE ST_CONTAINS (geometry, '.$sPointSQL.' )';
-        
-        $aPoly = chksql(
-            $this->oDB->getRow($sSQL),
-            'Could not determine polygon containing the point.'
+        $oResult = null;
+
+        if ($iMaxRank > 4) {
+            $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
+            if ($aPlace) {
+                return new Result($aPlace['place_id']);
+            }
+        }
+
+        // If no polygon which contains the searchpoint is found,
+        // searches in the country_osm_grid table for a polygon.
+        return  $this->lookupInCountry($sPointSQL, $iMaxRank);
+    }
+
+    protected function lookupInCountry($sPointSQL, $iMaxRank)
+    {
+        // searches for polygon in table country_osm_grid which contains the searchpoint
+        // and searches for the nearest place node to the searchpoint in this polygon
+        $sSQL = 'SELECT country_code FROM country_osm_grid';
+        $sSQL .= ' WHERE ST_CONTAINS(geometry, '.$sPointSQL.') LIMIT 1';
+
+        $sCountryCode = chksql(
+            $this->oDB->getOne($sSQL),
+            'Could not determine country polygon containing the point.'

         );
         );

-        if ($aPoly) {
-            $sCountryCode = $aPoly['country_code'];
-            
-            $sSQL = 'SELECT *, ST_distance('.$sPointSQL.', geometry) as distance';
+        if ($sCountryCode) {
+            if ($iMaxRank > 4) {
+                // look for place nodes with the given country code
+                $sSQL = 'SELECT place_id FROM';
+                $sSQL .= ' (SELECT place_id, rank_search,';
+                $sSQL .= '         ST_distance('.$sPointSQL.', geometry) as distance';
+                $sSQL .= ' FROM placex';
+                $sSQL .= ' WHERE osm_type = \'N\'';
+                $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
+                $sSQL .= ' AND rank_search between 5 and ' .min(25, $iMaxRank);
+                $sSQL .= ' AND class = \'place\' AND type != \'postcode\'';
+                $sSQL .= ' AND name IS NOT NULL ';
+                $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
+                $sSQL .= ' AND ST_DWithin('.$sPointSQL.', geometry, 1.8)) p ';
+                $sSQL .= 'WHERE distance <= reverse_place_diameter(rank_search)';
+                $sSQL .= ' ORDER BY rank_search DESC, distance ASC';
+                $sSQL .= ' LIMIT 1';
+
+                if (CONST_Debug) var_dump($sSQL);
+                $aPlace = chksql(
+                    $this->oDB->getRow($sSQL),
+                    'Could not determine place node.'
+                );
+                if ($aPlace) {
+                    return new Result($aPlace['place_id']);
+                }
+            }
+
+            // still nothing, then return the country object
+            $sSQL = 'SELECT place_id, ST_distance('.$sPointSQL.', centroid) as distance';

             $sSQL .= ' FROM placex';
             $sSQL .= ' FROM placex';

-            $sSQL .= ' WHERE osm_type = \'N\'';
-            $sSQL .= ' AND country_code = \''.$sCountryCode.'\'';
-            $sSQL .= ' AND rank_address > 0';
-            $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
-            $sSQL .= ' AND type != \'postcode\'';
-            $sSQL .= ' AND name IS NOT NULL ';
-            $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
-            $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
-            $sSQL .= ' LIMIT 1';
-            
+            $sSQL .= ' WHERE country_code = \''.$sCountryCode.'\'';
+            $sSQL .= ' AND rank_search = 4 AND rank_address = 4';
+            $sSQL .= ' AND class in (\'boundary\',  \'place\')';
+            $sSQL .= ' AND linked_place_id is null';
+            $sSQL .= ' ORDER BY distance ASC';
+

             if (CONST_Debug) var_dump($sSQL);
             if (CONST_Debug) var_dump($sSQL);

-            $aPlacNode = chksql(
+            $aPlace = chksql(

                 $this->oDB->getRow($sSQL),
                 'Could not determine place node.'
             );
                 $this->oDB->getRow($sSQL),
                 'Could not determine place node.'
             );

-            if ($aPlacNode) {
-                return $aPlacNode;
+            if ($aPlace) {
+                return new Result($aPlace['place_id']);

             }
         }
             }
         }

+
+        return null;

     }
     }

-    
+
+    /**
+     * Search for areas or nodes for areas or nodes between state and suburb level.
+     *
+     * @param string $sPointSQL Search point as SQL string.
+     * @param int    $iMaxRank  Maximum address rank of the feature.
+     *
+     * @return Record of the found feature or null.
+     *
+     * Searches first for polygon that contains the search point.
+     * If such a polygon is found, place nodes with a higher rank are
+     * searched inside the polygon.
+     */

     protected function lookupPolygon($sPointSQL, $iMaxRank)
     {
     protected function lookupPolygon($sPointSQL, $iMaxRank)
     {

-    
-        $oResult = null;
-        $aPlace = null;
-        
-        $sSQL = 'SELECT * FROM';
-        $sSQL .= '(select place_id,parent_place_id,rank_address,country_code, geometry';
+        // polygon search begins at suburb-level
+        if ($iMaxRank > 25) $iMaxRank = 25;
+        // no polygon search over country-level
+        if ($iMaxRank < 5) $iMaxRank = 5;
+        // search for polygon
+        $sSQL = 'SELECT place_id, parent_place_id, rank_address, rank_search FROM';
+        $sSQL .= '(select place_id, parent_place_id, rank_address, rank_search, country_code, geometry';

         $sSQL .= ' FROM placex';
         $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';
         $sSQL .= ' FROM placex';
         $sSQL .= ' WHERE ST_GeometryType(geometry) in (\'ST_Polygon\', \'ST_MultiPolygon\')';

-        $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+        $sSQL .= ' AND rank_address Between 5 AND ' .$iMaxRank;

         $sSQL .= ' AND geometry && '.$sPointSQL;
         $sSQL .= ' AND type != \'postcode\' ';
         $sSQL .= ' AND name is not null';
         $sSQL .= ' AND geometry && '.$sPointSQL;
         $sSQL .= ' AND type != \'postcode\' ';
         $sSQL .= ' AND name is not null';


@@ -128,31 +183,35 @@ class ReverseGeocode
             'Could not determine polygon containing the point.'
         );
         if ($aPoly) {
             'Could not determine polygon containing the point.'
         );
         if ($aPoly) {

+        // if a polygon is found, search for placenodes begins ...

             $iParentPlaceID = $aPoly['parent_place_id'];
             $iRankAddress = $aPoly['rank_address'];
             $iParentPlaceID = $aPoly['parent_place_id'];
             $iRankAddress = $aPoly['rank_address'];

+            $iRankSearch = $aPoly['rank_search'];

             $iPlaceID = $aPoly['place_id'];
             $iPlaceID = $aPoly['place_id'];

-            
+

             if ($iRankAddress != $iMaxRank) {
             if ($iRankAddress != $iMaxRank) {

-                $sSQL = 'SELECT *';
-                $sSQL .= ' FROM (';
-                $sSQL .= ' SELECT place_id, rank_address,country_code, geometry,';
+                $sSQL = 'SELECT place_id FROM ';
+                $sSQL .= '(SELECT place_id, rank_search, country_code, geometry,';

                 $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
                 $sSQL .= ' FROM placex';
                 $sSQL .= ' WHERE osm_type = \'N\'';
                 $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
                 $sSQL .= ' FROM placex';
                 $sSQL .= ' WHERE osm_type = \'N\'';

-                $sSQL .= ' AND rank_address > '.$iRankAddress;
-                $sSQL .= ' AND rank_address <= ' .Min(25, $iMaxRank);
+                // using rank_search because of a better differentiation
+                // for place nodes at rank_address 16
+                $sSQL .= ' AND rank_search > '.$iRankSearch;
+                $sSQL .= ' AND rank_search <= '.$iMaxRank;
+                $sSQL .= ' AND class = \'place\'';

                 $sSQL .= ' AND type != \'postcode\'';
                 $sSQL .= ' AND name IS NOT NULL ';
                 $sSQL .= ' AND type != \'postcode\'';
                 $sSQL .= ' AND name IS NOT NULL ';

-                $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
-                // preselection through bbox
-                $sSQL .= ' AND (SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.') && geometry';
+                $sSQL .= ' AND indexed_status = 0 AND linked_place_id is null';
+                $sSQL .= ' AND ST_DWithin('.$sPointSQL.', geometry, reverse_place_diameter('.$iRankSearch.'::smallint))';

                 $sSQL .= ' ORDER BY distance ASC,';
                 $sSQL .= ' rank_address DESC';
                 $sSQL .= ' limit 500) as a';
                 $sSQL .= ' WHERE ST_CONTAINS((SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.'), geometry )';
                 $sSQL .= ' ORDER BY distance ASC,';
                 $sSQL .= ' rank_address DESC';
                 $sSQL .= ' limit 500) as a';
                 $sSQL .= ' WHERE ST_CONTAINS((SELECT geometry FROM placex WHERE place_id = '.$iPlaceID.'), geometry )';

-                $sSQL .= ' ORDER BY distance ASC, rank_address DESC';
+                $sSQL .= ' AND distance <= reverse_place_diameter(rank_search)';
+                $sSQL .= ' ORDER BY distance ASC, rank_search DESC';

                 $sSQL .= ' LIMIT 1';
                 $sSQL .= ' LIMIT 1';

-                
+

                 if (CONST_Debug) var_dump($sSQL);
                 $aPlacNode = chksql(
                     $this->oDB->getRow($sSQL),
                 if (CONST_Debug) var_dump($sSQL);
                 $aPlacNode = chksql(
                     $this->oDB->getRow($sSQL),


@@ -166,6 +225,7 @@ class ReverseGeocode
         return $aPoly;
     }
 
         return $aPoly;
     }
 

+

     public function lookup($fLat, $fLon, $bDoInterpolation = true)
     {
         return $this->lookupPoint(
     public function lookup($fLat, $fLon, $bDoInterpolation = true)
     {
         return $this->lookupPoint(


@@ -176,38 +236,21 @@ class ReverseGeocode
 
     public function lookupPoint($sPointSQL, $bDoInterpolation = true)
     {
 
     public function lookupPoint($sPointSQL, $bDoInterpolation = true)
     {

-        
+        // starts if the search is on POI or street level,
+        // searches for the nearest POI or street,
+        // if a street is found and a POI is searched for,
+        // the nearest POI which the found street is a parent of is choosen.

         $iMaxRank = $this->iMaxRank;
 
         // Find the nearest point
         $fSearchDiam = 0.006;
         $oResult = null;
         $aPlace = null;
         $iMaxRank = $this->iMaxRank;
 
         // Find the nearest point
         $fSearchDiam = 0.006;
         $oResult = null;
         $aPlace = null;

-        $fMaxAreaDistance = 1;
-        $bIsTigerStreet = false;
-        
-        // try with interpolations before continuing
-        if ($bDoInterpolation && $iMaxRank >= 30) {
-            $aHouse = $this->lookupInterpolation($sPointSQL, $fSearchDiam/3);
-
-            if ($aHouse) {
-                $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
-                $oResult->iHouseNumber = closestHouseNumber($aHouse);
-
-                $aPlace = $aHouse;
-                $iParentPlaceID = $aHouse['parent_place_id']; // the street
-                $iMaxRank = 30;
-                
-                return $oResult;
-            }
-        }// no interpolation found, continue search
-        
+

         // for POI or street level
         if ($iMaxRank >= 26) {
             $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';
         // for POI or street level
         if ($iMaxRank >= 26) {
             $sSQL = 'select place_id,parent_place_id,rank_address,country_code,';

-            $sSQL .= 'CASE WHEN ST_GeometryType(geometry) in (\'ST_Polygon\',\'ST_MultiPolygon\') THEN ST_distance('.$sPointSQL.', centroid)';
-            $sSQL .= ' ELSE ST_distance('.$sPointSQL.', geometry) ';
-            $sSQL .= ' END as distance';
+            $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';

             $sSQL .= ' FROM ';
             $sSQL .= ' placex';
             $sSQL .= '   WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
             $sSQL .= ' FROM ';
             $sSQL .= ' placex';
             $sSQL .= '   WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';


@@ -216,11 +259,11 @@ class ReverseGeocode
             if ($iMaxRank == 26) {
                 $sSQL .= ' rank_address = 26';
             } else {
             if ($iMaxRank == 26) {
                 $sSQL .= ' rank_address = 26';
             } else {

-                $sSQL .= ' rank_address >= 26';
+                $sSQL .= ' rank_address between 26 and '.$iMaxRank;

             }
             $sSQL .= ' and (name is not null or housenumber is not null';
             $sSQL .= ' or rank_address between 26 and 27)';
             }
             $sSQL .= ' and (name is not null or housenumber is not null';
             $sSQL .= ' or rank_address between 26 and 27)';

-            $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
+            $sSQL .= ' and class not in (\'railway\',\'tunnel\',\'bridge\',\'man_made\')';

             $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
             $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
             $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
             $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';


@@ -230,15 +273,41 @@ class ReverseGeocode
                 $this->oDB->getRow($sSQL),
                 'Could not determine closest place.'
             );
                 $this->oDB->getRow($sSQL),
                 'Could not determine closest place.'
             );

-            
+
+            if (CONST_Debug) var_dump($aPlace);

             if ($aPlace) {
             if ($aPlace) {

-                    $iPlaceID = $aPlace['place_id'];
-                    $oResult = new Result($iPlaceID);
-                    $iParentPlaceID = $aPlace['parent_place_id'];
-                    // if street and maxrank > streetlevel
-                if (($aPlace['rank_address'] == 26 || $aPlace['rank_address'] == 27)&& $iMaxRank > 27) {
+                $iPlaceID = $aPlace['place_id'];
+                $oResult = new Result($iPlaceID);
+                $iRankAddress = $aPlace['rank_address'];
+                $iParentPlaceID = $aPlace['parent_place_id'];
+            }
+
+            if ($bDoInterpolation && $iMaxRank >= 30) {
+                $fDistance = $fSearchDiam;
+                if ($aPlace) {
+                    // We can't reliably go from the closest street to an
+                    // interpolation line because the closest interpolation
+                    // may have a different street segments as a parent.
+                    // Therefore allow an interpolation line to take precendence
+                    // even when the street is closer.
+                    $fDistance = $iRankAddress < 28 ? 0.001 : $aPlace['distance'];
+                }
+
+                $aHouse = $this->lookupInterpolation($sPointSQL, $fDistance);
+
+                if ($aHouse) {
+                    $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
+                    $oResult->iHouseNumber = closestHouseNumber($aHouse);
+                    $aPlace = $aHouse;
+                    $iRankAddress = 30;
+                }
+            }
+
+            if ($aPlace) {
+                // if street and maxrank > streetlevel
+                if ($iRankAddress <= 27 && $iMaxRank > 27) {

                     // find the closest object (up to a certain radius) of which the street is a parent of
                     // find the closest object (up to a certain radius) of which the street is a parent of

-                    $sSQL = ' select place_id,parent_place_id,rank_address,country_code,';
+                    $sSQL = ' select place_id,';

                     $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
                     $sSQL .= ' FROM ';
                     $sSQL .= ' placex';
                     $sSQL .= ' ST_distance('.$sPointSQL.', geometry) as distance';
                     $sSQL .= ' FROM ';
                     $sSQL .= ' placex';


@@ -246,9 +315,8 @@ class ReverseGeocode
                     $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.001)';
                     $sSQL .= ' AND parent_place_id = '.$iPlaceID;
                     $sSQL .= ' and rank_address != 28';
                     $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, 0.001)';
                     $sSQL .= ' AND parent_place_id = '.$iPlaceID;
                     $sSQL .= ' and rank_address != 28';

-                    $sSQL .= ' and (name is not null or housenumber is not null';
-                    $sSQL .= ' or rank_address between 26 and 27)';
-                    $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
+                    $sSQL .= ' and (name is not null or housenumber is not null)';
+                    $sSQL .= ' and class not in (\'railway\',\'tunnel\',\'bridge\',\'man_made\')';

                     $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
                     $sSQL .= ' ORDER BY distance ASC limit 1';
                     if (CONST_Debug) var_dump($sSQL);
                     $sSQL .= ' and indexed_status = 0 and linked_place_id is null';
                     $sSQL .= ' ORDER BY distance ASC limit 1';
                     if (CONST_Debug) var_dump($sSQL);


@@ -257,33 +325,42 @@ class ReverseGeocode
                         'Could not determine closest place.'
                     );
                     if ($aStreet) {
                         'Could not determine closest place.'
                     );
                     if ($aStreet) {

-                        $iPlaceID = $aStreet['place_id'];
-                        $oResult = new Result($iPlaceID);
-                        $iParentPlaceID = $aStreet['parent_place_id'];
+                        if (CONST_Debug) var_dump($aStreet);
+                        $oResult = new Result($aStreet['place_id']);

                     }
                 }
                     }
                 }

-            } else {
-                $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
-                if ($aPlace) {
-                    $oResult = new Result($aPlace['place_id']);
-                } elseif(!$aPlace && $iMaxRank > 4)  {
-                    $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
-                    if ($aPlace) {
-                        $oResult = new Result($aPlace['place_id']);
+
+                  // In the US we can check TIGER data for nearest housenumber
+                if (CONST_Use_US_Tiger_Data
+                    && $iRankAddress <= 27
+                    && $aPlace['country_code'] == 'us'
+                    && $this->iMaxRank >= 28
+                ) {
+                    $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search,';
+                    $sSQL .= 'ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';
+                    $sSQL .= 'ST_distance('.$sPointSQL.', linegeo) as distance,';
+                    $sSQL .= 'startnumber,endnumber,interpolationtype';
+                    $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$oResult->iId;
+                    $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, 0.001)';
+                    $sSQL .= ' ORDER BY distance ASC limit 1';
+                    if (CONST_Debug) var_dump($sSQL);
+                    $aPlaceTiger = chksql(
+                        $this->oDB->getRow($sSQL),
+                        'Could not determine closest Tiger place.'
+                    );
+                    if ($aPlaceTiger) {
+                        if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
+                        $oResult = new Result($aPlaceTiger['place_id'], Result::TABLE_TIGER);
+                        $oResult->iHouseNumber = closestHouseNumber($aPlaceTiger);

                     }
                 }
                     }
                 }

+            } else {
+                // if no POI or street is found ...
+                $oResult = $this->lookupLargeArea($sPointSQL, 25);

             }
             }

-            // lower than street level ($iMaxRank < 26 )

         } else {
         } else {

-            $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
-            if ($aPlace) {
-                $oResult = new Result($aPlace['place_id']);
-            } elseif(!$aPlace && $iMaxRank > 4) {
-                $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
-                if ($aPlace) {
-                    $oResult = new Result($aPlace['place_id']);
-                }
-            }
+            // lower than street level ($iMaxRank < 26 )
+            $oResult = $this->lookupLargeArea($sPointSQL, $iMaxRank);

         }
         return $oResult;
     }
         }
         return $oResult;
     }