com.esri.arcgis.spatialanalyst
Class RasterGeneralizeOp

java.lang.Object
  com.esri.arcgis.spatialanalyst.RasterGeneralizeOp

All Implemented Interfaces:

IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, com.esri.arcgis.interop.RemoteObjRef, IGeneralizeOp, ISupportErrorInfo, java.io.Serializable

public class RasterGeneralizeOp
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IGeneralizeOp, ISupportErrorInfo

COM Class 'RasterGeneralizeOp'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description 'A mechanism for performing simplifying operations on rasters.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geoanalyst.IRasterAnalysisEnvironment

IID, IID3297e9c5_93a1_11d2_9f33_00c04f8ed1d7, xxDummy

Fields inherited from interface com.esri.arcgis.geoanalyst.IGeoAnalysisEnvironment

IID3297e9c8_93a1_11d2_9f33_00c04f8ed1d7

Fields inherited from interface com.esri.arcgis.spatialanalyst.IGeneralizeOp

IID, IID273774e8_ead9_11d3_9f93_00c04f8ef00e, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

RasterGeneralizeOp()
Constructs a RasterGeneralizeOp using ArcGIS Engine.

RasterGeneralizeOp(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterGeneralizeOp theRasterGeneralizeOp = (RasterGeneralizeOp) obj;

Method Summary

IGeoDataset	aggregate(IGeoDataset raster, int cellFactor, int aggregationType, boolean expandExtent, boolean ignoreNoData) Generates a reduced resolution version of a raster.
IGeoDataset	boundaryClean(IGeoDataset raster, int sortType, boolean runTwice) Smoothes the boundary between zones by expanding and shrinking the boundary.
boolean	equals(java.lang.Object o) Compare this object with another
IGeoDataset	expand(IGeoDataset raster, int numberCells, java.lang.Object zoneList) Expands the selected zones by a specified number of cells.
void	getCellSize(int[] envType, double[] cellSize) Gets the type and value of cell size in the RasterAnalysis.
static java.lang.String	getClsid() getClsid.
java.lang.String	getDefaultOutputRasterPrefix() The default output raster prefix.
java.lang.String	getDefaultOutputVectorPrefix() The default output vector prefix.
void	getExtent(int[] envType, IEnvelope[] extent) Gets the type and values of extent in the RasterAnalysis.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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
IGeoDataset	majorityFilter(IGeoDataset raster, boolean useDiagonalNeighbors, boolean halfIsMajority) Replaces cells based upon the majority of their contiguous neighboring cells.
IGeoDataset	nibble(IGeoDataset raster, IGeoDataset maskRaster, boolean useNoData) Replaces areas in a raster corresponding to a mask, with the values of the nearest neighbors.
IGeoDataset	regionGroup(IGeoDataset raster, boolean useDiagonalNeighbors, boolean withinZones, boolean createLinkField, java.lang.Object excludedValue) Records for each cell in the output, the identity of the connected region to which it belongs.
void	release() Release a RasterGeneralizeOp.
IGeoDataset	resample(IGeoDataset raster, double newCellSize, int resampleType) Resamples the raster to a new cell size.
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	setCellSize(int envType, java.lang.Object cellSizeProvider) Sets the type and value of cell size in the RasterAnalysis.
void	setDefaultOutputRasterPrefix(java.lang.String rasterPrefix) The default output raster prefix.
void	setDefaultOutputVectorPrefix(java.lang.String vectorPrefix) The default output vector prefix.
void	setExtent(int envType, java.lang.Object extentProvider, java.lang.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	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	shrink(IGeoDataset raster, int numberCells, java.lang.Object zoneList) Shrinks the selected zones by a specified number of cells.
IGeoDataset	thin(IGeoDataset raster, boolean backgroundIsNoData, boolean filterData, boolean roundCorners, java.lang.Object maxThickness) Thins rasterized linear features by reducing the number of pixels representing the width of the features.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterGeneralizeOp

public RasterGeneralizeOp()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a RasterGeneralizeOp using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterGeneralizeOp

public RasterGeneralizeOp(java.lang.Object obj)
                   throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a RasterGeneralizeOp.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setCellSize

public void setCellSize(int envType,
                        java.lang.Object cellSizeProvider)
                 throws java.io.IOException,
                        AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSize

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      java.lang.Object extentProvider,
                      java.lang.Object snapRasterData)
               throws java.io.IOException,
                      AutomationException

Sets the type and values of extent in the RasterAnalysis.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

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

Gets the type and values of extent in the RasterAnalysis.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

setMaskByRef in interface IRasterAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

getMask in interface IRasterAnalysisEnvironment

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerifyType

public void setVerifyType(int verifyType)
                   throws java.io.IOException,
                          AutomationException

The verify type of the RasterAnalysis.

Specified by:

setVerifyType in interface IRasterAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws java.io.IOException,
                         AutomationException

The verify type of the RasterAnalysis.

Specified by:

getVerifyType in interface IRasterAnalysisEnvironment

Returns:

A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public java.lang.String getDefaultOutputRasterPrefix()
                                              throws java.io.IOException,
                                                     AutomationException

The default output raster prefix.

Specified by:

getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Returns:

The rasterPrefix

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(java.lang.String rasterPrefix)
                                  throws java.io.IOException,
                                         AutomationException

The default output raster prefix.

Specified by:

setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment

Parameters:

rasterPrefix - The rasterPrefix (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public java.lang.String getDefaultOutputVectorPrefix()
                                              throws java.io.IOException,
                                                     AutomationException

The default output vector prefix.

Specified by:

getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Returns:

The vectorPrefix

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(java.lang.String vectorPrefix)
                                  throws java.io.IOException,
                                         AutomationException

The default output vector prefix.

Specified by:

setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment

Parameters:

vectorPrefix - The vectorPrefix (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws java.io.IOException,
                                                AutomationException

Restores to the previous default raster analysis environment.

Specified by:

restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Remove all previously stored default rasteranalysis environments.

Specified by:

reset in interface IRasterAnalysisEnvironment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws java.io.IOException,
                                 AutomationException

The output workspace of GeoAnalysis.

Specified by:

setOutWorkspaceByRef in interface IGeoAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws java.io.IOException,
                                  AutomationException

The output workspace of GeoAnalysis.

Specified by:

getOutWorkspace in interface IGeoAnalysisEnvironment

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws java.io.IOException,
                                        AutomationException

The output spatial reference of GeoAnalysis.

Specified by:

setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws java.io.IOException,
                                                AutomationException

The output spatial reference of GeoAnalysis.

Specified by:

getOutSpatialReference in interface IGeoAnalysisEnvironment

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

aggregate

public IGeoDataset aggregate(IGeoDataset raster,
                             int cellFactor,
                             int aggregationType,
                             boolean expandExtent,
                             boolean ignoreNoData)
                      throws java.io.IOException,
                             AutomationException

Generates a reduced resolution version of a raster.

Specified by:

aggregate in interface IGeneralizeOp

Parameters:

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

cellFactor - The cellFactor (in)

aggregationType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)

expandExtent - The expandExtent (in)

ignoreNoData - The ignoreNoData (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

boundaryClean

public IGeoDataset boundaryClean(IGeoDataset raster,
                                 int sortType,
                                 boolean runTwice)
                          throws java.io.IOException,
                                 AutomationException

Smoothes the boundary between zones by expanding and shrinking the boundary.

Specified by:

boundaryClean in interface IGeneralizeOp

Parameters:

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

sortType - A com.esri.arcgis.spatialanalyst.esriGeoAnalysisSortEnum constant (in)

runTwice - The runTwice (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expand

public IGeoDataset expand(IGeoDataset raster,
                          int numberCells,
                          java.lang.Object zoneList)
                   throws java.io.IOException,
                          AutomationException

Expands the selected zones by a specified number of cells.

Specified by:

expand in interface IGeneralizeOp

Parameters:

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

numberCells - The numberCells (in)

zoneList - A Variant (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

majorityFilter

public IGeoDataset majorityFilter(IGeoDataset raster,
                                  boolean useDiagonalNeighbors,
                                  boolean halfIsMajority)
                           throws java.io.IOException,
                                  AutomationException

Replaces cells based upon the majority of their contiguous neighboring cells.

Specified by:

majorityFilter in interface IGeneralizeOp

Parameters:

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

useDiagonalNeighbors - The useDiagonalNeighbors (in)

halfIsMajority - The halfIsMajority (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nibble

public IGeoDataset nibble(IGeoDataset raster,
                          IGeoDataset maskRaster,
                          boolean useNoData)
                   throws java.io.IOException,
                          AutomationException

Replaces areas in a raster corresponding to a mask, with the values of the nearest neighbors.

Specified by:

nibble in interface IGeneralizeOp

Parameters:

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

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

useNoData - The useNoData (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

regionGroup

public IGeoDataset regionGroup(IGeoDataset raster,
                               boolean useDiagonalNeighbors,
                               boolean withinZones,
                               boolean createLinkField,
                               java.lang.Object excludedValue)
                        throws java.io.IOException,
                               AutomationException

Records for each cell in the output, the identity of the connected region to which it belongs.

Specified by:

regionGroup in interface IGeneralizeOp

Parameters:

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

useDiagonalNeighbors - The useDiagonalNeighbors (in)

withinZones - The withinZones (in)

createLinkField - The createLinkField (in)

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resample

public IGeoDataset resample(IGeoDataset raster,
                            double newCellSize,
                            int resampleType)
                     throws java.io.IOException,
                            AutomationException

Resamples the raster to a new cell size.

Specified by:

resample in interface IGeneralizeOp

Parameters:

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

newCellSize - The newCellSize (in)

resampleType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shrink

public IGeoDataset shrink(IGeoDataset raster,
                          int numberCells,
                          java.lang.Object zoneList)
                   throws java.io.IOException,
                          AutomationException

Shrinks the selected zones by a specified number of cells.

Specified by:

shrink in interface IGeneralizeOp

Parameters:

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

numberCells - The numberCells (in)

zoneList - A Variant (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

thin

public IGeoDataset thin(IGeoDataset raster,
                        boolean backgroundIsNoData,
                        boolean filterData,
                        boolean roundCorners,
                        java.lang.Object maxThickness)
                 throws java.io.IOException,
                        AutomationException

Thins rasterized linear features by reducing the number of pixels representing the width of the features.

Specified by:

thin in interface IGeneralizeOp

Parameters:

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

backgroundIsNoData - The backgroundIsNoData (in)

filterData - The filterData (in)

roundCorners - The roundCorners (in)

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.