com.esri.arcgis.spatialanalyst
Interface IMathOp

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterMathOps

public interface IMathOp
extends Serializable

Provides access to members that control the mathematical operations.

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. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux


    Method Summary
     IGeoDataset abs(IGeoDataset geoDataset)
              Calculates the absolute value of cells in a raster.
     IGeoDataset divide(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
              Divides the values of two inputs.
     IGeoDataset esri_float(IGeoDataset geoDataset)
              Converts a raster into floating point representation.
     IGeoDataset esri_int(IGeoDataset geoDataset)
              Converts a raster to integer by truncation.
     IGeoDataset exp(IGeoDataset geoDataset)
              Calculates the base e exponential of cells in a raster.
     IGeoDataset exp10(IGeoDataset geoDataset)
              Calculates the base 10 exponential of cells in a raster.
     IGeoDataset exp2(IGeoDataset geoDataset)
              Calculates the base 2 exponential of cells in a raster.
     IGeoDataset ln(IGeoDataset geoDataset)
              Calculates the natural logarithm (base e) of cells in a raster.
     IGeoDataset log10(IGeoDataset geoDataset)
              Calculates the base 10 logarithm of cells in a raster.
     IGeoDataset log2(IGeoDataset geoDataset)
              Calculates the base 2 logarithm of cells in a raster.
     IGeoDataset minus(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
              Subtracts the values of two inputs.
     IGeoDataset mod(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
              Finds the remainder of the first input when divided by the second.
     IGeoDataset negate(IGeoDataset geoDataset)
              Changes the sign of the input raster (multiplies by -1).
     IGeoDataset plus(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
              Adds the values of two inputs.
     IGeoDataset power(IGeoDataset geoDataset, double power)
              Raises the cells in a raster to the Nth power.
     IGeoDataset powerByCellValue(IGeoDataset geoDataset, IGeoDataset powerDataset)
              Raises the cells in a raster to the power of values found in another raster.
     IGeoDataset roundDown(IGeoDataset geoDataset)
              Returns the next lower whole number for each cell in a raster.
     IGeoDataset roundUp(IGeoDataset geoDataset)
              Returns the next higher whole number for each cell in a raster.
     IGeoDataset square(IGeoDataset geoDataset)
              Calculates the square of cells in a raster.
     IGeoDataset squareRoot(IGeoDataset geoDataset)
              Calculates the square root of cells in a raster.
     IGeoDataset times(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
              Multiplies the values of two inputs.
     

    Method Detail

    divide

    IGeoDataset divide(IGeoDataset geoDataset1,
                       IGeoDataset geoDataset2)
                       throws IOException,
                              AutomationException
    Divides the values of two inputs.

    Remarks

    geoDataset1

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    geoDataset2

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    minus

    IGeoDataset minus(IGeoDataset geoDataset1,
                      IGeoDataset geoDataset2)
                      throws IOException,
                             AutomationException
    Subtracts the values of two inputs.

    Remarks

    geoDataset1

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    geoDataset2

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    plus

    IGeoDataset plus(IGeoDataset geoDataset1,
                     IGeoDataset geoDataset2)
                     throws IOException,
                            AutomationException
    Adds the values of two inputs.

    Remarks

    geoDataset1

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    geoDataset2

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    times

    IGeoDataset times(IGeoDataset geoDataset1,
                      IGeoDataset geoDataset2)
                      throws IOException,
                             AutomationException
    Multiplies the values of two inputs.

    Remarks

    geoDataset1

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    geoDataset2

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    mod

    IGeoDataset mod(IGeoDataset geoDataset1,
                    IGeoDataset geoDataset2)
                    throws IOException,
                           AutomationException
    Finds the remainder of the first input when divided by the second.

    Remarks

    geoDataset1

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    geoDataset2

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    abs

    IGeoDataset abs(IGeoDataset geoDataset)
                    throws IOException,
                           AutomationException
    Calculates the absolute value of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    esri_float

    IGeoDataset esri_float(IGeoDataset geoDataset)
                           throws IOException,
                                  AutomationException
    Converts a raster into floating point representation.

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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

    exp

    IGeoDataset exp(IGeoDataset geoDataset)
                    throws IOException,
                           AutomationException
    Calculates the base e exponential of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    exp2

    IGeoDataset exp2(IGeoDataset geoDataset)
                     throws IOException,
                            AutomationException
    Calculates the base 2 exponential of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    exp10

    IGeoDataset exp10(IGeoDataset geoDataset)
                      throws IOException,
                             AutomationException
    Calculates the base 10 exponential of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    ln

    IGeoDataset ln(IGeoDataset geoDataset)
                   throws IOException,
                          AutomationException
    Calculates the natural logarithm (base e) of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    log2

    IGeoDataset log2(IGeoDataset geoDataset)
                     throws IOException,
                            AutomationException
    Calculates the base 2 logarithm of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    log10

    IGeoDataset log10(IGeoDataset geoDataset)
                      throws IOException,
                             AutomationException
    Calculates the base 10 logarithm of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    negate

    IGeoDataset negate(IGeoDataset geoDataset)
                       throws IOException,
                              AutomationException
    Changes the sign of the input raster (multiplies by -1).

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    power

    IGeoDataset power(IGeoDataset geoDataset,
                      double power)
                      throws IOException,
                             AutomationException
    Raises the cells in a raster to the Nth power.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Power

    defines the power to which to raise the input

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    roundDown

    IGeoDataset roundDown(IGeoDataset geoDataset)
                          throws IOException,
                                 AutomationException
    Returns the next lower whole number for each cell in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    roundUp

    IGeoDataset roundUp(IGeoDataset geoDataset)
                        throws IOException,
                               AutomationException
    Returns the next higher whole number for each cell in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    square

    IGeoDataset square(IGeoDataset geoDataset)
                       throws IOException,
                              AutomationException
    Calculates the square of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    squareRoot

    IGeoDataset squareRoot(IGeoDataset geoDataset)
                           throws IOException,
                                  AutomationException
    Calculates the square root of cells in a raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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

    esri_int

    IGeoDataset esri_int(IGeoDataset geoDataset)
                         throws IOException,
                                AutomationException
    Converts a raster to integer by truncation.

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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

    powerByCellValue

    IGeoDataset powerByCellValue(IGeoDataset geoDataset,
                                 IGeoDataset powerDataset)
                                 throws IOException,
                                        AutomationException
    Raises the cells in a raster to the power of values found in another raster.

    Remarks

    geoDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor

    powerDataset

    an input Raster, RasterDataset, RasterBand, or RasterDescriptor. It

    defines the power to which to raise the input on a cell by cell basis

    Product Availability

    Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

    Supported Platforms

    Windows, Solaris, Linux

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