]> git.openstreetmap.org Git - nominatim.git/blob - lib/ReverseGeocode.php
fix function declaration 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(
82                 $this->oDB->getRow($sSQL),
83                 "Could not determine closest place."
84             );
85             $iPlaceID = $aPlace['place_id'];
86             $iParentPlaceID = $aPlace['parent_place_id'];
87             $bIsInUnitedStates = ($aPlace['calculated_country_code'] == 'us');
88         }
89         // if a street or house was found, look in interpolation lines table
90         if ($bDoInterpolation && $this->iMaxRank >= 28 && $aPlace && $aPlace['rank_search'] >= 26) {
91             // if a house was found, search the interpolation line that is at least as close as the house
92             $sSQL = 'SELECT place_id, parent_place_id, 30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
93             $sSQL .= ' FROM location_property_osmline';
94             $sSQL .= ' WHERE ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';
95             $sSQL .= ' and indexed_status = 0 ';
96             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
97             
98             if (CONST_Debug) {
99                 $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
100                 var_dump($sSQL);
101
102                 $aAllHouses = chksql($this->oDB->getAll($sSQL));
103                 foreach ($aAllHouses as $i) {
104                     echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
105                 }
106             }
107             $aPlaceLine = chksql(
108                 $this->oDB->getRow($sSQL),
109                 "Could not determine closest housenumber on an osm interpolation line."
110             );
111             if ($aPlaceLine) {
112                 if (CONST_Debug) var_dump('found housenumber in interpolation lines table', $aPlaceLine);
113                 if ($aPlace['rank_search'] == 30) {
114                     // if a house was already found in placex, we have to find out, 
115                     // if the placex house or the interpolated house are closer to the searched point
116                     // distance between point and placex house
117                     $sSQL = 'SELECT ST_distance('.$sPointSQL.', house.geometry) as distance FROM placex as house WHERE house.place_id='.$iPlaceID;
118                     $aDistancePlacex = chksql(
119                         $this->oDB->getRow($sSQL),
120                         "Could not determine distance between searched point and placex house."
121                     );
122                     $fDistancePlacex = $aDistancePlacex['distance'];
123                     // distance between point and interpolated house (fraction on interpolation line)
124                     $sSQL = 'SELECT ST_distance('.$sPointSQL.', ST_LineInterpolatePoint(linegeo, '.$aPlaceLine['fraction'].')) as distance';
125                     $sSQL .= ' FROM location_property_osmline WHERE place_id = '.$aPlaceLine['place_id'];
126                     $aDistanceInterpolation = chksql(
127                         $this->oDB->getRow($sSQL),
128                         "Could not determine distance between searched point and interpolated house."
129                     );
130                     $fDistanceInterpolation = $aDistanceInterpolation['distance'];
131                     if ($fDistanceInterpolation < $fDistancePlacex) {
132                         // interpolation is closer to point than placex house
133                         $bPlaceIsLine = true;
134                         $aPlace = $aPlaceLine;
135                         $iPlaceID = $aPlaceLine['place_id'];
136                         $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
137                         $fFraction = $aPlaceLine['fraction'];
138                         $iMaxRank = 30;
139                     }
140                     // else: nothing to do, take placex house from above
141                 } else {
142                     $bPlaceIsLine = true;
143                     $aPlace = $aPlaceLine;
144                     $iPlaceID = $aPlaceLine['place_id'];
145                     $iParentPlaceID = $aPlaceLine['parent_place_id']; // the street
146                     $fFraction = $aPlaceLine['fraction'];
147                     $iMaxRank = 30;
148                 }
149             }
150         }
151         
152         // Only street found? If it's in the US we can check TIGER data for nearest housenumber
153         if (CONST_Use_US_Tiger_Data && $bDoInterpolation && $bIsInUnitedStates && $this->iMaxRank >= 28 && $iPlaceID && ($aPlace['rank_search'] == 26 || $aPlace['rank_search'] == 27 )) {
154             $fSearchDiam = 0.001;
155             $sSQL = 'SELECT place_id,parent_place_id,30 as rank_search, ST_line_locate_point(linegeo,'.$sPointSQL.') as fraction';
156             //if (CONST_Debug) { $sSQL .= ', housenumber, ST_distance('.$sPointSQL.', centroid) as distance, st_y(centroid) as lat, st_x(centroid) as lon'; }
157             $sSQL .= ' FROM location_property_tiger WHERE parent_place_id = '.$iPlaceID;
158             $sSQL .= ' AND ST_DWithin('.$sPointSQL.', linegeo, '.$fSearchDiam.')';  //no centroid anymore in Tiger data, now we have lines
159             $sSQL .= ' ORDER BY ST_distance('.$sPointSQL.', linegeo) ASC limit 1';
160
161             if (CONST_Debug) {
162                 $sSQL = preg_replace('/limit 1/', 'limit 100', $sSQL);
163                 var_dump($sSQL);
164
165                 $aAllHouses = chksql($this->oDB->getAll($sSQL));
166                 foreach ($aAllHouses as $i) {
167                     echo $i['housenumber'] . ' | ' . $i['distance'] * 1000 . ' | ' . $i['lat'] . ' | ' . $i['lon']. ' | '. "<br>\n";
168                 }
169             }
170
171             $aPlaceTiger = chksql(
172                 $this->oDB->getRow($sSQL),
173                 "Could not determine closest Tiger place."
174             );
175             if ($aPlaceTiger) {
176                 if (CONST_Debug) var_dump('found Tiger housenumber', $aPlaceTiger);
177                 $bPlaceIsTiger = true;
178                 $aPlace = $aPlaceTiger;
179                 $iPlaceID = $aPlaceTiger['place_id'];
180                 $iParentPlaceID = $aPlaceTiger['parent_place_id']; // the street
181                 $fFraction = $aPlaceTiger['fraction'];
182                 $iMaxRank = 30;
183             }
184         }
185
186         // The point we found might be too small - use the address to find what it is a child of
187         if ($iPlaceID && $iMaxRank < 28) {
188             if (($aPlace['rank_search'] > 28 || $bPlaceIsTiger || $bPlaceIsLine) && $iParentPlaceID) {
189                 $iPlaceID = $iParentPlaceID;
190             }
191             $sSQL  = 'select address_place_id';
192             $sSQL .= ' FROM place_addressline';
193             $sSQL .= " WHERE place_id = $iPlaceID";
194             $sSQL .= " ORDER BY abs(cached_rank_address - $iMaxRank) asc,cached_rank_address desc,isaddress desc,distance desc";
195             $sSQL .= ' LIMIT 1';
196             $iPlaceID = chksql($this->oDB->getOne($sSQL), "Could not get parent for place.");
197             if (!$iPlaceID) {
198                 $iPlaceID = $aPlace['place_id'];
199             }
200         }
201         return array(
202                 'place_id' => $iPlaceID,
203                 'type' => $bPlaceIsTiger ? 'tiger' : ($bPlaceIsLine ? 'interpolation' : 'osm'),
204                 'fraction' => ($bPlaceIsTiger || $bPlaceIsLine) ? $fFraction : -1
205                );
206     }
207     
208 }