|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.geoanalyst.RasterMakerOp
public class RasterMakerOp
A mechanism for generating rasters.
| Constructor Summary | |
|---|---|
RasterMakerOp()
Constructs a RasterMakerOp using ArcGIS Engine. |
|
RasterMakerOp(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterMakerOp theRasterMakerOp = (RasterMakerOp) 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 |
makeConstant(double value,
boolean treatAsInteger)
Makes a constant raster. |
IGeoDataset |
makeNormal()
Makes a normally distributed raster. |
IGeoDataset |
makeRandom(Object seed)
Makes a randomly distributed raster. |
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. |
| 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 RasterMakerOp()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public RasterMakerOp(Object obj)
throws IOException
RasterMakerOp theRasterMakerOp = (RasterMakerOp) obj;
obj to RasterMakerOp.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic 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 IRasterAnalysisEnvironmentenvType - 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 IRasterAnalysisEnvironmentenvType - 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 IRasterAnalysisEnvironmentenvType - 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 IRasterAnalysisEnvironmentenvType - 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 IRasterAnalysisEnvironmentmask - 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 IRasterAnalysisEnvironmentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setVerifyType(int verifyType)
throws IOException,
AutomationException
setVerifyType in interface IRasterAnalysisEnvironmentverifyType - 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 IRasterAnalysisEnvironmentIOException - 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 IRasterAnalysisEnvironmentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultOutputRasterPrefix(String rasterPrefix)
throws IOException,
AutomationException
setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironmentrasterPrefix - 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 IRasterAnalysisEnvironmentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefaultOutputVectorPrefix(String vectorPrefix)
throws IOException,
AutomationException
setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironmentvectorPrefix - 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 IRasterAnalysisEnvironmentIOException - 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 IRasterAnalysisEnvironmentIOException - 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 IRasterAnalysisEnvironmentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutWorkspaceByRef(IWorkspace workspace)
throws IOException,
AutomationException
setOutWorkspaceByRef in interface IGeoAnalysisEnvironmentworkspace - 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 IGeoAnalysisEnvironmentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
throws IOException,
AutomationException
setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironmentspatialReference - 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 IGeoAnalysisEnvironmentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAvoidDataConversion(boolean bAvoid)
throws IOException,
AutomationException
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.
setAvoidDataConversion in interface IRasterAnalysisGlobalEnvironmentbAvoid - The bAvoid (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isAvoidDataConversion()
throws IOException,
AutomationException
isAvoidDataConversion in interface IRasterAnalysisGlobalEnvironmentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addOutputDatasetName(int index,
IDatasetName pOutName)
throws IOException,
AutomationException
addOutputDatasetName in interface IRasterOpBaseindex - The index (in)pOutName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutputDatasetNameArrayByRef(IArray rhs1)
throws IOException,
AutomationException
setOutputDatasetNameArrayByRef in interface IRasterOpBaserhs1 - A reference to a com.esri.arcgis.system.IArray (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset makeConstant(double value,
boolean treatAsInteger)
throws IOException,
AutomationException
|
value |
constant value to create output raster dataset from. |
|
treatAsInteger |
a boolean specifying the data type of the output raster dataset. If TRUE, an integer raster will be created. If FALSE, a floating-point raster will be created |
makeConstant in interface IRasterMakerOpvalue - The value (in)treatAsInteger - The treatAsInteger (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset makeNormal()
throws IOException,
AutomationException
creates a grid with randomly dispersed values of a normal distribution on a cell-by-cell basis within the analysis window.
Arguments
There are no arguments with the NORMAL function. The output is a Raster object of the same extent and cell size as the current analysis environment.
makeNormal in interface IRasterMakerOpIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeoDataset makeRandom(Object seed)
throws IOException,
AutomationException
|
[seed] |
a value to be used to reseed the random number generator. This may be a scalar, integer or floating point number, or an expression resulting in such a number. Rasters are not permitted as input. By default the random number generator is automatically seeded using the current value of the system clock (seconds since January 1, 1970). The range of permissible values for [seed] is from ¾(2**31) + 1 to 2**31, or ¾ |
makeRandom in interface IRasterMakerOpseed - 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 interfaceSupportsErrorInfo(GUID riid)
throws IOException,
AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - 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 | ||||||||