This document is archived and information here might be outdated.  Recommended version.


IConditionalOp.SetNull Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IConditionalOp.SetNull Method

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.

[Visual Basic .NET]
Public Function SetNull ( _
    ByVal ConditionalRaster As IGeoDataset, _
    ByVal FalseRaster As IGeoDataset _
) As IGeoDataset

[C#]
public IGeoDataset SetNull (
    IGeoDataset ConditionalRaster,
    IGeoDataset FalseRaster
);

[C++]
HRESULT SetNull(
  IGeoDataset* ConditionalRaster,
  IGeoDataset* FalseRaster
);

[C++]

Parameters
ConditionalRaster [in]

  ConditionalRaster is a parameter of type IGeoDataset*
FalseRaster [in]

  FalseRaster is a parameter of type IGeoDataset*

Product Availability

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

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.

 

See Also

IConditionalOp Interface