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

Create TrigOp ATanH Raster Snippet (ArcObjects .NET 10.5 SDK)

ArcObjects Library Reference

Create TrigOp ATanH Raster Snippet

[C#]

/// <summary>
/// Create an inverse hyperbolic tangent raster from an input GeoDataset.
/// </summary>
/// <param name="geoDataset">An IGeoDataset interface that has cell values that need to have inverse hyperbolic tangent value computed.</param>
/// <returns>An IGeoDataset interface that contains inverse hyperbolic tangent values of the input raster.</returns>
/// <remarks>
/// Note: the input geoDataset must be of Type IRaster, IRasterDataset, IRasterBand, or IRasterDescriptor.
/// 
/// For information about the ITrigOp.ATanH Method see:
/// http://edndoc.esri.com/arcobjects/9.2/ComponentHelp/esriSpatialAnalyst/ITrigOp_ATanH.htm
/// 
/// For more information on working with the ArcGIS Spatial Anaylst objects see:
/// http://edndoc.esri.com/arcobjects/9.2/CPP_VB6_VBA_VCPP_Doc/COM/VB6/working/work_rasters/sptl_analyst_objs.htm
/// </remarks>
public ESRI.ArcGIS.Geodatabase.IGeoDataset CreateTrigOpATanHRaster(ESRI.ArcGIS.Geodatabase.IGeoDataset geoDataset)
{

    if (geoDataset is ESRI.ArcGIS.Geodatabase.IRaster | geoDataset is ESRI.ArcGIS.Geodatabase.IRasterDataset | geoDataset is ESRI.ArcGIS.DataSourcesRaster.IRasterBand | geoDataset is ESRI.ArcGIS.GeoAnalyst.IRasterDescriptor)
    {

        //Create the RasterMathOps object
        ESRI.ArcGIS.SpatialAnalyst.ITrigOp trigOp=new ESRI.ArcGIS.SpatialAnalyst.RasterMathOpsClass();

        // Create the output raster object                      
        ESRI.ArcGIS.Geodatabase.IGeoDataset geoDataset_output=trigOp.ATanH(geoDataset);

        return geoDataset_output;

    }
    else
    {

        //Invalid type of GeoDataset for this process
        return null;

    }

}

[Visual Basic .NET]

''' <summary>
''' Create an inverse hyperbolic tangent raster from an input GeoDataset.
''' </summary>
''' <param name="geoDataset">An IGeoDataset interface that has cell values that need to have inverse hyperbolic tangent value computed.</param>
''' <returns>An IGeoDataset interface that contains inverse hyperbolic tangent values of the input raster.</returns>
''' <remarks>
''' Note: the input geoDataset must be of Type IRaster, IRasterDataset, IRasterBand, or IRasterDescriptor.
''' 
''' For information about the ITrigOp.ATanH Method see:
''' http://edndoc.esri.com/arcobjects/9.2/ComponentHelp/esriSpatialAnalyst/ITrigOp_ATanH.htm
''' 
''' For more information on working with the ArcGIS Spatial Anaylst objects see:
''' http://edndoc.esri.com/arcobjects/9.2/CPP_VB6_VBA_VCPP_Doc/COM/VB6/working/work_rasters/sptl_analyst_objs.htm
''' </remarks>
Public Function CreateTrigOpATanHRaster(ByVal geoDataset As ESRI.ArcGIS.Geodatabase.IGeoDataset) As ESRI.ArcGIS.Geodatabase.IGeoDataset

  If (TypeOf geoDataset Is ESRI.ArcGIS.Geodatabase.IRaster _
  Or TypeOf geoDataset Is ESRI.ArcGIS.Geodatabase.IRasterDataset _
  Or TypeOf geoDataset Is ESRI.ArcGIS.DataSourcesRaster.IRasterBand _
  Or TypeOf geoDataset Is ESRI.ArcGIS.GeoAnalyst.IRasterDescriptor) Then

    'Create the RasterMathOps object
    Dim trigOp As ESRI.ArcGIS.SpatialAnalyst.ITrigOp=New ESRI.ArcGIS.SpatialAnalyst.RasterMathOpsClass

    ' Create the output raster object                   
    Dim geoDataset_output As ESRI.ArcGIS.Geodatabase.IGeoDataset=trigOp.ATanH(geoDataset)

    Return geoDataset_output

  Else

    'Invalid type of GeoDataset for this process
    Return Nothing

  End If

End Function