|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.spatialanalyst.RasterLocalOp
public class RasterLocalOp
A mechanism for performing local operations on rasters.
Constructor Summary | |
---|---|
RasterLocalOp()
Constructs a RasterLocalOp using ArcGIS Engine. |
|
RasterLocalOp(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterLocalOp theRasterLocalOp = (RasterLocalOp) obj; |
Method Summary | |
---|---|
IGeoDataset |
combine(IGeoDataset localData)
Combines the Local GeoDatasets. |
boolean |
equals(Object o)
Compare this object with another |
IGeoDataset |
equalTo(IGeoDataset valueData,
IGeoDataset localData)
Calculates the local equal-to values between GeoDatasets. |
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. |
IGeoDataset |
greaterThan(IGeoDataset valueData,
IGeoDataset localData)
Calculates the local greater-than values between GeoDatasets. |
int |
hashCode()
the hashcode for this object |
IGeoDataset |
highestPosition(IGeoDataset localData)
Calculates the local highest position within GeoDatasets. |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
IGeoDataset |
lessThan(IGeoDataset valueData,
IGeoDataset localData)
Calculates the local less-than values between GeoDatasets. |
IGeoDataset |
localStatistics(IGeoDataset localData,
int type)
Calculates the local statistics of the GeoDataset. |
IGeoDataset |
lowestPosition(IGeoDataset localData)
Calculates the local lowest position within GeoDatasets. |
IGeoDataset |
popularity(IGeoDataset valueData,
IGeoDataset localData)
Calculates the local popularity between GeoDatasets. |
IGeoDataset |
rank(IGeoDataset valueData,
IGeoDataset localData)
Calculates the local rank between GeoDatasets. |
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,
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 |
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. |
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 |
---|
public RasterLocalOp() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic RasterLocalOp(Object obj) throws IOException
RasterLocalOp theRasterLocalOp = (RasterLocalOp) obj;
obj
to RasterLocalOp
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setCellSize(int envType, Object cellSizeProvider) throws IOException, AutomationException
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. |
setCellSize
in interface IRasterAnalysisEnvironment
envType
- A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)cellSizeProvider
- A Variant (in, optional, pass null if not required)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getCellSize(int[] envType, double[] cellSize) throws IOException, AutomationException
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 |
getCellSize
in interface IRasterAnalysisEnvironment
envType
- A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)cellSize
- The cellSize (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExtent(int envType, Object extentProvider, Object snapRasterData) throws IOException, AutomationException
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. |
setExtent
in interface IRasterAnalysisEnvironment
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getExtent(int[] envType, IEnvelope[] extent) throws IOException, AutomationException
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. |
getExtent
in interface IRasterAnalysisEnvironment
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaskByRef(IGeoDataset mask) throws IOException, AutomationException
setMaskByRef
in interface IRasterAnalysisEnvironment
mask
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset getMask() throws IOException, AutomationException
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.
getMask
in interface IRasterAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVerifyType(int verifyType) throws IOException, AutomationException
setVerifyType
in interface IRasterAnalysisEnvironment
verifyType
- A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getVerifyType() throws IOException, AutomationException
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.
getVerifyType
in interface IRasterAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDefaultOutputRasterPrefix() throws IOException, AutomationException
The user specified prefix which is included to all temporary output RasterDatasets during analysis.
getDefaultOutputRasterPrefix
in interface IRasterAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefaultOutputRasterPrefix(String rasterPrefix) throws IOException, AutomationException
setDefaultOutputRasterPrefix
in interface IRasterAnalysisEnvironment
rasterPrefix
- The rasterPrefix (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDefaultOutputVectorPrefix() throws IOException, AutomationException
The user specified prefix which is included to all temporary output Shapefiles during analysis.
getDefaultOutputVectorPrefix
in interface IRasterAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefaultOutputVectorPrefix(String vectorPrefix) throws IOException, AutomationException
setDefaultOutputVectorPrefix
in interface IRasterAnalysisEnvironment
vectorPrefix
- The vectorPrefix (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAsNewDefaultEnvironment() throws IOException, AutomationException
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.
setAsNewDefaultEnvironment
in interface IRasterAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void restoreToPreviousDefaultEnvironment() throws IOException, AutomationException
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.
restoreToPreviousDefaultEnvironment
in interface IRasterAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void reset() throws IOException, AutomationException
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.
reset
in interface IRasterAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOutWorkspaceByRef(IWorkspace workspace) throws IOException, AutomationException
setOutWorkspaceByRef
in interface IGeoAnalysisEnvironment
workspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspace getOutWorkspace() throws IOException, AutomationException
The variable is an object specifying the directory or subdirectory to contain the output rasterdataset
getOutWorkspace
in interface IGeoAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOutSpatialReferenceByRef(ISpatialReference spatialReference) throws IOException, AutomationException
setOutSpatialReferenceByRef
in interface IGeoAnalysisEnvironment
spatialReference
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getOutSpatialReference() throws IOException, AutomationException
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.
getOutSpatialReference
in interface IGeoAnalysisEnvironment
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset localStatistics(IGeoDataset localData, int type) throws IOException, AutomationException
LocalData |
a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor that identifies the values for the local processing |
type |
an esriGeoAnalysisStatisticsEnum defining the local statistic to calculate for each location on the input Rasters The enumeration types are: |
localStatistics
in interface ILocalOp
localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)type
- A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset equalTo(IGeoDataset valueData, IGeoDataset localData) throws IOException, AutomationException
valueData |
an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the values that will be used to determine the number of times that the value occurs in each Raster in the LocalData multiband Raster for each cell location |
localData |
a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the list of Rasters that is used to evaluate the number of occurrences the values in the list of Rasters are equal to the first argument (valueData) for each cell location |
equalTo
in interface ILocalOp
valueData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset greaterThan(IGeoDataset valueData, IGeoDataset localData) throws IOException, AutomationException
valueDataset |
an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the value that will be used to determine the number of times that values in the argument list, the localDataset, are greater than the specified input for each cell location |
localDataset |
a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list that is used to evaluate the number of occurrences the values of the argument list are greater than in the valueDataset for each cell location |
greaterThan
in interface ILocalOp
valueData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset lessThan(IGeoDataset valueData, IGeoDataset localData) throws IOException, AutomationException
valueDataset |
an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the value that will be used to determine the number of times that values in the argument list, the localDataset, are less than the specified input for each cell location |
localDataset |
a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list that is used to evaluate the number of occurrences the values of the argument list are less than in the valueDataset for each cell location |
lessThan
in interface ILocalOp
valueData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset popularity(IGeoDataset valueData, IGeoDataset localData) throws IOException, AutomationException
valueData | an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the popularity position of the specified inputs in the argument list defined by localData that will be returned |
localData | a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list that is used to evaluate the popularity of the values for each cell location |
popularity
in interface ILocalOp
valueData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset rank(IGeoDataset valueData, IGeoDataset localData) throws IOException, AutomationException
valueData | an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the position in the rank order of the specified inputs in the argument list defined by localData to derive the output value |
localData | a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the argument list to identify the value for the rank, defined by the first argument for each cell location |
rank
in interface ILocalOp
valueData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset lowestPosition(IGeoDataset localData) throws IOException, AutomationException
LocalData |
a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor that identifies the values used in defining the argument list for the local processing |
lowestPosition
in interface ILocalOp
localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset highestPosition(IGeoDataset localData) throws IOException, AutomationException
localData |
a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the list of Rasters that is used to evaluate the position of the input Raster with the highest value for each cell within the analysis window |
highestPosition
in interface ILocalOp
localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeoDataset combine(IGeoDataset localData) throws IOException, AutomationException
LocalData | a multiband Raster, RasterDataset, RasterBand, or RasterDescriptor |
combine
in interface ILocalOp
localData
- A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |