com.esri.arcgis.geoanalyst
Interface IRasterAnalysisEnvironment

All Superinterfaces:
IGeoAnalysisEnvironment, Serializable
All Known Implementing Classes:
GridTableOp, RasterAnalysis, RasterConditionalOp, RasterConversionOp, RasterDensityOp, RasterDistanceOp, RasterExtractionOp, RasterGeneralizeOp, RasterGroundwaterOp, RasterHydrologyOp, RasterInterpolationOp, RasterLocalOp, RasterMakerOp, RasterMapAlgebraOp, RasterMathOps, RasterMathSupportOp, RasterModel, RasterMultivariateOp, RasterNeighborhoodOp, RasterReclassOp, RasterSurfaceOp, RasterTransformationOp, RasterZonalOp

public interface IRasterAnalysisEnvironment
extends IGeoAnalysisEnvironment, Serializable

Provides access to members that control the environment for raster analysis.

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.

    Supported Platforms

    Windows, Solaris, Linux


    Method Summary
     void getCellSize(int[] envType, double[] cellSize)
              Gets the type and value of cell size in the RasterAnalysis.
     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.
     int getVerifyType()
              The verify type of the RasterAnalysis.
     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 setVerifyType(int verifyType)
              The verify type of the RasterAnalysis.
     
    Methods inherited from interface com.esri.arcgis.geoanalyst.IGeoAnalysisEnvironment
    getOutSpatialReference, getOutWorkspace, setOutSpatialReferenceByRef, setOutWorkspaceByRef
     

    Method Detail

    setCellSize

    void setCellSize(int envType,
                     Object cellSizeProvider)
                     throws IOException,
                            AutomationException
    Sets the type and value of cell size in the RasterAnalysis.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)
    cellSizeProvider - A Variant (in, optional, pass null if not required)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getCellSize

    void getCellSize(int[] envType,
                     double[] cellSize)
                     throws IOException,
                            AutomationException
    Gets the type and value of cell size in the RasterAnalysis.

    Remarks

    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

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)
    cellSize - The cellSize (out: use single element array)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    setExtent

    void setExtent(int envType,
                   Object extentProvider,
                   Object snapRasterData)
                   throws IOException,
                          AutomationException
    Sets the type and values of extent in the RasterAnalysis.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    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:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getExtent

    void getExtent(int[] envType,
                   IEnvelope[] extent)
                   throws IOException,
                          AutomationException
    Gets the type and values of extent in the RasterAnalysis.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    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:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    setMaskByRef

    void setMaskByRef(IGeoDataset mask)
                      throws IOException,
                             AutomationException
    Mask allows processing to occur only for a selected set of cells.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    mask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getMask

    IGeoDataset getMask()
                        throws IOException,
                               AutomationException
    Mask allows processing to occur only for a selected set of cells.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    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.

    setVerifyType

    void setVerifyType(int verifyType)
                       throws IOException,
                              AutomationException
    The verify type of the RasterAnalysis.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getVerifyType

    int getVerifyType()
                      throws IOException,
                             AutomationException
    The verify type of the RasterAnalysis.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Returns:
    A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getDefaultOutputRasterPrefix

    String getDefaultOutputRasterPrefix()
                                        throws IOException,
                                               AutomationException
    The default output raster prefix.

    Remarks

    The user specified prefix which is included to all temporary output RasterDatasets during analysis.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Returns:
    The rasterPrefix
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    setDefaultOutputRasterPrefix

    void setDefaultOutputRasterPrefix(String rasterPrefix)
                                      throws IOException,
                                             AutomationException
    The default output raster prefix.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    rasterPrefix - The rasterPrefix (in)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    getDefaultOutputVectorPrefix

    String getDefaultOutputVectorPrefix()
                                        throws IOException,
                                               AutomationException
    The default output vector prefix.

    Remarks

    The user specified prefix which is included to all temporary output Shapefiles during analysis.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Returns:
    The vectorPrefix
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    setDefaultOutputVectorPrefix

    void setDefaultOutputVectorPrefix(String vectorPrefix)
                                      throws IOException,
                                             AutomationException
    The default output vector prefix.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    vectorPrefix - The vectorPrefix (in)
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    setAsNewDefaultEnvironment

    void setAsNewDefaultEnvironment()
                                    throws IOException,
                                           AutomationException
    Sets the raster analysis environment of the object as new default environment.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    restoreToPreviousDefaultEnvironment

    void restoreToPreviousDefaultEnvironment()
                                             throws IOException,
                                                    AutomationException
    Restores to the previous default raster analysis environment.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    reset

    void reset()
               throws IOException,
                      AutomationException
    Remove all previously stored default rasteranalysis environments.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.