/
shreadh.html
153 lines (105 loc) · 5.21 KB
/
shreadh.html
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>SHTOOLS - Spherical harmonic I/O and storage routines</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../css/sh.css">
<link rel="icon" type="image/vnd.microsoft.icon" href="../../images/favicon.ico">
</head>
<body>
<div class="main">
<p class="centeredimage"><img src="../../images/logo.jpg" width=894 height=135 alt="SHTOOLS --- Tools for working with spherical harmonics"></p>
<table class="menu">
<tbody>
<tr>
<td><a href="http://shtools.ipgp.fr/">HOME</a></td>
<td><a href="https://github.com/SHTOOLS/SHTOOLS/releases">DOWNLOAD</a></td>
<td class="selected"><a href="../../documentation.html">DOCUMENTATION</a></td>
<td><a href="../../faq.html">FAQ</a> </td>
</tr>
</tbody>
</table>
<p class="dir">
> <a href="../../../index.html" class="dir">Home</a> > <a href="../../documentation.html" class="dir">Documentation</a> > <a href="../../io.html" class="dir">Spherical Harmonic I/O and Storage</a></p>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
<B>SHREADH(1)</B> SHTOOLS 3.0 <B>SHREADH(1)</B>
</PRE>
<H2 class="man">SHReadH</H2 class="man"><PRE>
SHReadH - Read spherical harmonic coefficients from an ASCII file.
</PRE>
<H2 class="man">SYNOPSIS</H2 class="man"><PRE>
SUBROUTINE SHReadH ( FILENAME, CILM, LMAX, SKIP, HEADER )
CHARACTER(*) FILENAME
REAL*8 CILM(2, LMAX+1, LMAX+1)
INTEGER LMAX
INTEGER, OPTIONAL SKIP
REAL*8, OPTIONAL <B>HEADER()</B>
</PRE>
<H2 class="man">DESCRIPTION</H2 class="man"><PRE>
<B>SHReadH</B> will read spherical harmonic coefficients from an ASCII file
into an array CILM. The maximum spherical harmonic degree that is read
is determined by the minimum of the dimension of the input array CILM -
1 and the maximum degree of the coefficients in the file. If the
optional array SKIP is specified, parsing of the file will commence
after the first SKIP lines. If the optional array HEADER is specified,
then the first N elements after the skipped lines will be output, where
N is the length of the array HEADER.
The spherical harmonic coefficients in the file are assumed to be
ordered by increasing degree L and angular order M according to the
format
L, M, CILM(1, L+1, M+1), CILM(2, L+1, M+1).
The actual delimeters are unimportant. If the optional array ERROR is
specified, then the error for each coefficient will be read according
to the format
L, M, CILM(1, L+1, M+1), CILM(2, L+1, M+1), ERROR(1, L+1, M+1),
ERROR(2, L+1, M+1).
</PRE>
<H2 class="man">ARGUMENTS</H2 class="man"><PRE>
FILENAME (input) CHARACTER(*)
The ASCII filename containing the spherical harmonic
coefficients.
CILM (output) REAL*8, DIMENSION (2, LMAX+1, LMAX+1)
The spherical harmonic coefficients contained in FILENAME.
LMAX (output) INTEGER
The maximum spherical harmonic degree of CILM. This is the
minimum of the maximum spherical harmonic degree of FILENAME
and the dimension of CILM - 1.
SKIP (input) INTEGER, OPTIONAL
The number of lines to skip before parsing FILENAME.
HEADER (output) REAL*8, OPTIONAL DIMENSION (N)
A vector containing the first N numbers in the first line of
the file (following any skipped lines).
</PRE>
<H2 class="man">NOTES</H2 class="man"><PRE>
The first spherical harmonic degree of the filename does not have to be
0; this is determined from the first element after the SKIP and HEADER
lines.
The ordering of the file is explcitly given by
l, 0 / l, 1 / l, 2 /l, ... / l, m / l+1, 0 / l+1, 1 / ...
</PRE>
<H2 class="man">SEE ALSO</H2 class="man"><PRE>
<B>shreadjpl(1)</B>, <B>shreadgrace(1)</B>, <B>shreadchamp(1)</B>
<http://shtools.ipgp.fr/>
</PRE>
<H2 class="man">COPYRIGHT AND LICENSE</H2 class="man"><PRE>
Copyright 2012 by Mark Wieczorek <wieczor@ipgp.fr>.
This is free software; you can distribute and modify it under the terms
of the revised BSD license.
SHTOOLS 3.0 2015-03-06 <B>SHREADH(1)</B>
</PRE>
<p class="dir">
> <a href="../../../index.html" class="dir">Home</a> > <a href="../../documentation.html" class="dir">Documentation</a> > <a href="../../io.html" class="dir">Spherical Harmonic I/O</a></p>
<table class="footer2" summary = "SHTOOLS; Fortran and Python spherical harmonic transform software package">
<tbody>
<tr>
<td class="c1"><a href="http://www.ipgp.fr/">Institut de Physique du Globe de Paris</a></td>
<td class="c2"><a href="http://www.sorbonne-paris-cite.fr/index.php/en">University of Sorbonne Paris Cité</a></td>
<td class="c3">© 2015 <a href="http://www.ipgp.fr/~wieczor">Mark Wieczorek</a></td>
</tr>
</tbody>
</table>
</div>
</body>
</html>