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