Pairwise Clip (Analysis)

Summary

Extracts input features that overlay the clip features.

Use this tool to cut out a piece of one feature class using one or more of the features in 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 area of interest (AOI)—that contains a geographic subset of the features in another, larger feature class.

An alternate tool is available for vector data clip operations. See the Clip tools for details.

Illustration

Usage

• The Clip Features parameter values can be points, lines, or polygons, depending on the geometry type of the Input Features parameter value.

  • When the Input Features parameter value is polygon, the Clip Features parameter value must also be polygon.
  • When the Input Features parameter value is line, the Clip Features parameter value can be line or polygon. When clipping line features with line features, only the coincident lines or line segments will be written to the output, as shown in the image below.
  • When the Input Features parameter value is point, the Clip Features parameter value can be point, line, or polygon. When clipping point features with point features, only the coincident points will be written to the output, as shown in the image below. When clipping point features with line features, only the points that are coincident with the line features will be written to the output.

• The Output Feature Class parameter will contain all the attributes of the Input Features parameter.

• Line features clipped by polygon features:

  

• Point features clipped by polygon features:

  

• Line features clipped with line features:

  

• Point features clipped with point features:

  

• This tool honors the Parallel Processing Factor environment. If the environment is not set (the default) or is set to 100, full parallel processing will be enabled and the tool will attempt to distribute the work to all the logical cores on the machine. Setting the environment to 0 will disable parallel processing. Specifying a factor between 1 and 99 will cause the tool to identify the percentage of logical cores to use by applying the formula (Parallel Processing Factor / 100 * Logical Cores) rounded up to the nearest integer. If the result of this formula is 0 or 1, parallel processing will not be enabled.

Parameters

Dialog

Label	Explanation	Data Type
Input Features	The features to be clipped.	Feature Layer
Clip Features	The features to use to clip the input features.	Feature Layer
Output Feature Class	The feature class to be created.	Feature Class
XY Tolerance (Optional)	The minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in x or y (or both). Caution: Changing this parameter's value may cause failure or unexpected results. It is recommended that you do not modify this parameter. It has been removed from view on the tool dialog box. By default, the input feature class's spatial reference x,y tolerance property is used.	Linear Unit

Python

arcpy.analysis.PairwiseClip(in_features, clip_features, out_feature_class, {cluster_tolerance})

Name	Explanation	Data Type
in_features	The features to be clipped.	Feature Layer
clip_features	The features to use to clip the input features.	Feature Layer
out_feature_class	The feature class to be created.	Feature Class
cluster_tolerance (Optional)	The minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in x or y (or both). Caution: Changing this parameter's value may cause failure or unexpected results. It is recommended that you do not modify this parameter. It has been removed from view on the tool dialog box. By default, the input feature class's spatial reference x,y tolerance property is used.	Linear Unit

Code sample

PairwiseClip example 1 (Python window)

The following Python window script demonstrates how to use the PairwiseClip function in immediate mode.

import arcpy
arcpy.env.workspace = "C:/data"
arcpy.analysis.PairwiseClip("majorrds.shp", "study_quads.shp", 
                            "C:/output/studyarea.shp")

PairwiseClip example 2 (stand-alone script)

The following Python script demonstrates how to use the PairwiseClip function in a stand-alone script.

# Name: PairwiseClip_Example2.py
# Description: Clip major roads that fall within the study area. 

# Import system modules
import arcpy

# Set workspace
arcpy.env.workspace = "C:/data"

# Set local variables
in_features = "majorrds.shp"
clip_features = "study_quads.shp"
out_feature_class = "C:/output/studyarea.shp"

# Execute Pairwise Clip
arcpy.analysis.PairwiseClip(in_features, clip_features, out_feature_class)

Environments

Default Output Z Value, M Resolution, M Tolerance, Output CONFIG Keyword, Output M Domain, Output XY Domain, Output Z Domain, Output Coordinate System, Extent, Output has M values, Output has Z values, XY Resolution, XY Tolerance, Z Resolution, Z Tolerance, Parallel Processing Factor, Maintain Curve Segments, Transfer field domains, subtypes and attribute rules

Licensing information

• Basic: Yes
• Standard: Yes
• Advanced: Yes