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

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

All Implemented Interfaces:

GPTool

public class ExtractSubDataset
extends AbstractGPTool

Extracts raster datasets stored within a subdataset raster file. The Extract Subdataset tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is useful since ArcCatalog is only able to preview the first subdataset within the parent file.
• Subdataset file formats can be either Hierarchical Data Format (HDF) or National Imagery Transmission Format (NITF) files
• The data structure allows the file format to consist of multiple datasets in one parent file. In addition, each of the subdatasets can consist of one band or multiple bands.
• If you do not choose any subdatasets, the default will be to only return the first subdataset.
• When storing your raster dataset to a JPEG or a JPEG 2000 file, you can specify the compression quality within the Raster Storage Settings in the Environment Settings dialog box.
• The GIF format does not support multiband; therefore, it is not a valid output format unless your raster dataset is single band.

Field Summary

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

vals

Constructor Summary

ExtractSubDataset()
Creates the Extract Subdataset tool with defaults.

ExtractSubDataset(Object inRaster, Object outRaster)
Creates the Extract Subdataset tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getOutRaster() Returns the Output Raster parameter of this tool .
Object	getSubdatasetIndex() Returns the Subdataset ID 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	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output Raster parameter of this tool .
void	setSubdatasetIndex(Object subdatasetIndex) Sets the Subdataset ID 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

ExtractSubDataset

public ExtractSubDataset()

Creates the Extract Subdataset tool with defaults.

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

ExtractSubDataset

public ExtractSubDataset(Object inRaster,
                         Object outRaster)

Creates the Extract Subdataset 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:

inRaster - the input subdataset raster format. valid inputs can either be HDF or NITF files.

outRaster - the name and extension of the raster dataset to be created. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input subdataset raster format. valid inputs can either be HDF or NITF files. This is a required parameter.

Returns:

the Input Raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input Raster parameter of this tool . This parameter is the input subdataset raster format. valid inputs can either be HDF or NITF files. This is a required parameter.

Parameters:

inRaster - the input subdataset raster format. valid inputs can either be HDF or NITF files.

getOutRaster

public Object getOutRaster()

Returns the Output Raster parameter of this tool . This parameter is the name and extension of the raster dataset to be created. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. 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 the name and extension of the raster dataset to be created. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. This is a required parameter.

Parameters:

outRaster - the name and extension of the raster dataset to be created. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.

getSubdatasetIndex

public Object getSubdatasetIndex()

Returns the Subdataset ID parameter of this tool . This parameter is define the subdatasets that you want to extract. This is an optional parameter.

Returns:

the Subdataset ID

setSubdatasetIndex

public void setSubdatasetIndex(Object subdatasetIndex)

Sets the Subdataset ID parameter of this tool . This parameter is define the subdatasets that you want to extract. This is an optional parameter.

Parameters:

subdatasetIndex - define the subdatasets that you want to extract.

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