サマリー
A Polyline object is a shape defined by one or more paths, in which a path is a series of connected segments.
説明
多くのジオプロセシング ワークフローでは、座標とジオメトリの情報を使用して特定の操作を行うことだけが必要で、新しい (一時) フィーチャクラスを作成し、カーソルを使用してフィーチャクラスにデータを設定し、そのフィーチャクラスを使用し、最後に一時フィーチャクラスを削除するというプロセスをすべて行う必要はないことがあります。ジオプロセシングを簡単に実行できるように、入力および出力の両フィーチャクラスの代わりにジオメトリ オブジェクトを使用できます。Geometry、Multipoint、PointGeometry、Polygon、または Polyline の各クラスを使用して、ジオメトリ オブジェクトを最初から作成できます。
During the creation of a geometry object, a simplification process is performed to make the geometry topologically consistent according to its geometry type. For instance, it rectifies polygons that may be self-intersecting or contain incorrect ring orientations. Coordinates may move within the resolution of the geometry's spatial reference.
The following operators can be used in place of geometry methods:
Python operator | Geometry method |
---|---|
+ | intersect |
| | union |
- | difference |
^ | symmetricDifference |
== | equals |
!= | not equals |
For example, to union two geometry objects, g3 = g1 | g2 is equivalent to g3 = g1.union(g2).
The + operator will use the geometry type (dimension) of the first geometry to determine the geometry type of the output.
構文
Polyline (inputs, {spatial_reference}, {has_z}, {has_m}, {has_id})
パラメーター | 説明 | データ タイプ |
inputs | The coordinate information used to create the object. The data type can be Point or Array objects. | Object |
spatial_reference | The spatial reference of the new geometry. (デフォルト値は次のとおりです None) | SpatialReference |
has_z | Specifies whether the geometry will be z-enabled. (デフォルト値は次のとおりです False) | Boolean |
has_m | Specifies whether the geometry will be m-enabled. (デフォルト値は次のとおりです False) | Boolean |
has_id | Specifies whether the geometry will support point IDs. (デフォルト値は次のとおりです False) | Boolean |
プロパティ
プロパティ | 説明 | データ タイプ |
JSON (読み取り専用) | An Esri JSON representation of the geometry as a string. ヒント:The returned string can be converted to a dictionary using the json module's loads function. | String |
WKB (読み取り専用) | The well-known binary (WKB) representation for OGC geometry. This property provides a portable representation of a geometry value as a contiguous stream of bytes. | Bytearray |
WKT (読み取り専用) | The well-known text (WKT) representation for OGC geometry. This property provides a portable representation of a geometry value as a text string. Any true curves in the geometry will be densified into approximate curves in the WKT string. | String |
area (読み取り専用) | The area of a polygon feature. The area is zero for all other feature types. | Double |
centroid (読み取り専用) | The true centroid if it is within or on the feature; otherwise, it is the label point. | Point |
extent (読み書き) | The extent of the geometry. | Extent |
firstPoint (読み取り専用) | The first coordinate point of the geometry. | Point |
hasCurves (読み取り専用) | Specifies whether the geometry has a curve. | Boolean |
hullRectangle (読み取り専用) | A space-delimited string of the coordinate pairs of the convex hull rectangle. | String |
isMultipart (読み取り専用) | Specifies whether the number of parts for the geometry is more than one. | Boolean |
labelPoint (読み取り専用) | The point at which the label is located. This point is always located within or on a feature. | Point |
lastPoint (読み取り専用) | The last coordinate of the feature. | Point |
length (読み取り専用) | The length of the linear feature. The calculation uses 2D Cartesian mathematics. For point and multipoint geometry, the length will be zero. For polygon geometry, the length will be the 2D length of the boundary. | Double |
length3D (読み取り専用) | The 3D length of the linear feature. The calculation uses 3D Cartesian mathematics. For point and multipoint geometry, the length will be zero. For polygon geometry, the length will be the 3D length of the boundary. 注意:The operation does not perform unit conversion between the horizontal and the vertical coordinate systems. The x, y, and z coordinates are assumed to be in the same linear unit. 注意:This property is only available for projected data. | Double |
partCount (読み取り専用) | The number of geometry parts for the feature. | Integer |
pointCount (読み取り専用) | The total number of points for the feature. | Integer |
spatialReference (読み取り専用) | The spatial reference of the geometry. | SpatialReference |
trueCentroid (読み取り専用) | The center of gravity for a feature. | Point |
type (読み取り専用) | The geometry type: polygon, polyline, point, or multipoint. | String |
方法の概要
方法 | 説明 |
boundary () | Constructs the boundary of the geometry. |
buffer (distance) | Constructs a polygon at a specified distance from the geometry. |
clip (envelope) | Constructs the intersection of the geometry and the specified extent. |
contains (second_geometry, {relation}) | Indicates if the base geometry contains the comparison geometry. contains is the opposite of within. Only True relationships are shown in this illustration. |
convexHull () | Constructs the geometry that is the minimal bounding polygon such that all outer angles are convex. |
crosses (second_geometry) | Indicates if the two geometries intersect in a geometry of a lesser shape type. Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and an polygon cross if they share a polyline or a point (for vertical line) in common on the interior of the polygon which is not equivalent to the entire polyline. Only True relationships are shown in this illustration. |
cut (cutter) | Splits this geometry into a part left of the cutting polyline, and a part right of it. When a polyline or polygon is cut, it is split where it intersects the cutter polyline. Each piece is classified as left of or right of the cutter. This classification is based on the orientation of the cutter line. Parts of the target polyline that do not intersect the cutting polyline are returned as part of the right of result for that input polyline. If a geometry is not cut, the left geometry will be empty (None). |
densify (method, distance, {deviation}) | Creates a geometry with added vertices. |
difference (other) | Constructs the geometry that is composed only of the region unique to the base geometry but not part of the other geometry. The following illustration shows the results when the red polygon is the source geometry. |
disjoint (second_geometry) | Indicates if the base and comparison geometries share no points in common. Two geometries intersect if disjoint returns False. Only True relationships are shown in this illustration. |
distanceTo (other) | Returns the minimum distance between two geometries. The distance is in the units of the geometry's spatial reference. If the geometries intersect, the minimum distance is 0. Both geometries must have the same projection. |
equals (second_geometry) | Indicates if the base and comparison geometries are of the same shape type and define the same set of points in the plane. This is a 2D comparison only; M and Z values are ignored. Only True relationships are shown in this illustration. |
generalize (max_offset) | Creates a new simplified geometry using a specified maximum offset tolerance. |
getLength ({method}, {units}) | Returns the length of the feature using a measurement method. |
getPart ({index}) | Returns an Array object of Point objects for a particular part of the geometry if an index is specified. If an index is not specified, an Array object containing an Array of Point objects for each geometry part is returned. The getPart method is equivalent to indexing an object; that is, obj.getPart(0) is equivalent to obj[0]. |
intersect (other, dimension) | Constructs a geometry that is the geometric intersection of the two input geometries. Different dimension values can be used to create different shape types. The intersection of two geometries of the same shape type is a geometry containing only the regions of overlap between the original geometries. For faster results, test if the two geometries are disjoint before calling intersect. |
measureOnLine (in_point, {use_percentage}) | Returns a measure from the start point of this line to the in_point. |
move ({dx}, {dy}, {dz}) | Moves a geometry by specified distances along the x-, y-, and z-axes to create a new geometry. |
overlaps (second_geometry) | Indicates if the intersection of the two geometries has the same shape type as one of the input geometries and is not equivalent to either of the input geometries. Only True relationships are shown in this illustration. |
pointFromAngleAndDistance (angle, distance, {method}) | Returns a point at a given angle in degrees and distance in the units of the geometry's spatial reference using the specified measurement type. |
positionAlongLine (value, {use_percentage}, {geodesic}) | Returns a point on a line at a specified distance from the beginning of the line. |
projectAs (spatial_reference, {transformation_name}) | Projects a geometry from one spatial reference to another. When the geometry object and the destination spatial reference do not have a common datum, specify a transformation_name parameter value. For more information, see Geographic datum transformations and ListTransformations. A vertical transformation will be performed when the following criteria are met:
When the transformation_name parameter value is a vertical transformation, and neither the geometry object nor the destination spatial reference have a vertical coordinate system, the function will fail with a ValueError exception. If either the geometry object or the spatial_reference parameter value have an unknown spatial reference, the output geometry's spatial reference will be that of the spatial_reference parameter value. Use of unknown spatial reference is not recommended for analysis. The projectAs method will not modify m-values, if present. |
queryPointAndDistance (in_point, {as_percentage}) | Finds the point on the polyline nearest to the in_point and the distance between those points. It also returns information about the side of the line the point is on as well as the distance along the line where the nearest point occurs. |
reverseOrientation () | Reverses the order of the vertices in the polyline. |
rotate ({origin}, {rotation_angle}) | Rotates a geometry around a specified origin by the degrees given in radians. The rotation is applied relative to the origin, so that the geometry rotates around the origin. The position of the rotated geometry is significantly affected by the choice of origin. Rotate does not apply to the z-direction. The following describes a few possible choices for the origin and its affect on the output:
|
scale ({origin}, {sx}, {sy}, {sz}) | Scales a geometry from a specified origin by specified factors along the x-, y-, and z-axes to create a new geometry. The position of a transformed point (or vertex) is given by
The transformation is applied relative to the origin, so that the origin remains stationary while the geometry expands or contracts around it. The position and the direction of the expansion or contraction for the resulting geometries is significantly affected by the origin. The following describes a few possible choices for the origin and its affect on the output:
|
segmentAlongLine (start_measure, end_measure, {use_percentage}) | Returns a Polyline between start and end measures. Similar to Polyline.positionAlongLine but will return a polyline segment between two points on the polyline instead of a single point. |
snapToLine (in_point) | Returns a new point based on in_point snapped to this geometry. |
symmetricDifference (other) | Constructs the geometry that is the union of two geometries minus the instersection of those geometries. The two input geometries must be the same shape type. |
touches (second_geometry) | Indicates if the boundaries of the geometries intersect. Two geometries touch when the intersection of the geometries is not empty, but the intersection of their interiors is empty. For example, a point touches a polyline only if the point is coincident with one of the polyline end points. Only True relationships are shown in this illustration. |
union (other) | Constructs the geometry that is the set-theoretic union of the input geometries. The two geometries being unioned must be the same shape type. |
within (second_geometry, {relation}) | Indicates if the base geometry is within the comparison geometry. within is the opposite operator of contains. Only True relationships are shown in this illustration. The base geometry is within the comparison geometry if the base geometry is the intersection of the geometries and the intersection of their interiors is not empty. within is a Clementini operator, except in the case of an empty base geometry. |
方法
boundary ()
データ タイプ | 説明 |
Object | A polygon's boundary is a polyline. A polyline's boundary is a multipoint, corresponding to the endpoints of the line. A point or multipoint's boundary is an empty point or multipoint. |
buffer (distance)
パラメーター | 説明 | データ タイプ |
distance | The buffer distance. The buffer distance is in the same units as the geometry that is being buffered. A negative distance can only be specified against a polygon geometry. | Double |
データ タイプ | 説明 |
Polygon | The buffered polygon geometry. |
clip (envelope)
パラメーター | 説明 | データ タイプ |
envelope | An Extent object used to define the clip extent. | Extent |
データ タイプ | 説明 |
Object | An output geometry clipped to the specified extent. |
contains (second_geometry, {relation})
パラメーター | 説明 | データ タイプ |
second_geometry | A second geometry. | Object |
relation | The spatial relationship type.
(デフォルト値は次のとおりです None) | String |
データ タイプ | 説明 |
Boolean |
A return Boolean value of True indicates this geometry contains the second geometry. |
convexHull ()
データ タイプ | 説明 |
Object | The resulting geometry. The convex hull of a single point is the point itself. |
crosses (second_geometry)
パラメーター | 説明 | データ タイプ |
second_geometry | A second geometry. | Object |
データ タイプ | 説明 |
Boolean | A return Boolean value of True indicates the two geometries intersect in a geometry of a lesser shape type. |
cut (cutter)
パラメーター | 説明 | データ タイプ |
cutter | The cutting polyline geometry. | PolyLine |
データ タイプ | 説明 |
Geometry | A list of two geometries. |
densify (method, distance, {deviation})
パラメーター | 説明 | データ タイプ |
method | The method of densification.
| String |
distance | The maximum distance between vertices. The actual distance between vertices will usually be less than the maximum distance, as new vertices will be evenly distributed along the original segment. If using a type of DISTANCE or ANGLE, the distance is measured in the units of the geometry's spatial reference. If using a type of GEODESIC, the distance is measured in meters. | Double |
deviation | Densify uses straight lines to approximate curves. You use deviation to control the accuracy of this approximation. The deviation is the maximum distance between the new segment and the original curve. The smaller its value, the more segments will be required to approximate the curve. If using a type of DISTANCE, the deviation is measured in the units of the geometry's spatial reference. If using a type of ANGLE, the deviation is measured in radians. If using a type of GEODESIC, the deviation is not used. | Double |
データ タイプ | 説明 |
Geometry | The densified geometry. |
difference (other)
パラメーター | 説明 | データ タイプ |
other | A second geometry. | Object |
データ タイプ | 説明 |
Object | The resulting geometry. |
disjoint (second_geometry)
パラメーター | 説明 | データ タイプ |
second_geometry | A second geometry. | Object |
データ タイプ | 説明 |
Boolean | A return Boolean value of True indicates that the two geometries share no points in common. |
distanceTo (other)
パラメーター | 説明 | データ タイプ |
other | A second geometry. | Object |
データ タイプ | 説明 |
Double | The distance between the two geometries. |
equals (second_geometry)
パラメーター | 説明 | データ タイプ |
second_geometry | A second geometry. | Object |
データ タイプ | 説明 |
Boolean |
A return Boolean value of True indicates that the two geometries are of the same shape type and define the same set of points in the plane. |
generalize (max_offset)
パラメーター | 説明 | データ タイプ |
max_offset | The maximum offset tolerance. | Double |
データ タイプ | 説明 |
Geometry | The generalized geometry. |
getLength ({method}, {units})
パラメーター | 説明 | データ タイプ |
method | The method used to measure length.
(デフォルト値は次のとおりです GEODESIC) | String |
units | The units in which the length will be calculated.
| String |
データ タイプ | 説明 |
Double | The length of the feature. By default, for projected coordinate systems, length will be returned in the units of the coordinate system, and for geographic coordinate systems, length will be returned in meters. |
getPart ({index})
パラメーター | 説明 | データ タイプ |
index | The index position of the geometry. | Integer |
データ タイプ | 説明 |
Array | The resultant Array object. |
intersect (other, dimension)
パラメーター | 説明 | データ タイプ |
other | The second geometry. | Object |
dimension | The topological dimension (shape type) of the resulting geometry.
| Integer |
データ タイプ | 説明 |
Object | A new geometry (point, multipoint, polyline, or polygon) that is the geometric intersection of the two input geometries. |
measureOnLine (in_point, {use_percentage})
パラメーター | 説明 | データ タイプ |
in_point | A point (PointGeometry or Point) that is used to measure from the start point of the polyline. If the point does not intersect the line, the function will use the nearest location on the line from the point. | PointGeometry |
use_percentage | If False, the measure will be returned as a distance; if True, the measure will be returned as a percentage. (デフォルト値は次のとおりです False) | Boolean |
データ タイプ | 説明 |
Double | The distance or percentage value. |
move ({dx}, {dy}, {dz})
パラメーター | 説明 | データ タイプ |
dx | The distance the geometry will be moved along the x-axis. (デフォルト値は次のとおりです 0.0) | Double |
dy | The distance the geometry will be moved along the y-axis. (デフォルト値は次のとおりです 0.0) | Double |
dz | The distance the geometry will be moved along the z-axis. The geometry must be z-aware and have z-values. (デフォルト値は次のとおりです 0.0) | Double |
データ タイプ | 説明 |
Geometry | An output geometry, moved by the specified distances along the x-, y-, and z-axes. |
overlaps (second_geometry)
パラメーター | 説明 | データ タイプ |
second_geometry | A second geometry. | Object |
データ タイプ | 説明 |
Boolean | A return Boolean value of True indicates the intersection of the two geometries has the same dimension as one of the input geometries. |
pointFromAngleAndDistance (angle, distance, {method})
パラメーター | 説明 | データ タイプ |
angle | The angle in degrees to the returned point. | Double |
distance | The distance in the units of the geometry's spatial reference to the returned point. | Double |
method | PLANAR measurements reflect the projection of geographic data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, or PRESERVE_SHAPE measurement types can be chosen as an alternative if desired.
(デフォルト値は次のとおりです GEODESIC) | String |
データ タイプ | 説明 |
PointGeometry | Returns a point at a given angle and distance in degrees and meters. |
positionAlongLine (value, {use_percentage}, {geodesic})
パラメーター | 説明 | データ タイプ |
value | The distance along the line. The distance will be evaluated based on the geodesic parameter value. If the geodesic parameter value is False, the distance will be evaluated in meters. If the geodesic parameter value is True, the distance will be evaluated in the units of the feature's spatial reference. If the value exceeds the length of the line or precedes the length of the line (a negative value), the behaviour will depend on the geodesic parameter value as follows:
| Double |
use_percentage | Specifies whether the distance is specified as a fixed unit of measure (False) or a ratio of the length of the line (True). For percentages, express the value parameter as a double from 0.0 (0 percent) to 1.0 (100 percent). 注意:This parameter is only supported when the geodesic parameter value is False. (デフォルト値は次のとおりです False) | Boolean |
geodesic | Specifies whether the distance measure will be geodesic (True) or planar (False). (デフォルト値は次のとおりです False) | Boolean |
データ タイプ | 説明 |
PointGeometry | The point on the line at a specified distance from the beginning of the line. |
projectAs (spatial_reference, {transformation_name})
パラメーター | 説明 | データ タイプ |
spatial_reference | The spatial reference to which the geometry will be projected. The value can be a SpatialReference object or the coordinate system name. | SpatialReference |
transformation_name | The geotransformation name. With ArcGIS Pro, if you do not specify a transformation, none will be applied. With ArcGIS Server, if you do not specify a transformation, a fallback transformation will be applied. | String |
データ タイプ | 説明 |
Object | The projected geometry. |
queryPointAndDistance (in_point, {as_percentage})
パラメーター | 説明 | データ タイプ |
in_point | The input point. Both PointGeometry and Point objects are accepted. | PointGeometry |
as_percentage | If False, the measure will be returned as a distance; if True, the measure will be returned as a percentage. (デフォルト値は次のとおりです False) | Boolean |
データ タイプ | 説明 |
tuple | Returns a tuple that includes the following:
Distances are measured in the units of the geometry's spatial reference. |
reverseOrientation ()
データ タイプ | 説明 |
Geometry | An output geometry with vertices in the reverse order of the input polyline. |
rotate ({origin}, {rotation_angle})
パラメーター | 説明 | データ タイプ |
origin | The origin of the transformation. The argument can be either an arcpy.Point object or an arcpy.PointGeometry object. The default origin, arcpy.Point(0.0, 0.0), will usually be located outside the target geometry. (デフォルト値は次のとおりです arcpy.Point(0.0, 0.0)) | Point |
rotation_angle | The angle, in radians, to rotate the geometry around its origin. The default rotation angle is 0.0 radians (no rotation). (デフォルト値は次のとおりです 0.0) | Float |
データ タイプ | 説明 |
Geometry | An output geometry rotated by the specified angle around the specified origin. |
scale ({origin}, {sx}, {sy}, {sz})
パラメーター | 説明 | データ タイプ |
origin | The origin of the transformation. The argument can be either an arcpy.Point object or an arcpy.PointGeometry object. The default origin, arcpy.Point(0.0, 0.0, 0.0), will usually be located outside the target geometry. (デフォルト値は次のとおりです arcpy.Point(0.0, 0.0, 0.0)) | Point |
sx | The factor that will be used to scale the geometry along the x-axis. (デフォルト値は次のとおりです 1.0) | Double |
sy | The factor that will be used to scale the geometry along the y-axis. (デフォルト値は次のとおりです 1.0) | Double |
sz | The factor that will be used to scale the geometry along the z-axis. The geometry must be z-aware and have z-values. (デフォルト値は次のとおりです 1.0) | Double |
データ タイプ | 説明 |
Geometry | An output geometry scaled from the specified origin and by specified factors along the x-, y-, and z-axes. |
segmentAlongLine (start_measure, end_measure, {use_percentage})
パラメーター | 説明 | データ タイプ |
start_measure | The starting distance from the beginning of the line. | Double |
end_measure | The ending distance from the beginning of the line. | Double |
use_percentage | The start and end measures may be specified as fixed units or as a ratio. If True, start_measure and end_measure are used as a percentage; if False, start_measure and end_measure are used as a distance. For percentages, the measures should be expressed as a double from 0.0 (0 percent) to 1.0 (100 percent). (デフォルト値は次のとおりです False) | Boolean |
データ タイプ | 説明 |
PolyLine | The segment of the line between two points. |
snapToLine (in_point)
パラメーター | 説明 | データ タイプ |
in_point | A point (PointGeometry or Point) to be snapped to the line. | PointGeometry |
データ タイプ | 説明 |
PointGeometry | The snapped point. |
symmetricDifference (other)
パラメーター | 説明 | データ タイプ |
other | A second geometry. | Object |
データ タイプ | 説明 |
Object | The resulting geometry. |
touches (second_geometry)
パラメーター | 説明 | データ タイプ |
second_geometry | A second geometry. | Object |
データ タイプ | 説明 |
Boolean | A return Boolean value of True indicates the boundaries of the geometries intersect. |
union (other)
パラメーター | 説明 | データ タイプ |
other | A second geometry. | Object |
データ タイプ | 説明 |
Object | The resulting geometry. |
within (second_geometry, {relation})
パラメーター | 説明 | データ タイプ |
second_geometry | A second geometry. | Object |
relation | The spatial relationship type.
(デフォルト値は次のとおりです None) | String |
データ タイプ | 説明 |
Boolean | A return Boolean value of True indicates this geometry is contained within the second geometry. |
コードのサンプル
Create a polyline feature class from scratch.
import arcpy
# Create a spatial reference from a wkid
spatial_ref = arcpy.SpatialReference(32145)
# A list of features and coordinate pairs
feature_info = [[[1, 2], [2, 4], [3, 7]],
[[6, 8], [5, 7], [7, 2], [9, 5]]]
# A list that will contain the Polyline objects
features = []
# Create Polyline objects from an array of points
for feature in feature_info:
array = arcpy.Array([arcpy.Point(*coords) for coords in feature])
polyline = arcpy.Polyline(array, spatial_ref)
features.append(polyline)
# Persist a copy of the Polyline objects using CopyFeatures
arcpy.management.CopyFeatures(features, "c:/geometry/polylines.shp")