This page was created by the IDL library routine mk_html_help2.

Last modified: Sun Nov 11 12:37:48 2007.

ssl_general/cotrans/special

• TCROSSP
• TDOTP
• TINTERPOL_MXN
• TNORMALIZE
• TVECTOR_ROTATE
  

Routine Descriptions

PROCEDURE: TCROSSP
Purpose:
  Vectorized routine to calculate the cross product of two tplot
  variables containing arrays of 3d vectors and storing the result
  in a tplot variable

Arguments: 
 v1: The name of the tplot variable storing the first vector in the cross product
 v2: The name of the tplot variable storing the second vector in the
 cross product
 
 newname(optional): the name of the output tplot variable

 error(optional): named variable in which to return error state of
 the computation.  1 = success 0 = failure

NOTES: 

(See ssl_general/cotrans/special/tcrossp.pro)

PROCEDURE: TDOTP
Purpose:
  Vectorized routine to calculate the dot product of two tplot
  variables containing arrays of vectors and storing the results
  in a tplot variable

Arguments: 
 v1: The name of the tplot variable storing the first vector in the dot product
 v2: The name of the tplot variable storing the second vector in the
 dot product
 
 newname(optional): the name of the output tplot variable

 error(optional): named variable in which to return the error state
 of the computation.  1 = success 0 = failure

NOTES: 

(See ssl_general/cotrans/special/tdotp.pro)

Function: tinterpol_mxn

Purpose:  Generalized interpolates across a series of vectors(since
interpol only works on 1-d vectors) This function works on any
n-dimensional vectors. Basically, this is an element by element
interpolation across M

 - i. works on tplot variables
     - ii. allows no extrapolation beyond valid data with
          /no_extrapolate keyword"
              
Arguments:
            xv_tvar = tplot variable to be interpolated, the y component
            can have any dimesions
            uses x component for x abcissa values
            uz_tvar = tplot variable that V will be fit to
            uses x component for u abcissa values
            newname = output variable name(optional) defaults to
            xv_tvar+'_interp'
            /LINEAR = pass this argument to specify linear
            interpolation(this is the default behavior)
            /QUADRATIC = pass this argument to specify quadratic
            interpolation
            /SPLINE = pass this argument to specify spline
            interpolation
            /NO_EXTRAPOLATE = pass this argument to prevent
            extrapolation of data values in V passed it's start and
            end points
            error(optional): named variable in which to return the error state
            of the computation.  1 = success 0 = failure


CALLING SEQUENCE;
           tinterpol_mxn,'tplot_var1','tplot_var2',out_var='tplot_var_out'
           tinterpol_mxn,'tplot_var1','tplot_var2',/NO_EXTRAPOLATE
           tinterpol_mxn,'tplot_var1','tplot_var2',/SPLINE
         
Output: an N by D1 by D2 by ... array stored in an output tplot variabel

Notes: 
Uses a for loop over D1*D2*..., but I'm operating under the assumption that
D1*D2... << M (D1 * D2 *... is waaaay less than M)

It uses a little bit of modular arithmatic so this function is
generalized to any array dimensionality(IDL limits at 8)


Examples:
 if the input is an array of 3-d vectors(say 1,1,1 and 2,2,2) and we
 want 3 vectors out the output is 1,1,1 1.5 1.5 1.5 2,2,2
 if the input is an array of 3x3 matrices(say all ones and all twos) 
 and we want three matrices then output is all 1s all 1.5s all 2s 
 

 $LastChangedBy: pcruce $
 $LastChangedDate: 2007-10-03 14:18:24 -0700 (Wed, 03 Oct 2007) $
 $LastChangedRevision: 1659 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_3_01/cotrans/special/tinterpol_mxn.pro $

(See ssl_general/cotrans/special/tinterpol_mxn.pro)

PROCEDURE: TNORMALIZE
Purpose:
  Vectorized routine to normalize all the vectors stored in a tplot
  variable


Arguments: 
 v: The name of the tplot variable storing the vectors to be
 normalized
 newname(optional): The name of the output tplot variable. Defaults
 to v+'_normalized'
 error(optional): Named variable in which to return the error state
 of the computation, 1 = success, 0 = failure
 

NOTES:

 $LastChangedBy: pcruce $
 $LastChangedDate: 2007-08-10 15:40:38 -0700 (Fri, 10 Aug 2007) $
 $LastChangedRevision: 1378 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_3_01/cotrans/special/tnormalize.pro $

(See ssl_general/cotrans/special/tnormalize.pro)

Procedure: tvector_rotate

Purpose:  rotates a set of vectors by a set of coordinate
          transformation matrices inputs and outputs are tplot variables
Arguments:

 mat_var_in: the name of the tplot variable storing input matrices

 vec_var_in: the name of the tplot variable storing input vectors(can
 use normal globbing)


 newname(optional): the name of the output variable, defaults to 
                    vec_var_in + '_rot'
                    If you use type globbing in the vector variable
                    This option will be disabled

 error(optional): named variable in which to return the error state
 of the computation.  1 = success 0 = failure


CALLING SEQUENCE:

 tvector_rotate,'matrix_var','vector_var',newname = 'out_var',error=error

 tvector_rotate,'matrix_var','vector_var'

Notes: 

(See ssl_general/cotrans/special/tvector_rotate.pro)