com.esri.arcgis.spatialanalyst
Interface IConditionalOp

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterConditionalOp

public interface IConditionalOp
extends Serializable

Provides access to members that control the conditional 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 con(IGeoDataset conditionalRaster, IGeoDataset trueRaster, Object falseRaster)
              Performs a conditional if/else evaluation.
     IGeoDataset pick(IGeoDataset valueRaster, IGeoDataset collectionOfRasters)
              Using the values of 'valueRaster', determines which raster in 'collectionofRasters' will be used for the output values.
     IGeoDataset setNull(IGeoDataset conditionalRaster, IGeoDataset falseRaster)
              Returns NoData if the evaluation of the input 'conditionalRaster' is true, or returns the value specified by the 'falseRaster' if it is false, on a cell by cell basis.
     

    Method Detail

    con

    IGeoDataset con(IGeoDataset conditionalRaster,
                    IGeoDataset trueRaster,
                    Object falseRaster)
                    throws IOException,
                           AutomationException
    Performs a conditional if/else evaluation.

    Remarks

    conditionalRaster an input Raster, RasterDataset, RasterBand, or RasterDescriptor. The values should be comprised of 1s and 0s with a 1 representing True condition and a 0 a False condition
    trueRaster the value that will be used as the output value if the conditionalRaster is True
    [falseRaster] the value that will be used as the output value if the conditionalRaster is False. If no falseRaster is specified, all False values (0s) in the conditionalRaster will be assigned NoData

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    conditionalRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    trueRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    falseRaster - A Variant (in, optional, pass null if not required)
    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.

    setNull

    IGeoDataset setNull(IGeoDataset conditionalRaster,
                        IGeoDataset falseRaster)
                        throws IOException,
                               AutomationException
    Returns NoData if the evaluation of the input 'conditionalRaster' is true, or returns the value specified by the 'falseRaster' if it is false, on a cell by cell basis.

    Remarks

    conditionRaster a conditional input Raster, RasterDataset, RasterBand, or RasterDescriptor to be tested for Boolean 'True' or 'False'
    falseRaster defines what the output value will be if the evaluation of the condition is False

    If no argument is specified, the output will receive NoData. Unless the desired result is a grid containing all NoData, it is advisable to specify an output for this argument.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    conditionalRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    falseRaster - 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.

    pick

    IGeoDataset pick(IGeoDataset valueRaster,
                     IGeoDataset collectionOfRasters)
                     throws IOException,
                            AutomationException
    Using the values of 'valueRaster', determines which raster in 'collectionofRasters' will be used for the output values.

    Remarks

    valueRaster an input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the expression position that will be executed
    collectionOfRasters name of a multiband Raster

    If the value in the input valueRaster equals '1', then the first Raster in the collectionOfRasters will be used to compute the value for the output Raster. If the value in the input valueRaster equals '2', then the second Raster in the collectionOfRasters will be used to compute the value for the output Raster; if the value on the input valueRaster equals 'n', the expression in the 'nth' position in the collectionOrRasters will be used.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    valueRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    collectionOfRasters - 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.