The Filter by extent tool returns a subset of a dataset based on a specified spatial extent. The output is a new dataset containing only the records that are geographically within the specified extent.
Examples
The Filter by extent tool can be used in scenarios such as the following:
- You want to exclude points that are outside of the study area, so you filter the input dataset by the extent of the study area dataset.
- You have a nationwide dataset and you want to create subsets of the data for specific extents.
Parameters
The following table outlines the parameters used in the Filter by extent tool:
| Parameter | Description |
|---|---|
Input dataset | The dataset to be filtered. |
Geometry | The geometry field from the input dataset containing the locations that will be filtered. |
Extent type | Specifies the type of extent that will be used for filtering. You can specify x- and y-values or use the extent of another dataset. |
X min | The minimum x-value of the extent to filter by. This is also referred to as the left of an extent. |
Y min | The minimum y-value of the extent to filter by. This is also referred to as the bottom of an extent. |
X max | The maximum x-value of the extent to filter by. This is also referred to as the right of an extent. |
Y max | The maximum y-value of the extent to filter by. This is also referred to as the top of an extent. |
Extent dataset | The dataset that contains the geometry field representing the extent that will be used to filter. |
Extent geometry | The geometry field from the extent dataset. The extent of this geometry will be used to filter records from the input dataset. |
Usage notes
Use the Input dataset parameter to identify the dataset to be filtered.
Use the Extent type parameter to specify the type of extent that will be used for filtering. The options are as follows:
- Define an extent—Filter the input dataset to a specified extent using x- and y-values. To specify the extent values, use the X min, Y min, X max, and Y max parameters.
- Use the extent of another dataset—Filter the input dataset using the extent of another dataset. Use the Extent dataset and Extent geometry parameters to select the geometry field with the appropriate extent.
If you choose Define an extent, the input extent values will be in the same unit as the coordinate system of the input dataset. The following examples describe how to specify extent values:
- If the dataset is in a projected coordinate system that uses linear units of feet, use extent values represented as feet. For example, if the input dataset has a spatial reference of NAD 1983 State Plane California V FIPS 0405 (US Feet), specify the following values: X min of 6500000.5, Y min of 1700000.8, X max of 6700000.1, and Y max of 1900000.3.
- If the input dataset is in a geographic coordinate system that uses angular units of degrees, such as WGS84, specify the following values: X min of -180.0, Y min of -90.0, X max of 180.0, and Y max of 90.0.
If the spatial references differ between the input geometry field and the extent layer geometry field, the extent geometry will be projected to the spatial reference of the input geometry.
Outputs
The tool output includes a dataset containing only the records that fall within the specific extent. The output dataset will contain all fields from the input dataset.
Limitations
The following are known limitations of the Filter by extent tool:
- The tool only returns a single dataset, which contains the records within the extent. The records outside of the extent will be excluded from results.
- If the extent values specified are not in the same unit as the coordinate system for the input dataset, no records will be returned.
- Input records with no spatial location, such as null values, will not be included in the result.
Licensing requirements
The following licensing and configurations are required:
- Creator or Professional user type
- Publisher, Facilitator, or Administrator role, or an equivalent custom role
To learn more about Data Pipelines requirements, see Requirements.