NAME
Geo::Parser::Text - Perl extension for geoparsing, geocoding and standardizing locations from free form text. Worldwide Coverage. Geocode places to latitude, longitude, elevation. And vice-versa.
VERSION
Version 0.051
SYNOPSIS
use Geo::Parser::Text;
# initialize with your host
my $g = Geo::Parser::Text->new([geo_host]);
# Scan text in $str for locations...
my $hashref = $g->geocode(scantext=>$str);
# Geocode a single location from $str...
my $hashref = $g->geocode(locate=>$str);
#
# Example...
#!/usr/bin/perl
use strict;
use Geo::Parser::Text;
use Data::Dumper;
my $g = Geo::Parser::Text->new('https://geocode.xyz');
my $str = "The most important museums of Amsterdam are located on the Museumplein, located at the southwestern side of the Rijksmuseum.";
my $ref = $g->geocode(scantext=>$str,region=>'NL');
print Dumper $ref;
#expected response
$Response = {
'match' => [
{
'longt' => '4.88355',
'location' => 'RIJKSMUSEUM, AMSTERDAM, NL',
'matchtype' => 'street',
'confidence' => '1.0',
'MentionIndices' => '112',
'latt' => '52.35976'
},
{
'longt' => '4.87986',
'location' => 'MUSEUMPLEIN, AMSTERDAM, NL',
'matchtype' => 'street',
'confidence' => '1.0',
'MentionIndices' => '59',
'latt' => '52.35791'
},
{
'longt' => '4.89574',
'location' => 'Amsterdam,NL',
'matchtype' => 'locality',
'confidence' => '0.4',
'MentionIndices' => '30',
'latt' => '52.36014'
}
]
};
#or
#forward geocode and cleanup/standardize input address
my $ref = $g->geocode(locate=>'10 Downing St, Londino UK');
print Dumper $ref;
#expected response
$Response = {
'standard' => {
'stnumber' => '10',
'addresst' => 'DOWNING STREET',
'city' => 'Londino',
'prov' => 'UK',
'countryname' => 'United Kingdom',
'postal' => {},
'confidence' => '0.60'
},
'longt' => '-0.12768',
'elevation' => {},
'latt' => '51.50354'
};
#reverse geocode
my $ref = $g->geocode(locate=>'51.5034066,-0.1275923');
print Dumper $ref;
#expected response
$Response = {
'confidence' => '0.9',
'distance' => '0',
'city' => 'London',
'inlatt' => '51.50341',
'stnumber' => '9',
'latt' => '51.50328',
'postal' => 'SW1A 2AG',
'staddress' => 'Downing Street',
'longt' => '-0.12751',
'inlongt' => '-0.12759',
'prov' => 'UK'
};
DESCRIPTION
This module provides a Perl front end for the geocode.xyz, geocoder.ca API.
It allows the programmer to extract locations containing street addresses, street intersections and city names along with their geocoded latitude,longitude from bodies of text such as microblogs or wikipedia entries. (It should work with any type of text, but dumping html text or paragraphs containing over 200 words, will slow down the response.
If you need faster parsing grab the geocode.xyz server image on the AWS, and run it on a faster server.
If you run your own instance, make sure to pass the instance ip address or domain name at invocation eg, Geo::Parser::Text->new($server). For North American locations use geocoder.ca
The api also geocodes single locations (returning the location matched with the highest probability from a string of text. If you pass a latitude,longitude pair, it will reverse geocode that point)
Geocoding requests also return the elevation value of the point in meters.
For explanation on the API responses see https://geocode.xyz/api
METHODS
new
my $geo = new ( host => 'https://geocode.xyz');
Initialize with the default server. https://geocode.xyz for Worldwide coverage, https://geocoder.ca for North America.
geocode
my $ref = $geo->geocode(locate=>'Paris France'); or my $ref = $geo->geocode(scantext=>'Paris France');
Set the text to be scanned or string to be geocoded and return a hash reference with the response.
Takes a hash of parameter names and values. You are required to pass a hash to geocode with either the scantext or locate key set to the text you want to geocode/geoparse.
You may also pass other optional arguments as described in the API at https://geocode.xyz/api.
Foe eg: my $ref = $geo->geocode(locate=>'Paris France', auth=>'your auth code for unthrottled access', region=>'FR');
None by default.
REQUIREMENTS
XML::Simple, LWP::UserAgent, HTTP::Request, URI Data::Dumper
SEE ALSO
This module was featured in the 2016 Perl Advent Calendar. Read the article.
AUTHOR
Ervin Ruci, <eruci at geocode.xyz>
BUGS
Please report any bugs or feature requests to bug-geo-parser-text at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Geo-Parser-Text. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Geo::Parser::TextYou can also look for information at:
RT: CPAN's request tracker (report bugs here)
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
Search CPAN
ACKNOWLEDGEMENTS
LICENSE AND COPYRIGHT
Copyright 2018 Ervin Ruci.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
SEE ALSO
Geo::Coder::CA Geo::Coder::List HTML::GoogleMaps::V3 Geo::Coder::OpenCage Geo::Parse::OSM Text::NLP