Documentation for /home/davin/idl/socware/

Generated by IDLdoc

Directory: general/cotrans/

Contents

.pro files

cotrans.pro

procedure: cotrans, name_in, name_out [, time]Purpose: geophysical coordinate transformations GEI<-->GSE; GSE<-->GSM; GSM<-->SM; GEI<-->GEO; GEO<-->MAG; interpolates the spinphase, right ascension, declination updates coord_sys attribute of output tplot variable.

cotrans_get_coord.pro

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

cotrans_lib.pro

pro sub_GSE2GSMPurpose: transforms data from GSE to GSMkeywords: /GSM2GSE : inverse transformationExample: sub_GSE2GSM,tha_fglc_gse,tha_fglc_gsm sub_GSE2GSM,tha_fglc_gsm,tha_fglc_gse,/GSM2GSENotes: under construction!! will run faster in the near future!!Written by Hannes Schwarzl $LastChangedBy: jwl $ $LastChangedDate: 2014-11-05 14:26:45 -0800 (Wed, 05 Nov 2014) $ $LastChangedRevision: 16140 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/general/cotrans/cotrans_lib.pro $

cotrans_set_coord.pro

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

geo2mag.pro

NAME: geo2mag PURPOSE: Convert from geographic to geomagnetic coordinates CALLING SEQUENCE: geo2mag, time, data_in, data_out INPUT: time = an array [n] of double precision time in seconds from 1970-Jan-01/00:00:00.000 data_in = an array [n,3] of position data in km.

gse2agsm.pro

Procedure: gse2agsm Purpose: Converts between GSE coordinates and aberrated GSM coordinates Inputs: in_data: structure containing data to be transformed in GSE coordinates Output: out_data: structure containing the transformed data in aberrated GSM coordinates Keywords: sw_velocity (optional): vector containing solar wind velocity data, [Vx, Vy, Vz] in GSE coordinates rotation_angle (optional): angle to rotate about the Z axis to point into the solar wind (degrees) Notes: Either the solar wind velocity (/sw_velocity) or rotation angle (/rotation_angle) keyword needs to be defined to do the transformation Examples: In the following example, the data to be transformed into aGSM coordinates is in a standard tplot variable named 'position_gse'.

hdz2geo.pro

procedure: hdz2geoPurpose: Coordinate transformation between HDZ coordinates & GEO coordinates HDZ is defined as: H = horizontal field strength, in the plane formed by Z and GEO graphic north D = field strength in the Z x X direction in nT Z = downward field strength H should be a projection onto a basis vector pointing north from station in nT D should be a projection onto a basis vector perpendicular to H in the horizontal plane.

mag2geo.pro

NAME: mag2geo.pro PURPOSE: Convert from geomagnetic to geographic coordinates CALLING SEQUENCE: mag2geo, time, data_in, data_out INPUT: data_in = an [n,3] element array of position data in km and in MAG coordinates KEYWORD INPUTS: None OUTPUT: data_in = an [n,3] element array of position data in km in newly transformed GEO coordinates EXAMPLE: IDL> geo2mag, data_in data_out NOTES: The algorithm and rotational matrices were developed by Pascal Saint-Hilaire (Saint-Hilaire@astro.phys.ethz.ch), May 2002 MODIFICATION HISTORY:

spg2ssl.pro

procedure: spg2sslPurpose: coordinate transformation SPG<-->SSL;inputs name_thx_xxx_in ...