.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Geo::Surface 3pm"
.TH Geo::Surface 3pm "2010-05-19" "perl v5.14.2" "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::Surface \- A surface description.
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 2
\& Geo::Surface
\&   is a Geo::Shape
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $island = Geo::Surface\->new($outer, $lake1, $lake2);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
In this context, a \*(L"surface\*(R" is defined as one filled area with
possible enclosures in one projection system.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
Geo::Surface\->\fBnew\fR((SURFACE|(\s-1OUTER\s0,INNER,...)), [\s-1OPTIONS\s0])
.Sp
.RS 4
When called as instance method, some defaults are copied from the
object where the call is made upon.
.Sp
You may either provide a Math::Polygon::Surface \s-1SURFACE\s0, or a \s-1LIST\s0
of lines.  In the latter case, the first line is the \s-1OUTER\s0 polygon of
the surface, and the other are all \s-1INNER\s0 enclosures: lakes.  Lines
are and Geo::Line, Math::Polygon objects, or \s-1ARRAY\s0 of points.
.Sp
If no projection is specified, then the projection of the first
Geo-encoded line will be used.
.Sp
.Vb 2
\& Option\-\-Defined in\-\-Default
\& proj    Geo::Shape  see Geo::Proj::defaultProjection()
.Ve
.Sp
\&. proj => \s-1LABEL\s0
.RE
.SS "Attributes"
.IX Subsection "Attributes"
\&\f(CW$obj\fR\->\fBgeoInner\fR
.Sp
.RS 4
Returns a \s-1LIST\s0 of enclosed polygons, converted to Geo::Line objects.
.RE
.PP
\&\f(CW$obj\fR\->\fBgeoOuter\fR
.Sp
.RS 4
Returns the outer polygon as Geo::Line object.
.RE
.PP
\&\f(CW$obj\fR\->\fBinner\fR
.Sp
.RS 4
Returns a \s-1LIST\s0 of enclosed Math::Polygon objects.
.RE
.PP
\&\f(CW$obj\fR\->\fBouter\fR
.Sp
.RS 4
Returns the outer Math::Polygon.
.RE
.PP
\&\f(CW$obj\fR\->\fBproj\fR
.Sp
.RS 4
See \*(L"Attributes\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBproj4\fR
.Sp
.RS 4
See \*(L"Attributes\*(R" in Geo::Shape
.RE
.SS "Projections"
.IX Subsection "Projections"
\&\f(CW$obj\fR\->\fBin\fR(LABEL|'utm')
.Sp
.RS 4
See \*(L"Projections\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBprojectOn\fR(\s-1NICK\s0, \s-1POINTS\s0)
.Sp
.RS 4
See \*(L"Projections\*(R" in Geo::Shape
.RE
.SS "Geometry"
.IX Subsection "Geometry"
\&\f(CW$obj\fR\->\fBarea\fR
.Sp
.RS 4
Returns the area enclosed by the outer polygon, minus the erea of
the enclosures.  Only useful when the points are in some orthogonal
projection.
.RE
.PP
\&\f(CW$obj\fR\->\fBbbox\fR
.Sp
.RS 4
The bounding box of outer surface polygon.
.RE
.PP
\&\f(CW$obj\fR\->\fBbboxCenter\fR
.Sp
.RS 4
See \*(L"Geometry\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBbboxRing\fR([\s-1XMIN\s0, \s-1YMIN\s0, \s-1XMAX\s0, \s-1YMAX\s0, [\s-1PROJ\s0]])
.PP
Geo::Surface\->\fBbboxRing\fR([\s-1XMIN\s0, \s-1YMIN\s0, \s-1XMAX\s0, \s-1YMAX\s0, [\s-1PROJ\s0]])
.Sp
.RS 4
See \*(L"Geometry\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBdistance\fR(\s-1OBJECT\s0, [\s-1UNIT\s0])
.Sp
.RS 4
See \*(L"Geometry\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBperimeter\fR
.Sp
.RS 4
The length of the outer polygon. Only useful in a orthogonal
coordinate systems.
.RE
.SS "Display"
.IX Subsection "Display"
\&\f(CW$obj\fR\->\fBdeg2dm\fR(\s-1DEGREES\s0, \s-1POS\s0, \s-1NEG\s0)
.PP
Geo::Surface\->\fBdeg2dm\fR(\s-1DEGREES\s0, \s-1POS\s0, \s-1NEG\s0)
.Sp
.RS 4
See \*(L"Display\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBdeg2dms\fR(\s-1DEGREES\s0, \s-1POS\s0, \s-1NEG\s0)
.PP
Geo::Surface\->\fBdeg2dms\fR(\s-1DEGREES\s0, \s-1POS\s0, \s-1NEG\s0)
.Sp
.RS 4
See \*(L"Display\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBdms2deg\fR(\s-1DMS\s0)
.PP
Geo::Surface\->\fBdms2deg\fR(\s-1DMS\s0)
.Sp
.RS 4
See \*(L"Display\*(R" in Geo::Shape
.RE
.PP
\&\f(CW$obj\fR\->\fBtoString\fR([\s-1PROJECTION\s0])
.Sp
.RS 4
Returns a string representation of the line, which is also used for
stringification.
.RE
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Warning: Geo::Line is should be filled
.Sp
.RS 4
When Geo::Line objects are used to compose a surface, each of them
must be filled.  Representation of rivers and such do not belong in a
surface description.
.RE
.PP
Error: distance calculation not implemented between a \f(CW$kind\fR and a \f(CW$kind\fR
.Sp
.RS 4
Only a subset of all objects can be used in the distance calculation.
The limitation is purely caused by lack of time to implement this.
.RE
.PP
Error: \fIin()\fR not implemented for a \f(CW$class\fR
.PP
Error: not known what to do with \f(CW$component\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Geo-Point distribution version 0.93,
built on May 19, 2010. Website: \fIhttp://perl.overmeer.net/geo/\fR
All modules in this suite:
\&\*(L"Geo::Point\*(R",
\&\*(L"Geo::Proj4\*(R",
\&\*(L"Geo::WKT\*(R",
\&\*(L"Math::Polygon\*(R",
\&\*(L"Geo::GML\*(R",
\&\*(L"Geo::ISO19139\*(R",
\&\*(L"Geo::EOP\*(R",
\&\*(L"Geo::Format::Envisat\*(R", and
\&\*(L"Geo::Format::Landsat\*(R".
.PP
Please post questions or ideas to the mailinglist at
\&\fIhttp://geo\-perl@list.hut.fi\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2005\-2010 by Mark Overmeer. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR