com.esri.arcgis.geoprocessing.tools.multidimensiontools
Class RasterToNetCDF

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.multidimensiontools.RasterToNetCDF

All Implemented Interfaces:

GPTool

public class RasterToNetCDF
extends AbstractGPTool

Converts a raster dataset to a netCDF file. The Raster to NetCDF tool is contained in the Multidimension Tools tool box.

Usage tips:

• The input can be any valid raster dataset or raster catalog.
• The default variable name is the same as the input raster name.
• The output netCDF variable type is either float or integer based on the input raster dataset type.
• The default x dimension and y dimension names are x and y, respectively.
• Band dimension is only applicable for a multiband raster.
• Field to dimension mapping is only applicable for a raster catalog.

Field Summary

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

vals

Constructor Summary

RasterToNetCDF()
Creates the Raster to NetCDF tool with defaults.

RasterToNetCDF(Object inRaster, Object outNetCDFFile)
Creates the Raster to NetCDF tool with the required parameters.

Method Summary

String	getBandDimension() Returns the Band Dimension parameter of this tool .
Object	getFieldsToDimensions() Returns the Fields to Dimensions parameter of this tool .
Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getOutNetCDFFile() Returns the Output netCDF File 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.
String	getVariable() Returns the Variable parameter of this tool .
String	getVariableUnits() Returns the Variable Units parameter of this tool .
String	getXDimension() Returns the X Dimension parameter of this tool .
String	getYDimension() Returns the Y Dimension parameter of this tool .
void	setBandDimension(String bandDimension) Sets the Band Dimension parameter of this tool .
void	setFieldsToDimensions(Object fieldsToDimensions) Sets the Fields to Dimensions parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setOutNetCDFFile(Object outNetCDFFile) Sets the Output netCDF File parameter of this tool .
void	setVariable(String variable) Sets the Variable parameter of this tool .
void	setVariableUnits(String variableUnits) Sets the Variable Units parameter of this tool .
void	setXDimension(String xDimension) Sets the X Dimension parameter of this tool .
void	setYDimension(String yDimension) Sets the Y Dimension 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

RasterToNetCDF

public RasterToNetCDF()

Creates the Raster to NetCDF tool with defaults.

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

RasterToNetCDF

public RasterToNetCDF(Object inRaster,
                      Object outNetCDFFile)

Creates the Raster to NetCDF 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 raster dataset or raster catalog.

outNetCDFFile - the output netCDF file. The filename must have a .nc extension.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input raster dataset or raster catalog. 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 raster dataset or raster catalog. This is a required parameter.

Parameters:

inRaster - the input raster dataset or raster catalog.

getOutNetCDFFile

public Object getOutNetCDFFile()

Returns the Output netCDF File parameter of this tool . This parameter is the output netCDF file. The filename must have a .nc extension. This is a required parameter.

Returns:

the Output netCDF File

setOutNetCDFFile

public void setOutNetCDFFile(Object outNetCDFFile)

Sets the Output netCDF File parameter of this tool . This parameter is the output netCDF file. The filename must have a .nc extension. This is a required parameter.

Parameters:

outNetCDFFile - the output netCDF file. The filename must have a .nc extension.

getVariable

public String getVariable()

Returns the Variable parameter of this tool . This parameter is the netCDF variable name that will be used in the output netCDF file. This variable will contain the values of cells in the input raster. This is an optional parameter.

Returns:

the Variable

setVariable

public void setVariable(String variable)

Sets the Variable parameter of this tool . This parameter is the netCDF variable name that will be used in the output netCDF file. This variable will contain the values of cells in the input raster. This is an optional parameter.

Parameters:

variable - the netCDF variable name that will be used in the output netCDF file. This variable will contain the values of cells in the input raster.

getVariableUnits

public String getVariableUnits()

Returns the Variable Units parameter of this tool . This parameter is the units of the data contained within the variable. The variable name is specified in the Variable parameter. This is an optional parameter.

Returns:

the Variable Units

setVariableUnits

public void setVariableUnits(String variableUnits)

Sets the Variable Units parameter of this tool . This parameter is the units of the data contained within the variable. The variable name is specified in the Variable parameter. This is an optional parameter.

Parameters:

variableUnits - the units of the data contained within the variable. The variable name is specified in the Variable parameter.

getXDimension

public String getXDimension()

Returns the X Dimension parameter of this tool . This parameter is the netCDF dimension name used to specify x, or longitude coordinates. This is an optional parameter.

Returns:

the X Dimension

setXDimension

public void setXDimension(String xDimension)

Sets the X Dimension parameter of this tool . This parameter is the netCDF dimension name used to specify x, or longitude coordinates. This is an optional parameter.

Parameters:

xDimension - the netCDF dimension name used to specify x, or longitude coordinates.

getYDimension

public String getYDimension()

Returns the Y Dimension parameter of this tool . This parameter is the netCDF dimension name used to specify y, or latitude coordinates. This is an optional parameter.

Returns:

the Y Dimension

setYDimension

public void setYDimension(String yDimension)

Sets the Y Dimension parameter of this tool . This parameter is the netCDF dimension name used to specify y, or latitude coordinates. This is an optional parameter.

Parameters:

yDimension - the netCDF dimension name used to specify y, or latitude coordinates.

getBandDimension

public String getBandDimension()

Returns the Band Dimension parameter of this tool . This parameter is the netCDF dimension name used to specify bands. This is an optional parameter.

Returns:

the Band Dimension

setBandDimension

public void setBandDimension(String bandDimension)

Sets the Band Dimension parameter of this tool . This parameter is the netCDF dimension name used to specify bands. This is an optional parameter.

Parameters:

bandDimension - the netCDF dimension name used to specify bands.

getFieldsToDimensions

public Object getFieldsToDimensions()

Returns the Fields to Dimensions parameter of this tool . This parameter is the field or fields used to create dimensions in the netCDF file. This is an optional parameter.

Returns:

the Fields to Dimensions

setFieldsToDimensions

public void setFieldsToDimensions(Object fieldsToDimensions)

Sets the Fields to Dimensions parameter of this tool . This parameter is the field or fields used to create dimensions in the netCDF file. This is an optional parameter.

Parameters:

fieldsToDimensions - the field or fields used to create dimensions in the netCDF file.

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