The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Geo::Hash::Grid - Make a grid based off of GeoHashes

VERSION

Version 0.08

SYNOPSIS

Sometimes you need a simple grid to cover a geographic area. This is a pretty easy way to get one that covers a geographic box and with a little spillover.

This module inherits from Geo::Hash::XS and subclasses all it's methods.

    use Geo::Hash::Grid;
        
    my $grid = Geo::Hash::Grid->new(
        sw_lat    => $south_west_latitude,
        sw_lon    => $south_west_longidude,
        ne_lat    => $north_east_latitude,
        ne_lon    => $north_east_longitude,
        precision => 8,
    );
        
    my $hash_count   = $grid->count;
        
    my $geohash_list = $grid->hashes;
        
    my $origin_list  = $grid->origins;
        

METHODS

new

Create the geohash grid that fits in a bounding box and specify the grid size.

  • sw_lat => $decimal_degrees

    Latitude of the southwest corner of bounding box

  • sw_lon => $decimal_degrees

    Longitude of the southwest corner of bounding box

  • ne_lat => $decimal_degrees

    Latitude of the northeast corner of bounding box

  • ne_lon => $decimal_degrees

    Longitude of the northeast corner of bounding box

  • precision => $integer

    Geohash precision

count

Get count of GeoHash's in bounding box

hashes

Get array reference of GeoHash's in bounding box

origins

Get list of hash references of GeoHash lat/long origins in bounding box

bboxes

Get a list of bounding boxes for each hash in the grid

AUTHOR

Adam Wohld, <adam at spatialsystems.org>

BUGS

Please report any bugs or feature requests to bug-geo-hash-grid at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Geo-Hash-Grid. 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::Hash::Grid

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2015 Adam Wohld.

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.