TUdataCT TCL UTILITIES USER MANUAL TUdataCT
SYNOPSIS
A set of geophysical coordinate transformations.
PACKAGE
TCLUTILS
NAME
TUdataCT
USAGE
TUdataCT  In CoIn XInfo Out CoOut {ntM} {Yr} {Dy} {Ms}
INPUT DEFINITIONS
In - Input X, Y, Z coordinate array
CoIn - Coordinate system of the input coordinate sytem
GEI - Geocentric Equitorial Inertial
GSE - Geocentric Solar Ecliptic
GSM - Geocentric Solar Magnetospheric
GEO - Geodetic
MAG - Geomagnetic
SM - Solar Magnetospheric
XInfo - Transformation matrices. These will either be created within the procedure or can be from one created in a previous call. It will be created if it doesn't currently exist or if ntM is 1.
Out - Output X, Y, Z coordinate array
CoOut - Coordinate system of the output coordinate sytem
GEI - Geocentric Equitorial Inertial
GSE - Geocentric Solar Ecliptic
GSM - Geocentric Solar Magnetospheric
GEO - Geodetic
MAG - Geomagnetic
SM - Solar Magnetospheric
ntM - New matrix tranformation flag. Default is 0.
0 - Do not recompute XInfo
1 - Recompute XInfo
Yr - Year used when computing the transformation matrices. Default is 1970.
Dy - Day of year used when computing the transformation matrices. Default is 1.
Dy - Millisecond of day used when computing the transformation matrices. Default is 0.
RETURN DEFINITION
NONE
DESCRIPTION
TUdataCT transforms the vector In which is in the coordinate system CoIn to the vector Out in the coordinate system CoOut. The routine computes the complete suite of rotation matrices for all transformations at each call for which XInfo is either undefined or ntM is set to 1. The transformation matrices are computed for the time given in Yr, Dy, and Ms. The transformation matrices returned in XInfo can be reused if routine is being successively called for a fixed time.
ERRORS
None Generated
C BACKING
Yes
EXAMPLE(S)
# SET up vector in GEI
                                                                                
set A(0)  7.0 ; set A(1)  1.0 ; set A(2)  10.0
puts stderr "A in GEI : [format "%.1f %.1f %.1f" $A(0) $A(1) $A(2)]"
                                                                                
# TRANSFORM it to MAG
                                                                                
TUdataCT A GEI XFInfo B MAG 0 2000 234 1200
puts stderr "A TO MAG : [format "%.1f %.1f %.1f" $B(0) $B(1) $B(2)]"
                                                                                
# TRANSFORM it back to GEI
                                                                                
TUdataCT B MAG XFInfo C GEI 0 2000 234 1200
puts stderr "BACK TO GEI : [format "%.1f %.1f %.1f" $C(0) $C(1) $C(2)]"

> A in GEI : 7.0 1.0 10.0
> A TO MAG : -4.2 6.6 9.4
> BACK TO GEI : 7.0 1.0 10.0

      
Sept 14, 2006