/usr/share/perl5/Geo/Surface.pod is in libgeo-point-perl 0.96-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | =encoding utf8
=head1 NAME
Geo::Surface - A surface description.
=head1 INHERITANCE
Geo::Surface
is a Geo::Shape
=head1 SYNOPSIS
my $island = Geo::Surface->new($outer, $lake1, $lake2);
=head1 DESCRIPTION
In this context, a "surface" is defined as one filled area with
possible enclosures in one projection system.
Extends L<"DESCRIPTION" in Geo::Shape|Geo::Shape/"DESCRIPTION">.
=head1 METHODS
Extends L<"METHODS" in Geo::Shape|Geo::Shape/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Geo::Shape|Geo::Shape/"Constructors">.
=over 4
=item Geo::Surface-E<gt>B<new>(<$surface | <$outer,$inner,...> >, %options)
When called as instance method, some defaults are copied from the
object where the call is made upon.
You may either provide a L<Math::Polygon::Surface|Math::Polygon::Surface> $surface, or a LIST
of lines. In the latter case, the first line is the $outer polygon of
the surface, and the other are all $inner enclosures: lakes. Lines
are and L<Geo::Line|Geo::Line>, L<Math::Polygon|Math::Polygon> objects, or ARRAY of points.
If no projection is specified, then the projection of the first
Geo-encoded line will be used.
-Option--Defined in--Default
proj Geo::Shape see Geo::Proj::defaultProjection()
=over 2
=item proj => LABEL
=back
=back
=head2 Attributes
Extends L<"Attributes" in Geo::Shape|Geo::Shape/"Attributes">.
=over 4
=item $obj-E<gt>B<geoInner>()
Returns a LIST of enclosed polygons, converted to L<Geo::Line|Geo::Line> objects.
=item $obj-E<gt>B<geoOuter>()
Returns the outer polygon as L<Geo::Line|Geo::Line> object.
=item $obj-E<gt>B<inner>()
Returns a LIST of enclosed L<Math::Polygon|Math::Polygon> objects.
=item $obj-E<gt>B<outer>()
Returns the outer L<Math::Polygon|Math::Polygon>.
=item $obj-E<gt>B<proj>()
Inherited, see L<Geo::Shape/"Attributes">
=item $obj-E<gt>B<proj4>()
Inherited, see L<Geo::Shape/"Attributes">
=back
=head2 Projections
Extends L<"Projections" in Geo::Shape|Geo::Shape/"Projections">.
=over 4
=item $obj-E<gt>B<in>(<$label|'utm'>)
Inherited, see L<Geo::Shape/"Projections">
=item $obj-E<gt>B<projectOn>($nick, @points)
Inherited, see L<Geo::Shape/"Projections">
=back
=head2 Geometry
Extends L<"Geometry" in Geo::Shape|Geo::Shape/"Geometry">.
=over 4
=item $obj-E<gt>B<area>()
Returns the area enclosed by the outer polygon, minus the erea of
the enclosures. Only useful when the points are in some orthogonal
projection.
=item $obj-E<gt>B<bbox>()
The bounding box of outer surface polygon.
=item $obj-E<gt>B<bboxCenter>()
Inherited, see L<Geo::Shape/"Geometry">
=item $obj-E<gt>B<bboxRing>([$xmin, $ymin, $xmax, $ymax, [$proj]])
=item Geo::Surface-E<gt>B<bboxRing>([$xmin, $ymin, $xmax, $ymax, [$proj]])
Inherited, see L<Geo::Shape/"Geometry">
=item $obj-E<gt>B<distance>($object, [$unit])
Inherited, see L<Geo::Shape/"Geometry">
=item $obj-E<gt>B<perimeter>()
The length of the outer polygon. Only useful in a orthogonal
coordinate systems.
=back
=head2 Display
Extends L<"Display" in Geo::Shape|Geo::Shape/"Display">.
=over 4
=item $obj-E<gt>B<deg2dm>($degrees, $pos, $neg)
=item Geo::Surface-E<gt>B<deg2dm>($degrees, $pos, $neg)
Inherited, see L<Geo::Shape/"Display">
=item $obj-E<gt>B<deg2dms>($degrees, $pos, $neg)
=item Geo::Surface-E<gt>B<deg2dms>($degrees, $pos, $neg)
Inherited, see L<Geo::Shape/"Display">
=item $obj-E<gt>B<dms2deg>($dms)
=item Geo::Surface-E<gt>B<dms2deg>($dms)
Inherited, see L<Geo::Shape/"Display">
=item $obj-E<gt>B<toString>([$projection])
Returns a string representation of the line, which is also used for
stringification.
=back
=head1 OVERLOAD
Extends L<"OVERLOAD" in Geo::Shape|Geo::Shape/"OVERLOAD">.
=over 4
=item overload: B<'""' (stringification)>
Inherited, see L<Geo::Shape/"OVERLOAD">
=item overload: B<'bool' (truth value)>
Inherited, see L<Geo::Shape/"OVERLOAD">
=back
=head1 DIAGNOSTICS
=over 4
=item Warning: Geo::Line is should be filled
When L<Geo::Line|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.
=item Error: distance calculation not implemented between a $kind and a $kind
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.
=item Error: in() not implemented for a $class
=item Error: not known what to do with $component
=back
=head1 SEE ALSO
This module is part of Geo-Point distribution version 0.96,
built on January 21, 2014. Website: F<http://perl.overmeer.net/geo/>
All modules in this suite:
L</Geo::Point>,
L</Geo::Proj4>,
L</Geo::WKT>,
L</Math::Polygon>,
L</Geo::GML>,
L</Geo::ISO19139>,
L</Geo::EOP>,
L</Geo::Format::Envisat>, and
L</Geo::Format::Landsat>.
Please post questions or ideas to the mailinglist at
F<http://geo-perl@list.hut.fi>
=head1 LICENSE
Copyrights 2005-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|