Point (arcpy)
Summary
The point object is used frequently with cursors. Point features return a single point object instead of an array of point objects. All other feature types—polygon, polyline, and multipoint—return an array of point objects or an array containing multiple arrays of point objects if the feature has multiple parts.
Discussion
A Point is not a geometry class, but is commonly used to construct geometry. In the example below, a Point is used to create a PointGeometry object.
point = arcpy.Point(25282, 43770)
ptGeometry = arcpy.PointGeometry(point)
Syntax
Parameter | Explanation | Data Type |
X |
The X coordinate of the point. (The default value is 0.0) | Double |
Y |
The Y coordinate of the point. (The default value is 0.0) | Double |
Z |
The Z coordinate of the point. (The default value is None) | Double |
M |
The M value of the point. (The default value is None) | Double |
ID |
The shape ID of the point. (The default value is 0) | Integer |
Properties
Property | Explanation | Data Type |
ID (Read and Write) |
An integer used to uniquely identify the point. | Integer |
M (Read and Write) |
The measure value of the point. | Double |
X (Read and Write) |
The horizontal coordinate of the point. | Double |
Y (Read and Write) |
The vertical coordinate of the point. | Double |
Z (Read and Write) |
The elevation value of the point. | Double |
Method Overview
Method | Explanation |
clone (point_object) |
Clone the point object. |
contains (second_geometry) |
Indicates if the base geometry contains the comparison geometry. contains is the opposite of within. Only True relationships are shown in this illustration. |
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. |
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. |
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. |
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. |
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. |
within (second_geometry) |
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. |
Methods
Parameter | Explanation | Data Type |
point_object |
A point object. | Point |
Parameter | Explanation | Data Type |
second_geometry |
A second geometry. | Object |
Data Type | Explanation |
Boolean |
A return Boolean value of True indicates this geometry contains the second geometry. |
Parameter | Explanation | Data Type |
second_geometry |
A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates the two geometries intersect in a geometry of a lesser shape type. |
Parameter | Explanation | Data Type |
second_geometry |
A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates that the two geometries share no points in common. |
Parameter | Explanation | Data Type |
second_geometry |
A second geometry. | Object |
Data Type | Explanation |
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. |
Parameter | Explanation | Data Type |
second_geometry |
A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates the intersection of the two geometries has the same dimension as one of the input geometries. |
Parameter | Explanation | Data Type |
second_geometry |
A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates the boundaries of the geometries intersect. |
Parameter | Explanation | Data Type |
second_geometry |
A second geometry. | Object |
Data Type | Explanation |
Boolean | A return Boolean value of True indicates this geometry is contained within the second geometry. |
Code Sample
Create Point object and display its properties.
import arcpy
# Create point object
point = arcpy.Point(2000, 2500)
# Print point properties
print("Point properties:")
print(" ID: {0}".format(point.ID))
print(" X: {0}".format(point.X))
print(" Y: {0}".format(point.Y))
Examine point objects in polygon array object, returned from geometry object.
import arcpy
# Create cursor to retrieve Hawaii shape
feature_class = "c:/data/Hawaii.shp"
cursor = arcpy.da.SearchCursor(feature_class, ["SHAPE@"])
for row in cursor:
# Get the geometry object from the shape field
print("Number of Hawaiian islands: {0}".format(row[0].partCount))
# GetPart returns an array of point objects for each part.
for island in row[0].getPart():
print("Vertices in island: {0}".format(island.count))
for point in island:
print("X: {0}, Y: {1})".format(point.X, point.Y))