NAME

Geo::Hex - Convert between latitude/longitude and GeoHex code (version 2:world wide)

SYNOPSIS

    use Geo::Hex;
    
    # From latitude/longitude to hex code
    
    my $code = latlng2geohex( $lat, $lng, $level );
    
    # From hex code to center latitude/longitude
    
    my ( $center_lat, $center_lng, $level ) = geohex2latlng( $code );
    
    # From latitude/longitude to zone object*
    my $zone = getZoneByLocation( $lat, $lng, $level );
    
    # From hex code to zone object*
    my $zone = getZoneByCode( $code );

    # * zone object: hash value
    # $zone->{code} : GeoHex code
    # $zone->{lat}  : Latirude of given GeoHex's center point
    # $zone->{lon}  : Longitude of given GeoHex's center point
    # $zone->{hx}   : Mercator X coordinate of given GeoHex's center point 
    # $zone->{hy}   : Mercator Y coordinate of given GeoHex's center point 

EXPORT

latlng2geohex( $lat, $lng, $level )

Convert latitude/longitude to GeoHex code. $level is optional, and default value is 16.

geohex2latlng( $hex )

Convert GeoHex code to center latitude/longitude, and level value.

getZoneByLocation( $lat, $lng, $level )

Convert latitude/longitude to GeoHex zone object. $level is optional, and default value is 16.

getZoneByCode( $hex )

Convert GeoHex code to GeoHex zone object.

DEPENDENCIES

Exporter POSIX Math::Round Math::Trig Geo::Proj4

AUTHOR

OHTSUKA Ko-hei <nene@kokogiko.net>

LICENCE AND COPYRIGHT

Copyright (c) 2009-2010, OHTSUKA Ko-hei <nene@kokogiko.net>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.