com.esri.arcgis.geoanalyst
Interface IReclassOp

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterReclassOp

public interface IReclassOp
extends Serializable

Provides access to members that control the Reclass Operation.

Remarks

Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations.

Product Availability

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

Method Summary

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.
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.

Method Detail

reclass

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

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

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

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

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

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

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

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

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

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.