com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class Near3D
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.analyst3dtools.Near3D
- All Implemented Interfaces:
- GPTool
public class Near3D
- extends AbstractGPTool
Determines the distance from each feature in the input features to the nearest features in the near features, within the search radius.
The Near 3D tool is contained in the 3D Analyst Tools tool box.
Usage tips:
- The input feature class and the near feature class(es) can be any simple geometry type. They must all have z values.
- The Near Features can include one or more feature classes of different shape types.
- The Near Features can be the same dataset as the Input Features. When an input feature's nearest Near Feature is itself (distance is 0), this feature is ignored and the next nearest feature is found.
- The basic difference between the tool and the Near 3D tool
is that the Near 3D tool works with 3D features instead of 2D
features. Furthermore, the distances which are compared by the Near
3D tool are the 3D (slope) distances, rather than the horizontal
distances. A number of additional fields can be output as well.
- The angle fields will only be created/populated if you check the Angle checkbox.
- The Input Features can be a layer on which you have performed a selection. The selected features will be used during the execution of the tool.
- The Near tool adds a number of analysis fields to the Input Features attribute table (if the field already exists, the value is updated). These include:
- The values for NEAR_FID, NEAR_DIST and NEAR_DIST3 will be -1 if no match is found within the Search Radius.
- The NEAR_DELTX, NEAR_DELTY, and NEAR_DELTZ fields will only be created/populated if you check the Delta checkbox.
- The NEAR_FROMX, NEAR_FROMY, NEAR_FROMZ, NEAR_X, NEAR_Y, and NEAR_Z fields will only be created/populated if you check the Location checkbox.
|
Constructor Summary |
Near3D()
Creates the Near 3D tool with defaults. |
Near3D(java.lang.Object inFeatures,
java.lang.Object nearFeatures)
Creates the Near 3D tool with the required parameters. |
|
Method Summary |
java.lang.String |
getAngle()
Returns the Angle parameter of this tool . |
java.lang.String |
getDelta()
Returns the Delta parameter of this tool . |
java.lang.Object |
getInFeatures()
Returns the Input Features parameter of this tool . |
java.lang.String |
getLocation()
Returns the Location parameter of this tool . |
java.lang.Object |
getNearFeatures()
Returns the Near Features parameter of this tool . |
java.lang.Object |
getOutFeatureClass()
Returns the Output Feature Class parameter of this tool (Read only). |
java.lang.Object |
getSearchRadius()
Returns the Search Radius parameter of this tool . |
java.lang.String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
java.lang.String |
getToolboxName()
Returns the name of the tool box containing this tool. |
java.lang.String |
getToolName()
Returns the name of this tool. |
void |
setAngle(java.lang.String angle)
Sets the Angle parameter of this tool . |
void |
setDelta(java.lang.String delta)
Sets the Delta parameter of this tool . |
void |
setInFeatures(java.lang.Object inFeatures)
Sets the Input Features parameter of this tool . |
void |
setLocation(java.lang.String location)
Sets the Location parameter of this tool . |
void |
setNearFeatures(java.lang.Object nearFeatures)
Sets the Near Features parameter of this tool . |
void |
setSearchRadius(java.lang.Object searchRadius)
Sets the Search Radius parameter of this tool . |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Near3D
public Near3D()
- Creates the Near 3D tool with defaults.
Initializes the array of tool parameters with the default values specified when the tool was created.
Near3D
public Near3D(java.lang.Object inFeatures,
java.lang.Object nearFeatures)
- Creates the Near 3D tool with the required parameters.
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
- Parameters:
inFeatures - the input feature class or layer containing features from which distances are calculated to each feature in the Near Features.nearFeatures - the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the input feature class to identify which near feature class contains the closest feature.
getInFeatures
public java.lang.Object getInFeatures()
- Returns the Input Features parameter of this tool .
This parameter is the input feature class or layer containing features from which distances are calculated to each feature in the Near Features.
This is a required parameter.
- Returns:
- the Input Features
setInFeatures
public void setInFeatures(java.lang.Object inFeatures)
- Sets the Input Features parameter of this tool .
This parameter is the input feature class or layer containing features from which distances are calculated to each feature in the Near Features.
This is a required parameter.
- Parameters:
inFeatures - the input feature class or layer containing features from which distances are calculated to each feature in the Near Features.
getNearFeatures
public java.lang.Object getNearFeatures()
- Returns the Near Features parameter of this tool .
This parameter is the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the input feature class to identify which near feature class contains the closest feature.
This is a required parameter.
- Returns:
- the Near Features
setNearFeatures
public void setNearFeatures(java.lang.Object nearFeatures)
- Sets the Near Features parameter of this tool .
This parameter is the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the input feature class to identify which near feature class contains the closest feature.
This is a required parameter.
- Parameters:
nearFeatures - the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the input feature class to identify which near feature class contains the closest feature.
getSearchRadius
public java.lang.Object getSearchRadius()
- Returns the Search Radius parameter of this tool .
This parameter is the maximum distance between Input Features and Near Features for which distance and FID will be determined. If no Search Radius is specified, all Near Features will be used.
This is an optional parameter.
- Returns:
- the Search Radius
setSearchRadius
public void setSearchRadius(java.lang.Object searchRadius)
- Sets the Search Radius parameter of this tool .
This parameter is the maximum distance between Input Features and Near Features for which distance and FID will be determined. If no Search Radius is specified, all Near Features will be used.
This is an optional parameter.
- Parameters:
searchRadius - the maximum distance between Input Features and Near Features for which distance and FID will be determined. If no Search Radius is specified, all Near Features will be used.
getLocation
public java.lang.String getLocation()
- Returns the Location parameter of this tool .
This parameter is determines whether six coordinate fields (two sets of x,y,z values) are added to each input feature. The values are the three coordinates of the input feature (NEAR_FROMX, NEAR_FROMY, NEAR_FROMZ), and the three coordinates of the nearest feature (NEAR_X, NEAR_Y, NEAR_Z). The fields NEAR_FID and NEAR_DIST are always added, regardless of the Location option.
This is an optional parameter.
- Returns:
- the Location
setLocation
public void setLocation(java.lang.String location)
- Sets the Location parameter of this tool .
This parameter is determines whether six coordinate fields (two sets of x,y,z values) are added to each input feature. The values are the three coordinates of the input feature (NEAR_FROMX, NEAR_FROMY, NEAR_FROMZ), and the three coordinates of the nearest feature (NEAR_X, NEAR_Y, NEAR_Z). The fields NEAR_FID and NEAR_DIST are always added, regardless of the Location option.
This is an optional parameter.
- Parameters:
location - determines whether six coordinate fields (two sets of x,y,z values) are added to each input feature. The values are the three coordinates of the input feature (NEAR_FROMX, NEAR_FROMY, NEAR_FROMZ), and the three coordinates of the nearest feature (NEAR_X, NEAR_Y, NEAR_Z). The fields NEAR_FID and NEAR_DIST are always added, regardless of the Location option.
getAngle
public java.lang.String getAngle()
- Returns the Angle parameter of this tool .
This parameter is determines whether the angles between the input feature and the nearest near feature will be calculated, and stored into the NEAR_ANG_H and NEAR_ANG_V fields. Both angle values are in degrees, where one degree represents 1/360 of a circle, and fractions of a degree are represented as decimal points. Horizontal angles are measured from 180° to -180°; 0° to the east, 90° to the north, 180° (-180°) to the west, and -90° to the south. Vertical angles are zero for horizontal, 90° for straight up, and -90° for straight down.
This is an optional parameter.
- Returns:
- the Angle
setAngle
public void setAngle(java.lang.String angle)
- Sets the Angle parameter of this tool .
This parameter is determines whether the angles between the input feature and the nearest near feature will be calculated, and stored into the NEAR_ANG_H and NEAR_ANG_V fields. Both angle values are in degrees, where one degree represents 1/360 of a circle, and fractions of a degree are represented as decimal points. Horizontal angles are measured from 180° to -180°; 0° to the east, 90° to the north, 180° (-180°) to the west, and -90° to the south. Vertical angles are zero for horizontal, 90° for straight up, and -90° for straight down.
This is an optional parameter.
- Parameters:
angle - determines whether the angles between the input feature and the nearest near feature will be calculated, and stored into the NEAR_ANG_H and NEAR_ANG_V fields. Both angle values are in degrees, where one degree represents 1/360 of a circle, and fractions of a degree are represented as decimal points. Horizontal angles are measured from 180° to -180°; 0° to the east, 90° to the north, 180° (-180°) to the west, and -90° to the south. Vertical angles are zero for horizontal, 90° for straight up, and -90° for straight down.
getDelta
public java.lang.String getDelta()
- Returns the Delta parameter of this tool .
This parameter is determines whether the distances along the primary axes between the input feature and the nearest near feature will be calculated, and stored into the NEAR_DELTX, NEAR_DELTY, and NEAR_DELTZ fields.
This is an optional parameter.
- Returns:
- the Delta
setDelta
public void setDelta(java.lang.String delta)
- Sets the Delta parameter of this tool .
This parameter is determines whether the distances along the primary axes between the input feature and the nearest near feature will be calculated, and stored into the NEAR_DELTX, NEAR_DELTY, and NEAR_DELTZ fields.
This is an optional parameter.
- Parameters:
delta - determines whether the distances along the primary axes between the input feature and the nearest near feature will be calculated, and stored into the NEAR_DELTX, NEAR_DELTY, and NEAR_DELTZ fields.
getOutFeatureClass
public java.lang.Object getOutFeatureClass()
- Returns the Output Feature Class parameter of this tool (Read only).
This is an derived parameter.
- Returns:
- the Output Feature Class
getToolName
public java.lang.String getToolName()
- Returns the name of this tool.
- Returns:
- the tool name
getToolboxName
public java.lang.String getToolboxName()
- Returns the name of the tool box containing this tool.
- Returns:
- the tool box name
getToolboxAlias
public java.lang.String getToolboxAlias()
- Returns the alias of the tool box containing this tool.
- Returns:
- the tool box alias