This page was created by the IDL library routine mk_html_help2.

Last modified: Thu Sep 27 14:05:48 2007.

Directory Listing of Routines

Routine Descriptions

COTRANS

 [Next Routine] [List of Routines] 
procedure: cotrans, name_in, name_out [, time]

Purpose: geophysical coordinate transformations

         GEI<-->GSE;
         GSE<-->GSM;

         interpolates the spinphase, right ascension, declination
         updates coord_sys atribute of output tplot variable.

inputs

   name_in 	... data in the input coordinate system (t-plot variable name, 
                                                        or array)
   name_out    ... variable name for output            (t-plot variable name,
                                                        or array)
   time        ... optional input: array of times for input values, if provided
                   then the first parameter is an array, and the second
                   parameter is a named variable to contain the output array.


keywords:
   TRANSFORMATIONS


	/GEI2GSE
	/GSE2GEI

	/GSE2GSM
	/GSM2GSE

Examples:


      cotrans('tha_fgl_gse','tha_fgl_gsm',/GSE2GSM)
      cotrans('tha_fgl_gsm','tha_fgl_gse',/GSM2GSE)

      cotrans('tha_fgl_gse','tha_fgl_gei',/GSE2GEI)
      cotrans('tha_fgl_gei','tha_fgl_gse',/GEI2GSE)

Notes: under construction!!

Written by: Hannes Schwarzl

 $LastChangedBy: kenb-mac $
 $LastChangedDate: 2007-07-16 19:16:48 -0700 (Mon, 16 Jul 2007) $
 $LastChangedRevision: 1125 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_2_02/cotrans/cotrans.pro $

(See ssl_general/cotrans/cotrans.pro)

COTRANS_GET_COORD

 [Previous Routine] [Next Routine] [List of Routines] 
	Function: COTRANS_GET_COORD

	Purpose:  determine the coordinate system of data by 
                 examining the contents of it's DLIMIT structure.

	Calling Sequence:
		tplot_var = 'tha_eff'
		get_data, tplot_var, data=d, limit=l, dlimit=dl
		coord = cotrans_get_coord( dl) 
               ; -- or --
               coord = cotrans_get_coord('tha_eff')

	Arguements:
		DL, Anonymous STRUCT, or tplot variable name.

	Notes:
		None.

 $LastChangedBy: kenb-mac $
 $LastChangedDate: 2007-05-01 15:11:55 -0700 (Tue, 01 May 2007) $
 $LastChangedRevision: 622 $
 $URL $

(See ssl_general/cotrans/cotrans_get_coord.pro)

COTRANS_LIB[10]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: tgsmgse_vect

Purpose: GSM to GSE transformation
         (vectorized version of tgsmgse from ROCOTLIB by
          Patrick Robert)



Notes: under construction!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[11]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: cdipdir_vect

Purpose: calls cdipdir from ROCOTLIB in a vectorized environment



Notes: under construction!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $

 faster algorithm (for loop across all points avoided) Hannes 05/25/2007

 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[12]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: cdipdir

Purpose: cdipdir from ROCOTLIB. direction of Earth's magnetic axis in GEO



Notes: under construction!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[1]

 [Previous Routine] [Next Routine] [List of Routines] 
pro sub_GSE2GSM

Purpose: transforms data from GSE to GSM


keywords:
   /GSM2GSE : inverse transformation
Example:
      sub_GSE2GSM,tha_fglc_gse,tha_fglc_gsm

      sub_GSE2GSM,tha_fglc_gsm,tha_fglc_gse,/GSM2GSE


Notes: under construction!!  will run faster in the near future!!

Written by Hannes Schwarzl
 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_2_02/cotrans/cotrans_lib.pro $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[2]

 [Previous Routine] [Next Routine] [List of Routines] 
pro: sub_GEI2GSE

Purpose: transforms THEMIS fluxgate magnetometer data from GEI to GSE


keywords:
   /GSE2GEI : inverse transformation
Example:
      sub_GEI2GSE,tha_fglc_gei,tha_fglc_gse

      sub_GEI2GSE,tha_fglc_gse,tha_fglc_gei,/GSE2GEI


Notes: under construction!!  will run faster in the near future!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[2]

 [Previous Routine] [Next Routine] [List of Routines] 
proceddure: subGEI2GSE

Purpose: transforms data from GEI to GSE

INPUTS: TIMES as time_struct, DATA_in as nx3 array


keywords:

Example:


Notes: under construction!!  will run faster in the near future!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[3]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: subGSE2GEI

Purpose: transforms data from GSE to GEI

INPUTS: TIMES as time_struct, DATA_in as nx3 array


keywords:

Example:


Notes: under construction!!  will run faster in the near future!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[4]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: subGSE2GSM

Purpose: transforms data from GSE to GSM

INPUTS: TIMES as time_struct, DATA_in as nx3 array


keywords:

Example:


Notes: under construction!!  will run faster in the near future!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[5]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: subGSM2GSE

Purpose: transforms data from GSM to GSE

INPUTS: TIMES as time_struct, DATA_in as nx3 array


keywords:

Example:


Notes: under construction!!  will run faster in the near future!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[6]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: csundir_vect

Purpose: calculates the direction of the sun
         (vectorized version of csundir from ROCOTLIB by
          Patrick Robert)

INPUTS: integer time


output :      gst      greenwich mean sideral time (radians)
              slong    longitude along ecliptic (radians)
              sra      right ascension (radians)
              sdec     declination of the sun (radians)
              obliq    inclination of Earth's axis (radians)



Notes: under construction!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[7]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: tgeigse_vect

Purpose: GEI to GSE transformation
         (vectorized version of tgeigse from ROCOTLIB by
          Patrick Robert)



Notes: under construction!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[8]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: tgsegei_vect

Purpose: GSE to GEI transformation
         (vectorized version of tgsegei from ROCOTLIB by
          Patrick Robert)



Notes: under construction!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_LIB[9]

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: tgsegsm_vect

Purpose: GSE to GSM transformation
         (vectorized version of tgsegsm from ROCOTLIB by
          Patrick Robert)



Notes: under construction!!

 $LastChangedBy: hannes $
 $LastChangedDate: 2007-05-28 10:22:27 -0700 (Mon, 28 May 2007) $
 $LastChangedRevision: 705 $
 $URL $

(See ssl_general/cotrans/cotrans_lib.pro)

COTRANS_SET_COORD

 [Previous Routine] [Next Routine] [List of Routines] 
	Function: COTRANS_SET_COORD

	Purpose:  set the coordinate system of data by 
                 setting the data_att structure of its DLIMIT structure.

	Calling Sequence:
		tplot_var = 'tha_eff'
		get_data, tplot_var, data=d, limit=l, dlimit=dl
		coord = cotrans_set_coord, dl, 'gei'
		store_data, tplot_var, data=d, limit=l, dlimit=dl

	Arguements:
		DL, Anonymous STRUCT.

	Notes:
		None.

 $LastChangedBy: mattd $
 $LastChangedDate: 2007-07-13 11:21:57 -0700 (Fri, 13 Jul 2007) $
 $LastChangedRevision: 1089 $
 $URL $

(See ssl_general/cotrans/cotrans_set_coord.pro)

DSL2GSE

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: dsl2gse

Purpose: THEMIS coordinate transformations

         DSL<-->GSE;

         interpolates, right ascension, declination
         updates coord_sys atribute of output tplot variable.

inputs

	name_thx_xxx_in 	... data in the input coordinate system (t-plot variable name)
   name_thx_spinras     ... right ascension (t-plot variable name)
   name_thx_spindec     ... declination (t-plot variable name)
   name_thx_xxx_out     ... name for output (t-plot variable name)

keywords:
   TRANSFORMATIONS


   /GSE2DSL inverse transformation
Example:
      dsl2gse('tha_fgl_dsl','tha_spinras','tha_spindec','tha_fglc_gse')

        expects attitude in GEI (tha_spinras,tha_spindec)

      dsl2gse('tha_fglc_gse','tha_spinras','tha_spindec','tha_fgl_dsl',/GSE2DSL)

        expects attitude in GEI (tha_spinras,tha_spindec)

Notes: under construction!! will run faster in the near future!!

Written by Hannes Schwarzl
 $LastChangedBy: kenb-mac $
 $LastChangedDate: 2007-07-16 19:16:48 -0700 (Mon, 16 Jul 2007) $
 $LastChangedRevision: 1125 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_2_02/cotrans/dsl2gse.pro $

(See ssl_general/cotrans/dsl2gse.pro)

SPG2SSL

 [Previous Routine] [Next Routine] [List of Routines] 
procedure: spg2ssl

Purpose: coordinate transformation

         SPG<-->SSL;


inputs

	name_thx_xxx_in 	... data in the input coordinate system (t-plot variable name)
   name_thx_xxx_out    ... name for output  (t-plot variable name)

keywords:
   TRANSFORMATIONS

   /SSL2SPG inverse transformation
Example:
      spg2ssl,'tha_fgl_spg','tha_fgl_ssl'
      ssl2spg,'tha_fgl_ssl','tha_fgl_spg',/SSL2SPG
Notes: under construction!!

Written by Hannes Schwarzl
 $LastChangedBy: kenb-mac $
 $LastChangedDate: 2007-05-05 10:29:05Z $
 $LastChangedRevision: 645 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/trunk/cotrans/ssl2dsl.pro $

(See ssl_general/cotrans/spg2ssl.pro)

SSL2DSL

 [Previous Routine] [List of Routines] 
procedure: ssl2dsl

Purpose: despins (spins) THEMIS  data

         SSL<-->DSL;

         interpolates the spinphase, spin period
         updates coord_sys atribute of output tplot variable.

inputs

	name_thx_xxx_in 	... data in the input coordinate system (t-plot variable name)
   name_thx_spinper		... spin period (t-plot variable name)
   name_thx_spinphase   ... spin phase  (t-plot variable name)
   name_thx_xxx_out     ... name for output  (t-plot variable name)

keywords:
   TRANSFORMATIONS

   /DSL2SSL inverse transformation
Example:
      ssl2dsl('tha_fgl_ssl','tha_spinper','tha_spinphase','tha_fgl_dsl')
      ssl2dsl('tha_fgl_dsl','tha_spinper','tha_spinphase','tha_fgl_ssl',/DSL2SSL)
Notes: under construction!!

Written by Hannes Schwarzl
 $LastChangedBy: kenb-mac $
 $LastChangedDate: 2007-07-16 19:16:48 -0700 (Mon, 16 Jul 2007) $
 $LastChangedRevision: 1125 $
 $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/ssl_general/tags/tdas_2_02/cotrans/ssl2dsl.pro $

(See ssl_general/cotrans/ssl2dsl.pro)