add documentation for reverse-only

[nominatim.git] / lib / ReverseGeocode.php

diff --git a/lib/ReverseGeocode.php b/lib/ReverseGeocode.php
index f854d098132d6c5532dd3f5372ba6496f5b14d4f..820ca3855b178ef4365201ce5db9481f159d223b 100644 (file)
--- a/lib/ReverseGeocode.php
+++ b/lib/ReverseGeocode.php
@@ -47,13 +47,12 @@ class ReverseGeocode
     /**
      * Find the closest interpolation with the given search diameter.
      *
     /**
      * Find the closest interpolation with the given search diameter.
      *

-     * @param string  $sPointSQL      Reverse geocoding point as SQL
-     * @param float   $fSearchDiam    Search diameter
-     * @param integer $iParentPlaceID Id of parent object
+     * @param string $sPointSQL   Reverse geocoding point as SQL
+     * @param float  $fSearchDiam Search diameter

      *
      * @return Record of the interpolation or null.
      */
      *
      * @return Record of the interpolation or null.
      */

-    protected function lookupInterpolation($sPointSQL, $fSearchDiam, $iParentPlaceID = 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 = 'SELECT place_id, parent_place_id, 30 as rank_search,';
         $sSQL .= '  ST_LineLocatePoint(linegeo,'.$sPointSQL.') as fraction,';


@@ -62,9 +61,6 @@ class ReverseGeocode
         $sSQL .= ' FROM location_property_osmline';
         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
         $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';
         $sSQL .= ' FROM location_property_osmline';
         $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
         $sSQL .= ' and indexed_status = 0 and startnumber is not NULL ';

-        if (isset($iParentPlaceID)) {
-            $sSQL .= ' and parent_place_id = '.$iParentPlaceID;
-        }

         $sSQL .= ' ORDER BY distance ASC limit 1';
 
         return chksql(
         $sSQL .= ' ORDER BY distance ASC limit 1';
 
         return chksql(


@@ -73,78 +69,107 @@ class ReverseGeocode
         );
     }
 
         );
     }
 

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

     {
     {

-        // starts the nopolygonFound function if no polygon is found with the lookupPolygon function

         $oResult = null;
 
         $oResult = null;
 

-        $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);
-        if ($aPlace) {
-            $oResult = new Result($aPlace['place_id']);
-        // if no polygon which contains the searchpoint is found,
-        // the noPolygonFound function searches in the country_osm_grid table for a polygon
-        } elseif (!$aPlace && $iMaxRank > 4) {
-            $aPlace = $this->noPolygonFound($sPointSQL, $iMaxRank);
+        if ($iMaxRank > 4) {
+            $aPlace = $this->lookupPolygon($sPointSQL, $iMaxRank);

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

-                $oResult = new Result($aPlace['place_id']);
+                return new Result($aPlace['place_id']);

             }
         }
             }
         }

-        return $oResult;
+
+        // 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 noPolygonFound($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';
     {
         // 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';
+        $sSQL .= ' WHERE ST_CONTAINS(geometry, '.$sPointSQL.') LIMIT 1';

 
 

-        $aPoly = chksql(
-            $this->oDB->getRow($sSQL),
-            'Could not determine polygon containing the point.'
+        $sCountryCode = chksql(
+            $this->oDB->getOne($sSQL),
+            'Could not determine country polygon containing the point.'

         );
         );

-        if ($aPoly) {
-            $sCountryCode = $aPoly['country_code'];
+        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';

 
 

-            $sSQL = 'SELECT place_id, ST_distance('.$sPointSQL.', geometry) as distance';
+                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 .= ' AND ST_DWithin('.$sPointSQL.', geometry, 1.0)';
-            $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)
     {

-        // searches for polygon where the searchpoint is within
-        // if a polygon is found, placenodes with a higher rank are searched inside the polygon
-

         // polygon search begins at suburb-level
         if ($iMaxRank > 25) $iMaxRank = 25;
         // no polygon search over country-level
         // polygon search begins at suburb-level
         if ($iMaxRank > 25) $iMaxRank = 25;
         // no polygon search over country-level

-        if ($iMaxRank < 4) $iMaxRank = 4;
+        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\')';
         // 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 .= ' AND rank_address Between 4 AND ' .$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';


@@ -165,49 +190,26 @@ class ReverseGeocode
             $iPlaceID = $aPoly['place_id'];
 
             if ($iRankAddress != $iMaxRank) {
             $iPlaceID = $aPoly['place_id'];
 
             if ($iRankAddress != $iMaxRank) {

-            //search diameter for the place node search
-                if ($iMaxRank <= 4) {
-                    $fSearchDiam = 4;
-                } elseif ($iMaxRank <= 8) {
-                    $fSearchDiam = 2;
-                } elseif ($iMaxRank <= 10) {
-                    $fSearchDiam = 1;
-                } elseif ($iMaxRank <= 12) {
-                    $fSearchDiam = 0.8;
-                } elseif ($iMaxRank <= 17) {
-                    $fSearchDiam = 0.6;
-                } elseif ($iMaxRank <= 18) {
-                    $fSearchDiam = 0.2;
-                } elseif ($iMaxRank <= 25) {
-                    $fSearchDiam = 0.1;
-                }
-
-                $sSQL = 'SELECT place_id';
-                $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\'';

-                if ($iRankAddress = 16) {
-                // 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\'';
-                } else {
-                    $sSQL .= ' AND rank_address > '.$iRankAddress;
-                    $sSQL .= ' AND rank_address <= ' .$iMaxRank;
-                }
-                $sSQL .= ' AND ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
+                // 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';
 
                 if (CONST_Debug) var_dump($sSQL);
                 $sSQL .= ' LIMIT 1';
 
                 if (CONST_Debug) var_dump($sSQL);


@@ -244,15 +246,11 @@ class ReverseGeocode
         $fSearchDiam = 0.006;
         $oResult = null;
         $aPlace = null;
         $fSearchDiam = 0.006;
         $oResult = null;
         $aPlace = null;

-        $fMaxAreaDistance = 1;
-        $bIsTigerStreet = false;

 
         // 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.')';


@@ -276,29 +274,40 @@ class ReverseGeocode
                 'Could not determine closest place.'
             );
 
                 'Could not determine closest place.'
             );
 

+            if (CONST_Debug) var_dump($aPlace);

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

-
-                $iDistance = $aPlace['distance'];

                 $iPlaceID = $aPlace['place_id'];
                 $oResult = new Result($iPlaceID);
                 $iPlaceID = $aPlace['place_id'];
                 $oResult = new Result($iPlaceID);

+                $iRankAddress = $aPlace['rank_address'];

                 $iParentPlaceID = $aPlace['parent_place_id'];
                 $iParentPlaceID = $aPlace['parent_place_id'];

+            }

 
 

-                if ($bDoInterpolation && $iMaxRank >= 30) {
-                    if ($aPlace['rank_address'] <=27) {
-                        $iDistance = 0.001;
-                    }
-                    $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance);
+            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'];
+                }

 
 

-                    if ($aHouse) {
-                        $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
-                        $oResult->iHouseNumber = closestHouseNumber($aHouse);
-                    }
+                $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 street and maxrank > streetlevel

-                if (($aPlace['rank_address'] <=27)&& $iMaxRank > 27) {
+                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';


@@ -316,31 +325,23 @@ class ReverseGeocode
                         'Could not determine closest place.'
                     );
                     if ($aStreet) {
                         'Could not determine closest place.'
                     );
                     if ($aStreet) {

-                        $iDistance = $aStreet['distance'];
-                        $iPlaceID = $aStreet['place_id'];
-                        $oResult = new Result($iPlaceID);
-                        $iParentPlaceID = $aStreet['parent_place_id'];
-
-                        if ($bDoInterpolation && $iMaxRank >= 30) {
-                            $aHouse = $this->lookupInterpolation($sPointSQL, $iDistance, $iParentPlaceID);
-
-                            if ($aHouse) {
-                                $oResult = new Result($aHouse['place_id'], Result::TABLE_OSMLINE);
-                                $oResult->iHouseNumber = closestHouseNumber($aHouse);
-                            }
-                        }
+                        if (CONST_Debug) var_dump($aStreet);
+                        $oResult = new Result($aStreet['place_id']);

                     }
                 }
 
                   // In the US we can check TIGER data for nearest housenumber
                     }
                 }
 
                   // In the US we can check TIGER data for nearest housenumber

-                if (CONST_Use_US_Tiger_Data && $aPlace['country_code'] == 'us' && $this->iMaxRank >= 28) {
-                    $fSearchDiam = $aPlace['rank_address'] > 28 ? $aPlace['distance'] : 0.001;
+                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 = '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, '.$fSearchDiam.')';
+                    $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, 0.001)';

                     $sSQL .= ' ORDER BY distance ASC limit 1';
                     if (CONST_Debug) var_dump($sSQL);
                     $aPlaceTiger = chksql(
                     $sSQL .= ' ORDER BY distance ASC limit 1';
                     if (CONST_Debug) var_dump($sSQL);
                     $aPlaceTiger = chksql(


@@ -349,18 +350,17 @@ class ReverseGeocode
                     );
                     if ($aPlaceTiger) {
                         if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
                     );
                     if ($aPlaceTiger) {
                         if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);

-                        $aPlace = $aPlaceTiger;
-                        $oResult = new Result($aPlace['place_id'], Result::TABLE_TIGER);
+                        $oResult = new Result($aPlaceTiger['place_id'], Result::TABLE_TIGER);

                         $oResult->iHouseNumber = closestHouseNumber($aPlaceTiger);
                     }
                 }
                         $oResult->iHouseNumber = closestHouseNumber($aPlaceTiger);
                     }
                 }

-            // if no POI or street is found ...

             } else {
             } else {

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

             }
             }

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

         } else {
         } else {

-            $oResult = $this->PolygonFunctions($sPointSQL, $iMaxRank);
+            // lower than street level ($iMaxRank < 26 )
+            $oResult = $this->lookupLargeArea($sPointSQL, $iMaxRank);

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