com.esri.arcgis.geoanalyst
Class ITransformationOpProxy

java.lang.Object
  extended bycom.esri.arcgis.interop.Dispatch
      extended bycom.esri.arcgis.geoanalyst.ITransformationOpProxy
All Implemented Interfaces:
java.io.Externalizable, ITransformationOp, java.io.Serializable

public class ITransformationOpProxy
extends Dispatch
implements ITransformationOp, java.io.Serializable

Provides access to members that control the transformation operations.

Product Availability

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

See Also:
Serialized Form

Field Summary
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF
 
Constructor Summary
  ITransformationOpProxy()
          For internal use only
  ITransformationOpProxy(java.lang.Object obj)
           
protected ITransformationOpProxy(java.lang.Object obj, java.lang.String iid)
           
  ITransformationOpProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
           
protected ITransformationOpProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Adds a Java object to be a listener for a specific kind of event generated by the COM object.
 IGeoDataset clip(IGeoDataset geoDataset, IEnvelope rectangle)
          Subsets a raster using a rectangle.
 IGeoDataset flip(IGeoDataset geoDataset)
          Flips a raster along the horizontal axis.
 IGeoDataset mirror(IGeoDataset geoDataset)
          Mirrors a raster along the vertical axis.
 IGeoDataset mosaic(IRasterBandCollection collectionOfRasters, int mosaicType)
          Creates one raster from two or more adjacent rasters and makes a smooth transition over the overlapping areas of the neighboring rasters.
 IGeoDataset projectFast(IGeoDataset geoDataset, ISpatialReference newSpatialReference, int resampleType, java.lang.Object cellSize)
          Converts a raster between two coordinate systems on region bases.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Removes a Java object as a listener to events generated by a COM object.
 IGeoDataset resample(IGeoDataset geoDataset, double newCellsize, int resampleType)
          Resamples raster to a new cell size.
 IGeoDataset reScale(IGeoDataset inData, double xScale, double yScale)
          Scales the coordinates of a raster.
 IGeoDataset rotate(IGeoDataset geoDataset, int resampleType, double angle, java.lang.Object origin)
          Rotates a raster around a point by a specified angle.
 IGeoDataset shift(IGeoDataset geoDataset, double xShift, double yShift, java.lang.Object pSnapRasterData)
          Shifts the coordinates of a raster.
 IGeoDataset warp(IGeoDataset geoDataset, IPointCollection sourceControlPoints, IPointCollection targetControlPoints, int transformType, int resampleType)
          Transforms a raster along a set of links using a polynomial transformation.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Constructor Detail

ITransformationOpProxy

public ITransformationOpProxy(java.lang.String CLSID,
                              java.lang.String host,
                              AuthInfo authInfo)
                       throws java.net.UnknownHostException,
                              java.io.IOException

ITransformationOpProxy

public ITransformationOpProxy()
For internal use only


ITransformationOpProxy

public ITransformationOpProxy(java.lang.Object obj)
                       throws java.io.IOException

ITransformationOpProxy

protected ITransformationOpProxy(java.lang.Object obj,
                                 java.lang.String iid)
                          throws java.io.IOException

ITransformationOpProxy

protected ITransformationOpProxy(java.lang.String CLSID,
                                 java.lang.String iid,
                                 java.lang.String host,
                                 AuthInfo authInfo)
                          throws java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Description copied from class: Dispatch
Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
addListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object to be informed of the events
theSource - the proxy class that represents the COM class that is the source of the events
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Description copied from class: Dispatch
Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
removeListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object that no longer wishes to be informed of the events
Throws:
java.io.IOException

flip

public IGeoDataset flip(IGeoDataset geoDataset)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ITransformationOp
Flips a raster along the horizontal axis.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor to make a Flip copy of(along the horizontal axis).

Specified by:
flip in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mirror

public IGeoDataset mirror(IGeoDataset geoDataset)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ITransformationOp
Mirrors a raster along the vertical axis.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor to make a mirror copy of (along the verticle axis).

Specified by:
mirror in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

shift

public IGeoDataset shift(IGeoDataset geoDataset,
                         double xShift,
                         double yShift,
                         java.lang.Object pSnapRasterData)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ITransformationOp
Shifts the coordinates of a raster.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataSet

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

xShift

The value to shift the x coordinates by.

yShift

The value to shift the y coordinates by.

pSnapRasterData

The input raster to snap cell alignment to

Specified by:
shift in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
xShift - The xShift (in)
yShift - The yShift (in)
pSnapRasterData - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reScale

public IGeoDataset reScale(IGeoDataset inData,
                           double xScale,
                           double yScale)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ITransformationOp
Scales the coordinates of a raster.

Supported Platforms

Windows, Solaris, Linux

Remarks

inData

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

xScale

Factor to scale the cell size in the x direction by.
The factor must be greater than 0.

yScale

Factor to scale the cell size in the y direction by.
The factor must be greater than 0.

Specified by:
reScale in interface ITransformationOp
Parameters:
inData - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
xScale - The xScale (in)
yScale - The yScale (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rotate

public IGeoDataset rotate(IGeoDataset geoDataset,
                          int resampleType,
                          double angle,
                          java.lang.Object origin)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ITransformationOp
Rotates a raster around a point by a specified angle.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

resampleType

an esriGeoAnalysisResampleEnum specifing the resampling algorithm to be used when sampling a Raster

can be of type:

esriGeoAnalysisResampleBilinear - bilinear interpolation. This is Default.

esriGeoAnalysisResampleCubic - cubic convolution.

esriGeoAnalysisResampleNearest - nearest neighbor assignment.

angle 

The angle in degrees to rotate the raster. This can be any floating-point number.

[origin]

The pivot point to rotate the raster around.

The default is the lower left corner of input GeoDataset

Specified by:
rotate in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
resampleType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant (in)
angle - The angle (in)
origin - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

clip

public IGeoDataset clip(IGeoDataset geoDataset,
                        IEnvelope rectangle)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ITransformationOp
Subsets a raster using a rectangle.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Rectangle

an IEnvelope identifying the lower-left and upper-right coordinates of the rectangle defining the area to be subset from the input GeoDatabase

The coordinates are specified in map units and are in the same units as the GeoDataset.

Specified by:
clip in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
rectangle - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resample

public IGeoDataset resample(IGeoDataset geoDataset,
                            double newCellsize,
                            int resampleType)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: ITransformationOp
Resamples raster to a new cell size.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataSet

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

newCellsize

The cell size the output raster will be created at.

This will be the value in the Environment if it is explicitly set. Otherwise, it is the shortest of the width or the height of the extent of in_point_features, in the input spatial reference, divided by 250.

resampleType

an esriGeoAnalysisResampleEnum specifing the resampling algorithm to be used when sampling a Raster

can be of type:

esriGeoAnalysisResampleBilinear - bilinear interpolation. This is Default.

esriGeoAnalysisResampleCubic - cubic convolution.

esriGeoAnalysisResampleNearest - nearest neighbor assignment.

Specified by:
resample in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
newCellsize - The newCellsize (in)
resampleType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

warp

public IGeoDataset warp(IGeoDataset geoDataset,
                        IPointCollection sourceControlPoints,
                        IPointCollection targetControlPoints,
                        int transformType,
                        int resampleType)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ITransformationOp
Transforms a raster along a set of links using a polynomial transformation.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

sourceControlPoints

The source points are the "from" coordinates of the links.

targetControlPoints

The target points are the "to" coordinates of the links.

transformType

an esriGeoTransTypeEnum specifying the geometric transformation type.

There are three types, specifying the order of the polynomial. Higher order values will fit a more complex surface.

esriGeoTransPolyOrder1 - A first order polynomial fits a flat plane to the input points.  This is default.

esriGeoTransPolyOrder2  - Transformation is a second order polynomial

esriGeoTransPolyOrder3 - Transformation is a third order polynomial.

resampleType

an esriGeoAnalysisResampleEnum specifing the resampling algorithm to be used when sampling a Raster

can be of type:

esriGeoAnalysisResampleBilinear - bilinear interpolation. This is Default.

esriGeoAnalysisResampleCubic - cubic convolution.

esriGeoAnalysisResampleNearest - nearest neighbor assignment.

 

Specified by:
warp in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
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)
resampleType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

projectFast

public IGeoDataset projectFast(IGeoDataset geoDataset,
                               ISpatialReference newSpatialReference,
                               int resampleType,
                               java.lang.Object cellSize)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: ITransformationOp
Converts a raster between two coordinate systems on region bases.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

newSpatialReference

references an object supporting ISpatialReference interface that specifies the output spatial reference. 

resampleType

an esriGeoAnalysisResampleEnum specifing the resampling algorithm to be used when sampling a Raster

can be of type:

esriGeoAnalysisResampleBilinear - bilinear interpolation. This is Default.

esriGeoAnalysisResampleCubic - cubic convolution.

esriGeoAnalysisResampleNearest - nearest neighbor assignment.

[cellSize]

ouput cellsize.  The default is the current environment setting.

Specified by:
projectFast in interface ITransformationOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
newSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
resampleType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant (in)
cellSize - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mosaic

public IGeoDataset mosaic(IRasterBandCollection collectionOfRasters,
                          int mosaicType)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ITransformationOp
Creates one raster from two or more adjacent rasters and makes a smooth transition over the overlapping areas of the neighboring rasters.

Supported Platforms

Windows, Solaris, Linux

Remarks

collectionOfRasters

input collection of Raster objects that support IRasterBandCollection interface

MosaicType

an enumeration type constant which specifies the method used to mosaic overlapping areas.

can be of type:
 
MT_FIRST - The output value will be determined by the order the inputs are entered, with the first raster specified as the top. This is the default.

MT_BLEND - The output value will be a blend of values of the overlapped cells.

MT_MEAN - The output value will be the mean value of the overlapped cells.

MT_MIN - The output value will be the minimum value of the overlapped cells.

MT_MAX - The output value will be the maximum value of the overlapped cells.

Specified by:
mosaic in interface ITransformationOp
Parameters:
collectionOfRasters - A reference to a com.esri.arcgis.datasourcesraster.IRasterBandCollection (in)
mosaicType - A com.esri.arcgis.datasourcesraster.rstMosaicOperatorType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.