com.esri.arcgis.spatialanalyst
Interface IGPSATransformationFunction

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPSATransformationFunction, IGPSATransformationFunctionProxy

public interface IGPSATransformationFunction
extends java.io.Serializable

COM Interface 'IGPSATransformationFunction'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description: 'Provides access to the transformation function object used for transformation function.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID333cd08e_e094_4a3d_8f7c_040a8413fe18
static int	xxDummy Deprecated. Internal use only

Method Summary

void	getDefaultTransformationValues(int type, java.lang.String pInData, double fromScale, double toScale, boolean bBuildStats, IGPEnvironmentManager pEnvMgr, double[] lowerThreshold, java.lang.Object[] valueBelowThreshold, double[] upperThreshold, java.lang.Object[] valueAboveThreshold, double[] num1, double[] num2, double[] num3, java.lang.String[] fileName) Gets the default values of a transformation function
int	getType() type of transformation function parameters.
void	setCustom(java.lang.String[] fileName, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a custom transformation function.
void	setDefault() Sets default transformation function parameters.
void	setExponential(java.lang.Object minimum, java.lang.Object baseFactor, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Exponential transformation function.
void	setGaussian(java.lang.Object midPoint, java.lang.Object spread, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Gaussion transformation function.
void	setLarge(java.lang.Object midPoint, java.lang.Object spread, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Large transformation function.
void	setLinear(java.lang.Object minimum, java.lang.Object maximum, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Linear transformation function.
void	setLogarithm(java.lang.Object minimum, java.lang.Object factor, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Logarithm transformation function.
void	setLogisticDecay(java.lang.Object minimum, java.lang.Object maximum, java.lang.Object yInterceptPercent, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Logistic Decay transformation function.
void	setLogisticGrowth(java.lang.Object minimum, java.lang.Object maximum, java.lang.Object yInterceptPercent, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Logistic Growth transformation function.
void	setMSLarge(java.lang.Object nMeans, java.lang.Object nSTDVs, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a MSLarge transformation function.
void	setMSSmall(java.lang.Object nMeans, java.lang.Object nSTDVs, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a MSSmall transformation function.
void	setNear(java.lang.Object midPoint, java.lang.Object spread, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Near transformation function.
void	setPower(java.lang.Object minimum, java.lang.Object exponent, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Power transformation function.
void	setSmall(java.lang.Object midPoint, java.lang.Object spread, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Small transformation function.
void	setSymmetricLinear(java.lang.Object minimum, java.lang.Object maximum, java.lang.Object lowerThreshold, java.lang.Object valueBelowThreshold, java.lang.Object upperThreshold, java.lang.Object valueAboveThreshold, IGPMessage ppGPMessage) Defines a Symetric Linear transformation function.

Field Detail

IID333cd08e_e094_4a3d_8f7c_040a8413fe18

static final int IID333cd08e_e094_4a3d_8f7c_040a8413fe18

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getType

int getType()
            throws java.io.IOException,
                   AutomationException

type of transformation function parameters.

Returns:

A com.esri.arcgis.spatialanalyst.esriSATransformationFunctionEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefault

void setDefault()
                throws java.io.IOException,
                       AutomationException

Sets default transformation function parameters.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGaussian

void setGaussian(java.lang.Object midPoint,
                 java.lang.Object spread,
                 java.lang.Object lowerThreshold,
                 java.lang.Object valueBelowThreshold,
                 java.lang.Object upperThreshold,
                 java.lang.Object valueAboveThreshold,
                 IGPMessage ppGPMessage)
                 throws java.io.IOException,
                        AutomationException

Defines a Gaussion transformation function.

Parameters:

midPoint - A Variant (in)

spread - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSmall

void setSmall(java.lang.Object midPoint,
              java.lang.Object spread,
              java.lang.Object lowerThreshold,
              java.lang.Object valueBelowThreshold,
              java.lang.Object upperThreshold,
              java.lang.Object valueAboveThreshold,
              IGPMessage ppGPMessage)
              throws java.io.IOException,
                     AutomationException

Defines a Small transformation function.

Parameters:

midPoint - A Variant (in)

spread - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLarge

void setLarge(java.lang.Object midPoint,
              java.lang.Object spread,
              java.lang.Object lowerThreshold,
              java.lang.Object valueBelowThreshold,
              java.lang.Object upperThreshold,
              java.lang.Object valueAboveThreshold,
              IGPMessage ppGPMessage)
              throws java.io.IOException,
                     AutomationException

Defines a Large transformation function.

Parameters:

midPoint - A Variant (in)

spread - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNear

void setNear(java.lang.Object midPoint,
             java.lang.Object spread,
             java.lang.Object lowerThreshold,
             java.lang.Object valueBelowThreshold,
             java.lang.Object upperThreshold,
             java.lang.Object valueAboveThreshold,
             IGPMessage ppGPMessage)
             throws java.io.IOException,
                    AutomationException

Defines a Near transformation function.

Parameters:

midPoint - A Variant (in)

spread - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMSSmall

void setMSSmall(java.lang.Object nMeans,
                java.lang.Object nSTDVs,
                java.lang.Object lowerThreshold,
                java.lang.Object valueBelowThreshold,
                java.lang.Object upperThreshold,
                java.lang.Object valueAboveThreshold,
                IGPMessage ppGPMessage)
                throws java.io.IOException,
                       AutomationException

Defines a MSSmall transformation function.

Parameters:

nMeans - A Variant (in)

nSTDVs - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMSLarge

void setMSLarge(java.lang.Object nMeans,
                java.lang.Object nSTDVs,
                java.lang.Object lowerThreshold,
                java.lang.Object valueBelowThreshold,
                java.lang.Object upperThreshold,
                java.lang.Object valueAboveThreshold,
                IGPMessage ppGPMessage)
                throws java.io.IOException,
                       AutomationException

Defines a MSLarge transformation function.

Parameters:

nMeans - A Variant (in)

nSTDVs - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLinear

void setLinear(java.lang.Object minimum,
               java.lang.Object maximum,
               java.lang.Object lowerThreshold,
               java.lang.Object valueBelowThreshold,
               java.lang.Object upperThreshold,
               java.lang.Object valueAboveThreshold,
               IGPMessage ppGPMessage)
               throws java.io.IOException,
                      AutomationException

Defines a Linear transformation function.

Parameters:

minimum - A Variant (in)

maximum - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymmetricLinear

void setSymmetricLinear(java.lang.Object minimum,
                        java.lang.Object maximum,
                        java.lang.Object lowerThreshold,
                        java.lang.Object valueBelowThreshold,
                        java.lang.Object upperThreshold,
                        java.lang.Object valueAboveThreshold,
                        IGPMessage ppGPMessage)
                        throws java.io.IOException,
                               AutomationException

Defines a Symetric Linear transformation function.

Parameters:

minimum - A Variant (in)

maximum - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExponential

void setExponential(java.lang.Object minimum,
                    java.lang.Object baseFactor,
                    java.lang.Object lowerThreshold,
                    java.lang.Object valueBelowThreshold,
                    java.lang.Object upperThreshold,
                    java.lang.Object valueAboveThreshold,
                    IGPMessage ppGPMessage)
                    throws java.io.IOException,
                           AutomationException

Defines a Exponential transformation function.

Parameters:

minimum - A Variant (in)

baseFactor - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLogarithm

void setLogarithm(java.lang.Object minimum,
                  java.lang.Object factor,
                  java.lang.Object lowerThreshold,
                  java.lang.Object valueBelowThreshold,
                  java.lang.Object upperThreshold,
                  java.lang.Object valueAboveThreshold,
                  IGPMessage ppGPMessage)
                  throws java.io.IOException,
                         AutomationException

Defines a Logarithm transformation function.

Parameters:

minimum - A Variant (in)

factor - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPower

void setPower(java.lang.Object minimum,
              java.lang.Object exponent,
              java.lang.Object lowerThreshold,
              java.lang.Object valueBelowThreshold,
              java.lang.Object upperThreshold,
              java.lang.Object valueAboveThreshold,
              IGPMessage ppGPMessage)
              throws java.io.IOException,
                     AutomationException

Defines a Power transformation function.

Parameters:

minimum - A Variant (in)

exponent - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLogisticGrowth

void setLogisticGrowth(java.lang.Object minimum,
                       java.lang.Object maximum,
                       java.lang.Object yInterceptPercent,
                       java.lang.Object lowerThreshold,
                       java.lang.Object valueBelowThreshold,
                       java.lang.Object upperThreshold,
                       java.lang.Object valueAboveThreshold,
                       IGPMessage ppGPMessage)
                       throws java.io.IOException,
                              AutomationException

Defines a Logistic Growth transformation function.

Parameters:

minimum - A Variant (in)

maximum - A Variant (in)

yInterceptPercent - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLogisticDecay

void setLogisticDecay(java.lang.Object minimum,
                      java.lang.Object maximum,
                      java.lang.Object yInterceptPercent,
                      java.lang.Object lowerThreshold,
                      java.lang.Object valueBelowThreshold,
                      java.lang.Object upperThreshold,
                      java.lang.Object valueAboveThreshold,
                      IGPMessage ppGPMessage)
                      throws java.io.IOException,
                             AutomationException

Defines a Logistic Decay transformation function.

Parameters:

minimum - A Variant (in)

maximum - A Variant (in)

yInterceptPercent - A Variant (in)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustom

void setCustom(java.lang.String[] fileName,
               java.lang.Object lowerThreshold,
               java.lang.Object valueBelowThreshold,
               java.lang.Object upperThreshold,
               java.lang.Object valueAboveThreshold,
               IGPMessage ppGPMessage)
               throws java.io.IOException,
                      AutomationException

Defines a custom transformation function.

Parameters:

fileName - The fileName (in/out: use single element array)

lowerThreshold - A Variant (in)

valueBelowThreshold - A Variant (in)

upperThreshold - A Variant (in)

valueAboveThreshold - A Variant (in)

ppGPMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultTransformationValues

void getDefaultTransformationValues(int type,
                                    java.lang.String pInData,
                                    double fromScale,
                                    double toScale,
                                    boolean bBuildStats,
                                    IGPEnvironmentManager pEnvMgr,
                                    double[] lowerThreshold,
                                    java.lang.Object[] valueBelowThreshold,
                                    double[] upperThreshold,
                                    java.lang.Object[] valueAboveThreshold,
                                    double[] num1,
                                    double[] num2,
                                    double[] num3,
                                    java.lang.String[] fileName)
                                    throws java.io.IOException,
                                           AutomationException

Gets the default values of a transformation function

Parameters:

type - A com.esri.arcgis.spatialanalyst.esriSATransformationFunctionEnum constant (in)

pInData - The pInData (in)

fromScale - The fromScale (in)

toScale - The toScale (in)

bBuildStats - The bBuildStats (in)

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

lowerThreshold - The lowerThreshold (out: use single element array)

valueBelowThreshold - A Variant (out: use single element array)

upperThreshold - The upperThreshold (out: use single element array)

valueAboveThreshold - A Variant (out: use single element array)

num1 - The num1 (out: use single element array)

num2 - The num2 (out: use single element array)

num3 - The num3 (out: use single element array)

fileName - The fileName (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.