Multipoint

Summary

A Multipoint object is an ordered collection of points.

Discussion

In many geoprocessing workflows, you may need to run a specific operation using coordinate and geometry information but don't necessarily want to go through the process of creating a new (temporary) feature class, populating the feature class with cursors, using the feature class, then deleting the temporary feature class. Geometry objects can be used instead for both input and output to make geoprocessing easier. Geometry objects can be created from scratch using Geometry, Multipoint, PointGeometry, Polygon, or Polyline classes.

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.

Syntax

 Multipoint (inputs, {spatial_reference}, {has_z}, {has_m}, {has_id})

Parameter	Explanation	Data Type
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. (The default value is None)	SpatialReference
has_z	Specifies whether the geometry will be z-enabled. (The default value is False)	Boolean
has_m	Specifies whether the geometry will be m-enabled. (The default value is False)	Boolean
has_id	Specifies whether the geometry will support point IDs. (The default value is False)	Boolean

Properties

Property	Explanation	Data Type
JSON (Read Only)	An Esri JSON representation of the geometry as a string. Tip: The returned string can be converted to a dictionary using the json module's loads function.	String
WKB (Read Only)	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 (Read Only)	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 (Read Only)	The area of a polygon feature. The area is zero for all other feature types.	Double
centroid (Read Only)	The true centroid if it is within or on the feature; otherwise, it is the label point.	Point
extent (Read and Write)	The extent of the geometry.	Extent
firstPoint (Read Only)	The first coordinate point of the geometry.	Point
hasCurves (Read Only)	Specifies whether the geometry has a curve.	Boolean
hullRectangle (Read Only)	A space-delimited string of the coordinate pairs of the convex hull rectangle.	String
isMultipart (Read Only)	Specifies whether the number of parts for the geometry is more than one.	Boolean
labelPoint (Read Only)	The point at which the label is located. This point is always located within or on a feature.	Point
lastPoint (Read Only)	The last coordinate of the feature.	Point
length (Read Only)	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 (Read Only)	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. Caution: 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. Caution: This property is only available for projected data.	Double
partCount (Read Only)	The number of geometry parts for the feature.	Integer
pointCount (Read Only)	The total number of points for the feature.	Integer
spatialReference (Read Only)	The spatial reference of the geometry.	SpatialReference
trueCentroid (Read Only)	The center of gravity for a feature.	Point
type (Read Only)	The geometry type: polygon, polyline, point, or multipoint.	String

Method Overview

Method	Explanation
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).
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.
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.
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.
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: The geometry object has z-coordinates. The geometry object's spatial reference and the spatial_reference parameter values both have a vertical coordinate system. The transformation_name parameter value is a vertical transformation. 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.
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: The origin is outside the geometry (not within or touching the geometry)—The location of the geometry will change, but the geometry will maintain relative positions to other geometries rotated in the same way. Positions will rotate around the origin. The origin is at the centroid of the geometry (the centroid is within or touching geometry)—The geometry will rotate (spin) in place around its centroid. The origin is on a vertex of the geometry—The geometry will rotate around the chosen vertex.
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 ( (x - origin_x) * scale_x + origin_x, (y - origin_y) * scale_y + origin_y, (z - origin_z) * scale_z + origin_z ) 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: The origin is outside the geometry (not within or touching the geometry)—The size and location of the geometry will change, but the geometry will maintain relative positions to other geometries scaled in the same way. Positions will expand away from or contract toward the origin point. The origin is at the centroid of the geometry (if the centroid is within or touching geometry)—The size of the geometry will change, but the geometry's location will remain anchored at the centroid. The geometry will grow or shrink in place around the centroid. The origin is on a vertex of the geometry—The size of the geometry will change, but the position of the geometry will remain anchored at the chosen vertex. The geometry will grow from or shrink toward the chosen vertex.
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.

Methods

boundary ()

Return Value

Data Type	Explanation
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)

Parameter	Explanation	Data Type
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

Return Value

Data Type	Explanation
Polygon	The buffered polygon geometry.

clip (envelope)

Parameter	Explanation	Data Type
envelope	An Extent object used to define the clip extent.	Extent

Return Value

Data Type	Explanation
Object	An output geometry clipped to the specified extent.

contains (second_geometry, {relation})

Parameter	Explanation	Data Type
second_geometry	A second geometry.	Object
relation	The spatial relationship type. BOUNDARY— Relationship has no restrictions for interiors or boundaries. CLEMENTINI— Interiors of geometries must intersect. Specifying CLEMENTINI is equivalent to specifying None. This is the default. PROPER— Boundaries of geometries must not intersect. (The default value is None)	String

Return Value

Data Type	Explanation
Boolean	A return Boolean value of True indicates this geometry contains the second geometry.

convexHull ()

Return Value

Data Type	Explanation
Object	The resulting geometry. The convex hull of a single point is the point itself.

crosses (second_geometry)

Parameter	Explanation	Data Type
second_geometry	A second geometry.	Object

Return Value

Data Type	Explanation
Boolean	A return Boolean value of True indicates the two geometries intersect in a geometry of a lesser shape type.

cut (cutter)

Parameter	Explanation	Data Type
cutter	The cutting polyline geometry.	PolyLine

Return Value

Data Type	Explanation
Geometry	A list of two geometries.

difference (other)

Parameter	Explanation	Data Type
other	A second geometry.	Object

Return Value

Data Type	Explanation
Object	The resulting geometry.

disjoint (second_geometry)

Parameter	Explanation	Data Type
second_geometry	A second geometry.	Object

Return Value

Data Type	Explanation
Boolean	A return Boolean value of True indicates that the two geometries share no points in common.

distanceTo (other)

Parameter	Explanation	Data Type
other	A second geometry.	Object

Return Value

Data Type	Explanation
Double	The distance between the two geometries.

equals (second_geometry)

Parameter	Explanation	Data Type
second_geometry	A second geometry.	Object

Return Value

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.

getPart ({index})

Parameter	Explanation	Data Type
index	The index position of the geometry.	Integer

Return Value

Data Type	Explanation
Array	The resultant Array object.

intersect (other, dimension)

Parameter	Explanation	Data Type
other	The second geometry.	Object
dimension	The topological dimension (shape type) of the resulting geometry. 1—A zero-dimensional geometry (point or multipoint). 2—A one-dimensional geometry (polyline). 4—A two-dimensional geometry (polygon).	Integer

Return Value

Data Type	Explanation
Object	A new geometry (point, multipoint, polyline, or polygon) that is the geometric intersection of the two input geometries.

move ({dx}, {dy}, {dz})

Parameter	Explanation	Data Type
dx	The distance the geometry will be moved along the x-axis. (The default value is 0.0)	Double
dy	The distance the geometry will be moved along the y-axis. (The default value is 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. (The default value is 0.0)	Double

Return Value

Data Type	Explanation
Geometry	An output geometry, moved by the specified distances along the x-, y-, and z-axes.

overlaps (second_geometry)

Parameter	Explanation	Data Type
second_geometry	A second geometry.	Object

Return Value

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.

projectAs (spatial_reference, {transformation_name})

Parameter	Explanation	Data Type
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

Return Value

Data Type	Explanation
Object	The projected geometry.

rotate ({origin}, {rotation_angle})

Parameter	Explanation	Data Type
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. (The default value is 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). (The default value is 0.0)	Float

Return Value

Data Type	Explanation
Geometry	An output geometry rotated by the specified angle around the specified origin.

scale ({origin}, {sx}, {sy}, {sz})

Parameter	Explanation	Data Type
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. (The default value is arcpy.Point(0.0, 0.0, 0.0))	Point
sx	The factor that will be used to scale the geometry along the x-axis. (The default value is 1.0)	Double
sy	The factor that will be used to scale the geometry along the y-axis. (The default value is 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. (The default value is 1.0)	Double

Return Value

Data Type	Explanation
Geometry	An output geometry scaled from the specified origin and by specified factors along the x-, y-, and z-axes.

symmetricDifference (other)

Parameter	Explanation	Data Type
other	A second geometry.	Object

Return Value

Data Type	Explanation
Object	The resulting geometry.

touches (second_geometry)

Parameter	Explanation	Data Type
second_geometry	A second geometry.	Object

Return Value

Data Type	Explanation
Boolean	A return Boolean value of True indicates the boundaries of the geometries intersect.

union (other)

Parameter	Explanation	Data Type
other	A second geometry.	Object

Return Value

Data Type	Explanation
Object	The resulting geometry.

within (second_geometry, {relation})

Parameter	Explanation	Data Type
second_geometry	A second geometry.	Object
relation	The spatial relationship type. BOUNDARY— Relationship has no restrictions for interiors or boundaries. CLEMENTINI— Interiors of geometries must intersect. Specifying CLEMENTINI is equivalent to specifying None. This is the default. PROPER— Boundaries of geometries must not intersect. (The default value is None)	String

Return Value

Data Type	Explanation
Boolean	A return Boolean value of True indicates this geometry is contained within the second geometry.

Code sample

Multipoint example

Create a multipoint 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 hold each of the Multipoint objects
features = []

# Create Multipoint objects from an array of points
for feature in feature_info:
    array = arcpy.Array([arcpy.Point(*coords) for coords in feature])
    multipoint = arcpy.Multipoint(array, spatial_ref)
    features.append(multipoint)

# Persist a copy of the Multipoint objects using CopyFeatures
arcpy.management.CopyFeatures(features, "c:/geometry/multipoints.shp")