com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class Trend

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.Trend

All Implemented Interfaces:

GPTool

public class Trend
extends AbstractGPTool

Interpolates a surface from points using a trend technique. The Trend tool is contained in the 3D Analyst Tools tool box.
Learn more about how Trend works

Software restrictions: none

Usage tips:

• As the order of the polynomial is increased, the surface being fitted becomes progressively more complex. A higher-order polynomial will not always generate the most accurate surface; it is dependent on the data.
• The optional RMS file output contains information on the RMS (root mean square) error of the interpolation. This information can be used to determine the best value to use for the polynomial order, by changing the order value until you get the lowest RMS error. See How Trend works; for information on the RMS file.
• For the LOGISTIC option of Type of Regression, the z-value field of input point features should have codes of zero and one.
• Some input datasets may have several points with the same X,Y coordinates. If the values of the points at the common location are the same, they are considered duplicates and have no affect on the output. If the values are different, they are considered 'coincident' points. Interpolation functions may handle this data condition differently, in some cases using the first coincident point encountered for the calculation, or sometimes the last. This may cause some locations in the output raster to have different values than what you might expect. The solution is to prepare your data by removing these coincident points.
• The following environment settings affect this tool:

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

Trend()
Creates the Trend tool with defaults.

Trend(Object inPointFeatures, Object zField, Object outRaster)
Creates the Trend tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInPointFeatures() Returns the Input point features parameter of this tool .
int	getOrder() Returns the Polynomial order parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
Object	getOutRmsFile() Returns the Output RMS file parameter of this tool .
String	getRegressionType() Returns the Type of regression parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
Object	getZField() Returns the Z value field parameter of this tool .
void	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input point features parameter of this tool .
void	setOrder(int order) Sets the Polynomial order parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setOutRmsFile(Object outRmsFile) Sets the Output RMS file parameter of this tool .
void	setRegressionType(String regressionType) Sets the Type of regression parameter of this tool .
void	setZField(Object zField) Sets the Z value field parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Trend

public Trend()

Creates the Trend tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

Trend

public Trend(Object inPointFeatures,
             Object zField,
             Object outRaster)

Creates the Trend 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:

inPointFeatures - Composite Geodataset, the input point features containing z-values to be interpolated into a surface raster.

zField - Field, if the regression type is Logistic, the values in the field can only be 0 or 1.

outRaster - Raster Dataset, the output raster surface to be created.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features containing z-values to be interpolated into a surface raster. This is a required parameter.

Returns:

the Input point features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features containing z-values to be interpolated into a surface raster. This is a required parameter.

Parameters:

inPointFeatures - Composite Geodataset, the input point features containing z-values to be interpolated into a surface raster.

getZField

public Object getZField()

Returns the Z value field parameter of this tool . This parameter is Field, if the regression type is Logistic, the values in the field can only be 0 or 1. This is a required parameter.

Returns:

the Z value field

setZField

public void setZField(Object zField)

Sets the Z value field parameter of this tool . This parameter is Field, if the regression type is Logistic, the values in the field can only be 0 or 1. This is a required parameter.

Parameters:

zField - Field, if the regression type is Logistic, the values in the field can only be 0 or 1.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the output raster surface to be created. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the output raster surface to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the output raster surface to be created.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, this will be the value in the environment if it is explicitly set. Otherwise, it is the shorter of the width or the height of the extent of in_point_features in the input spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, this will be the value in the environment if it is explicitly set. Otherwise, it is the shorter of the width or the height of the extent of in_point_features in the input spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - Analysis cell size, this will be the value in the environment if it is explicitly set. Otherwise, it is the shorter of the width or the height of the extent of in_point_features in the input spatial reference, divided by 250.

getOrder

public int getOrder()

Returns the Polynomial order parameter of this tool . This parameter is Long, this must be an integer between 1 and 12. A value of 1 will fit a flat plane to the points, and a higher value will fit a more complex surface. The default is 1. This is an optional parameter.

Returns:

the Polynomial order

setOrder

public void setOrder(int order)

Sets the Polynomial order parameter of this tool . This parameter is Long, this must be an integer between 1 and 12. A value of 1 will fit a flat plane to the points, and a higher value will fit a more complex surface. The default is 1. This is an optional parameter.

Parameters:

order - Long, this must be an integer between 1 and 12. A value of 1 will fit a flat plane to the points, and a higher value will fit a more complex surface. The default is 1.

getRegressionType

public String getRegressionType()

Returns the Type of regression parameter of this tool . This parameter is String, the type of regression to be performed. This is an optional parameter.

Returns:

the Type of regression

setRegressionType

public void setRegressionType(String regressionType)

Sets the Type of regression parameter of this tool . This parameter is String, the type of regression to be performed. This is an optional parameter.

Parameters:

regressionType - String, the type of regression to be performed.

getOutRmsFile

public Object getOutRmsFile()

Returns the Output RMS file parameter of this tool . This parameter is File, the extension must be ".txt". This is an optional parameter.

Returns:

the Output RMS file

setOutRmsFile

public void setOutRmsFile(Object outRmsFile)

Sets the Output RMS file parameter of this tool . This parameter is File, the extension must be ".txt". This is an optional parameter.

Parameters:

outRmsFile - File, the extension must be ".txt".

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias