com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class BuildSeamlines

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.BuildSeamlines

All Implemented Interfaces:

GPTool

public class BuildSeamlines
extends AbstractGPTool

Automatically generates seamlines for your mosaic dataset. The Build Seamlines tool is contained in the Data Management Tools tool box.

Usage tips:

• You cannot build seamlines for a referenced mosaic dataset.

Field Summary

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

vals

Constructor Summary

BuildSeamlines()
Creates the Build Seamlines tool with defaults.

BuildSeamlines(Object inMosaicDataset, String sortMethod)
Creates the Build Seamlines tool with the required parameters.

Method Summary

double	getCellSize() Returns the Cell Size parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
Object	getOrderByAttribute() Returns the Sort Attribute parameter of this tool .
double	getOrderByBaseValue() Returns the Sort Base Value parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
String	getSortMethod() Returns the Sort Method parameter of this tool .
String	getSortOrder() Returns the Sort Ascending 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	getViewPoint() Returns the View Point parameter of this tool .
void	setCellSize(double cellSize) Sets the Cell Size parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setOrderByAttribute(Object orderByAttribute) Sets the Sort Attribute parameter of this tool .
void	setOrderByBaseValue(double orderByBaseValue) Sets the Sort Base Value parameter of this tool .
void	setSortMethod(String sortMethod) Sets the Sort Method parameter of this tool .
void	setSortOrder(String sortOrder) Sets the Sort Ascending parameter of this tool .
void	setViewPoint(Object viewPoint) Sets the View Point 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

BuildSeamlines

public BuildSeamlines()

Creates the Build Seamlines tool with defaults.

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

BuildSeamlines

public BuildSeamlines(Object inMosaicDataset,
                      String sortMethod)

Creates the Build Seamlines 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:

inMosaicDataset - path and name of the mosaic dataset.

sortMethod - the sort method is similar to the mosaic method, in it defines the order in which the rasters will be fused together to generate the image used to create the seamlines.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is path and name of the mosaic dataset. This is a required parameter.

Returns:

the Mosaic Dataset

setInMosaicDataset

public void setInMosaicDataset(Object inMosaicDataset)

Sets the Mosaic Dataset parameter of this tool . This parameter is path and name of the mosaic dataset. This is a required parameter.

Parameters:

inMosaicDataset - path and name of the mosaic dataset.

getCellSize

public double getCellSize()

Returns the Cell Size parameter of this tool . This parameter is the cell size affects the granularity at which the seamlines will be calculated. this can affect the length of time it takes to generate the seamline. If this value is the same as the raster's cell size it will take longer, than if it is set to a larger cell size. This is an optional parameter.

Returns:

the Cell Size

setCellSize

public void setCellSize(double cellSize)

Sets the Cell Size parameter of this tool . This parameter is the cell size affects the granularity at which the seamlines will be calculated. this can affect the length of time it takes to generate the seamline. If this value is the same as the raster's cell size it will take longer, than if it is set to a larger cell size. This is an optional parameter.

Parameters:

cellSize - the cell size affects the granularity at which the seamlines will be calculated. this can affect the length of time it takes to generate the seamline. If this value is the same as the raster's cell size it will take longer, than if it is set to a larger cell size.

getSortMethod

public String getSortMethod()

Returns the Sort Method parameter of this tool . This parameter is the sort method is similar to the mosaic method, in it defines the order in which the rasters will be fused together to generate the image used to create the seamlines. This is a required parameter.

Returns:

the Sort Method

setSortMethod

public void setSortMethod(String sortMethod)

Sets the Sort Method parameter of this tool . This parameter is the sort method is similar to the mosaic method, in it defines the order in which the rasters will be fused together to generate the image used to create the seamlines. This is a required parameter.

Parameters:

sortMethod - the sort method is similar to the mosaic method, in it defines the order in which the rasters will be fused together to generate the image used to create the seamlines.

getSortOrder

public String getSortOrder()

Returns the Sort Ascending parameter of this tool . This parameter is when using the ATTRIBUTE sort method, the rasters will be sorted in an ascending order as defined by the Sort Attribute. This is an optional parameter.

Returns:

the Sort Ascending

setSortOrder

public void setSortOrder(String sortOrder)

Sets the Sort Ascending parameter of this tool . This parameter is when using the ATTRIBUTE sort method, the rasters will be sorted in an ascending order as defined by the Sort Attribute. This is an optional parameter.

Parameters:

sortOrder - when using the ATTRIBUTE sort method, the rasters will be sorted in an ascending order as defined by the Sort Attribute.

getOrderByAttribute

public Object getOrderByAttribute()

Returns the Sort Attribute parameter of this tool . This parameter is the attribute fielded to order rasters when the sort method is ATTRIBUTE. The default attribute is ObjectID. This is an optional parameter.

Returns:

the Sort Attribute

setOrderByAttribute

public void setOrderByAttribute(Object orderByAttribute)

Sets the Sort Attribute parameter of this tool . This parameter is the attribute fielded to order rasters when the sort method is ATTRIBUTE. The default attribute is ObjectID. This is an optional parameter.

Parameters:

orderByAttribute - the attribute fielded to order rasters when the sort method is ATTRIBUTE. The default attribute is ObjectID.

getOrderByBaseValue

public double getOrderByBaseValue()

Returns the Sort Base Value parameter of this tool . This parameter is the rasters are sorted based on the difference between their value and this value from the Sort Attribute field. This is an optional parameter.

Returns:

the Sort Base Value

setOrderByBaseValue

public void setOrderByBaseValue(double orderByBaseValue)

Sets the Sort Base Value parameter of this tool . This parameter is the rasters are sorted based on the difference between their value and this value from the Sort Attribute field. This is an optional parameter.

Parameters:

orderByBaseValue - the rasters are sorted based on the difference between their value and this value from the Sort Attribute field.

getViewPoint

public Object getViewPoint()

Returns the View Point parameter of this tool . This parameter is the coordinate location to use when the sort method is VIEW_POINT. This is an optional parameter.

Returns:

the View Point

setViewPoint

public void setViewPoint(Object viewPoint)

Sets the View Point parameter of this tool . This parameter is the coordinate location to use when the sort method is VIEW_POINT. This is an optional parameter.

Parameters:

viewPoint - the coordinate location to use when the sort method is VIEW_POINT.

getOutMosaicDataset

public Object getOutMosaicDataset()

Returns the Mosaic Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Mosaic Dataset

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