| Label | Explanation | Data Type |
Contour Features
| The polyline feature layer that contains the contours. The information for the output bands will be derived from these features. | Feature Layer |
Elevation Field
| The field in the Contour Features feature layer from which the elevation values will be derived. | Field |
Area of Interest
| The AOI for the area where the elevation bands will be created. The AOI is typically stored in an index feature class that contains the extents for standard map sheets. A single feature must be selected on the feature class that is specified. | Layer |
Output Feature Class
| The feature class that will contain the banding features. | Feature Class |
Exclusion Features
(Optional) | The feature layers that define areas where bands will not be created. | Feature Layer |
Product
(Optional) | A supported map product, which determines the values for the Band Values parameter unless Custom is specified for this parameter. If left blank, at least one pair of Low and High parameter values is required.
| String |
Band Interval (Optional) | The interval specified when the band interval type is regular. This parameter is only available when Custom is specified as the Product parameter value. | Long |
Band Values
(Optional) | The low and high values in the bands that will be created. These values will be populated automatically from an .xml file if a particular product is specified for the Product parameter value; however, these values must be provided manually if Custom is specified for the Product parameter value and at least one pair of Low and High values is required. If no product is specified, at least one pair of Low and High values is still required. | Value Table |
Summary
Generates band features that represent elevation levels on a map product. The tool can be run with set values from standardized product specifications or with custom-defined values.
Illustration
Usage
The Area of Interest layer must have only one feature selected.
Use a Contour Features parameter value that has been collected using meters or feet.
The Output Feature Class parameter value will contain the following fields:
- Low_Value
- High_Value
- TintBand
ArcGIS Pro JOG, TPC, and ONC database product files have been updated with these appropriate fields. The BM datasets are JOG_BANDS_A, TPC_BANDS_A, and ONC_BANDS_A, respectively.
You can specify a Band Interval parameter value to create bands at regular intervals such as every 500 meters, or you can specify irregular intervals, but not both. If a Band Interval parameter value is specified, the Band Values parameter will be inactive.
If a standard product such as JOG-A, TPC, or ONC is specified for the Product parameter, the standard ranges defined by the product specification will be automatically populated for the Band Values parameter. Bands can be added or removed as required.
If Custom is specified for the Product parameter, the Band Values parameter values must also be specified.
If a band interval is specified, the resulting band polygons will be created based on the interval, starting with 0. For example, if the input contours are in meters and the value for the Band Interval parameter is set to 500, the output bands will be created from 0 to 500 meters, then 500 to 1,000 meters, and so on.
If the band values specified do not fully cover the range of elevations in the selected Area of Interest (AOI), no bands will be created over those areas. For example, if Band 1 is defined as 500 to 750 meters and Band 2 is defined as 750 to 1250 meters, but the elevation range in the specified AOI is 300 to 1500 meters, no elevation bands will be created for contour-bounded areas less than 500 meters or higher than 1250 meters.
-
The specified Band Interval parameter value or the resulting interval from specifying Low and High values for the Band Values parameter, must be divisible by the contour interval to ensure that the Output Feature Class parameter value isn't missing bands.
The generated bands will cover the extent of both the Contour Features and Exclusion Features parameter values to avoid gaps. If the Exclusion Features parameter value is not specified, the extent of the contour lines will set the bounds of the generated bands.
Ensure that contours cover the entire AOI specified in the Area of Interest parameter. Open contour lines must extend up to or beyond the specified AOI.
Remove any intersecting contour lines from the Contour Features parameter value before running the tool; otherwise, the tool will report an error.
The contour lines specified for the Contour Features parameter should be continuous. Use the Merge Lines By Pseudo Node tool to merge line features with matching attribute values.
Parameters
arcpy.topographic.GenerateElevationBandsFromFeatures(contour_features, elevation_field, area_of_interest, out_feature_class, {exclusion_features}, {product}, {band_interval}, {band_values})| Name | Explanation | Data Type |
contour_features | The polyline feature layer that contains the contours. The information for the output bands will be derived from these features. | Feature Layer |
elevation_field | The field in the contour_features feature layer from which the elevation values will be derived. | Field |
area_of_interest | The AOI for the area where the elevation bands will be created. The AOI is typically stored in an index feature class that contains the extents for standard map sheets. A single feature must be selected on the feature class that is specified. | Layer |
out_feature_class | The feature class that will contain the banding features. | Feature Class |
exclusion_features [exclusion_features,...] (Optional) | The feature layers that define areas where bands will not be created. | Feature Layer |
product (Optional) | A supported map product, which determines the values for the band_values parameter unless Custom is specified for this parameter. If left blank, at least one pair of Low and High parameter values is required.
| String |
band_interval (Optional) | The interval specified when the band interval type is regular. This parameter is only available when Custom is specified as the product parameter value. | Long |
band_values [band_values,...] (Optional) | The low and high values in the bands that will be created. These values will be populated automatically from an .xml file if a particular product is specified for the product parameter value; however, these values must be provided manually if Custom is specified for the product parameter value and at least one pair of Low and High values is required. If no product is specified, at least one pair of Low and High values is still required. | Value Table |
Code sample
The following code sample demonstrates how to use the GenerateElevationBandsFromFeatures function.
# Name: GenerateElevationBandsFromFeatures_sample.py
# Description: Generates band features used to represent different elevation levels on a JOG-A product.
# Import System Modules
import arcpy
# Check Out Extensions
arcpy.CheckOutExtension('Foundation')
# Setting the environment
arcpy.env.overwriteOutput = True
# Make Feature Layer for Area of Interest
arcpy.management.MakeFeatureLayer(r'C:\Users\Public\Documents\ArcGIS Defense Mapping\Product Files\2.9\ReferenceData\MapIndex.gdb\Reference\GRID_1_DEGREE', 'JOG_Layer')
# Select Area of Interest Feature
arcpy.management.SelectLayerByAttribute('JOG_Layer', 'NEW_SELECTION', "CID = '34N120W'")
# Setting Local Variables
contour_features = r'C:\Data\JOG.gdb\BM\HypsographyCrv'
elevation_field = 'ZVH'
area_of_interest = 'JOG_Layer'
out_feature_class = r'C:\Data\JOG.gdb\BM\JOG_BANDS_A'
exclusion_features = r'C:\Data\JOG.gdb\BM\HydrographySrf'
product = 'JOG-A'
band_interval = ''
band_values = '0 1315;1315 1970;1970 5250;5250 9190;9190 12470;12470 29200'
# Use the Generate Elevation Bands From Features tool to generate band features for JOG-A product
arcpy.topographic.GenerateElevationBandsFromFeatures(contour_features, elevation_field, area_of_interest, out_feature_class, exclusion_features, product, band_interval, band_values)
# Check In Extensions
arcpy.CheckInExtension('Foundation')Environments
Licensing information
- Basic: No
- Standard: No
- Advanced: Requires Production Mapping