]> git.openstreetmap.org Git - nominatim.git/blob - lib/ReverseGeocode.php
41eed262b8d20689896e9d38965874feaefa6862
[nominatim.git] / lib / ReverseGeocode.php
1 <?php
2
3 class ReverseGeocode
4 {
5     protected $oDB;
6     protected $iMaxRank = 28;
7
8
9     function ReverseGeocode(&$oDB)
10     {
11         $this->oDB =& $oDB;
12     }
13
14
15     function setZoom($iZoom)
16     {
17         // Zoom to rank, this could probably be calculated but a lookup gives fine control
18         $aZoomRank = array(
19                       0 => 2, // Continent / Sea
20                       1 => 2,
21                       2 => 2,
22                       3 => 4, // Country
23                       4 => 4,
24                       5 => 8, // State
25                       6 => 10, // Region
26                       7 => 10,
27                       8 => 12, // County
28                       9 => 12,
29                       10 => 17, // City
30                       11 => 17,
31                       12 => 18, // Town / Village
32                       13 => 18,
33                       14 => 22, // Suburb
34                       15 => 22,
35                       16 => 26, // Street, TODO: major street?
36                       17 => 26,
37                       18 => 30, // or >, Building
38                       19 => 30, // or >, Building
39                      );
40         $this->iMaxRank = (isset($iZoom) && isset($aZoomRank[$iZoom]))?$aZoomRank[$iZoom]:28;
41     }
42
43
44     /* lookup()
45      * returns { place_id =>, type => '(osm|tiger)' }
46      * fails if no place was found
47      */
48
49
50     function lookup($fLat, $fLon, $bDoInterpolation = true)
51     {
52         $sPointSQL = 'ST_SetSRID(ST_Point('.$fLon.','.$fLat.'),4326)';
53         $iMaxRank = $this->iMaxRank;
54
55         // Find the nearest point
56         $fSearchDiam = 0.0004;
57         $iPlaceID = null;
58         $aArea = false;
59         $fMaxAreaDistance = 1;
60         $bIsInUnitedStates = false;
61         $bPlaceIsTiger = false;
62         $bPlaceIsLine = false;
63         while (!$iPlaceID && $fSearchDiam < $fMaxAreaDistance) {
64             $fSearchDiam = $fSearchDiam * 2;
65
66             // If we have to expand the search area by a large amount then we need a larger feature
67             // then there is a limit to how small the feature should be
68             if ($fSearchDiam > 2 && $iMaxRank > 4) $iMaxRank = 4;
69             if ($fSearchDiam > 1 && $iMaxRank > 9) $iMaxRank = 8;
70             if ($fSearchDiam > 0.8 && $iMaxRank > 10) $iMaxRank = 10;
71             if ($fSearchDiam > 0.6 && $iMaxRank > 12) $iMaxRank = 12;
72             if ($fSearchDiam > 0.2 && $iMaxRank > 17) $iMaxRank = 17;
73             if ($fSearchDiam > 0.1 && $iMaxRank > 18) $iMaxRank = 18;
74             if ($fSearchDiam > 0.008 && $iMaxRank > 22) $iMaxRank = 22;
75             if ($fSearchDiam > 0.001 && $iMaxRank > 26) $iMaxRank = 26;
76
77             $sSQL = 'select place_id,parent_place_id,rank_search,calculated_country_code';
78             $sSQL .= ' FROM placex';
79             $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', geometry, '.$fSearchDiam.')';
80             $sSQL .= ' and rank_search != 28 and rank_search >= '.$iMaxRank;
81             $sSQL .= ' and (name is not null or housenumber is not null)';
82             $sSQL .= ' and class not in (\'waterway\',\'railway\',\'tunnel\',\'bridge\',\'man_made\')';
83             $sSQL .= ' and indexed_status = 0 ';
84             $sSQL .= ' and (ST_GeometryType(geometry) not in (\'ST_Polygon\',\'ST_MultiPolygon\') ';
85             $sSQL .= ' OR ST_DWithin('.$sPointSQL.', centroid, '.$fSearchDiam.'))';
86             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', geometry) ASC limit 1';
87             if (CONST_Debug) var_dump($sSQL);
88             $aPlace = chksql(
89                 $this->oDB->getRow($sSQL),
90                 "Could not determine closest place."
91             );
92             $iPlaceID = $aPlace['place_id'];
93             $iParentPlaceID = $aPlace['parent_place_id'];
94             $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
95         }
96         // if a street or house was found, look in interpolation lines table
97         if ($bDoInterpolation && $this->iMaxRank >= 28 && $aPlace && $aPlace['rank_search'] >= 26) {
98             // if a house was found, search the interpolation line that is at least as close as the house
99             $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
100             $sSQL .= ' FROM location_property_osmline';
101             $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
102             $sSQL .= ' and indexed_status = 0 ';
103             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
104             
105             if (CONST_Debug) {
106                 $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
107                 var_dump($sSQL);
108
109                 $aAllHouses = chksql($this->oDB->getAll($sSQL));
110                 foreach ($aAllHouses as $i) {
111                     echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
112                 }
113             }
114             $aPlaceLine = chksql(
115                 $this->oDB->getRow($sSQL),
116                 "Could not determine closest housenumber on an osm interpolation line."
117             );
118             if ($aPlaceLine) {
119                 if (CONST_Debug) var_dump('found housenumber in interpolation lines table', $aPlaceLine);
120                 if ($aPlace['rank_search'] == 30) {
121                     // if a house was already found in placex, we have to find out,
122                     // if the placex house or the interpolated house are closer to the searched point
123                     // distance between point and placex house
124                     $sSQL = 'SELECT ST_distance('.$sPointSQL.', house.geometry) as distance FROM placex as house WHERE house.place_id='.$iPlaceID;
125                     $aDistancePlacex = chksql(
126                         $this->oDB->getRow($sSQL),
127                         "Could not determine distance between searched point and placex house."
128                     );
129                     $fDistancePlacex = $aDistancePlacex['distance'];
130                     // distance between point and interpolated house (fraction on interpolation line)
131                     $sSQL = 'SELECT ST_distance('.$sPointSQL.', ST_LineInterpolatePoint(linegeo, '.$aPlaceLine['fraction'].')) as distance';
132                     $sSQL .= ' FROM location_property_osmline WHERE place_id = '.$aPlaceLine['place_id'];
133                     $aDistanceInterpolation = chksql(
134                         $this->oDB->getRow($sSQL),
135                         "Could not determine distance between searched point and interpolated house."
136                     );
137                     $fDistanceInterpolation = $aDistanceInterpolation['distance'];
138                     if ($fDistanceInterpolation < $fDistancePlacex) {
139                         // interpolation is closer to point than placex house
140                         $bPlaceIsLine = true;
141                         $aPlace = $aPlaceLine;
142                         $iPlaceID = $aPlaceLine['place_id'];
143                         $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
144                         $fFraction = $aPlaceLine['fraction'];
145                         $iMaxRank = 30;
146                     }
147                     // else: nothing to do, take placex house from above
148                 } else {
149                     $bPlaceIsLine = true;
150                     $aPlace = $aPlaceLine;
151                     $iPlaceID = $aPlaceLine['place_id'];
152                     $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
153                     $fFraction = $aPlaceLine['fraction'];
154                     $iMaxRank = 30;
155                 }
156             }
157         }
158         
159         // Only street found? If it's in the US we can check TIGER data for nearest housenumber
160         if (CONST_Use_US_Tiger_Data && $bDoInterpolation && $bIsInUnitedStates && $this->iMaxRank >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 )) {
161             $fSearchDiam = 0.001;
162             $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
163             //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
164             $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$iPlaceID;
165             $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';  //no centroid anymore in Tiger data, now we have lines
166             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
167
168             if (CONST_Debug) {
169                 $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
170                 var_dump($sSQL);
171
172                 $aAllHouses = chksql($this->oDB->getAll($sSQL));
173                 foreach ($aAllHouses as $i) {
174                     echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
175                 }
176             }
177
178             $aPlaceTiger = chksql(
179                 $this->oDB->getRow($sSQL),
180                 "Could not determine closest Tiger place."
181             );
182             if ($aPlaceTiger) {
183                 if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
184                 $bPlaceIsTiger = true;
185                 $aPlace = $aPlaceTiger;
186                 $iPlaceID = $aPlaceTiger['place_id'];
187                 $iParentPlaceID = $aPlaceTiger['parent_place_id']; // the street
188                 $fFraction = $aPlaceTiger['fraction'];
189                 $iMaxRank = 30;
190             }
191         }
192
193         // The point we found might be too small - use the address to find what it is a child of
194         if ($iPlaceID && $iMaxRank < 28) {
195             if (($aPlace['rank_search'] > 28 || $bPlaceIsTiger || $bPlaceIsLine) && $iParentPlaceID) {
196                 $iPlaceID = $iParentPlaceID;
197             }
198             $sSQL  = 'select address_place_id';
199             $sSQL .= ' FROM place_addressline';
200             $sSQL .= " WHERE place_id = $iPlaceID";
201             $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
202             $sSQL .= ' LIMIT 1';
203             $iPlaceID = chksql($this->oDB->getOne($sSQL), "Could not get parent for place.");
204             if (!$iPlaceID) {
205                 $iPlaceID = $aPlace['place_id'];
206             }
207         }
208         return array(
209                 'place_id' => $iPlaceID,
210                 'type' => $bPlaceIsTiger ? 'tiger' : ($bPlaceIsLine ? 'interpolation' : 'osm'),
211                 'fraction' => ($bPlaceIsTiger || $bPlaceIsLine) ? $fFraction : -1
212                );
213     }
214 }