com.esri.arcgis.geoanalyst
Interface IRasterAnalysisGDBEnvironment

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterAnalysis, RasterConversionOp, RasterTransformationOp

public interface IRasterAnalysisGDBEnvironment
extends Serializable

Provides access to members that control the environment for Geodatabase 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.

Method Summary

int	getCompressionType() The type and value of compression in the RasterAnalysis.
String	getConfigurationKeyword() The configuration keyword in the RasterAnalysis.
ISpatialReference	getGDBDomains() The XY, Z and M domains in the RasterAnalysis.
String	getIgnoredValue() The ignored value in statistics calculation in RasterAnalysis.
int	getJpegQuality() Jpeg compression quality in the RasterAnalysis.
int	getMosaicType() The mosaic type in the RasterAnalysis.
int	getPyramidLevel() The level in pyramid building in the RasterAnalysis.
int	getPyramidResampleType() The resample type in pyramid building in the RasterAnalysis.
int	getTileHeight() The GeoDatabase tile height in the RasterAnalysis.
int	getTileWidth() The GeoDatabase tile width in the RasterAnalysis.
int	getXSkipFactor() The skip factor in X direction in statistics calculation in the RasterAnalysis.
int	getYSkipFactor() The skip factor in Y direction in statistics calculation in the RasterAnalysis.
boolean	isBuildPyramid() Indicates if the pyramid building in the RasterAnalysis.
boolean	isCalculateStatistics() Indicates if the statistics calculation in the RasterAnalysis.
boolean	isGlobeOptimized() Indicates if the globe optimized type in the RasterAnalysis.
void	setBuildPyramid(boolean buildParamid) Indicates if the pyramid building in the RasterAnalysis.
void	setCalculateStatistics(boolean calculateStatistics) Indicates if the statistics calculation in the RasterAnalysis.
void	setCompressionType(int compressionType) The type and value of compression in the RasterAnalysis.
void	setConfigurationKeyword(String configKeyword) The configuration keyword in the RasterAnalysis.
void	setGDBDomainsByRef(ISpatialReference domainsSpRef) The XY, Z and M domains in the RasterAnalysis.
void	setGlobeOptimized(boolean globeOptimized) Indicates if the globe optimized type in the RasterAnalysis.
void	setIgnoredValue(String ignoredValue) The ignored value in statistics calculation in RasterAnalysis.
void	setJpegQuality(int jpegQuality) Jpeg compression quality in the RasterAnalysis.
void	setMosaicType(int mosaicType) The mosaic type in the RasterAnalysis.
void	setPyramidLevel(int level) The level in pyramid building in the RasterAnalysis.
void	setPyramidResampleType(int resampleType) The resample type in pyramid building in the RasterAnalysis.
void	setTileHeight(int tileHeight) The GeoDatabase tile height in the RasterAnalysis.
void	setTileWidth(int tileWidth) The GeoDatabase tile width in the RasterAnalysis.
void	setXSkipFactor(int xSkipFactor) The skip factor in X direction in statistics calculation in the RasterAnalysis.
void	setYSkipFactor(int ySkipFactor) The skip factor in Y direction in statistics calculation in the RasterAnalysis.

Method Detail

setGlobeOptimized

void setGlobeOptimized(boolean globeOptimized)
                       throws IOException,
                              AutomationException

Indicates if the globe optimized type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

globeOptimized - The globeOptimized (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGlobeOptimized

boolean isGlobeOptimized()
                         throws IOException,
                                AutomationException

Indicates if the globe optimized type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The globeOptimized

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicType

void setMosaicType(int mosaicType)
                   throws IOException,
                          AutomationException

The mosaic type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mosaicType - A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicType

int getMosaicType()
                  throws IOException,
                         AutomationException

The mosaic type in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressionType

void setCompressionType(int compressionType)
                        throws IOException,
                               AutomationException

The type and value of compression in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

compressionType - A com.esri.arcgis.geoanalyst.esriRasterGDBCompressionEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompressionType

int getCompressionType()
                       throws IOException,
                              AutomationException

The type and value of compression in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geoanalyst.esriRasterGDBCompressionEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJpegQuality

void setJpegQuality(int jpegQuality)
                    throws IOException,
                           AutomationException

Jpeg compression quality in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

jpegQuality - The jpegQuality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJpegQuality

int getJpegQuality()
                   throws IOException,
                          AutomationException

Jpeg compression quality in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The jpegQuality

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBuildPyramid

void setBuildPyramid(boolean buildParamid)
                     throws IOException,
                            AutomationException

Indicates if the pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

buildParamid - The buildParamid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBuildPyramid

boolean isBuildPyramid()
                       throws IOException,
                              AutomationException

Indicates if the pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The buildParamid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidResampleType

void setPyramidResampleType(int resampleType)
                            throws IOException,
                                   AutomationException

The resample type in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPyramidResampleType

int getPyramidResampleType()
                           throws IOException,
                                  AutomationException

The resample type in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidLevel

void setPyramidLevel(int level)
                     throws IOException,
                            AutomationException

The level in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

level - The level (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPyramidLevel

int getPyramidLevel()
                    throws IOException,
                           AutomationException

The level in pyramid building in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The level

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCalculateStatistics

void setCalculateStatistics(boolean calculateStatistics)
                            throws IOException,
                                   AutomationException

Indicates if the statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

calculateStatistics - The calculateStatistics (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCalculateStatistics

boolean isCalculateStatistics()
                              throws IOException,
                                     AutomationException

Indicates if the statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The calculateStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXSkipFactor

void setXSkipFactor(int xSkipFactor)
                    throws IOException,
                           AutomationException

The skip factor in X direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

xSkipFactor - The xSkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXSkipFactor

int getXSkipFactor()
                   throws IOException,
                          AutomationException

The skip factor in X direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The xSkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYSkipFactor

void setYSkipFactor(int ySkipFactor)
                    throws IOException,
                           AutomationException

The skip factor in Y direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ySkipFactor - The ySkipFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYSkipFactor

int getYSkipFactor()
                   throws IOException,
                          AutomationException

The skip factor in Y direction in statistics calculation in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The ySkipFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoredValue

void setIgnoredValue(String ignoredValue)
                     throws IOException,
                            AutomationException

The ignored value in statistics calculation in RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ignoredValue - The ignoredValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIgnoredValue

String getIgnoredValue()
                       throws IOException,
                              AutomationException

The ignored value in statistics calculation in RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The ignoredValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileWidth

void setTileWidth(int tileWidth)
                  throws IOException,
                         AutomationException

The GeoDatabase tile width in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

tileWidth - The tileWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileWidth

int getTileWidth()
                 throws IOException,
                        AutomationException

The GeoDatabase tile width in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The tileWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileHeight

void setTileHeight(int tileHeight)
                   throws IOException,
                          AutomationException

The GeoDatabase tile height in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

tileHeight - The tileHeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileHeight

int getTileHeight()
                  throws IOException,
                         AutomationException

The GeoDatabase tile height in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The tileHeight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConfigurationKeyword

void setConfigurationKeyword(String configKeyword)
                             throws IOException,
                                    AutomationException

The configuration keyword in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

configKeyword - The configKeyword (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationKeyword

String getConfigurationKeyword()
                               throws IOException,
                                      AutomationException

The configuration keyword in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The configKeyword

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGDBDomainsByRef

void setGDBDomainsByRef(ISpatialReference domainsSpRef)
                        throws IOException,
                               AutomationException

The XY, Z and M domains in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGDBDomains

ISpatialReference getGDBDomains()
                                throws IOException,
                                       AutomationException

The XY, Z and M domains in the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.