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

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

All Implemented Interfaces:

GPTool

public class DefineMosaicDatasetNoData
extends AbstractGPTool

Allows you to specify one or more NoData values for a mosaic dataset. The Define Mosaic Dataset NoData tool is contained in the Data Management Tools tool box.

Usage tips:

• NoData can be used to define pixel values that surround an image; however, the mosaic dataset can be made more efficient if the footprints are recomputed to remove these boundary areas. To recompute the footprints you can edit them manually or use the .
• This tool inserts the Mask function within the function chain for each raster item within a mosaic dataset.

Field Summary

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

vals

Constructor Summary

DefineMosaicDatasetNoData()
Creates the Define Mosaic Dataset NoData tool with defaults.

DefineMosaicDatasetNoData(Object inMosaicDataset, int numBands)
Creates the Define Mosaic Dataset NoData tool with the required parameters.

Method Summary

Object	getBandsForNodataValue() Returns the Bands for NoData Value parameter of this tool .
Object	getBandsForValidDataRange() Returns the Bands For Valid Data Range parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
int	getNumBands() Returns the Number of Bands parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
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	getWhereClause() Returns the Query Definition parameter of this tool .
void	setBandsForNodataValue(Object bandsForNodataValue) Sets the Bands for NoData Value parameter of this tool .
void	setBandsForValidDataRange(Object bandsForValidDataRange) Sets the Bands For Valid Data Range parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setNumBands(int numBands) Sets the Number of Bands parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Query Definition 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

DefineMosaicDatasetNoData

public DefineMosaicDatasetNoData()

Creates the Define Mosaic Dataset NoData tool with defaults.

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

DefineMosaicDatasetNoData

public DefineMosaicDatasetNoData(Object inMosaicDataset,
                                 int numBands)

Creates the Define Mosaic Dataset NoData 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.

numBands - defines the number of bands in the mosaic dataset. this value will be populated automatically, based on the mosaic dataset that is added, but you can override it.

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.

getNumBands

public int getNumBands()

Returns the Number of Bands parameter of this tool . This parameter is defines the number of bands in the mosaic dataset. this value will be populated automatically, based on the mosaic dataset that is added, but you can override it. This is a required parameter.

Returns:

the Number of Bands

setNumBands

public void setNumBands(int numBands)

Sets the Number of Bands parameter of this tool . This parameter is defines the number of bands in the mosaic dataset. this value will be populated automatically, based on the mosaic dataset that is added, but you can override it. This is a required parameter.

Parameters:

numBands - defines the number of bands in the mosaic dataset. this value will be populated automatically, based on the mosaic dataset that is added, but you can override it.

getBandsForNodataValue

public Object getBandsForNodataValue()

Returns the Bands for NoData Value parameter of this tool . This parameter is define a single value for each or all bands. Each band can have a unique NoData value defined, or the same value can be specified for all bands. This is an optional parameter.

Returns:

the Bands for NoData Value

setBandsForNodataValue

public void setBandsForNodataValue(Object bandsForNodataValue)

Sets the Bands for NoData Value parameter of this tool . This parameter is define a single value for each or all bands. Each band can have a unique NoData value defined, or the same value can be specified for all bands. This is an optional parameter.

Parameters:

bandsForNodataValue - define a single value for each or all bands. Each band can have a unique NoData value defined, or the same value can be specified for all bands.

getBandsForValidDataRange

public Object getBandsForValidDataRange()

Returns the Bands For Valid Data Range parameter of this tool . This parameter is the band number and the minimum and maximum pixel value of valid data. The NoData values will be those values outside the range. For example, for an 8-bit image, if you specify band1=10–200, then values 0–9 and 201–255 will be defined as NoData. This is an optional parameter.

Returns:

the Bands For Valid Data Range

setBandsForValidDataRange

public void setBandsForValidDataRange(Object bandsForValidDataRange)

Sets the Bands For Valid Data Range parameter of this tool . This parameter is the band number and the minimum and maximum pixel value of valid data. The NoData values will be those values outside the range. For example, for an 8-bit image, if you specify band1=10–200, then values 0–9 and 201–255 will be defined as NoData. This is an optional parameter.

Parameters:

bandsForValidDataRange - the band number and the minimum and maximum pixel value of valid data. The NoData values will be those values outside the range. For example, for an 8-bit image, if you specify band1=10–200, then values 0–9 and 201–255 will be defined as NoData.

getWhereClause

public Object getWhereClause()

Returns the Query Definition parameter of this tool . This parameter is using SQL you can define a query or use the Query Builder to build a query. This is an optional parameter.

Returns:

the Query Definition

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Query Definition parameter of this tool . This parameter is using SQL you can define a query or use the Query Builder to build a query. This is an optional parameter.

Parameters:

whereClause - using SQL you can define a query or use the Query Builder to build a query.

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