com.esri.arcgis.geoprocessing.tools.samples
Class WorkspaceToNewMosaic

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.samples.WorkspaceToNewMosaic

All Implemented Interfaces:

GPTool

public class WorkspaceToNewMosaic
extends AbstractGPTool

Creates a new raster dataset in the output location and mosaics all the raster datasets in the input workspace, or geodatabase, into it. The Workspace to New Mosaic tool is contained in the Samples tool box.

Usage tips:

• The input workspace should contain all the raster datasets you want to mosaic together. The inputs must have the same number of bands; otherwise, the tool will not run.
• If your output raster dataset is stored in the file system, you must specify the proper extension for the new raster dataset. Valid outputs to a file system raster dataset include ESRI GRID (no extension), ERDAS IMAGINE (.img), and TIFF (.tif).
• This sample tool was created using Python. The code can be viewed and edited, to help you write your own scripts.
• The Raster Analysis Environment Settings are not valid for this tool.

Field Summary

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

vals

Constructor Summary

WorkspaceToNewMosaic()
Creates the Workspace to New Mosaic tool with defaults.

WorkspaceToNewMosaic(Object inputWorkspace, Object outputLocation, String ouputRasterName)
Creates the Workspace to New Mosaic tool with the required parameters.

Method Summary

String	getColormapMode() Returns the Colormap Mode parameter of this tool .
String	getConfigKeyword() Returns the Config Keyword parameter of this tool .
String	getConvert1BitDataTo8Bit() Returns the Convert 1 bit data to 8 bit parameter of this tool .
Object	getDerivedRaster() Returns the Derived Raster parameter of this tool (Read only).
double	getIgnoreBackgroundValue() Returns the Ignore Background Value parameter of this tool .
Object	getInputWorkspace() Returns the Input Workspace parameter of this tool .
String	getMosaicMode() Returns the Mosaic Mode parameter of this tool .
double	getMosaicTolerance() Returns the Mosaic Tolerance parameter of this tool .
double	getNodataValue() Returns the Nodata Value parameter of this tool .
String	getOuputRasterName() Returns the Ouput Raster Name parameter of this tool .
Object	getOutputLocation() Returns the Output Location parameter of this tool .
Object	getPyramidOrigin() Returns the Pyramid Origin 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.
void	setColormapMode(String colormapMode) Sets the Colormap Mode parameter of this tool .
void	setConfigKeyword(String configKeyword) Sets the Config Keyword parameter of this tool .
void	setConvert1BitDataTo8Bit(String convert1BitDataTo8Bit) Sets the Convert 1 bit data to 8 bit parameter of this tool .
void	setIgnoreBackgroundValue(double ignoreBackgroundValue) Sets the Ignore Background Value parameter of this tool .
void	setInputWorkspace(Object inputWorkspace) Sets the Input Workspace parameter of this tool .
void	setMosaicMode(String mosaicMode) Sets the Mosaic Mode parameter of this tool .
void	setMosaicTolerance(double mosaicTolerance) Sets the Mosaic Tolerance parameter of this tool .
void	setNodataValue(double nodataValue) Sets the Nodata Value parameter of this tool .
void	setOuputRasterName(String ouputRasterName) Sets the Ouput Raster Name parameter of this tool .
void	setOutputLocation(Object outputLocation) Sets the Output Location parameter of this tool .
void	setPyramidOrigin(Object pyramidOrigin) Sets the Pyramid Origin 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

WorkspaceToNewMosaic

public WorkspaceToNewMosaic()

Creates the Workspace to New Mosaic tool with defaults.

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

WorkspaceToNewMosaic

public WorkspaceToNewMosaic(Object inputWorkspace,
                            Object outputLocation,
                            String ouputRasterName)

Creates the Workspace to New Mosaic 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:

inputWorkspace - null

outputLocation - null

ouputRasterName - null

Method Detail

getInputWorkspace

public Object getInputWorkspace()

Returns the Input Workspace parameter of this tool . This is a required parameter.

Returns:

the Input Workspace

setInputWorkspace

public void setInputWorkspace(Object inputWorkspace)

Sets the Input Workspace parameter of this tool . This is a required parameter.

Parameters:

inputWorkspace - null

getOutputLocation

public Object getOutputLocation()

Returns the Output Location parameter of this tool . This is a required parameter.

Returns:

the Output Location

setOutputLocation

public void setOutputLocation(Object outputLocation)

Sets the Output Location parameter of this tool . This is a required parameter.

Parameters:

outputLocation - null

getOuputRasterName

public String getOuputRasterName()

Returns the Ouput Raster Name parameter of this tool . This is a required parameter.

Returns:

the Ouput Raster Name

setOuputRasterName

public void setOuputRasterName(String ouputRasterName)

Sets the Ouput Raster Name parameter of this tool . This is a required parameter.

Parameters:

ouputRasterName - null

getConfigKeyword

public String getConfigKeyword()

Returns the Config Keyword parameter of this tool . This is an optional parameter.

Returns:

the Config Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)

Sets the Config Keyword parameter of this tool . This is an optional parameter.

Parameters:

configKeyword - null

getMosaicMode

public String getMosaicMode()

Returns the Mosaic Mode parameter of this tool . This is an optional parameter.

Returns:

the Mosaic Mode

setMosaicMode

public void setMosaicMode(String mosaicMode)

Sets the Mosaic Mode parameter of this tool . This is an optional parameter.

Parameters:

mosaicMode - null

getColormapMode

public String getColormapMode()

Returns the Colormap Mode parameter of this tool . This is an optional parameter.

Returns:

the Colormap Mode

setColormapMode

public void setColormapMode(String colormapMode)

Sets the Colormap Mode parameter of this tool . This is an optional parameter.

Parameters:

colormapMode - null

getPyramidOrigin

public Object getPyramidOrigin()

Returns the Pyramid Origin parameter of this tool . This is an optional parameter.

Returns:

the Pyramid Origin

setPyramidOrigin

public void setPyramidOrigin(Object pyramidOrigin)

Sets the Pyramid Origin parameter of this tool . This is an optional parameter.

Parameters:

pyramidOrigin - null

getIgnoreBackgroundValue

public double getIgnoreBackgroundValue()

Returns the Ignore Background Value parameter of this tool . This is an optional parameter.

Returns:

the Ignore Background Value

setIgnoreBackgroundValue

public void setIgnoreBackgroundValue(double ignoreBackgroundValue)

Sets the Ignore Background Value parameter of this tool . This is an optional parameter.

Parameters:

ignoreBackgroundValue - null

getNodataValue

public double getNodataValue()

Returns the Nodata Value parameter of this tool . This is an optional parameter.

Returns:

the Nodata Value

setNodataValue

public void setNodataValue(double nodataValue)

Sets the Nodata Value parameter of this tool . This is an optional parameter.

Parameters:

nodataValue - null

getConvert1BitDataTo8Bit

public String getConvert1BitDataTo8Bit()

Returns the Convert 1 bit data to 8 bit parameter of this tool . This is an optional parameter.

Returns:

the Convert 1 bit data to 8 bit

setConvert1BitDataTo8Bit

public void setConvert1BitDataTo8Bit(String convert1BitDataTo8Bit)

Sets the Convert 1 bit data to 8 bit parameter of this tool . This is an optional parameter.

Parameters:

convert1BitDataTo8Bit - null

getMosaicTolerance

public double getMosaicTolerance()

Returns the Mosaic Tolerance parameter of this tool . This is an optional parameter.

Returns:

the Mosaic Tolerance

setMosaicTolerance

public void setMosaicTolerance(double mosaicTolerance)

Sets the Mosaic Tolerance parameter of this tool . This is an optional parameter.

Parameters:

mosaicTolerance - null

getDerivedRaster

public Object getDerivedRaster()

Returns the Derived Raster parameter of this tool (Read only). This is an derived parameter.

Returns:

the Derived Raster

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