Horus Doc || Global Function Guide || General documentation   | Function documentation  

HxTanh

Synopsis

HxImageRep HxTanh (HxImageRep img)

Input

HxImageRep img
The image you want to take the hyperbolic tangent of.

Return value

HxImageRep
The pixelwise hyperbolic tangent of the input image.

Description

This function takes the hyperbolic tangent of every pixel value of the input image. For vector images, the hyperbolic tangent of every element of the vector is taken.

Remarks

No possible errors
This function can not result in any errors.

Examples

Taking the hyperbolic tangent of an image.

#include "HxImageRepGlobalFuncs.h"
#include "HxImageRep.h"

HxImageRep HxTanhExample1(HxImageRep img) {
   img = HxImageAsDouble(img);
   img = HxContrastStretch(img, 4.0);
   img = HxAddVal(img, -2.0);
   img = HxTanh(img);
   img = HxContrastStretch(img, 255.0);
   img = HxImageAsByte(img);
   return img;
}

int main(int argc, char* argv[])
{
    HxImageRep im1 = HxMakeFromFile(argv[1]);
    im1 = HxTanhExample1(im1);
    HxWriteFile(im1, argv[2]);

    return 0;
}

exampleImage1.gif

Input image for the HxTanh example.

HxTanhResult1.gif

Output image of the HxTanh example.

This example illustrates the result of taking the hyperbolic tangent of an image.

See also

HxTan, HxSinh, HxAtan,

Keywords

Unary, Trigonometric,


Generated on Mon Jan 27 15:45:02 2003 for GlobalFunctionGuide by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001