.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Geo::Coordinates::OSGB::Maps 3pm"
.TH Geo::Coordinates::OSGB::Maps 3pm "2022-12-06" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Geo::Coordinates::OSGB::Maps \- Data for OSGB Maps
.SH "VERSION"
.IX Header "VERSION"
V2.20
.SH "SUBROUTINES AND METHODS"
.IX Header "SUBROUTINES AND METHODS"
This module exports no functions, but just two hashes of data.
.ie n .SS "Hash %name_for_map_series"
.el .SS "Hash \f(CW%name_for_map_series\fP"
.IX Subsection "Hash %name_for_map_series"
The keys are the single letter codes used for each map series.
The values are the descriptive names of each series.
Currently we have:
.PP
.Vb 5
\&  A : OS Landranger
\&  B : OS Explorer
\&  C : OS One\-Inch 7th series
\&  H : Harvey British Mountain Maps
\&  J : Harvey Superwalker
.Ve
.ie n .SS "Hash %maps"
.el .SS "Hash \f(CW%maps\fP"
.IX Subsection "Hash %maps"
The keys are short identifiers for each sheet or inset.  Where a map has more than one side, or includes
insets then, there will be a separate entry for each side and inset.
.PP
The value for each key is another hash containing the following items
.IP "bbox" 4
.IX Item "bbox"
The bounding box of the sheet as a list of two pairs of coordinates (in metres
from the grid origin)
.IP "polygon" 4
.IX Item "polygon"
A list of pairs of coordinates (in metres from grid origin) that define the
corners of the sheet.  The list starts at the \s-1SW\s0 corner (approximately, some do
not have an obvious place to start), and works round anticlockwise.  In all
cases the last pair is the same as the first pair.
.IP "area" 4
.IX Item "area"
The calculated area of the sheet in square kilometres.
.IP "series" 4
.IX Item "series"
A single letter series identifier \*(-- this will be one of the keys from the
\&\*(L"name_for_map_series\*(R" hash.
.IP "number" 4
.IX Item "number"
The identifier for this map within the series, not including any suffix for a
sheet or an inset.  The two sides of a single map have the same number.  The
number is not always an integer \- Outdoor Leisure maps are designated \*(L"\s-1OL14\*(R"\s0
etc.  Those maps known by two numbers have a \*(L"number\*(R" consisting of both
numbers divided by a \*(L"/\*(R"; such as \*(L"418/OL60\*(R" in the Explorer series.
.IP "parent" 4
.IX Item "parent"
The key of the parent map for an inset.  Main sheets of a map will have
\&\*(L"parent\*(R" equal to their own key.
.IP "title" 4
.IX Item "title"
The title of the map.  Different sheets and insets from the same map will have
the same title.