- Timestamp:
- 06/12/06 16:49:30 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ReadWrite/read_grads.html
r104 r106 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> reading grads file (except "data type station" or "grib") 90 from the grads control file even if there is multiple data files. 91 92 </div> 90 93 91 94 … … 102 105 <div class="routine_details" id="_read_grads"> 103 106 104 <h2><a class="top" href="#container">top</a>read_grads </h2> 107 <h2><a class="top" href="#container">top</a>read_grads <span class="categories"> reading function 108 </span></h2> 105 109 106 110 <p class="header"> 107 <span class="result">result = </span>read_grads(<span class="result"><a href="#_read_grads_param_var">var</a>, <a href="#_read_grads_param_date1">date1</a>, <a href="#_read_grads_param_date2">date2</a></span>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_grads_keyword_BOX">BOX</a>=<span class="result">BOX</span>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<span class="result">EVERYTHING</span>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 108 109 <div class="comments"> 110 NAME:read_grads 111 112 PURPOSE:reading grads file (except "data type station" or "grib") 113 from the grads control file even if there is multiple data files. 114 115 CATEGORY:reading function 116 117 CALLING SEQUENCE: 118 res=read_grads(var, date1 [, date2], FILENAME = filename) 119 120 INPUTS: 121 var: the variable name 122 date1: date of the beginning (yyyymmdd if TIMESTEP is not activate) 123 date2: last date. Optionnal, if not scpecified date2=date1 124 125 KEYWORD PARAMETERS: 126 127 FILENAME: the grads control file name: 'xxxx.ctl' 128 129 GLAMBOUNDARY (via computegrid.pro):a 2 elements vector, 130 {lon1,lon2], giving the longitute boundaries that should be 131 used to visualize the data. 132 lon2 > lon1 133 lon2 - lon1 eq 360 134 key_shift will be automatically defined according to 135 GLAMBOUNDARY. 136 137 /TIMESTEP: to specify that the dates are time steps instead of 111 <span class="result">result = </span>read_grads(<span class="result"><a href="#_read_grads_param_var">var</a>, <a href="#_read_grads_param_date1">date1</a>[, <a href="#_read_grads_param_date2">date2</a>]</span>, <a href="#_read_grads_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_read_grads_keyword_BOX">BOX</a>=<span class="result">BOX</span>, <a href="#_read_grads_keyword_TIMESTEP">TIMESTEP</a>=<span class="result">TIMESTEP</span>, <a href="#_read_grads_keyword_EVERYTHING">EVERYTHING</a>=<span class="result">EVERYTHING</span>, <a href="#_read_grads_keyword_NOSTRUCT">NOSTRUCT</a>=<span class="result">NOSTRUCT</span>, <a href="#_read_grads_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 112 113 <div class="comments"></div> 114 115 116 117 118 <h3>Parameters</h3> 119 120 121 <h4 id="_read_grads_param_var">var 122 <span class="attr">in</span> 123 124 125 <span class="attr">required</span> 126 127 128 129 130 </h4> 131 132 <div class="comments"> the variable name</div> 133 134 <h4 id="_read_grads_param_date1">date1 135 <span class="attr">in</span> 136 137 138 <span class="attr">required</span> 139 140 141 142 143 </h4> 144 145 <div class="comments"> date of the beginning (yyyymmdd if TIMESTEP is not activate)</div> 146 147 <h4 id="_read_grads_param_date2">date2 148 <span class="attr">in</span> 149 150 <span class="attr">optional</span> 151 152 153 154 155 156 </h4> 157 158 <div class="comments"> last date. Optionnal, if not scpecified date2=date1 159 </div> 160 161 162 163 164 165 166 <h3>Keywords</h3> 167 168 <h4 id="_read_grads_keyword_FILENAME">FILENAME 169 170 171 172 173 174 175 176 177 </h4> 178 179 <div class="comments"> the grads control file name: 'xxxx.ctl' 180 </div> 181 182 <h4 id="_read_grads_keyword_BOX">BOX 183 184 185 186 187 188 189 190 191 </h4> 192 193 <div class="comments"></div> 194 195 <h4 id="_read_grads_keyword_TIMESTEP">TIMESTEP 196 197 198 199 200 201 202 203 204 </h4> 205 206 <div class="comments"> to specify that the dates are time steps instead of 138 207 true calendar. 139 140 IODIRECTORY;a string giving the name of iodirectory (see 141 isafile.pro for all possibilities). default value is common 142 variable iodir 143 </div> 144 145 146 147 148 <h3>Parameters</h3> 149 150 151 <h4 id="_read_grads_param_var">var 152 153 154 155 156 157 158 159 160 </h4> 161 162 <div class="comments"></div> 163 164 <h4 id="_read_grads_param_date1">date1 165 166 167 168 169 170 171 172 173 </h4> 174 175 <div class="comments"></div> 176 177 <h4 id="_read_grads_param_date2">date2 178 179 180 181 182 183 184 185 186 </h4> 187 188 <div class="comments"></div> 189 190 191 192 193 194 195 <h3>Keywords</h3> 196 197 <h4 id="_read_grads_keyword_FILENAME">FILENAME 198 199 200 201 202 203 204 205 206 </h4> 207 208 <div class="comments"></div> 209 210 <h4 id="_read_grads_keyword_BOX">BOX 211 212 213 214 215 216 217 218 219 </h4> 220 221 <div class="comments"></div> 222 223 <h4 id="_read_grads_keyword_TIMESTEP">TIMESTEP 224 225 226 227 228 229 230 231 232 </h4> 233 234 <div class="comments"></div> 208 </div> 235 209 236 210 <h4 id="_read_grads_keyword_EVERYTHING">EVERYTHING
Note: See TracChangeset
for help on using the changeset viewer.
