Geometry

Summary

Geometry objects define a spatial location and an associated geometric shape.

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.

Syntax

Geometry(geometry, inputs, {spatial_reference}, {has_z}, {has_m}, {has_id})

Name	Explanation	Data type
geometry	The geometry type. `point`—The geometry is a point. `polygon`—The geometry is a polygon. `polyline`—The geometry is a polyline. `multipoint`—The geometry is a multipoint.	String
inputs	The coordinate information used to create the object. The data type can be `Point` or `Array` objects.	Object
spatial_reference (Optional)	The spatial reference of the new geometry. The default value is None.	SpatialReference
has_z (Optional)	Specifies whether the geometry will be z-enabled. The default value is False.	Boolean
has_m (Optional)	Specifies whether the geometry will be m-enabled. The default value is False.	Boolean
has_id (Optional)	Specifies whether the geometry will support point IDs. The default value is False.	Boolean

Properties

Name	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

Methods

`angleAndDistanceTo(other, {method})`

Returns a tuple of angle and distance to a point or polygon.

Name	Explanation	Data type
other	The second geometry. If the geometry is a polygon, the distance is measured to the centroid of the polygon.	PointGeometry
method (Optional)	Specifies the method that will be used to measure distance. GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid. GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used. LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line. PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth. The default value is GEODESIC.	String

Name

Explanation

Data type

other

The second geometry. If the geometry is a polygon, the distance is measured to the centroid of the polygon.

PointGeometry

method

(Optional)

Specifies the method that will be used to measure distance.

GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid.
GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used.
LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line.
PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth.

The default value is GEODESIC.

String

Return value

Data type	Explanation
tuple	Returns a tuple of angle (in degrees) and distance (in meters) to another point.

`boundary()`

Construct the boundary of the geometry.

Boundary operator

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)`

Construct a polygon at a specified distance from the geometry.

Buffer operator

Name	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 for a polygon geometry.	Double

Name

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 for a polygon geometry.

Double

Return value

Data type	Explanation
Polygon	The buffered polygon geometry.

`clip(envelope)`

Constructs the intersection of the geometry and the specified extent.

Clip operator

Name	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})`

Specifies whether the base geometry contains the comparison geometry.

The contains method is the opposite of the within method.

Only True relationships are shown in this illustration.

Possible contains relationships

Name Explanation Data type

second_geometry

A second geometry.

Object

relation

(Optional)

Specifies the spatial relationship type that will be used.

BOUNDARY—The relationship has no restrictions for interiors or boundaries.
CLEMENTINI—Interiors of geometries must intersect. This option 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	Returns whether this geometry contains the second geometry.

`convexHull()`

Constructs the geometry that is the minimal bounding polygon such that all outer angles are convex.

ConvexHull operator

Return value

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

`crosses(second_geometry)`

Specifies whether 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 a polygon cross if they share a polyline or a point (for a vertical line) in common on the interior of the polygon that is not equivalent to the entire polyline.

Only True relationships are shown in this illustration.

Possible crosses relationships

Name	Explanation	Data type
second_geometry	A second geometry.	Object

Return value

Data type	Explanation
Boolean	Returns whether the two geometries intersect in a geometry of a lesser shape type.

`cut(cutter)`

Split the 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).

Cut operator

Name	Explanation	Data type
cutter	The cutting polyline geometry.	PolyLine

Return value

Data type	Explanation
Geometry	A list of two geometries.

`densify(method, distance, {deviation})`

Creates a geometry with added vertices.

Name Explanation Data type

Name	Explanation	Data type
method	The method of densification. DISTANCE—Creates a feature that is a piecewise linear approximation of the input. ANGLE—Creates a feature that is a piecewise linear approximation of the input. Vertices are introduced at points where the angle between tangents at those points is the provided `angle`. GEODESIC—Densifies and reshapes segments between input vertices so that the output segments follow the shortest ground path connecting input vertices.	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 (Optional)	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

method

The method of densification.

DISTANCE—Creates a feature that is a piecewise linear approximation of the input.
ANGLE—Creates a feature that is a piecewise linear approximation of the input. Vertices are introduced at points where the angle between tangents at those points is the provided angle.
GEODESIC—Densifies and reshapes segments between input vertices so that the output segments follow the shortest ground path connecting input vertices.

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

(Optional)

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

Return value

Data type	Explanation
Geometry	The densified geometry.

`difference(other)`

Construct 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:

Difference operator

Name	Explanation	Data type
other	A second geometry.	Object

Return value

Data type	Explanation
Object	The resulting geometry.

`disjoint(second_geometry)`

Specifies whether the base and comparison geometries have points in common.

Two geometries intersect when this method returns False.

Only True relationships are shown in this illustration.

Possible disjoint relationships

Name	Explanation	Data type
second_geometry	A second geometry.	Object

Return value

Data type	Explanation
Boolean	Returns whether the two geometries have points in common.

`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.

Name	Explanation	Data type
other	A second geometry.	Object

Return value

Data type	Explanation
Double	The distance between the two geometries.

`equals(second_geometry)`

Specifies whether 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.

Possible equals relationships

Name	Explanation	Data type
second_geometry	A second geometry.	Object

Return value

Data type	Explanation
Boolean	Returns whether the two geometries are of the same shape type and define the same set of points in the plane.

`generalize(max_offset)`

Creates a simplified geometry using a specified maximum offset tolerance.

Name	Explanation	Data type
max_offset	The maximum offset tolerance.	Double

Return value

Data type	Explanation
Geometry	The generalized geometry.

`getArea({method}, {units})`

Returns the area of the feature using a measurement method.

Name	Explanation	Data type
method (Optional)	The method used to measure area. GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid. GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used. LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line. PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth. PRESERVE_SHAPE—This type calculates the area or length of the geometry on the surface of the earth ellipsoid, for geometry defined in a projected or geographic coordinate system. This option preserves the shape of the geometry in its coordinate system. The default value is GEODESIC.	String
units (Optional)	The units in which the area will be calculated. Learn more about area units SquareKilometers—Square kilometers Hectares—Hectares Ares—Ares SquareMeters—Square meters SquareDecimeters—Square decimeters SquareCentimeters—Square centimeters SquareMillimeters—Square millimeters SquareMilesInt—Square statute miles AcresInt—International acres SquareYardsInt—Square international yards SquareFeetInt—Square international feet SquareInchesInt—Square international inches SquareMilesUS—Square US survey miles AcresUS—Square US survey acres SquareYardsUS—Square US survey yards SquareFeetUS—Square US survey feet SquareInchesUS—Square US survey inches Unknown—Unknown	String

Name

Explanation

Data type

method

(Optional)

The method used to measure area.

GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid.
GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used.
LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line.
PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth.
PRESERVE_SHAPE—This type calculates the area or length of the geometry on the surface of the earth ellipsoid, for geometry defined in a projected or geographic coordinate system. This option preserves the shape of the geometry in its coordinate system.

The default value is GEODESIC.

String

units

(Optional)

The units in which the area will be calculated.

Learn more about area units

SquareKilometers—Square kilometers
Hectares—Hectares
Ares—Ares
SquareMeters—Square meters
SquareDecimeters—Square decimeters
SquareCentimeters—Square centimeters
SquareMillimeters—Square millimeters
SquareMilesInt—Square statute miles
AcresInt—International acres
SquareYardsInt—Square international yards
SquareFeetInt—Square international feet
SquareInchesInt—Square international inches
SquareMilesUS—Square US survey miles
AcresUS—Square US survey acres
SquareYardsUS—Square US survey yards
SquareFeetUS—Square US survey feet
SquareInchesUS—Square US survey inches
Unknown—Unknown

String

Return value

Data type	Explanation
Double	The area of the feature. By default, for projected coordinate systems, area will be returned in the units of the coordinate system, and for geographic coordinate systems, area will be returned in square meters.

Data type

Explanation

Double

The area of the feature.

By default, for projected coordinate systems, area will be returned in the units of the coordinate system, and for geographic coordinate systems, area will be returned in square meters.

`getLength({method}, {units})`

Returns the length of the feature using a measurement method.

Name	Explanation	Data type
method (Optional)	The method used to measure length. GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid. GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used. LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line. PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth. PRESERVE_SHAPE—This type calculates the area or length of the geometry on the surface of the earth ellipsoid, for geometry defined in a projected or geographic coordinate system. This option preserves the shape of the geometry in its coordinate system. The default value is GEODESIC.	String
units (Optional)	The units in which the length will be calculated. Learn more about linear units Kilometers—Kilometers Meters—Meters Decimeters—Decimeters Millimeters—Millimeters Centimeters—Centimeters NauticalMilesInt—International nautical miles MilesInt—Statute miles YardsInt—International yards FeetInt—International feet InchesInt—International inches NauticalMiles—US survey nautical miles Miles—US survey miles Yards—US survey yards Feet—US survey feet Inches—US survey inches DecimalDegrees—Decimal degrees Points—Points Unknown—Unknown	String

Name

Explanation

Data type

method

(Optional)

The method used to measure length.

GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid.
GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used.
LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line.
PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth.
PRESERVE_SHAPE—This type calculates the area or length of the geometry on the surface of the earth ellipsoid, for geometry defined in a projected or geographic coordinate system. This option preserves the shape of the geometry in its coordinate system.

The default value is GEODESIC.

String

units

(Optional)

The units in which the length will be calculated.

Learn more about linear units

Kilometers—Kilometers
Meters—Meters
Decimeters—Decimeters
Millimeters—Millimeters
Centimeters—Centimeters
NauticalMilesInt—International nautical miles
MilesInt—Statute miles
YardsInt—International yards
FeetInt—International feet
InchesInt—International inches
NauticalMiles—US survey nautical miles
Miles—US survey miles
Yards—US survey yards
Feet—US survey feet
Inches—US survey inches
DecimalDegrees—Decimal degrees
Points—Points
Unknown—Unknown

String

Return value

Data type	Explanation
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.

Data type

Explanation

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})`

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].

Name	Explanation	Data type
index (Optional)	The index position of the geometry.	Integer

Return value

Data type	Explanation
Array	The resultant `Array` object.

`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.

Intersect operator

For faster results, test whether the two geometries are disjoint before calling intersect.

Name

Explanation

Data type

other

The second geometry.

Object

dimension

Specifies the topological dimension (shape type) of the resulting geometry.

1—The geometry will be a zero-dimensional geometry (point or multipoint).
2—The geometry will be a one-dimensional geometry (polyline).
4—The geometry will be 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.

`measureOnLine(in_point, {use_percentage})`

Returns a measure from the start point of this line to the in_point.

Name Explanation Data type

Name	Explanation	Data type
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 (Optional)	If `False`, the measure will be returned as a distance; if `True`, the measure will be returned as a percentage. The default value is False.	Boolean

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

(Optional)

If False, the measure will be returned as a distance; if True, the measure will be returned as a percentage.

The default value is False.

Boolean

Return value

Data type	Explanation
Double	The distance or percentage value.

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

Moves a geometry by specified distances along the x-, y-, and z-axes to create a new geometry.

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

Name

Explanation

Data type

(Optional)

The distance the geometry will be moved along the x-axis.

The default value is 0.0.

Double

(Optional)

The distance the geometry will be moved along the y-axis.

The default value is 0.0.

Double

(Optional)

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)`

Specifies whether 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.

Possible overlaps relationships

Name	Explanation	Data type
second_geometry	A second geometry.	Object

Return value

Data type	Explanation
Boolean	Returns whether the intersection of the two geometries has the same dimension as one of the input geometries.

`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.

Name	Explanation	Data type
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 (Optional)	Specifies the method that will be used to measure distance. GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid. GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used. LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line. PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth. The default value is GEODESIC.	String

Name

Explanation

Data type

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

(Optional)

Specifies the method that will be used to measure distance.

GEODESIC—The shortest line between any two points on the earth's surface on a spheroid (ellipsoid). One use for a geodesic line is to determine the shortest distance between two cities for an airplane's flight path. This is also known as a great circle line if based on a sphere rather than an ellipsoid.
GREAT_ELLIPTIC—The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and endpoints of a segment. This is also known as a great circle when a sphere is used.
LOXODROME—The line follows a single compass bearing, or azimuth. Great circle routes are often broken into a series of loxodromes, which simplifies navigation. This is also known as a rhumb line.
PLANAR—Planar measurements use 2D Cartesian mathematics to calculate lengths and areas. This option is only available when measuring in a projected coordinate system and the 2D plane of that coordinate system will be used as the basis for the measurements. Planar measurements reflect the projection of geographic data onto a 2D surface, and do not account for the curvature of the earth.

The default value is GEODESIC.

String

Return value

Data type	Explanation
PointGeometry	Returns a point at a given angle and distance in degrees and meters.

`positionAlongLine(value, {use_percentage}, {geodesic})`

Returns a point on a line at a specified distance from the beginning of the line.

Name Explanation Data type

Name	Explanation	Data type
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: If the `geodesic` parameter value is `False`, exceeding the length of the line will return the endpoint of the line, and a negative distance value will return the starting point of the line. If the `geodesic` parameter value is `True`, exceeding or preceding the length of the line will cause the method to fail.	Double
use_percentage (Optional)	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). Note: This parameter is only supported when the `geodesic` parameter value is `False`. The default value is False.	Boolean
geodesic (Optional)	Specifies whether the distance measure will be geodesic (`True`) or planar (`False`). The default value is False.	Boolean

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:

If the geodesic parameter value is False, exceeding the length of the line will return the endpoint of the line, and a negative distance value will return the starting point of the line.
If the geodesic parameter value is True, exceeding or preceding the length of the line will cause the method to fail.

Double

use_percentage

(Optional)

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).

Note:

This parameter is only supported when the geodesic parameter value is False.

The default value is False.

Boolean

geodesic

(Optional)

Specifies whether the distance measure will be geodesic (True) or planar (False).

The default value is False.

Boolean

Return value

Data type	Explanation
PointGeometry	The point on the 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:

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.

Name Explanation Data type

Name	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 (Optional)	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

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

(Optional)

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.

`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.

Name Explanation Data type

Name	Explanation	Data type
in_point	The input point. Both `PointGeometry` and `Point` objects are accepted.	PointGeometry
as_percentage (Optional)	If `False`, the measure will be returned as a distance; if `True`, the measure will be returned as a percentage. The default value is False.	Boolean

in_point

The input point. Both PointGeometry and Point objects are accepted.

PointGeometry

as_percentage

(Optional)

If False, the measure will be returned as a distance; if True, the measure will be returned as a percentage.

The default value is False.

Boolean

Return value

Data type Explanation

Data type	Explanation
tuple	Returns a tuple that includes the following: A `PointGeometry` object that is the nearest point on the polyline to the `in_point`. The distance between the start point of the line and the returned point on the line. The minimum distance between the line and the `in_point`. A Boolean that indicates whether the `in_point` is on the right side of the line. The direction of the line determines the right and left sides. Distances are measured in the units of the geometry's spatial reference.

tuple

Returns a tuple that includes the following:

A PointGeometry object that is the nearest point on the polyline to the in_point.
The distance between the start point of the line and the returned point on the line.
The minimum distance between the line and the in_point.
A Boolean that indicates whether the in_point is on the right side of the line. The direction of the line determines the right and left sides.

Distances are measured in the units of the geometry's spatial reference.

`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.

Name Explanation Data type

origin

(Optional)

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

(Optional)

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})`

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

\(( \space (x \space - \space origin_x) \space * \space scale_x \space + \space origin_x, \space (y \space - \space origin_y) \space * \space scale_y \space + \space origin_y, \space (z \space - \space origin_z) \space * \space scale_z \space + \space origin_z \space )\)

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.

Name	Explanation	Data type
origin (Optional)	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 (Optional)	The factor that will be used to scale the geometry along the x-axis. The default value is 1.0.	Double
sy (Optional)	The factor that will be used to scale the geometry along the y-axis. The default value is 1.0.	Double
sz (Optional)	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.

`segmentAlongLine(start_measure, end_measure, {use_percentage})`

Returns a Polyline between start and end measures. It is similar to the Polyline.positionAlongLine method but will return a polyline segment between two points on the polyline instead of a single point.

Name Explanation Data type

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

(Optional)

Specifies whether the start and end measures are used as a percentage.

If True, the start_measure and end_measure parameter values are used as a percentage. If False, the start_measure and end_measure parameter values 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).

The default value is False.

Boolean

Return value

Data type	Explanation
PolyLine	The segment of the line between two points.

`snapToLine(in_point)`

Returns a new point based on a point snapped to this geometry.

Name	Explanation	Data type
in_point	The point (`PointGeometry` or `Point`) that will be snapped to the line.	PointGeometry

Return value

Data type	Explanation
PointGeometry	The snapped point.

`symmetricDifference(other)`

Constructs the geometry that is the union of two geometries minus the intersection of those geometries.

The two input geometries must be the same shape type.

symmetricDifference operator

Name	Explanation	Data type
other	A second geometry.	Object

Return value

Data type	Explanation
Object	The resulting geometry.

`touches(second_geometry)`

Specifies whether 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.

Possible touches relationships

Name	Explanation	Data type
second_geometry	A second geometry.	Object

Return value

Data type	Explanation
Boolean	Returns whether the boundaries of the geometries intersect.

`union(other)`

Constructs the geometry that is the set-theoretic union of the input geometries.

The two geometries must have the same shape type.

The result is a single geometry that is the combination of both input geometries. Anything within either of the input geometries will be part of the result. However, anything that is common to both geometries will only exist once in the result.

The order of the input geometries has no effect on the output.

Union operator

Name	Explanation	Data type
other	The second geometry.	Object

Return value

Data type	Explanation
Object	The resulting geometry.

`within(second_geometry, {relation})`

Specifies whether the base geometry is within the comparison geometry.

The within method is the opposite operator of the contains method.

Only True relationships are shown in this illustration.

Possible within relationships

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. The within method is a Clementini operator, except in the case of an empty base geometry.

Name Explanation Data type

second_geometry

A second geometry.

Object

relation

(Optional)

Specifies the spatial relationship type that will be used.

BOUNDARY—The relationship has no restrictions for interiors or boundaries.
CLEMENTINI—Interiors of geometries must intersect. This option 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	Returns whether the base geometry is within the comparison geometry.

Code sample

Geometry example

When you set the output parameter of a geoprocessing tool to an empty Geometry object, the tool will return a list of Geometry objects.

import arcpy

# Run the Copy Features tool, setting the output to the geometry object.
# geometries is returned as a list of geometry objects.
geometries = arcpy.management.CopyFeatures("c:/data/streets.shp",
                                           arcpy.Geometry())

# Walk through each geometry, totaling the length
length = 0
for geometry in geometries:
    length += geometry.length

print("Total length: {0}".format(length))

Geometry

Summary

Discussion

Syntax

Properties

Tip:

Caution:

Caution:

Methods

angleAndDistanceTo(other, {method})

Return value

boundary()

Return value

buffer(distance)

Return value

clip(envelope)

Return value

contains(second_geometry, {relation})

Return value

convexHull()

Return value

crosses(second_geometry)

Return value

cut(cutter)

Return value

densify(method, distance, {deviation})

Return value

difference(other)

Return value

disjoint(second_geometry)

Return value

distanceTo(other)

Return value

equals(second_geometry)

Return value

generalize(max_offset)

Return value

getArea({method}, {units})

Return value

getLength({method}, {units})

Return value

getPart({index})

Return value

intersect(other, dimension)

Return value

measureOnLine(in_point, {use_percentage})

Return value

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

Return value

overlaps(second_geometry)

Return value

pointFromAngleAndDistance(angle, distance, {method})

Return value

positionAlongLine(value, {use_percentage}, {geodesic})

Note:

Return value

projectAs(spatial_reference, {transformation_name})

Return value

queryPointAndDistance(in_point, {as_percentage})

Return value

rotate({origin}, {rotation_angle})

Return value

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

Return value

segmentAlongLine(start_measure, end_measure, {use_percentage})

Return value

snapToLine(in_point)

Return value

symmetricDifference(other)

Return value

touches(second_geometry)

Return value

union(other)

Return value

within(second_geometry, {relation})

Return value

Code sample

Related topics

`angleAndDistanceTo(other, {method})`

`boundary()`

`buffer(distance)`

`clip(envelope)`

`contains(second_geometry, {relation})`

`convexHull()`

`crosses(second_geometry)`

`cut(cutter)`

`densify(method, distance, {deviation})`

`difference(other)`

`disjoint(second_geometry)`

`distanceTo(other)`

`equals(second_geometry)`

`generalize(max_offset)`

`getArea({method}, {units})`

`getLength({method}, {units})`

`getPart({index})`

`intersect(other, dimension)`

`measureOnLine(in_point, {use_percentage})`

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

`overlaps(second_geometry)`

`pointFromAngleAndDistance(angle, distance, {method})`

`positionAlongLine(value, {use_percentage}, {geodesic})`

`projectAs(spatial_reference, {transformation_name})`

`queryPointAndDistance(in_point, {as_percentage})`

`rotate({origin}, {rotation_angle})`

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

`segmentAlongLine(start_measure, end_measure, {use_percentage})`

`snapToLine(in_point)`

`symmetricDifference(other)`

`touches(second_geometry)`

`union(other)`

`within(second_geometry, {relation})`