ISIS Application Documentation
 
    This program will apply a chosen function to the input cube
  
             Overview
            
              Parameters
               
              Example 1 
 
 
 
          Description
         
    This program will apply the chosen function to the input cube.
    The following functions with their corresponding restrictions are available:
     NOTE:  Trig functions requiring angles as the input must be in radians.
    	FUNCTION       RESTRICTIONS
	cos (x)
	sin (x)
	tan (x)        x cannot equal: 90, 270, -90, -270,
                                       pi/2, 3pi/2, -pi/2, -3pi/2
	arccos(x)      -1.0 < x < 1.0
	arcsin(x)      -1.0 < x < 1.0
	arctan(x)
	1.0 / x        x cannot equal 0.
	sqrt (x)       x must be greater than or equal to 0.
	10 ^ x
	e ^ x
	x ^ y          x is the input cube, y is an input constant
	log (x)        x > 0
	ln (x)         x > 0
	abs(x)
 
   
 
 
          Categories
         
 
Applications 
 
 
              History
           
Tracie Sucharski 2002-10-18 
      Original version
     
 
Tracie Sucharski 2002-10-29 
      If input pixel is a special pixel, output the input value instead
      of the NULL value.
     
 
K Teal Thompson 2002-11-22 
      Add example.
     
 
Tracie Sucharski 2003-01-28 
      Removed from Utility category.
     
 
K Teal Thompson 2003-02-03 
      Make images smaller.  Move "constants" group below "functions" group.
     
 
Tracie Sucharski 2003-04-03 
      Added to liens:
        1.  Add degree and radian radio buttons.
        2.  Move constants group below functions goup.
     
 
Stuart Sides 2003-04-04 
      Fixed problem with isiscvs not checking in the thumb and image directories.
     
 
Stuart Sides 2003-05-16 
      Modified schema location from astogeology... to isis.astrogeology..."
     
 
Stuart Sides 2003-07-29 
      Modified filename parameters to be cube parameters where necessary
     
 
Tracie Sucharski 2004-07-16 
        Add error checking for cos/sin function.  Print number invalid input pixels.
     
 
Brendan George 2006-09-28 
        Documentation fixes
     
 
Brendan George 2007-01-09 
        Fixed appTest
     
 
Steven Lambright 2007-08-21 
        Fixed output to contain valid pvl
     
 
 
 
 
 
 
                Parameter Groups
             
Files 
                    Name
                     
                    Description
                     
 
FROM 
          Input file (X value)
         
 
TO 
          Output file
         
 
Functions 
                    Name
                     
                    Description
                     
 
FUNCTION  Function to apply to input cube  
 
Constants 
                    Name
                     
                    Description
                     
 
Y y value for XTOY function 
 
 
 
 
Files :
                        FROM 
 
                         Description
                        
          Cube that is used as input to chosen function (x value).
          NOTE:  For trig functions requiring angles, input must be in radians.
        
                             Type
                            cube 
 
                               File Mode
                              input 
 
                               Filter
                              
          *.cub
         
 
 
 
Files :
                        TO 
 
                         Description
                        
          Cube containing the result of the function.
        
                             Type
                            cube 
 
                               File Mode
                              output 
 
                               Pixel Type
                              real 
 
                               Filter
                              
          *.cub
         
 
 
 
Functions :
                        FUNCTION 
 
                         Description
                        
          This indicates the function to apply to the input cube.
        
                             Type
                            string 
 
                               Default
                              COS 
 
                               Option List:
                              
                                   Option 
                                   Brief 
                                   Description 
 
COS cosine 
              Apply the cosine function to the input pixel (x).
              X must be in radians.
            Exclusions 
 
 
SIN sine 
              Apply the sine function to the input pixel (x).
              x must be in radians.
            Exclusions 
 
 
TAN tangent 
              Apply the tangent function to the input pixel (x).
              x cannot equal:  pi/2, 3pi/2, -pi/2, -3p/2, and must be
              in radians.
            Exclusions 
 
 
ACOS arc cosine 
              Apply the arc cosine function to the input pixel (x).
              x must be in radians and between -1.0 and 1.0.
            Exclusions 
 
 
ASIN arc sine 
              Apply the arc sine function to the input pixel (x).
              x must be in radians and between -1.0 and 1.0.
            Exclusions 
 
 
ATAN arc tan 
              Apply the arc tangent function to the input pixel.
            Exclusions 
 
 
INV inverse 
              Apply the inverse function, 1/x, to the input cube.
              (x > 0.)
            Exclusions 
 
 
SQRT square root 
              Take the square root of the input pixel (x).
              (x > 0.)
            Exclusions 
 
 
POW10 Power of 10 
              Take 10 to the power of x (x=input pixel)
            Exclusions 
 
 
EXP exponent 
              Take e to the x (x=input pixel)
	       e = 2.7182818284590452353602874713526
            Exclusions 
 
 
XTOY x ^ y 
              Calculate x (FROM) to the power of y.
            Inclusions 
 
 
LOG10 Log base 10(x) 
              Calculate the log 10 of the input pixel (x).
              (x > 0.)
            Exclusions 
 
 
LN Natural log(x) 
              Calculate the natural log of the input pixel (x).
              (x > 0.)
            Exclusions 
 
 
ABS Absolute value(x) 
              Calculate the absolute value of the input pixel (x).
            Exclusions 
 
 
 
 
 
 
Constants :
                        Y 
 
                         Description
                        
	  y value which is only used when FUNCTION=XTOY.
	
 
 
                Example 1 
 X to Y 
                Description
                 
        This example shows the use of the "x to y" function.
      
                  Command Line
                   
cubefunc  fr=../IN/9700r.cub t=OUT/cubefunc fu=xtoy y=3
         
        You have to use "fr" for the FROM parameter because the parameter FUNCTION starts with an "f", also.
        
 
                  GUI Screenshot
                   
 
 
 
Cubefunc Gui
 
Example Gui
Screenshot of GUI with parameters filled in to perform
a cubefunc operation on the input image. 
 
 
 
                   Input Image
                  
 
 
 
 Input Io image
 
 Input image for cubefunc
                                Parameter Name:
                                 FROM 
This is the input image for the cubefunc example.
          
 
 
 
                   Output Image
                  
 
 
 
Output image showing results of cubefunc using the X to Y function.
 
 Output image for cubefunc
                                Parameter Name:
                                 TO 
 This is the "X to Y" output image that results.