Skip To Content

Clip Layer

Summary

Extracts input features from within specified polygons.

Illustration

Clip Layer workflow diagram

Usage

  • Use this tool to cut out a piece of a feature class using one or more of the features from another feature class as a cookie cutter. This is particularly useful for creating a new feature class—also referred to as a study area or an area of interest (AOI)—that contains a geographic subset of the features from another, larger feature class.

  • The output result will contain input layer features that overlay clip layer polygons.

  • All fields from the Input Layer parameter will be included in the output result. Fields from the Clip Layer parameter will not be included in the output.

  • Optionally set an extent to define the area of analysis.

    Learn more about setting an extent

  • This geoprocessing tool is powered by ArcGIS GeoAnalytics Server. Analysis is completed on your GeoAnalytics Server, and results are stored in your content in ArcGIS Enterprise.

  • When running GeoAnalytics Tools, the analysis is completed on the GeoAnalytics Tools. For optimal performance, data should be available to the GeoAnalytics Tools through feature layers hosted on your ArcGIS Enterprise portal or through big data file shares. Data that is not local to your GeoAnalytics Tools will be moved to your GeoAnalytics Tools before analysis begins. This means that it will take longer to run a tool, and in some cases, moving the data from ArcGIS Pro to your GeoAnalytics Tools may fail. The threshold for failure depends on your network speeds, as well as the size and complexity of the data. Therefore, it is recommended that you always share your data or create a big data file share.

    Learn more about sharing data to your portal

    Learn more about creating a big data file share through Server Manager

Syntax

ClipLayer_geoanalytics (input_layer, clip_layer, {output_name}, {data_store})
ParameterExplanationData Type
input_layer

The dataset containing the point, line, or polygon features to be clipped.

Feature Set
clip_layer

The dataset containing the polygon features used to clip the input features.

Record Set
output_name
(Optional)

The name of the output feature service.

String
data_store
(Optional)

Specifies the ArcGIS Data Store where the output will be saved. The default is SPATIOTEMPORAL_DATA_STORE. All results stored to the SPATIOTEMPORAL_DATA_STORE will be stored in WGS84. Results stored in a RELATIONAL_DATA_STORE will maintain their coordinate system.

  • SPATIOTEMPORAL_DATA_STOREOutput will be stored in a spatiotemporal big data store. This is the default.
  • RELATIONAL_DATA_STOREOutput will be stored in a relational data store.
String

Derived Output

NameExplanationData Type
output

The clipped output.

Record Set

Code sample

ClipLayer example (stand-alone script)

The following Python script demonstrates how to use the ClipLayer tool.

#-------------------------------------------------------------------------------
# Name: ClipLayer.py
# Description: Clip USA Rivers to the extent of state boundaries.
# Results can be found in your Portal

# Requirements: ArcGIS GeoAnalytics Server

# Import system modules
import arcpy

# Set local variables
clipFeatures = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA_Rivers/FeatureServer/0"
studyArea = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Nebraska_Boundary/FeatureServer/0"
outFS = "NebraskaRivers"
dataStore = "RELATIONAL_DATA_STORE"

# Execute Clip Layer
arcpy.geoanalytics.ClipLayer(clipFeatures, studyArea, outFS, dataStore)

Environments

Output Coordinate System

The coordinate system that will be used for analysis. Analysis will be completed on the input coordinate system unless specified by this parameter. For GeoAnalytics Tools, final results will be stored in the spatiotemporal data store in WGS84.

Licensing information

  • Basic: Requires ArcGIS GeoAnalytics Server
  • Standard: Requires ArcGIS GeoAnalytics Server
  • Advanced: Requires ArcGIS GeoAnalytics Server

Related topics