com.esri.arcgis.datasourcesraster
Interface IRasterGeometryProc3

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRasterGeometryProc3Proxy, RasterGeometryProc

public interface IRasterGeometryProc3

extends java.io.Serializable

Provides access to members that allow raster geometry processing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRasterXFormByIndex method returns the transformation coefficients and the order of transformation on a specified raster band. The transformation coefficients are returned as a variant, which is an Nx2 array with N varies with the transformation order. First order transformation returns a 3x2 array, second order and third order transformations return 6x2 and 10x2 arrays, respectively.

The PutRasterXForm is not intended for outside developers.

See Also:

IRasterGeometryProc

Method Summary

void	clip(IEnvelope ipRectangle, IRaster ipRaster) Clips the input raster based on the specified envelope.
void	flip(IRaster ipRaster) Flips the input raster.
void	getRasterXFormByIndex(IRaster pRaster, int band, boolean forward, int index, int[] order, java.lang.Object[] pVar) Gets the polynomial order and the polynomial coefficients of the indexed transformation.
int	getRasterXFormCount(IRaster pRaster, int band) Gets the number of transformations.
int	getRasterXFormOrderByIndex(IRaster pRaster, int band, int index) Gets the polynomial order of the indexed transformation.
boolean	isPixelToMapTransSimple(IRaster ipRaster) Indicates if the transformation of pixel to map is simple.
java.lang.Object	leastSquareFit(IPointCollection sourceControlPoints, IPointCollection targetControlPoints, int transformType, boolean forwardTransformation, boolean returnTransformationCoef) Computes a least squares fit for the input control points.
IRaster	merge(java.lang.String saveas_name, IWorkspace ipWorkspace, java.lang.String outRasterFormat, double cellSize, ISpatialReference ipSR, IRaster ipRaster) Merges the input rasters into a single dataset.
void	mirror(IRaster ipRaster) Mirrors the input raster.
IRaster	mosaic(java.lang.String saveas_name, IWorkspace ipWorkspace, java.lang.String outRasterFormat, double cellSize, ISpatialReference ipSR, IRaster ipRaster) Mosaics the input rasters into a single dataset.
IPointCollection	pointsMap2PixelTransform(IPointCollection pInPoints, boolean isForward, IRaster pRaster) Performs the map to pixel transformation.
IPointCollection	pointsTransform(IPointCollection inPoints, boolean isForward, IRaster ipRaster) Transforms a set of points based upon the transformation being applied to the input raster.
void	projectFast(ISpatialReference ipNewSR, int resampleType, java.lang.Object cellSize, IRaster ipRaster) Projects the input raster using a single polynomial fit to compute the adjustment between coordinate systems.
void	putRasterXForm(IRaster pRaster, boolean clean, int order, java.lang.Object pVar) Sets a polynomial transformation to the Raster.
void	rectify(java.lang.String saveas_name, java.lang.String format, IRaster ipRaster) Persists the input raster to a new dataset of the specified format.
void	register(IRaster ipRaster) Outputs the current transformation properties to the dataset header or auxilliary file.
void	resample(int resampleType, double newCellsize, IRaster ipRaster) Resamples the input raster to a new cellsize.
void	reScale(double xScale, double yScale, IRaster ipRaster) Scales the input raster by the specified x and y scale factors.
void	reset(IRaster ipRaster) Resets the input raster to its native coordinate space.
void	rotate(IPoint ipPivotPoint, double rotateAngle, IRaster ipRaster) Rotates the input raster around the specified pivot by an angle specified in degrees.
void	shift(double deltaX, double deltaY, IRaster ipRaster) Shifts the input raster by deltaX and deltaY map units.
void	twoPointsAdjust(IPointCollection sourceControlPoints, IPointCollection targetControlPoints, IRaster ipRaster) Performs a Hermite transformation on the input raster based upon the 2 input control point pairs.
void	warp(IPointCollection sourceControlPoints, IPointCollection targetControlPoints, int transformType, IRaster ipRaster) Warps the input raster based upon the input control points using the transformation type specified.

Method Detail

flip

public void flip(IRaster ipRaster)
          throws java.io.IOException,
                 AutomationException

Flips the input raster.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mirror

public void mirror(IRaster ipRaster)
            throws java.io.IOException,
                   AutomationException

Mirrors the input raster.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shift

public void shift(double deltaX,
                  double deltaY,
                  IRaster ipRaster)
           throws java.io.IOException,
                  AutomationException

Shifts the input raster by deltaX and deltaY map units.

Supported Platforms

Windows, Solaris, Linux

Parameters:

deltaX - The deltaX (in)

deltaY - The deltaY (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reScale

public void reScale(double xScale,
                    double yScale,
                    IRaster ipRaster)
             throws java.io.IOException,
                    AutomationException

Scales the input raster by the specified x and y scale factors.

Supported Platforms

Windows, Solaris, Linux

Parameters:

xScale - The xScale (in)

yScale - The yScale (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotate

public void rotate(IPoint ipPivotPoint,
                   double rotateAngle,
                   IRaster ipRaster)
            throws java.io.IOException,
                   AutomationException

Rotates the input raster around the specified pivot by an angle specified in degrees.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ipPivotPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

rotateAngle - The rotateAngle (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

warp

public void warp(IPointCollection sourceControlPoints,
                 IPointCollection targetControlPoints,
                 int transformType,
                 IRaster ipRaster)
          throws java.io.IOException,
                 AutomationException

Warps the input raster based upon the input control points using the transformation type specified.

Supported Platforms

Windows, Solaris, Linux

Parameters:

sourceControlPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

targetControlPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

transformType - A com.esri.arcgis.datasourcesraster.esriGeoTransTypeEnum constant (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

twoPointsAdjust

public void twoPointsAdjust(IPointCollection sourceControlPoints,
                            IPointCollection targetControlPoints,
                            IRaster ipRaster)
                     throws java.io.IOException,
                            AutomationException

Performs a Hermite transformation on the input raster based upon the 2 input control point pairs.

Supported Platforms

Windows, Solaris, Linux

Parameters:

sourceControlPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

targetControlPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pointsTransform

public IPointCollection pointsTransform(IPointCollection inPoints,
                                        boolean isForward,
                                        IRaster ipRaster)
                                 throws java.io.IOException,
                                        AutomationException

Transforms a set of points based upon the transformation being applied to the input raster.

Supported Platforms

Windows, Solaris, Linux

Parameters:

inPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

isForward - The isForward (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

leastSquareFit

public java.lang.Object leastSquareFit(IPointCollection sourceControlPoints,
                                       IPointCollection targetControlPoints,
                                       int transformType,
                                       boolean forwardTransformation,
                                       boolean returnTransformationCoef)
                                throws java.io.IOException,
                                       AutomationException

Computes a least squares fit for the input control points.

Supported Platforms

Windows, Solaris, Linux

Parameters:

sourceControlPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

targetControlPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

transformType - A com.esri.arcgis.datasourcesraster.esriGeoTransTypeEnum constant (in)

forwardTransformation - The forwardTransformation (in)

returnTransformationCoef - The returnTransformationCoef (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset(IRaster ipRaster)
           throws java.io.IOException,
                  AutomationException

Resets the input raster to its native coordinate space.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rectify

public void rectify(java.lang.String saveas_name,
                    java.lang.String format,
                    IRaster ipRaster)
             throws java.io.IOException,
                    AutomationException

Persists the input raster to a new dataset of the specified format.

Supported Platforms

Windows, Solaris, Linux

Remarks

The output formats as well as the strings used for the supported formats are below, and they are case sensitive:

Format Name	String Used
Imagine	"IMAGINE Image"
TIFF	"TIFF"
GRID	"GRID"
JPEG	"JPG"
JP2000	"JP2"
BMP	"BMP"
PNG	"PNG"
GIF	"GIF"
PCI Raster	"PIX"
USGS ASCII DEM	"DEM"
X11 Pixmap	"XPM"
PCRaster	"MAP"
USGS ASCII DEM	"DEM"

Parameters:

saveas_name - The saveas_name (in)

format - The format (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

register

public void register(IRaster ipRaster)
              throws java.io.IOException,
                     AutomationException

Outputs the current transformation properties to the dataset header or auxilliary file.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clip

public void clip(IEnvelope ipRectangle,
                 IRaster ipRaster)
          throws java.io.IOException,
                 AutomationException

Clips the input raster based on the specified envelope.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ipRectangle - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

projectFast

public void projectFast(ISpatialReference ipNewSR,
                        int resampleType,
                        java.lang.Object cellSize,
                        IRaster ipRaster)
                 throws java.io.IOException,
                        AutomationException

Projects the input raster using a single polynomial fit to compute the adjustment between coordinate systems.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

resampleType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

cellSize - A Variant (in, optional, pass null if not required)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in, optional, pass null if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

merge

public IRaster merge(java.lang.String saveas_name,
                     IWorkspace ipWorkspace,
                     java.lang.String outRasterFormat,
                     double cellSize,
                     ISpatialReference ipSR,
                     IRaster ipRaster)
              throws java.io.IOException,
                     AutomationException

Merges the input rasters into a single dataset.

Supported Platforms

Windows, Solaris, Linux

Parameters:

saveas_name - The saveas_name (in)

ipWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

outRasterFormat - The outRasterFormat (in)

cellSize - The cellSize (in)

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

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mosaic

public IRaster mosaic(java.lang.String saveas_name,
                      IWorkspace ipWorkspace,
                      java.lang.String outRasterFormat,
                      double cellSize,
                      ISpatialReference ipSR,
                      IRaster ipRaster)
               throws java.io.IOException,
                      AutomationException

Mosaics the input rasters into a single dataset.

Supported Platforms

Windows, Solaris, Linux

Parameters:

saveas_name - The saveas_name (in)

ipWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

outRasterFormat - The outRasterFormat (in)

cellSize - The cellSize (in)

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

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resample

public void resample(int resampleType,
                     double newCellsize,
                     IRaster ipRaster)
              throws java.io.IOException,
                     AutomationException

Resamples the input raster to a new cellsize.

Supported Platforms

Windows, Solaris, Linux

Parameters:

resampleType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

newCellsize - The newCellsize (in)

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPixelToMapTransSimple

public boolean isPixelToMapTransSimple(IRaster ipRaster)
                                throws java.io.IOException,
                                       AutomationException

Indicates if the transformation of pixel to map is simple.

Parameters:

ipRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

The isSimple

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterXFormCount

public int getRasterXFormCount(IRaster pRaster,
                               int band)
                        throws java.io.IOException,
                               AutomationException

Gets the number of transformations.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRasterXFormCount method returns the number of geometric transformations on a specified raster band.

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

band - The band (in)

Returns:

The xFormCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterXFormOrderByIndex

public int getRasterXFormOrderByIndex(IRaster pRaster,
                                      int band,
                                      int index)
                               throws java.io.IOException,
                                      AutomationException

Gets the polynomial order of the indexed transformation.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetRasterXFormByIndex method returns the transformation coefficients and the order of transformation on a specified raster band. The transformation coefficients are returned as a variant, which is an n x 2 array where n varies with the transformation order. First order transformation returns a 3 x 2 array, second order and third order transformations return 6 x 2 and 10 x 2 arrays, respectively.

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

band - The band (in)

index - The index (in)

Returns:

A com.esri.arcgis.datasourcesraster.esriGeoTransTypeEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterXFormByIndex

public void getRasterXFormByIndex(IRaster pRaster,
                                  int band,
                                  boolean forward,
                                  int index,
                                  int[] order,
                                  java.lang.Object[] pVar)
                           throws java.io.IOException,
                                  AutomationException

Gets the polynomial order and the polynomial coefficients of the indexed transformation.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetRasterXFormOrderByIndex method returns the order of a specified geometric transformation on a raster band.

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

band - The band (in)

forward - The forward (in)

index - The index (in)

order - A com.esri.arcgis.datasourcesraster.esriGeoTransTypeEnum constant (in/out: use single element array)

pVar - A Variant (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putRasterXForm

public void putRasterXForm(IRaster pRaster,
                           boolean clean,
                           int order,
                           java.lang.Object pVar)
                    throws java.io.IOException,
                           AutomationException

Sets a polynomial transformation to the Raster.

Supported Platforms

Windows, Solaris, Linux

Remarks

The PutRasterXForm method appends a polynomial transformation to a raster. You can also clean the existing transformations on the raster by setting parameter clean to be true. Since calling this method does not automatically update the cell size and extent of the raster like other geometric operations (Shift, Rotate, etc.) do, Rectify or SaveAs will not persist the transformations to a raster dataset directly. Therefore, this method is not recommended to use.

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

clean - The clean (in)

order - A com.esri.arcgis.datasourcesraster.esriGeoTransTypeEnum constant (in)

pVar - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pointsMap2PixelTransform

public IPointCollection pointsMap2PixelTransform(IPointCollection pInPoints,
                                                 boolean isForward,
                                                 IRaster pRaster)
                                          throws java.io.IOException,
                                                 AutomationException

Performs the map to pixel transformation.

Supported Platforms

Windows, Solaris, Linux

Remarks

The PointsMap2PixelTransform method takes all the transformations on a Raster, and then performs transformations between map space and pixel space. This method works better for rasters with square cell size.

Parameters:

pInPoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

isForward - The isForward (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.