com.esri.arcgis.geoanalyst
Class RasterReclassOp

java.lang.Object
  com.esri.arcgis.geoanalyst.RasterReclassOp

All Implemented Interfaces:

IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, IRasterAnalysisGlobalEnvironment, IRasterOpBase, IReclassOp, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class RasterReclassOp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IRasterAnalysisGlobalEnvironment, IRasterOpBase, IReclassOp, ISupportErrorInfo

Raster Reclass operation class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterReclassOp()
Constructs a RasterReclassOp using ArcGIS Engine.

RasterReclassOp(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterReclassOp theRasterReclassOp = (RasterReclassOp) obj;

Method Summary

void	addOutputDatasetName(int index, IDatasetName pOutName) Adds an output dataset name to the specified index.
boolean	equals(Object o) Compare this object with another
void	getCellSize(int[] envType, double[] cellSize) Gets the type and value of cell size in the RasterAnalysis.
static String	getClsid() getClsid.
String	getDefaultOutputRasterPrefix() The default output raster prefix.
String	getDefaultOutputVectorPrefix() The default output vector prefix.
void	getExtent(int[] envType, IEnvelope[] extent) Gets the type and values of extent in the RasterAnalysis.
IGeoDataset	getMask() Mask allows processing to occur only for a selected set of cells.
ISpatialReference	getOutSpatialReference() The output spatial reference of GeoAnalysis.
IWorkspace	getOutWorkspace() The output workspace of GeoAnalysis.
int	getVerifyType() The verify type of the RasterAnalysis.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isAvoidDataConversion() Indicates weather to avoid data conversion in the RasterAnalysis.
IGeoDataset	lookup(IGeoDataset geoDataset, String fieldName) Creates a new raster by looking up values found in another field in the table of the input raster.
IGeoDataset	reclass(IGeoDataset geoDataset, ITable remapTable, String fromField, String toField, String outField, boolean retainMissingValues) Reclassifies (or changes) the values of the input cells of a raster by using a remap table.
IGeoDataset	reclassByASCIIFile(IGeoDataset inRaster, String sRemapFile, boolean retainMissingValues) Reclassifies (or changes) the values of the input cells of a raster by using an ascii remap file.
IGeoDataset	reclassByRemap(IGeoDataset geoDataset, IRemap remap, boolean retainMissingValues) Reclassifies (or changes) the values of the input cells of a raster by using a remap that is built programmatically.
void	reset() Remove all previously stored default rasteranalysis environments.
void	restoreToPreviousDefaultEnvironment() Restores to the previous default raster analysis environment.
void	setAsNewDefaultEnvironment() Sets the raster analysis environment of the object as new default environment.
void	setAvoidDataConversion(boolean bAvoid) Indicates weather to avoid data conversion in the RasterAnalysis.
void	setCellSize(int envType, Object cellSizeProvider) Sets the type and value of cell size in the RasterAnalysis.
void	setDefaultOutputRasterPrefix(String rasterPrefix) The default output raster prefix.
void	setDefaultOutputVectorPrefix(String vectorPrefix) The default output vector prefix.
void	setExtent(int envType, Object extentProvider, Object snapRasterData) Sets the type and values of extent in the RasterAnalysis.
void	setMaskByRef(IGeoDataset mask) Mask allows processing to occur only for a selected set of cells.
void	setOutputDatasetNameArrayByRef(IArray rhs1) Puts output name array.
void	setOutSpatialReferenceByRef(ISpatialReference spatialReference) The output spatial reference of GeoAnalysis.
void	setOutWorkspaceByRef(IWorkspace workspace) The output workspace of GeoAnalysis.
void	setVerifyType(int verifyType) The verify type of the RasterAnalysis.
IGeoDataset	slice(IGeoDataset geoDataset, int sliceType, int zoneCount, Object baseZone) Slices a range of values of the input cells by zones of equal area or equal interval.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RasterReclassOp

public RasterReclassOp()
                throws IOException,
                       UnknownHostException

Constructs a RasterReclassOp using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterReclassOp

public RasterReclassOp(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterReclassOp theRasterReclassOp = (RasterReclassOp) obj;

Construct a RasterReclassOp using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterReclassOp.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setCellSize

public void setCellSize(int envType,
                        Object cellSizeProvider)
                 throws IOException,
                        AutomationException

Sets the type and value of cell size in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster cellsize environment settings for analysis. All subsequent results will be to the value specified. It can be of type esriRasterEnvMaxOf – The largest cell size of all input raster datasets that are specifed in the function. This is the default. This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead. esriRasterEnvMinOf - Smallest cell size of all input raster datasets. This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead esriRasterEnvValue - Any user specified value for the cell size. Use this option to specify a particular value for a cell size or for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only input.

[cellSizeProvider]

A specified value (double) or RasterDataset that is used to provide the cellsize environment value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCellSize in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

cellSizeProvider - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

public void getCellSize(int[] envType,
                        double[] cellSize)
                 throws IOException,
                        AutomationException

Gets the type and value of cell size in the RasterAnalysis.

Remarks

envType	will return an enumeration type constant specifying the raster cellsize environment settings for analysis. It can be of type esriRasterEnvMaxOf - largest cell size of all input datasets. This is the default. esriRasterEnvMinOf - smallest cell size of all input datasets esriRasterEnvValue - User specified value.
cellsize	returns a value that specifying the current environment setting for cellsize

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCellSize in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

cellSize - The cellSize (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      Object extentProvider,
                      Object snapRasterData)
               throws IOException,
                      AutomationException

Sets the type and values of extent in the RasterAnalysis.

Remarks

envType	An enumeration type specifying the raster extent environment settings for analysis. All subsequent results will be to this extent. It can be of type esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default. esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used. esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.
[extentProvider]	An envelope object supporting IEnvelope interface or RasterDataset that is used to provide the environment values of the analysis extent.
[snapRasterData]	A RasterDataset that can be used to snap all output raster datasets to the cell registration of the specified raster. All subsequent results will share the lower-left corner and cell size of the specified raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExtent in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)

extentProvider - A Variant (in, optional, pass null if not required)

snapRasterData - A Variant (in, optional, pass null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(int[] envType,
                      IEnvelope[] extent)
               throws IOException,
                      AutomationException

Gets the type and values of extent in the RasterAnalysis.

Remarks

envType

will return an enumeration constant specifying the raster extent environment settings for analysis. It can be of type, esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default. esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used. esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

extent

An envelope object supporting IEnvelope interface used to describe the values of the analysis extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IRasterAnalysisEnvironment

Parameters:

envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws IOException,
                         AutomationException

Mask allows processing to occur only for a selected set of cells.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaskByRef in interface IRasterAnalysisEnvironment

Parameters:

mask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws IOException,
                           AutomationException

Mask allows processing to occur only for a selected set of cells.

Remarks

The mask can be a reference to a Raster, RasterDataset, RasterBand, or RasterDescriptor object or FeatureClass, FeatureClassDescriptor object.

The mask identifies only those cells within the analysis extent that will be considered when performing an action. Only the identified cells will be processed in subsequent output raster datasets. All other cells are characterized as nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMask in interface IRasterAnalysisEnvironment

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerifyType

public void setVerifyType(int verifyType)
                   throws IOException,
                          AutomationException

The verify type of the RasterAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVerifyType in interface IRasterAnalysisEnvironment

Parameters:

verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws IOException,
                         AutomationException

The verify type of the RasterAnalysis.

Remarks

The value is an enumeration environment setting that contols the way that an output RasterDatasets are written to file when during analysis. The verify enumeration can be of type

esriRasterEnvVerifyOn - specifies that the user will be prompted to verify the output already exists and it is okay to overwrite it

esriRasterEnvVerifyOff - specifies that output data will be automatically overwritten if already exists. This is the default environment setting.

esriRasterEnvVerifyError - specifies that an error will be produced when the output already exists.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getVerifyType in interface IRasterAnalysisEnvironment

Returns:

A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public String getDefaultOutputRasterPrefix()
                                    throws IOException,
                                           AutomationException

The default output raster prefix.

Remarks

The user specified prefix which is included to all temporary output RasterDatasets during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Returns:

The rasterPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(String rasterPrefix)
                                  throws IOException,
                                         AutomationException

The default output raster prefix.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Parameters:

rasterPrefix - The rasterPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public String getDefaultOutputVectorPrefix()
                                    throws IOException,
                                           AutomationException

The default output vector prefix.

Remarks

The user specified prefix which is included to all temporary output Shapefiles during analysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Returns:

The vectorPrefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(String vectorPrefix)
                                  throws IOException,
                                         AutomationException

The default output vector prefix.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Parameters:

vectorPrefix - The vectorPrefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws IOException,
                                       AutomationException

Sets the raster analysis environment of the object as new default environment.

Remarks

Will set all current environment settings of the RasterAnalysis object as the new default environment. All subsequent analysis will use the set object properties unless otherwise specified.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws IOException,
                                                AutomationException

Restores to the previous default raster analysis environment.

Remarks

This will restore the default environment to the settings of the "previous" RasterAnalysisEnvironment object used to set the default environement. Note: If multiple default environments have been set it will reference the past settings one at a time in order of sequence.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Remove all previously stored default rasteranalysis environments.

Remarks

This method can be used to restore the system default raster environment settings for extent, cell size, precision, spatial reference and/or current workspace for analysis. This will change all previously altered environment settings made to the RasterAnlaysis object back to the original settings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IRasterAnalysisEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws IOException,
                                 AutomationException

The output workspace of GeoAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutWorkspaceByRef in interface IGeoAnalysisEnvironment

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws IOException,
                                  AutomationException

The output workspace of GeoAnalysis.

Remarks

The variable is an object specifying the directory or subdirectory to contain the output rasterdataset

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutWorkspace in interface IGeoAnalysisEnvironment

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws IOException,
                                        AutomationException

The output spatial reference of GeoAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws IOException,
                                                AutomationException

The output spatial reference of GeoAnalysis.

Remarks

The variable references an object that specifies the output features spatial reference. If not explicitly set the spatial reference of the input features will be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutSpatialReference in interface IGeoAnalysisEnvironment

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvoidDataConversion

public void setAvoidDataConversion(boolean bAvoid)
                            throws IOException,
                                   AutomationException

Indicates weather to avoid data conversion in the RasterAnalysis.

Remarks

Setting to false (the default setting) is the same as in versions before ArcGIS 9.4.

Setting the property to True ensures that all processing is performed natively on the raster data. This improves the overall performance as there is no need for the input data to be converted to ESRI grid format. The output data, however, is still temporary rasters in ESRI grid format.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment

Parameters:

bAvoid - The bAvoid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAvoidDataConversion

public boolean isAvoidDataConversion()
                              throws IOException,
                                     AutomationException

Indicates weather to avoid data conversion in the RasterAnalysis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment

Returns:

The bAvoid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addOutputDatasetName

public void addOutputDatasetName(int index,
                                 IDatasetName pOutName)
                          throws IOException,
                                 AutomationException

Adds an output dataset name to the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addOutputDatasetName in interface IRasterOpBase

Parameters:

index - The index (in)

pOutName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputDatasetNameArrayByRef

public void setOutputDatasetNameArrayByRef(IArray rhs1)
                                    throws IOException,
                                           AutomationException

Puts output name array.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setOutputDatasetNameArrayByRef in interface IRasterOpBase

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reclass

public IGeoDataset reclass(IGeoDataset geoDataset,
                           ITable remapTable,
                           String fromField,
                           String toField,
                           String outField,
                           boolean retainMissingValues)
                    throws IOException,
                           AutomationException

Reclassifies (or changes) the values of the input cells of a raster by using a remap table.

Remarks

geoDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor The values contained in this Raster will be the values to be reclassified.
remapTable	A table used to identify the input cell values, or range of values, to be reclassified and their respective reclassified output values. "From" and "To" fields define the input cell ranges to be reclassified and the "Out" field is used to specify a new reclassified output value. These fields are used in the fromField, toField and outField parameters. A sample table format is, From To Out 45.00 45.00 40 55.00 55.00 50 60.00 60.00 0 1.00 20.00 20 20.00 40.00 30 70.00 100.00 0 0.00 0.00 99
fromField	Specifies the field in the remapTable for the start of each range to be used to correlate the values on the input Raster that will be reclassed. For example, the "From" field in the above sample table.
toField	Specifies the field in the remapTable for the end of each range to be used to correlate the values on the input Raster that will be reclassed. For example, the "To" field in the above sample table.
outField	Specifies the field in the remapTable that is to be used to change or reclass the input values, or range of values, to the values contained in the outField. For example, the "Out" field in the above sample table.
retainMissingValues	Defines the manner in which values not present in the remapTable will be handled If True, then if any cell location on the input Raster contains a value that is not present or reclassed in the remap table, the value should remain intact and be written for that location to the output Raster. If False, then if any cell location on the input Raster contains a value that is not present or reclassed in the remap table, the value will be reclassed to NoData for that location on the output Raster.

Note:

• To reclassify individual values, it is possible to use a simple table of two field items, for example a "From" and an "Out" field . The first item identifies the value to reclassify, and the other item the value to assign it to. In this case, the "toField" parameter is set to the same as the "fromField". The value to assign to the output is "outField".
  
• To reclassify ranges of values, the table must have items defining the start and end of each range, along with the value to assign the range. For example, "From", "To", and "Out" respectively. The item defining the start of the range is the "fromField" and the value defining the end of the range is the "toField". The value to assign to the output is "outField".

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

reclass in interface IReclassOp

Parameters:

geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

remapTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

fromField - The fromField (in)

toField - The toField (in)

outField - The outField (in)

retainMissingValues - The retainMissingValues (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

slice

public IGeoDataset slice(IGeoDataset geoDataset,
                         int sliceType,
                         int zoneCount,
                         Object baseZone)
                  throws IOException,
                         AutomationException

Slices a range of values of the input cells by zones of equal area or equal interval.

Remarks

geoDataset	an input Raster, RasterDataset, RasterBand, or RasterDescriptor The values contained in this Raster will be the values that are sliced.
sliceType	An esriGeoAnalysisSliceEnum specifying the manner in which to slice the values in the input geoDataset. EsriGeoAnalysisSliceEqualArea - EqualArea specifies that the input values will be divided into the number of zones specified by zoneCount with each zone having a similar number of cells - each zone represents a similar amount of area. EsriGeoAnalysisSliceEqualInterval - The EqualInterval slice determines the range of the input values and divides the range into zoneCount. Each zone on the sliced output raster has the potential of having input cell values that have the same range from the extremes. EsriGeoAnalysisSliceNaturalBreaks - The NaturalNeighbor slice specifies that the classes will be based on natural groupings inherent in the data. Break points are identified by picking the class breaks that best group similar values and maximize the differences between classes. The cell values are divided into classes whose boundaries are set where there are relatively big jumps in the data values
zoneCount	Defines the number of zones that should be used with the calculations for the slicing method. When the sliceType EqualArea is used, the output raster will have zoneCounts with similar numbers of cells. When the sliceType EqualInterval is used, the output Raster will have zoneCounts, each containing equal value ranges on the output raster. When the sliceType NaturalBreaks is used, the output raster will have zonesCounts, with the number of cells in each determined by the class breaks
baseZone	When the sliceTypes EqualArea, EqualInterval and NaturalBreaks are used, the number that is input for the baseZone identifies the value to begin assigning to the output sliced zones. The zones will begin with the value assigned to the baseZone and increment by 1. If no base zone is specified, slice will begin the assignment at value 1.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

slice in interface IReclassOp

Parameters:

geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

sliceType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisSliceEnum constant (in)

zoneCount - The zoneCount (in)

baseZone - A Variant (in, optional, pass null if not required)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

lookup

public IGeoDataset lookup(IGeoDataset geoDataset,
                          String fieldName)
                   throws IOException,
                          AutomationException

Creates a new raster by looking up values found in another field in the table of the input raster.

Remarks

GeoDataset	the input Raster, RasterDataset, RasterBand, or RasterDescriptor
FieldName	the name of the field that contains the values upon which the input geodataset will be classified.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

lookup in interface IReclassOp

Parameters:

geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

fieldName - The fieldName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reclassByRemap

public IGeoDataset reclassByRemap(IGeoDataset geoDataset,
                                  IRemap remap,
                                  boolean retainMissingValues)
                           throws IOException,
                                  AutomationException

Reclassifies (or changes) the values of the input cells of a raster by using a remap that is built programmatically.

Remarks

GeoDataset	the input Raster, RasterDataset, RasterBand, or RasterDescriptor
Remap	the input remap object that supports IRemap interface. If reclassifying number or string values use the NumberRemap or StringRemap objects respectively.
retainMissingValues	a Boolean specifying whether to keep missing values in the analysis. If TRUE, values that have been omitted are given a NODATA value in output raster If FALSE, values that have been omitted are retained and unchanged in the output raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

reclassByRemap in interface IReclassOp

Parameters:

geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

remap - A reference to a com.esri.arcgis.geoanalyst.IRemap (in)

retainMissingValues - The retainMissingValues (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reclassByASCIIFile

public IGeoDataset reclassByASCIIFile(IGeoDataset inRaster,
                                      String sRemapFile,
                                      boolean retainMissingValues)
                               throws IOException,
                                      AutomationException

Reclassifies (or changes) the values of the input cells of a raster by using an ascii remap file.

Remarks

inRaster	the input Raster, RasterDataset, RasterBand, or RasterDescriptor
sRemapFile	the input ASCII file of specific format on which to classify the inRaster.
retainMissingValues	a Boolean specifying whether to keep missing values in the analysis. If TRUE, values that have been omitted are given a NODATA value in output raster If FALSE, values that have been omitted are retained and unchanged in the output raster.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

reclassByASCIIFile in interface IReclassOp

Parameters:

inRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)

sRemapFile - The sRemapFile (in)

retainMissingValues - The retainMissingValues (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGeoDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.