com.esri.arcgis.geoanalyst
Class RasterNeighborhood

java.lang.Object
  extended by com.esri.arcgis.geoanalyst.RasterNeighborhood
All Implemented Interfaces:
IRasterNeighborhood, IRasterNeighborhood2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class RasterNeighborhood
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterNeighborhood, IRasterNeighborhood2, ISupportErrorInfo

COM Class 'RasterNeighborhood'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoAnalyst.olb'

Description 'Esri Raster neighborhood object.' 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.IRasterNeighborhood
IID, IID3297e9cc_93a1_11d2_9f33_00c04f8ed1d7, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoanalyst.IRasterNeighborhood2
IID, IIDfdd19da5_0881_4d0a_b7dd_9a7c3ec24702, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
RasterNeighborhood()
          Constructs a RasterNeighborhood using ArcGIS Engine.
RasterNeighborhood(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterNeighborhood theRasterNeighborhood = (RasterNeighborhood) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void release()
          Release a RasterNeighborhood.
 void setAnnulus(double innerRadius, double outerRadius, int unitsType)
          Sets an annulus neighborhood object.
 void setCircle(double radius, int unitsType)
          Sets a circle neighborhood object.
 void setDefault()
          Sets a default neighborhood object.
 void setHighPassFilter()
          Sets a 3 x 3 high-pass filter neighborhood.
 void setIrregular(int height, int width, java.lang.Object entryValues)
          Sets a neighborhood object each of whose entries can be turned on or off.
 void setIrregularFile(java.lang.String fileName)
          Sets an irregular neighborhood by a file.
 void setLowPassFilter()
          Sets a 3 x 3 low-pass filter neighborhood.
 void setRectangle(double width, double height, int unitsType)
          Sets a rectangle neighborhood object.
 void setWedge(double radius, double startAngle, double endAngle, int unitsType)
          Sets a wedge neighborhood object.
 void setWeight(int height, int width, java.lang.Object entryValues)
          Sets a neighborhood object each of whose entries can be assigned a weight.
 void setWeightFile(java.lang.String fileName)
          Sets a weight neighborhood by a file.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RasterNeighborhood

public RasterNeighborhood()
                   throws java.io.IOException,
                          java.net.UnknownHostException
Constructs a RasterNeighborhood using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RasterNeighborhood

public RasterNeighborhood(java.lang.Object obj)
                   throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterNeighborhood theRasterNeighborhood = (RasterNeighborhood) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setDefault

public void setDefault()
                throws java.io.IOException,
                       AutomationException
Sets a default neighborhood object.

Specified by:
setDefault in interface IRasterNeighborhood
Specified by:
setDefault in interface IRasterNeighborhood2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnulus

public void setAnnulus(double innerRadius,
                       double outerRadius,
                       int unitsType)
                throws java.io.IOException,
                       AutomationException
Sets an annulus neighborhood object.

Specified by:
setAnnulus in interface IRasterNeighborhood
Specified by:
setAnnulus in interface IRasterNeighborhood2
Parameters:
innerRadius - The innerRadius (in)
outerRadius - The outerRadius (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCircle

public void setCircle(double radius,
                      int unitsType)
               throws java.io.IOException,
                      AutomationException
Sets a circle neighborhood object.

Specified by:
setCircle in interface IRasterNeighborhood
Specified by:
setCircle in interface IRasterNeighborhood2
Parameters:
radius - The radius (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIrregular

public void setIrregular(int height,
                         int width,
                         java.lang.Object entryValues)
                  throws java.io.IOException,
                         AutomationException
Sets a neighborhood object each of whose entries can be turned on or off.

Specified by:
setIrregular in interface IRasterNeighborhood
Specified by:
setIrregular in interface IRasterNeighborhood2
Parameters:
height - The height (in)
width - The width (in)
entryValues - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRectangle

public void setRectangle(double width,
                         double height,
                         int unitsType)
                  throws java.io.IOException,
                         AutomationException
Sets a rectangle neighborhood object.

Specified by:
setRectangle in interface IRasterNeighborhood
Specified by:
setRectangle in interface IRasterNeighborhood2
Parameters:
width - The width (in)
height - The height (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWedge

public void setWedge(double radius,
                     double startAngle,
                     double endAngle,
                     int unitsType)
              throws java.io.IOException,
                     AutomationException
Sets a wedge neighborhood object.

Specified by:
setWedge in interface IRasterNeighborhood
Specified by:
setWedge in interface IRasterNeighborhood2
Parameters:
radius - The radius (in)
startAngle - The startAngle (in)
endAngle - The endAngle (in)
unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeight

public void setWeight(int height,
                      int width,
                      java.lang.Object entryValues)
               throws java.io.IOException,
                      AutomationException
Sets a neighborhood object each of whose entries can be assigned a weight.

Specified by:
setWeight in interface IRasterNeighborhood
Specified by:
setWeight in interface IRasterNeighborhood2
Parameters:
height - The height (in)
width - The width (in)
entryValues - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHighPassFilter

public void setHighPassFilter()
                       throws java.io.IOException,
                              AutomationException
Sets a 3 x 3 high-pass filter neighborhood.

Specified by:
setHighPassFilter in interface IRasterNeighborhood2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLowPassFilter

public void setLowPassFilter()
                      throws java.io.IOException,
                             AutomationException
Sets a 3 x 3 low-pass filter neighborhood.

Specified by:
setLowPassFilter in interface IRasterNeighborhood2
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIrregularFile

public void setIrregularFile(java.lang.String fileName)
                      throws java.io.IOException,
                             AutomationException
Sets an irregular neighborhood by a file.

Specified by:
setIrregularFile in interface IRasterNeighborhood2
Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWeightFile

public void setWeightFile(java.lang.String fileName)
                   throws java.io.IOException,
                          AutomationException
Sets a weight neighborhood by a file.

Specified by:
setWeightFile in interface IRasterNeighborhood2
Parameters:
fileName - The fileName (in)
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.