/
pyshread2.1
105 lines (105 loc) · 3.19 KB
/
pyshread2.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.TH "pyshread2" "1" "2015\-04\-06" "Python" "SHTOOLS 3.1"
.SH SHRead2
.PP
Read spherical harmonic coefficients from a CHAMP or GRACE\-like
ascii\-formatted file.
.SH Usage
.PP
\f[C]cilm\f[], \f[C]lmax\f[], \f[C]gm\f[], \f[C]r0_pot\f[],
\f[C]dot\f[], \f[C]doystart\f[], \f[C]doyend\f[], \f[C]epoch\f[] =
pyshtools.SHRead2 (\f[C]filename\f[], \f[C]lmaxin\f[])
.SH Returns
.TP
.B \f[C]cilm\f[] : float, dimension (2, \f[C]lmaxin\f[]+1, \f[C]lmaxin\f[]+1)
The spherical harmonic coefficients contained in \f[C]filename\f[].
.RS
.RE
.TP
.B \f[C]lmax\f[] : integer
The maximum spherical harmonic degree of \f[C]cilm\f[].
This is the minimum of the dimension of \f[C]cilm\f[] and
\f[C]lmaxin\f[].
.RS
.RE
.TP
.B \f[C]gm\f[] : float
The mass\-gravitational constant.
.RS
.RE
.TP
.B \f[C]r0_pot\f[] : float
The reference radius of the potential coefficients.
.RS
.RE
.TP
.B \f[C]dot\f[] : float, dimension (2, \f[C]lmaxin\f[]+1, \f[C]lmaxin\f[]+1)
The time derivatives of the spherical harmonic coefficients.
The dimension of this array can be smaller than \f[C]lmax+1\f[].
.RS
.RE
.TP
.B \f[C]doystart\f[] : float
The starting time of the solution.
.RS
.RE
.TP
.B \f[C]doyend\f[] : float
The ending time of the solution
.RS
.RE
.TP
.B \f[C]epoch\f[] : float
The epoch time for the time derivates.
.RS
.RE
.SH Parameters
.TP
.B \f[C]filename\f[] : character(*)
The ascii\-formatted filename containing the spherical harmonic
coefficients.
.RS
.RE
.TP
.B \f[C]lmaxin\f[] : integer
This spherical harmonic degree controls the dimension of the output
array \f[C]cilm\f[].
The coefficients between \f[C]lmax+1\f[] and \f[C]lmaxin\f[] will be set
to zero.
.RS
.RE
.SH Description
.PP
\f[C]SHRead2\f[] will read spherical harmonic coefficients from a CHAMP
or GRACE\-like ascii\-formatted file into an array \f[C]cilm\f[].
The errors and time derivatives associated with the coefficients will be
read if the optional arrays \f[C]error\f[] and \f[C]dot\f[] are
specified, respectively.
The staring and ending date of the solution are specified by the
optional parameters \f[C]doystart\f[] and \f[C]doyend\f[], and the epoch
of the time derivates is specified by the optional parameter
\f[C]epoch\f[].
The maximum spherical harmonic degree is read from the file, and the
file does not need to be ordered by angular degree or order.
.PP
This routine does not read and output all parameters in the file.
Records that are read (and at least partially output) include:
\f[C]EARTH\f[], \f[C]GGM\f[], \f[C]SHM\f[], \f[C]GRCOF2\f[],
\f[C]GRDOTA\f[], \f[C]CALSDV\f[], \f[C]gfc\f[], \f[C]gfct\f[], and
\f[C]dot\f[].
Comments specified by the record \f[C]CMMNT\f[] will be print out to the
screen, as will the record names that are not currently implemented.
.PP
Each line of the file starts with a character string describing what
follows.
.IP \[bu] 2
\f[C]EARTH\f[] or \f[C]GGM\f[]: \f[C]GM\f[], \f[C]R0_POT\f[]
.IP \[bu] 2
\f[C]SHM\f[]: Maximum spherical harmonic degree of file.
.IP \[bu] 2
\f[C]GRCOF2\f[], \f[C]CALSDV\f[], or \f[C]gfc\f[]: spherical harmonic
coefficients, formatted as (\f[C]l\f[], \f[C]m\f[], \f[C]clm\f[],
\f[C]slm\f[]) or (\f[C]l\f[], \f[C]m\f[], \f[C]clm\f[], \f[C]slm\f[],
\f[C]clm_error\f[], \f[C]slm_error\f[]).
.SH See also
.PP
shread, shread2error, shreadjpl