Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.datasourcesraster
Interface IRasterGeometryProc3

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterGeometryProc
public interface IRasterGeometryProc3
extends Serializable

Provides access to members that allow raster geometry processing.

Product Availability

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

Method Summary
 void clip(IEnvelope pRectangle, IRaster pRaster)
          Clips the input raster based on the specified envelope.
 void flip(IRaster pRaster)
          Flips the input raster.
 void getRasterXFormByIndex(IRaster pRaster, int band, boolean forward, int index, int[] order, 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 pRaster)
          Indicates if the transformation of pixel to map is simple.
 Object leastSquareFit(IPointCollection sourceControlPoints, IPointCollection targetControlPoints, int transformType, boolean forwardTransformation, boolean returnTransformationCoef)
          Computes a least squares fit for the input control points.
 IRaster merge(String saveas_name, IWorkspace pWorkspace, String outRasterFormat, double cellSize, ISpatialReference pSR, IRaster pRaster)
          Merges the input rasters into a single dataset.
 void mirror(IRaster pRaster)
          Mirrors the input raster.
 IRaster mosaic(String saveas_name, IWorkspace pWorkspace, String outRasterFormat, double cellSize, ISpatialReference pSR, IRaster pRaster)
          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 pRaster)
          Transforms a set of points based upon the transformation being applied to the input raster.
 void projectFast(ISpatialReference pNewSR, int resampleType, Object cellSize, IRaster pRaster)
          Projects the input raster using a single polynomial fit to compute the adjustment between coordinate systems.
 void putRasterXForm(IRaster pRaster, boolean clean, int order, Object pVar)
          Sets a polynomial transformation to the Raster.
 void rectify(String saveas_name, String format, IRaster pRaster)
          Persists the input raster to a new dataset of the specified format.
 void register(IRaster pRaster)
          Outputs the current transformation properties to the dataset header or auxilliary file.
 void resample(int resampleType, double newCellsize, IRaster pRaster)
          Resamples the input raster to a new cellsize.
 void reScale(double xScale, double yScale, IRaster pRaster)
          Scales the input raster by the specified x and y scale factors.
 void reset(IRaster pRaster)
          Resets the input raster to its native coordinate space.
 void rotate(IPoint ipPivotPoint, double rotateAngle, IRaster pRaster)
          Rotates the input raster around the specified pivot by an angle specified in degrees.
 void shift(double deltaX, double deltaY, IRaster pRaster)
          Shifts the input raster by deltaX and deltaY map units.
 void twoPointsAdjust(IPointCollection sourceControlPoints, IPointCollection targetControlPoints, IRaster pRaster)
          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 pRaster)
          Warps the input raster based upon the input control points using the transformation type specified.
 

Method Detail

flip

void flip(IRaster pRaster)
          throws IOException,
                 AutomationException
Flips the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

mirror

void mirror(IRaster pRaster)
            throws IOException,
                   AutomationException
Mirrors the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

shift

void shift(double deltaX,
           double deltaY,
           IRaster pRaster)
           throws IOException,
                  AutomationException
Shifts the input raster by deltaX and deltaY map units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

reScale

void reScale(double xScale,
             double yScale,
             IRaster pRaster)
             throws IOException,
                    AutomationException
Scales the input raster by the specified x and y scale factors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

rotate

void rotate(IPoint ipPivotPoint,
            double rotateAngle,
            IRaster pRaster)
            throws IOException,
                   AutomationException
Rotates the input raster around the specified pivot by an angle specified in degrees.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ipPivotPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
rotateAngle - The rotateAngle (in)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

warp

void warp(IPointCollection sourceControlPoints,
          IPointCollection targetControlPoints,
          int transformType,
          IRaster pRaster)
          throws IOException,
                 AutomationException
Warps the input raster based upon the input control points using the transformation type specified.

Remarks

Warp method computes a polynomial transformation based on the input links, then applies this transformation to the input raster. The polynomial transformation specified can be first, second, or third order polynomials. Each transformation order requires a minimum number of control links. They are 3, 6, and 10 for order 1,2, and 3, respectively.

Product Availability

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

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)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

twoPointsAdjust

void twoPointsAdjust(IPointCollection sourceControlPoints,
                     IPointCollection targetControlPoints,
                     IRaster pRaster)
                     throws IOException,
                            AutomationException
Performs a Hermite transformation on the input raster based upon the 2 input control point pairs.

Product Availability

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

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)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pointsTransform

IPointCollection pointsTransform(IPointCollection inPoints,
                                 boolean isForward,
                                 IRaster pRaster)
                                 throws IOException,
                                        AutomationException
Transforms a set of points based upon the transformation being applied to the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

leastSquareFit

Object leastSquareFit(IPointCollection sourceControlPoints,
                      IPointCollection targetControlPoints,
                      int transformType,
                      boolean forwardTransformation,
                      boolean returnTransformationCoef)
                      throws IOException,
                             AutomationException
Computes a least squares fit for the input control points.

Product Availability

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

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

reset

void reset(IRaster pRaster)
           throws IOException,
                  AutomationException
Resets the input raster to its native coordinate space.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

rectify

void rectify(String saveas_name,
             String format,
             IRaster pRaster)
             throws IOException,
                    AutomationException
Persists the input raster to a new dataset of the specified format.

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"

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

register

void register(IRaster pRaster)
              throws IOException,
                     AutomationException
Outputs the current transformation properties to the dataset header or auxilliary file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

clip

void clip(IEnvelope pRectangle,
          IRaster pRaster)
          throws IOException,
                 AutomationException
Clips the input raster based on the specified envelope.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

projectFast

void projectFast(ISpatialReference pNewSR,
                 int resampleType,
                 Object cellSize,
                 IRaster pRaster)
                 throws IOException,
                        AutomationException
Projects the input raster using a single polynomial fit to compute the adjustment between coordinate systems.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pNewSR - 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)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

merge

IRaster merge(String saveas_name,
              IWorkspace pWorkspace,
              String outRasterFormat,
              double cellSize,
              ISpatialReference pSR,
              IRaster pRaster)
              throws IOException,
                     AutomationException
Merges the input rasters into a single dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
saveas_name - The saveas_name (in)
pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
outRasterFormat - The outRasterFormat (in)
cellSize - The cellSize (in)
pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mosaic

IRaster mosaic(String saveas_name,
               IWorkspace pWorkspace,
               String outRasterFormat,
               double cellSize,
               ISpatialReference pSR,
               IRaster pRaster)
               throws IOException,
                      AutomationException
Mosaics the input rasters into a single dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
saveas_name - The saveas_name (in)
pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
outRasterFormat - The outRasterFormat (in)
cellSize - The cellSize (in)
pSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resample

void resample(int resampleType,
              double newCellsize,
              IRaster pRaster)
              throws IOException,
                     AutomationException
Resamples the input raster to a new cellsize.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
resampleType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
newCellsize - The newCellsize (in)
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPixelToMapTransSimple

boolean isPixelToMapTransSimple(IRaster pRaster)
                                throws IOException,
                                       AutomationException
Indicates if the transformation of pixel to map is simple.

Product Availability

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

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

getRasterXFormCount

int getRasterXFormCount(IRaster pRaster,
                        int band)
                        throws IOException,
                               AutomationException
Gets the number of transformations.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
band - The band (in)
Returns:
The xFormCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRasterXFormOrderByIndex

int getRasterXFormOrderByIndex(IRaster pRaster,
                               int band,
                               int index)
                               throws IOException,
                                      AutomationException
Gets the polynomial order of the indexed transformation.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRasterXFormByIndex

void getRasterXFormByIndex(IRaster pRaster,
                           int band,
                           boolean forward,
                           int index,
                           int[] order,
                           Object[] pVar)
                           throws IOException,
                                  AutomationException
Gets the polynomial order and the polynomial coefficients of the indexed transformation.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

putRasterXForm

void putRasterXForm(IRaster pRaster,
                    boolean clean,
                    int order,
                    Object pVar)
                    throws IOException,
                           AutomationException
Sets a polynomial transformation to the Raster.

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 for ourside developers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

pointsMap2PixelTransform

IPointCollection pointsMap2PixelTransform(IPointCollection pInPoints,
                                          boolean isForward,
                                          IRaster pRaster)
                                          throws IOException,
                                                 AutomationException
Performs the map to pixel transformation.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD